AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#catalogString

The catalog related to the request. Fixed value: AWSMarketplace

Returns:

  • (String)

    The catalog related to the request.

#entity_typeString

The type of entities to retrieve.

Returns:

  • (String)

    The type of entities to retrieve.

#filter_listArray<Types::Filter>

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

Returns:

#max_resultsInteger

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

Returns:

  • (Integer)

    Specifies the upper limit of the elements on a single page.

#next_tokenString

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

Returns:

  • (String)

    The value of the next token, if it exists.

#sortTypes::Sort

An object that contains two attributes, SortBy and SortOrder.

Returns:

  • (Types::Sort)

    An object that contains two attributes, SortBy and SortOrder.