marketplacecatalog/aws.sdk.kotlin.services.marketplacecatalog.model/ListEntitiesRequest/Builder

Builder

Properties

The catalog related to the request. Fixed value: AWSMarketplace

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

entityTypeFilters

var entityTypeFilters: 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.

entityTypeSort

var entityTypeSort: 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.

filterList

var filterList: List<Filter>?

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

maxResults

var maxResults: Int?

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

nextToken

var nextToken: String?

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

ownershipType

var ownershipType: OwnershipType?

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.

sort

var sort: Sort?

An object that contains two attributes, SortBy and SortOrder.

Functions

sort

fun sort(block: Sort.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.marketplacecatalog.model.Sort inside the given block