<a id="cli-aws-account-access-list-entitlements"></a>

# list-entitlements

## Description

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.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/account-access-2018-05-10/ListEntitlements)

`list-entitlements` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `entitlements`

## Synopsis

```
  list-entitlements
--application-arn <value>
--filter <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--application-arn` (string) [required]

> Specifies the ARN of the application to list entitlements for.

> Constraints:

> * min: `49`
> * max: `2048`
> * pattern: `arn:[a-z0-9-]+:account-access:[a-z0-9]+(-[a-z0-9]+)*:[0-9]{12}:application/[a-zA-Z0-9-]+`

`--filter` (structure) [required]

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

> principalRole -> (structure)

> > The principal-to-role filter criteria for narrowing entitlement results.

> > principal -> (tagged union structure)

> > > The principal to filter entitlements by.

> > > #### NOTE
> > > This is a Tagged Union structure. Only one of the following top level keys can be set: `identityCenter`.

> > > identityCenter -> (tagged union structure)

> > > > The IAM Identity Center principal filter criteria.

> > > > #### NOTE
> > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `userId`, `groupId`.

> > > > userId -> (string)

> > > > > The unique identifier of a user in IAM Identity Center to filter by.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `47`
> > > > > * pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`

> > > > groupId -> (string)

> > > > > The unique identifier of a group in IAM Identity Center to filter by.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `47`
> > > > > * pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`

> > roleArn -> (string)

> > > The IAM role ARN to filter entitlements by.

> > > Constraints:

> > > * pattern: `arn:[a-z0-9-]+:iam::[0-9]{12}:role/([a-zA-Z0-9+=,.@_-]+/)*[a-zA-Z0-9+=,.@_-]+`

> > account -> (string)

> > > The 12-digit Amazon Web Services account ID to filter entitlements by.

> > > Constraints:

> > > * min: `12`
> > > * max: `12`
> > > * pattern: `[0-9]{12}`

JSON Syntax:

```json
{
  "principalRole": {
    "principal": {
      "identityCenter": {
        "userId": "string",
        "groupId": "string"
      }
    },
    "roleArn": "string",
    "account": "string"
  }
}
```

`--starting-token` (string)

> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--page-size` (integer)

> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `100`

`--max-items` (integer)

> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

entitlements -> (list)

> The list of entitlements for the specified application.

> (structure)

> > Contains information about an entitlement in a list result.

> > entitlementId -> (string) [required]

> > > The unique identifier of the entitlement.

> > entitlement -> (tagged union structure) [required]

> > > The summary information for the entitlement.

> > > #### NOTE
> > > This is a Tagged Union structure. Only one of the following top level keys can be set: `principalRole`.

> > > principalRole -> (structure)

> > > > The principal-to-role mapping summary for the entitlement.

> > > > principal -> (tagged union structure) [required]

> > > > > The principal (user or group) that is granted access to assume the IAM role.

> > > > > #### NOTE
> > > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `identityCenter`.

> > > > > identityCenter -> (tagged union structure)

> > > > > > The IAM Identity Center principal (user or group).

> > > > > > #### NOTE
> > > > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `userId`, `groupId`.

> > > > > > userId -> (string)

> > > > > > > The unique identifier of a user in IAM Identity Center.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `47`
> > > > > > > * pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`

> > > > > > groupId -> (string)

> > > > > > > The unique identifier of a group in IAM Identity Center.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `47`
> > > > > > > * pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`

> > > > roleArn -> (string) [required]

> > > > > The ARN of the IAM role that the principal can assume.

> > > > > Constraints:

> > > > > * pattern: `arn:[a-z0-9-]+:iam::[0-9]{12}:role/([a-zA-Z0-9+=,.@_-]+/)*[a-zA-Z0-9+=,.@_-]+`

> > > > account -> (string) [required]

> > > > > The 12-digit Amazon Web Services account ID where the IAM role resides.

> > > > > Constraints:

> > > > > * min: `12`
> > > > > * max: `12`
> > > > > * pattern: `[0-9]{12}`

> > > > accountName -> (string)

> > > > > The friendly name of the Amazon Web Services account where the IAM role resides.

> > createdAt -> (timestamp) [required]

> > > The date and time when the entitlement was created.

nextToken -> (string)

> 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.