KMS / Paginator / ListAliases

ListAliases

class KMS.Paginator.ListAliases

paginator = client.get_paginator('list_aliases')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KMS.Client.list_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    KeyId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• KeyId (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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

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 KMS key 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 KMS key in the account and Region. Formatted as Unix time.

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

  • NextToken (string) –

    A token to resume pagination.