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

Class: Aws::MarketplaceEntitlementService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#get_entitlements(params = {}) ⇒ Types::GetEntitlementsResult

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

Examples:

Request syntax with placeholder values


resp = client.get_entitlements({
  product_code: "ProductCode", # required
  filter: {
    "CUSTOMER_IDENTIFIER" => ["FilterValue"],
  },
  next_token: "NonEmptyString",
  max_results: 1,
})

Response structure


resp.entitlements #=> Array
resp.entitlements[0].product_code #=> String
resp.entitlements[0].dimension #=> String
resp.entitlements[0].customer_identifier #=> String
resp.entitlements[0].value.integer_value #=> Integer
resp.entitlements[0].value.double_value #=> Float
resp.entitlements[0].value.boolean_value #=> Boolean
resp.entitlements[0].value.string_value #=> String
resp.entitlements[0].expiration_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :product_code (required, 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.

  • :filter (Hash<String,Array>)

    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.

  • :next_token (String)

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

  • :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:

See Also:



215
216
217
218
# File 'gems/aws-sdk-marketplaceentitlementservice/lib/aws-sdk-marketplaceentitlementservice/client.rb', line 215

def get_entitlements(params = {}, options = {})
  req = build_request(:get_entitlements, params)
  req.send_request(options)
end