:doc:`DirectoryService <../../ds>` / Paginator / ListCertificates

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



.. py:class:: DirectoryService.Paginator.ListCertificates

  ::

    
    paginator = client.get_paginator('list_certificates')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/ListCertificates>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DirectoryId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DirectoryId: string
    :param DirectoryId: **[REQUIRED]** 

      The identifier of the directory.

      

    
    :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**

      
      ::

        {
            'CertificatesInfo': [
                {
                    'CertificateId': 'string',
                    'CommonName': 'string',
                    'State': 'Registering'|'Registered'|'RegisterFailed'|'Deregistering'|'Deregistered'|'DeregisterFailed',
                    'ExpiryDateTime': datetime(2015, 1, 1),
                    'Type': 'ClientCertAuth'|'ClientLDAPS'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CertificatesInfo** *(list) --* 

          A list of certificates with basic details including certificate ID, certificate common name, certificate state.

          
          

          - *(dict) --* 

            Contains general information about a certificate.

            
            

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

              The identifier of the certificate.

              
            

            - **CommonName** *(string) --* 

              The common name for the certificate.

              
            

            - **State** *(string) --* 

              The state of the certificate.

              
            

            - **ExpiryDateTime** *(datetime) --* 

              The date and time when the certificate will expire.

              
            

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

              The function that the registered certificate performs. Valid values include ``ClientLDAPS`` or ``ClientCertAuth``. The default value is ``ClientLDAPS``.

              
        
      
    