:doc:`DocDB <../../docdb>` / Client / describe_certificates

*********************
describe_certificates
*********************



.. py:method:: DocDB.Client.describe_certificates(**kwargs)

  

  Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeCertificates>`_  


  **Request Syntax**
  ::

    response = client.describe_certificates(
        CertificateIdentifier='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string'
    )
    
  :type CertificateIdentifier: string
  :param CertificateIdentifier: 

    The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to ``MaxRecords`` certificates is returned. This parameter is not case sensitive.

     

    Constraints

     

    
    * Must match an existing ``CertificateIdentifier``.
    

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

       

      Wildcards are not supported in filters.

      

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

        The name of the filter. Filter names are case sensitive.

        

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

        One or more filter values. Filter values are case sensitive.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints:

     

    
    * Minimum: 20
     
    * Maximum: 100
    

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeCertificates`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Certificates': [
              {
                  'CertificateIdentifier': 'string',
                  'CertificateType': 'string',
                  'Thumbprint': 'string',
                  'ValidFrom': datetime(2015, 1, 1),
                  'ValidTill': datetime(2015, 1, 1),
                  'CertificateArn': 'string'
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A list of certificates for this Amazon Web Services account.

        
        

        - *(dict) --* 

          A certificate authority (CA) certificate for an Amazon Web Services account.

          
          

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

            The unique key that identifies a certificate.

             

            Example: ``rds-ca-2019``

            
          

          - **CertificateType** *(string) --* 

            The type of the certificate.

             

            Example: ``CA``

            
          

          - **Thumbprint** *(string) --* 

            The thumbprint of the certificate.

            
          

          - **ValidFrom** *(datetime) --* 

            The starting date-time from which the certificate is valid.

             

            Example: ``2019-07-31T17:57:09Z``

            
          

          - **ValidTill** *(datetime) --* 

            The date-time after which the certificate is no longer valid.

             

            Example: ``2024-07-31T17:57:09Z``

            
          

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

            The Amazon Resource Name (ARN) for the certificate.

             

            Example: ``arn:aws:rds:us-east-1::cert:rds-ca-2019``

            
      
    
      

      - **Marker** *(string) --* 

        An optional pagination token provided if the number of records retrieved is greater than ``MaxRecords``. If this parameter is specified, the marker specifies the next record in the list. Including the value of ``Marker`` in the next call to ``DescribeCertificates`` results in the next page of certificates.

        
  
  **Exceptions**
  
  *   :py:class:`DocDB.Client.exceptions.CertificateNotFoundFault`

  