APIGateway / Client / update_client_certificate

update_client_certificate#

APIGateway.Client.update_client_certificate(**kwargs)#

Changes information about an ClientCertificate resource.

See also: AWS API Documentation

Request Syntax

response = client.update_client_certificate(
    clientCertificateId='string',
    patchOperations=[
        {
            'op': 'add'|'remove'|'replace'|'move'|'copy'|'test',
            'path': 'string',
            'value': 'string',
            'from': 'string'
        },
    ]
)
Parameters:
  • clientCertificateId (string) –

    [REQUIRED]

    The identifier of the ClientCertificate resource to be updated.

  • patchOperations (list) –

    For more information about supported patch operations, see Patch Operations.

    • (dict) –

      For more information about supported patch operations, see Patch Operations.

      • op (string) –

        An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..

      • path (string) –

        The op operation’s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {“name”:”value”}, the path for this property is /name. If the name property value is a JSON object (e.g., {“name”: {“child/name”: “child-value”}}), the path for the child/name property will be /name/child~1name. Any slash (“/”) character appearing in path names must be escaped with “~1”, as shown in the example above. Each op operation can have only one path associated with it.

      • value (string) –

        The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ‘{“a”: …}’.

      • from (string) –

        The copy update operation’s source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with “op”:”copy”, “from”:”/canarySettings/deploymentId” and “path”:”/deploymentId”.

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.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException