Class: Aws::MarketplaceCatalog::Types::ListEntitiesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-marketplacecatalog/types.rb

Overview

Note:

When making an API call, you may pass ListEntitiesRequest data as a hash:

{
  catalog: "Catalog", # required
  entity_type: "EntityType", # required
  filter_list: [
    {
      name: "FilterName",
      value_list: ["FilterValueContent"],
    },
  ],
  sort: {
    sort_by: "SortBy",
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  next_token: "NextToken",
  max_results: 1,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog ⇒ String

The catalog related to the request. Fixed value: ‘AWSMarketplace`

Returns:

  • (String) 


644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#entity_type ⇒ String

The type of entities to retrieve.

Returns:

  • (String) 


644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filter_list ⇒ Array<Types::Filter>

An array of filter objects. Each filter object contains two attributes, ‘filterName` and `filterValues`.

Returns:



644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  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.

Returns:

  • (Integer) 


644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The value of the next token, if it exists. Null if there are no more results.

Returns:

  • (String) 


644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#sort ⇒ Types::Sort

An object that contains two attributes, ‘SortBy` and `SortOrder`.

Returns:



644
645
646
647
648
649
650
651
652
653
 
# File 'lib/aws-sdk-marketplacecatalog/types.rb', line 644

class ListEntitiesRequest < Struct.new(
  :catalog,
  :entity_type,
  :filter_list,
  :sort,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end