Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListEntitlements

Lists the entitlements for a specified account access manager application. You can filter results by principal, IAM role, or account. Use pagination to ensure that the operation returns quickly and successfully.

Request Syntax


POST /entitlements-list HTTP/1.1
Content-type: application/json

{
   "applicationArn": "string",
   "filter": { 
      "principalRole": { 
         "account": "string",
         "principal": { ... },
         "roleArn": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applicationArn

Specifies the ARN of the application to list entitlements for.

Type: String

Length Constraints: Minimum length of 49. Maximum length of 2048.

Pattern: arn:[a-z0-9-]+:account-access:[a-z0-9]+(-[a-z0-9]+)*:[0-9]{12}:application/[a-zA-Z0-9-]+

Required: Yes

filter

Specifies filter criteria to narrow the entitlements returned. You can filter by principal, IAM role, or account.

Type: EntitlementFilter object

Required: Yes

maxResults

Specifies the maximum number of results to return in a single call.

Type: Integer

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

Required: No

nextToken

Specifies the pagination token from a previous call to retrieve the next set of results.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "entitlements": [ 
      { 
         "createdAt": "string",
         "entitlement": { ... },
         "entitlementId": "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

The list of entitlements for the specified application.

Type: Array of EntitlementsListMember objects

nextToken

The pagination token to use in a subsequent request to retrieve the next set of results. This value is null when there are no more results to return.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal service error occurred. Try your request again later.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist. Verify that the resource identifier is correct and that the resource exists in the current Region.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Try your request again later.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by the service. Check your request parameters and retry the request.

HTTP Status Code: 400