PaymentCryptographyControlPlane / Paginator / ListAliases

ListAliases¶

class PaymentCryptographyControlPlane.Paginator.ListAliases¶

paginator = client.get_paginator('list_aliases')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

KeyArn (string) – The keyARN for which you want to list all aliases.
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',
            'KeyArn': '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.