aws kms list-aliases

Gets a list of aliases in the caller's Amazon Web Services account and region. AWS CLI reference

2 examples 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

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.

aws kms list-aliasesIdentify

Its output

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

aws kms list-aliases --key-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Identify

--key-idLists only aliases that are associated with the specified KMS key.

Its output

{
    "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 in the AWS Key Management Service Developer Guide.

Options

3 in the AWS CLI reference

--key-idLists only aliases that are associated with the specified KMS key.

--limitUse this parameter to specify the maximum number of items to return.

--markerUse this parameter in a subsequent request after you receive a response with truncated results.