NAME

Paws::MarketplaceCatalog::ListEntities - Arguments for method ListEntities on Paws::MarketplaceCatalog

DESCRIPTION

This class represents the parameters used for calling the method ListEntities on the AWS Marketplace Catalog Service service. Use the attributes of this class as arguments to method ListEntities.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListEntities.

SYNOPSIS

my $catalog.marketplace = Paws->service('MarketplaceCatalog');
my $ListEntitiesResponse = $catalog . marketplace->ListEntities(
  Catalog    => 'MyCatalog',
  EntityType => 'MyEntityType',
  FilterList => [
    {
      Name      => 'MyFilterName',    # min: 1, max: 255; OPTIONAL
      ValueList => [
        'MyFilterValueContent', ...    # min: 1, max: 255
      ],    # min: 1, max: 10; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  MaxResults => 1,                # OPTIONAL
  NextToken  => 'MyNextToken',    # OPTIONAL
  Sort       => {
    SortBy    => 'MySortBy',      # min: 1, max: 255; OPTIONAL
    SortOrder => 'ASCENDING',     # values: ASCENDING, DESCENDING; OPTIONAL
  },    # OPTIONAL
);

# Results:
my $EntitySummaryList = $ListEntitiesResponse->EntitySummaryList;
my $NextToken         = $ListEntitiesResponse->NextToken;

# Returns a L<Paws::MarketplaceCatalog::ListEntitiesResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/catalog.marketplace/ListEntities

ATTRIBUTES

REQUIRED Catalog => Str

The catalog related to the request. Fixed value: AWSMarketplace

REQUIRED EntityType => Str

The type of entities to retrieve.

FilterList => ArrayRef[Paws::MarketplaceCatalog::Filter]

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

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 => Str

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

Sort => Paws::MarketplaceCatalog::Sort

An object that contains two attributes, SortBy and SortOrder.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListEntities in Paws::MarketplaceCatalog

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues