ListReceivedLicenses - Amazon License Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Lists received licenses.

Request Syntax

{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "LicenseArns": [ "string" ], "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


Filters to scope the results. The following filters are supported:

  • ProductSKU

  • Status

  • Fingerprint

  • IssuerName

  • Beneficiary

Type: Array of Filter objects

Required: No


Amazon Resource Names (ARNs) of the licenses.

Type: Array of strings

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: No


Maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No


Token for the next set of results.

Type: String

Required: No

Response Syntax

{ "Licenses": [ { "Beneficiary": "string", "ConsumptionConfiguration": { "BorrowConfiguration": { "AllowEarlyCheckIn": boolean, "MaxTimeToLiveInMinutes": number }, "ProvisionalConfiguration": { "MaxTimeToLiveInMinutes": number }, "RenewType": "string" }, "CreateTime": "string", "Entitlements": [ { "AllowCheckIn": boolean, "MaxCount": number, "Name": "string", "Overage": boolean, "Unit": "string", "Value": "string" } ], "HomeRegion": "string", "Issuer": { "KeyFingerprint": "string", "Name": "string", "SignKey": "string" }, "LicenseArn": "string", "LicenseMetadata": [ { "Name": "string", "Value": "string" } ], "LicenseName": "string", "ProductName": "string", "ProductSKU": "string", "ReceivedMetadata": { "AllowedOperations": [ "string" ], "ReceivedStatus": "string", "ReceivedStatusReason": "string" }, "Status": "string", "Validity": { "Begin": "string", "End": "string" }, "Version": "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.


Received license details.

Type: Array of GrantedLicense objects


Token for the next set of results.

Type: String


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


Access to resource denied.

HTTP Status Code: 400


The Amazon user account does not have permission to perform the action. Check the IAM policy associated with this account.

HTTP Status Code: 400


One or more parameter values are not valid.

HTTP Status Code: 400


Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400


Your resource limits have been exceeded.

HTTP Status Code: 400


The server experienced an internal error. Try again.

HTTP Status Code: 500


The provided input is not valid. Try your request again.

HTTP Status Code: 400

See Also

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