Class: Aws::MarketplaceCatalog::Types::ListEntitiesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MarketplaceCatalog::Types::ListEntitiesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-marketplacecatalog/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#catalog ⇒ String
The catalog related to the request.
-
#entity_type ⇒ String
The type of entities to retrieve.
-
#filter_list ⇒ Array<Types::Filter>
An array of filter objects.
-
#max_results ⇒ Integer
Specifies the upper limit of the elements on a single page.
-
#next_token ⇒ String
The value of the next token, if it exists.
-
#ownership_type ⇒ String
Filters the returned set of entities based on their owner.
-
#sort ⇒ Types::Sort
An object that contains two attributes, ‘SortBy` and `SortOrder`.
Instance Attribute Details
#catalog ⇒ String
The catalog related to the request. Fixed value: ‘AWSMarketplace`
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#entity_type ⇒ String
The type of entities to retrieve.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#filter_list ⇒ Array<Types::Filter>
An array of filter objects. Each filter object contains two attributes, ‘filterName` and `filterValues`.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
Specifies the upper limit of the elements on a single page. If a value isn’t provided, the default value is 20.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
The value of the next token, if it exists. Null if there are no more results.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#ownership_type ⇒ String
Filters the returned set of entities based on their owner. The default is ‘SELF`. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to `SHARED`. Entities shared through the AWS Marketplace Catalog API `PutResourcePolicy` operation can’t be discovered through the ‘SHARED` parameter.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |
#sort ⇒ Types::Sort
An object that contains two attributes, ‘SortBy` and `SortOrder`.
646 647 648 649 650 651 652 653 654 655 656 |
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 646 class ListEntitiesRequest < Struct.new( :catalog, :entity_type, :filter_list, :sort, :next_token, :max_results, :ownership_type) SENSITIVE = [] include Aws::Structure end |