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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/types.rb

Overview

Note:

When making an API call, you may pass GetEntitlementsRequest data as a hash:

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

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

Instance Attribute Summary collapse

Instance Attribute Details

#filterHash<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>>)


135
136
137
138
139
140
141
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/types.rb', line 135

class GetEntitlementsRequest < Struct.new(
  :product_code,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


135
136
137
138
139
140
141
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/types.rb', line 135

class GetEntitlementsRequest < Struct.new(
  :product_code,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


135
136
137
138
139
140
141
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/types.rb', line 135

class GetEntitlementsRequest < Struct.new(
  :product_code,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end

#product_codeString

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)


135
136
137
138
139
140
141
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/types.rb', line 135

class GetEntitlementsRequest < Struct.new(
  :product_code,
  :filter,
  :next_token,
  :max_results)
  include Aws::Structure
end