DocDB / Paginator / DescribeCertificates

DescribeCertificates

class DocDB.Paginator.DescribeCertificates

paginator = client.get_paginator('describe_certificates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DocDB.Client.describe_certificates().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CertificateIdentifier (string) –

  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.

• Filters (list) –

  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) –

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'Certificates': [
        {
            'CertificateIdentifier': 'string',
            'CertificateType': 'string',
            'Thumbprint': 'string',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidTill': datetime(2015, 1, 1),
            'CertificateArn': 'string'
        },
    ],
    'NextToken': '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

  • NextToken (string) –

    A token to resume pagination.