You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MarketplaceEntitlementService::Types::GetEntitlementsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetEntitlementsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  product_code: "ProductCode", # required
  filter: {
    "CUSTOMER_IDENTIFIER" => ["FilterValue"],
  },
  next_token: "NonEmptyString",
  max_results: 1,
}

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Hash<String,Array<String>>

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

Returns:

  • (Hash<String,Array<String>>) —

    Filter is used to return entitlements for a specific customer or for a specific dimension.

#max_results ⇒ Integer

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

Returns:

  • (Integer) —

    The maximum number of items to retrieve from the GetEntitlements operation.

#next_token ⇒ String

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

Returns:

  • (String) —

    For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

#product_code ⇒ String

Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

Returns:

  • (String) —

    Product code is used to uniquely identify a product in AWS Marketplace.