Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_client_certificates

get_client_certificates(**kwargs)

Gets a collection of ClientCertificate resources.

See also: AWS API Documentation

Request Syntax

response = client.get_client_certificates(
    position='string',
    limit=123
)
Parameters
  • position (string) -- The current pagination position in the paged result set.
  • limit (integer) -- The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Represents a collection of ClientCertificate resources.

    • position (string) --

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

Exceptions

  • APIGateway.Client.exceptions.BadRequestException
  • APIGateway.Client.exceptions.NotFoundException
  • APIGateway.Client.exceptions.UnauthorizedException
  • APIGateway.Client.exceptions.TooManyRequestsException