:doc:`Transfer <../../transfer>` / Paginator / ListCertificates

****************
ListCertificates
****************



.. py:class:: Transfer.Paginator.ListCertificates

  ::

    
    paginator = client.get_paginator('list_certificates')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Transfer.Client.list_certificates`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListCertificates>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'Certificates': [
                {
                    'Arn': 'string',
                    'CertificateId': 'string',
                    'Usage': 'SIGNING'|'ENCRYPTION'|'TLS',
                    'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE',
                    'ActiveDate': datetime(2015, 1, 1),
                    'InactiveDate': datetime(2015, 1, 1),
                    'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY',
                    'Description': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Certificates** *(list) --* 

          Returns an array of the certificates that are specified in the ``ListCertificates`` call.

          
          

          - *(dict) --* 

            Describes the properties of a certificate.

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the specified certificate.

              
            

            - **CertificateId** *(string) --* 

              An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

              
            

            - **Usage** *(string) --* 

              Specifies how this certificate is used. It can be used in the following ways:

               

              
              * ``SIGNING``: For signing AS2 messages
               
              * ``ENCRYPTION``: For encrypting AS2 messages
               
              * ``TLS``: For securing AS2 communications sent over HTTPS
              

              
            

            - **Status** *(string) --* 

              The certificate can be either ``ACTIVE``, ``PENDING_ROTATION``, or ``INACTIVE``. ``PENDING_ROTATION`` means that this certificate will replace the current certificate when it expires.

              
            

            - **ActiveDate** *(datetime) --* 

              An optional date that specifies when the certificate becomes active. If you do not specify a value, ``ActiveDate`` takes the same value as ``NotBeforeDate``, which is specified by the CA.

              
            

            - **InactiveDate** *(datetime) --* 

              An optional date that specifies when the certificate becomes inactive. If you do not specify a value, ``InactiveDate`` takes the same value as ``NotAfterDate``, which is specified by the CA.

              
            

            - **Type** *(string) --* 

              The type for the certificate. If a private key has been specified for the certificate, its type is ``CERTIFICATE_WITH_PRIVATE_KEY``. If there is no private key, the type is ``CERTIFICATE``.

              
            

            - **Description** *(string) --* 

              The name or short description that's used to identify the certificate.

              
        
      
    