APIGateway / Paginator / GetClientCertificates

GetClientCertificates

class APIGateway.Paginator.GetClientCertificates

paginator = client.get_paginator('get_client_certificates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from APIGateway.Client.get_client_certificates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'items': [
        {
            'clientCertificateId': 'string',
            'description': 'string',
            'pemEncodedCertificate': 'string',
            'createdDate': datetime(2015, 1, 1),
            'expirationDate': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents a collection of ClientCertificate resources.

  • items (list) –

    The current page of elements from this collection.

    • (dict) –

      Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

      • clientCertificateId (string) –

        The identifier of the client certificate.

      • description (string) –

        The description of the client certificate.

      • pemEncodedCertificate (string) –

        The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

      • createdDate (datetime) –

        The timestamp when the client certificate was created.

      • expirationDate (datetime) –

        The timestamp when the client certificate will expire.

      • tags (dict) –

        The collection of tags. Each tag element is associated with a given resource.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.