PaymentCryptographyControlPlane / Client / list_aliases

list_aliases#

PaymentCryptographyControlPlane.Client.list_aliases(**kwargs)#

Lists the aliases for all keys in the caller’s Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

Cross-account use: This operation can’t be used across different Amazon Web Services accounts.

Related operations:

See also: AWS API Documentation

Request Syntax

response = client.list_aliases(
    KeyArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • KeyArn (string) – The keyARN for which you want to list all aliases.

  • NextToken (string) – Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.

  • MaxResults (integer) –

    Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography 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.

Return type:

dict

Returns:

Response Syntax

{
    'Aliases': [
        {
            'AliasName': 'string',
            'KeyArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Aliases (list) –

      The list of aliases. Each alias describes the KeyArn contained within.

      • (dict) –

        Contains information about an alias.

        • AliasName (string) –

          A friendly name that you can use to refer to a key. The value must begin with alias/.

          Warning

          Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

        • KeyArn (string) –

          The KeyARN of the key associated with the alias.

    • NextToken (string) –

      The token for the next set of results, or an empty or null value if there are no more results.

Exceptions