:doc:`PaymentCryptographyControlPlane <../../payment-cryptography>` / Paginator / ListAliases

***********
ListAliases
***********



.. py:class:: PaymentCryptographyControlPlane.Paginator.ListAliases

  ::

    
    paginator = client.get_paginator('list_aliases')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PaymentCryptographyControlPlane.Client.list_aliases`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/ListAliases>`_    


    **Request Syntax**
    ::

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

      The ``keyARN`` for which you want to list all aliases.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

              
        
      
    