:doc:`DatabaseMigrationService <../../dms>` / Paginator / DescribeCertificates

********************
DescribeCertificates
********************



.. py:class:: DatabaseMigrationService.Paginator.DescribeCertificates

  ::

    
    paginator = client.get_paginator('describe_certificates')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DatabaseMigrationService.Client.describe_certificates`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeCertificates>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      Filters applied to the certificates described in the form of key-value pairs. Valid values are ``certificate-arn`` and ``certificate-id``.

      

    
      - *(dict) --* 

        Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular ``Describe*`` call or similar operation. Filters are used as an optional parameter for certain API operations.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter as specified for a ``Describe*`` or similar operation.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          The filter value, which can specify one or more values used to narrow the returned results.

          

        
          - *(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': [
                {
                    'CertificateIdentifier': 'string',
                    'CertificateCreationDate': datetime(2015, 1, 1),
                    'CertificatePem': 'string',
                    'CertificateWallet': b'bytes',
                    'CertificateArn': 'string',
                    'CertificateOwner': 'string',
                    'ValidFromDate': datetime(2015, 1, 1),
                    'ValidToDate': datetime(2015, 1, 1),
                    'SigningAlgorithm': 'string',
                    'KeyLength': 123,
                    'KmsKeyId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The Secure Sockets Layer (SSL) certificates associated with the replication instance.

          
          

          - *(dict) --* 

            The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

            
            

            - **CertificateIdentifier** *(string) --* 

              A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

              
            

            - **CertificateCreationDate** *(datetime) --* 

              The date that the certificate was created.

              
            

            - **CertificatePem** *(string) --* 

              The contents of a ``.pem`` file, which contains an X.509 certificate.

              
            

            - **CertificateWallet** *(bytes) --* 

              The location of an imported Oracle Wallet certificate for use with SSL. Example: ``filebase64("${path.root}/rds-ca-2019-root.sso")``

              
            

            - **CertificateArn** *(string) --* 

              The Amazon Resource Name (ARN) for the certificate.

              
            

            - **CertificateOwner** *(string) --* 

              The owner of the certificate.

              
            

            - **ValidFromDate** *(datetime) --* 

              The beginning date that the certificate is valid.

              
            

            - **ValidToDate** *(datetime) --* 

              The final date that the certificate is valid.

              
            

            - **SigningAlgorithm** *(string) --* 

              The signing algorithm for the certificate.

              
            

            - **KeyLength** *(integer) --* 

              The key length of the cryptographic algorithm being used.

              
            

            - **KmsKeyId** *(string) --* 

              An KMS key identifier that is used to encrypt the certificate.

               

              If you don't specify a value for the ``KmsKeyId`` parameter, then DMS uses your default encryption key.

               

              KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    