SDK for PHP 3.x

AWS Marketplace Entitlement Service 2017-01-11

Client: Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
Service ID: entitlement.marketplace
Version: 2017-01-11

This page describes the parameters and results for the operations of the AWS Marketplace Entitlement Service (2017-01-11), and shows how to use the Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient object to call the described operations. This documentation is specific to the 2017-01-11 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetEntitlements ( array $params = [] )
GetEntitlements retrieves entitlement values for a given product.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetEntitlements

Operations

GetEntitlements 

$result = $client->getEntitlements([/* ... */]);
$promise = $client->getEntitlementsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEntitlements([
    'Filter' => [
        '<GetEntitlementFilterName>' => ['<string>', ...],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductCode' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filter
Type: Associative array of custom strings keys (GetEntitlementFilterName) to stringss

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.

MaxResults
Type: int

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

NextToken
Type: string

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

ProductCode
Required: Yes
Type: 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.

Result Syntax

[
    'Entitlements' => [
        [
            'CustomerIdentifier' => '<string>',
            'Dimension' => '<string>',
            'ExpirationDate' => <DateTime>,
            'ProductCode' => '<string>',
            'Value' => [
                'BooleanValue' => true || false,
                'DoubleValue' => <float>,
                'IntegerValue' => <integer>,
                'StringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Entitlements
Type: Array of Entitlement structures

The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

NextToken
Type: string

For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

Errors

InvalidParameterException:

One or more parameters in your request was invalid.

ThrottlingException:

The calls to the GetEntitlements API are throttled.

InternalServiceErrorException:

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

Shapes

Entitlement

Description

An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

Members
CustomerIdentifier
Type: string

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

Dimension
Type: string

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

ExpirationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

ProductCode
Type: string

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

Value
Type: EntitlementValue structure

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

EntitlementValue

Description

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

Members
BooleanValue
Type: boolean

The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

DoubleValue
Type: double

The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

IntegerValue
Type: int

The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

StringValue
Type: string

The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

InternalServiceErrorException

Description

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

Members
message
Type: string

InvalidParameterException

Description

One or more parameters in your request was invalid.

Members
message
Type: string

ThrottlingException

Description

The calls to the GetEntitlements API are throttled.

Members
message
Type: string