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

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

Overview

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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.

‘CustomerIdentifier` and `CustomerAWSAccountID` are mutually exclusive. You can’t specify both in the same request.

Returns:

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


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

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

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


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

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

#next_token ⇒ String

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

Returns:

  • (String) 


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

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

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


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

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