APIGateway / Client / generate_client_certificate

generate_client_certificate#

APIGateway.Client.generate_client_certificate(**kwargs)#

Generates a ClientCertificate resource.

See also: AWS API Documentation

Request Syntax

response = client.generate_client_certificate(
    description='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • description (string) – The description of the ClientCertificate.

  • tags (dict) –

    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (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.ConflictException

  • APIGateway.Client.exceptions.LimitExceededException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException