GetEntitlements - AWS Marketplace Entitlement Service


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

Request Syntax

{ "Filter": { "string" : [ "string" ] }, "MaxResults": number, "NextToken": "string", "ProductCode": "string" }

Request Parameters

The request accepts the following data in JSON format.


In the following list, the required parameters are described first.


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes


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.

Type: String to array of strings map


Array Members: Minimum number of 1 item.

Required: No


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

Type: Integer

Required: No


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

Type: String

Pattern: \S+

Required: No

Response Syntax

{ "Entitlements": [ { "CustomerIdentifier": "string", "Dimension": "string", "ExpirationDate": number, "ProductCode": "string", "Value": { "BooleanValue": boolean, "DoubleValue": number, "IntegerValue": number, "StringValue": "string" } } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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.

Type: Array of Entitlement objects

Array Members: Minimum number of 0 items.


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.

Type: String

Pattern: \S+


For information about the errors that are common to all actions, see Common Errors.


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

HTTP Status Code: 500


One or more parameters in your request was invalid.

HTTP Status Code: 400


The calls to the GetEntitlements API are throttled.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: