You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::MarketplaceCatalog::Types::ListEntitiesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MarketplaceCatalog::Types::ListEntitiesRequest
- Defined in:
- (unknown)
Overview
When passing ListEntitiesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
catalog: "Catalog", # required
entity_type: "EntityType", # required
filter_list: [
{
name: "FilterName",
value_list: ["StringValue"],
},
],
sort: {
sort_by: "SortBy",
sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
},
next_token: "NextToken",
max_results: 1,
}
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.
-
#sort ⇒ Types::Sort
An object that contains two attributes,
SortBy
andSortOrder
.
Instance Attribute Details
#catalog ⇒ String
The catalog related to the request. Fixed value: AWSMarketplace
#entity_type ⇒ String
The type of entities to retrieve.
#filter_list ⇒ Array<Types::Filter>
An array of filter objects. Each filter object contains two attributes,
filterName
and filterValues
.
#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.
#next_token ⇒ String
The value of the next token, if it exists. Null if there are no more results.
#sort ⇒ Types::Sort
An object that contains two attributes, SortBy
and SortOrder
.