Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
Request Syntax
GET /v1/entitlements?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return per API request.
For example, you submit a
ListEntitlementsrequest with set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)The service might return fewer results than the
MaxResultsvalue. IfMaxResultsis not included in the request, the service defaults to pagination with a maximum of 20 results per page.Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
The token that identifies the batch of results that you want to see.
For example, you submit a
ListEntitlementsrequest withMaxResultsset at 5. The service returns the first batch of results (up to 5) and aNextTokenvalue. To see the next batch of results, you can submit theListEntitlementsrequest a second time and specify theNextTokenvalue.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"entitlements": [
{
"dataTransferSubscriberFeePercent": number,
"entitlementArn": "string",
"entitlementName": "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.
- entitlements
-
A list of entitlements that have been granted to you from other AWS accounts.
Type: Array of ListedEntitlement objects
- nextToken
-
The token that identifies the batch of results that you want to see.
For example, you submit a ListEntitlements request with
MaxResultsset at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit theListEntitlementsrequest a second time and specify theNextTokenvalue.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
HTTP Status Code: 400
- InternalServerErrorException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable or busy.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
