Skip to content

API Gateway  >  Operations  >  generate_client_certificate

generate_client_certificate

Operation

generate_client_certificate async 

generate_client_certificate(input: GenerateClientCertificateInput, plugins: list[Plugin] | None = None) -> GenerateClientCertificateOutput

Generates a ClientCertificate resource.

Parameters:

Name Type Description Default
input GenerateClientCertificateInput

An instance of GenerateClientCertificateInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GenerateClientCertificateOutput

An instance of GenerateClientCertificateOutput.

Input

GenerateClientCertificateInput dataclass

A request to generate a ClientCertificate resource.

Attributes

description class-attribute instance-attribute 
description: str | None = None

The description of the ClientCertificate.

tags class-attribute instance-attribute 
tags: dict[str, str] | None = None

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.

Output

GenerateClientCertificateOutput dataclass

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

Attributes

client_certificate_id class-attribute instance-attribute 
client_certificate_id: str | None = None

The identifier of the client certificate.

created_date class-attribute instance-attribute 
created_date: datetime | None = None

The timestamp when the client certificate was created.

description class-attribute instance-attribute 
description: str | None = None

The description of the client certificate.

expiration_date class-attribute instance-attribute 
expiration_date: datetime | None = None

The timestamp when the client certificate will expire.

pem_encoded_certificate class-attribute instance-attribute 
pem_encoded_certificate: str | None = None

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

tags class-attribute instance-attribute 
tags: dict[str, str] | None = None

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