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

Inherits:

Struct

• Object
• Struct
• Aws::MarketplaceCatalog::Types::ListEntitiesRequest

Defined in:

gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #catalog ⇒ String

  The catalog related to the request.

• #entity_type ⇒ String

  The type of entities to retrieve.

• #entity_type_filters ⇒ Types::EntityTypeFilters

  A Union object containing filter shapes for all EntityTypes.

• #entity_type_sort ⇒ Types::EntityTypeSort

  A Union object containing Sort shapes for all EntityTypes.

• #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

Returns:

• (String)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

#entity_type ⇒ String

The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

Returns:

• (String)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

#entity_type_filters ⇒ Types::EntityTypeFilters

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

Returns:

• (Types::EntityTypeFilters)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

#entity_type_sort ⇒ Types::EntityTypeSort

A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

Returns:

• (Types::EntityTypeSort)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

• (Array<Types::Filter>)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

Returns:

• (String)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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

#sort ⇒ Types::Sort

An object that contains two attributes, SortBy and SortOrder.

Returns:

• (Types::Sort)

# File 'gems/aws-sdk-marketplacecatalog/lib/aws-sdk-marketplacecatalog/types.rb', line 1375

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