AWS Key Management Service

{'Aliases': {'CreationDate': 'timestamp', 'LastUpdatedDate': 'timestamp'}}

Gets a list of aliases in the caller's AWS 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 customer master key (CMK), use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS 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 AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota .

Cross-account use : No. ListAliases does not return aliases in other AWS accounts.

Required permissions : kms:ListAliases (IAM policy)

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide .

Related operations:

• CreateAlias

• DeleteAlias

• UpdateAlias

See also: AWS API Documentation

Request Syntax

client.list_aliases(
    KeyId='string',
    Limit=123,
    Marker='string'
)

type KeyId

string

param KeyId

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS account.

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey .

type Limit

integer

param Limit

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

type Marker

string

param Marker

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

rtype

dict

returns

Response Syntax

{
    'Aliases': [
        {
            'AliasName': 'string',
            'AliasArn': 'string',
            'TargetKeyId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'LastUpdatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextMarker': 'string',
    'Truncated': True|False
}

Response Structure

• (dict) --

  • Aliases (list) --

    A list of aliases.

    • (dict) --

      Contains information about an alias.

      • AliasName (string) --

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

      • AliasArn (string) --

        String that contains the key ARN.

      • TargetKeyId (string) --

        String that contains the key identifier of the CMK associated with the alias.

      • CreationDate (datetime) --

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

      • LastUpdatedDate (datetime) --

        Date and time that the alias was most recently associated with a CMK 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.

  • 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 thisresponse to the Marker parameter in a subsequent request.