<a id="cli-aws-kms-list-aliases"></a>

# list-aliases

## Description

Gets a list of aliases in the caller’s Amazon Web Services account and region. For more information about aliases, see  CreateAlias .

By default, the `ListAliases` operation returns all aliases in the account and region. To get only the aliases associated with a particular KMS key, use the `KeyId` parameter.

The `ListAliases` response can include aliases that you created and associated with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format `aws/<service-name>` , such as `aws/dynamodb` .

The response might also include aliases that have no `TargetKeyId` field. These are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against your [KMS aliases quota](https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html#aliases-per-key) .

> **Cross-account use** : No. `ListAliases` does not return aliases in other Amazon Web Services accounts.

> **Required permissions** : [kms:ListAliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) (IAM policy)

For details, see [Controlling access to aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-access.html) in the *Key Management Service Developer Guide* .

> **Related operations:**
* CreateAlias
* DeleteAlias
* UpdateAlias

> **Eventual consistency** : The KMS API follows an eventual consistency model. For more information, see [KMS eventual consistency](https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency) .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases)

`list-aliases` 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: `Aliases`

## Synopsis

```
  list-aliases
[--key-id <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>]
```

## Options

`--key-id` (string)

> Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

> This parameter is optional. If you omit it, `ListAliases` returns all aliases in the account and Region.

> Specify the key ID or key ARN of the KMS key.

> For example:

> * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
> * Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

> To get the key ID and key ARN for a KMS key, use  ListKeys or  DescribeKey .

> Constraints:

> * min: `1`
> * max: `2048`

`--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: `1000`

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

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To list all aliases in an AWS account and Region**

The following `list-aliases` example lists all aliases in the default Region of the AWS account. The output includes aliases associated with AWS managed KMS keys and customer managed KMS keys.

```bash
aws kms list-aliases
```

Output:

```json
{
    "Aliases": [
        {
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/testKey",
            "AliasName": "alias/testKey",
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/FinanceDept",
            "AliasName": "alias/FinanceDept",
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/aws/dynamodb",
            "AliasName": "alias/aws/dynamodb",
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
        },
        {
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/aws/ebs",
            "AliasName": "alias/aws/ebs",
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444"
        }
    ]
}
```

**Example 2: To list all aliases for a particular KMS key**

The following `list-aliases` example uses the `key-id` parameter to list all aliases that are associated with a particular KMS key.

Each alias is associated with only one KMS key, but a KMS key can have multiple aliases. This command is very useful because the AWS KMS console lists only one alias for each KMS key. To find all aliases for a KMS key, you must use the `list-aliases` command.

This example uses the key ID of the KMS key for the `--key-id` parameter, but you can use a key ID, key ARN, alias name, or alias ARN in this command.

```bash
aws kms list-aliases \
    --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
```

Output:

```json
{
    "Aliases": [
        {
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/oregon-test-key",
            "AliasName": "alias/oregon-test-key"
        },
        {
            "TargetKeyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "AliasArn": "arn:aws:kms:us-west-2:123456789012:alias/project121-test",
            "AliasName": "alias/project121-test"
        }
    ]
}
```

For more information, see [Aliases in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *AWS Key Management Service Developer Guide*.

## Output

Aliases -> (list)

> A list of aliases.

> (structure)

> > Contains information about an alias.

> > AliasName -> (string)

> > > String that contains the alias. This value begins with `alias/` .

> > > Constraints:

> > > * min: `1`
> > > * max: `256`
> > > * pattern: `^[a-zA-Z0-9:/_-]+$`

> > AliasArn -> (string)

> > > String that contains the key ARN.

> > > Constraints:

> > > * min: `20`
> > > * max: `2048`

> > TargetKeyId -> (string)

> > > String that contains the key identifier of the KMS key associated with the alias.

> > > Constraints:

> > > * min: `1`
> > > * max: `2048`

> > CreationDate -> (timestamp)

> > > Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

> > LastUpdatedDate -> (timestamp)

> > > Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

NextMarker -> (string)

> When `Truncated` is true, this element is present and contains the value to use for the `Marker` parameter in a subsequent request.

> Constraints:

> * min: `1`
> * max: `1024`
> * pattern: `[\u0020-\u00FF]*`

Truncated -> (boolean)

> A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the `NextMarker` element in this response to the `Marker` parameter in a subsequent request.