Skip to content

CloudFront  >  Operations  >  update_public_key

update_public_key

Operation

update_public_key async

update_public_key(input: UpdatePublicKeyInput, plugins: list[Plugin] | None = None) -> UpdatePublicKeyOutput

Update public key information. Note that the only value you can change is the comment.

Parameters:

Name Type Description Default
input UpdatePublicKeyInput

An instance of UpdatePublicKeyInput.

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
UpdatePublicKeyOutput

An instance of UpdatePublicKeyOutput.

Input

UpdatePublicKeyInput dataclass

Bases: _SerdeShape

Dataclass for UpdatePublicKeyInput structure.

Attributes

id class-attribute instance-attribute
id: str | None = ...

The identifier of the public key that you are updating.

if_match class-attribute instance-attribute
if_match: str | None = ...

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

public_key_config class-attribute instance-attribute
public_key_config: PublicKeyConfig | None = ...

A public key configuration.

Output

UpdatePublicKeyOutput dataclass

Bases: _SerdeShape

Dataclass for UpdatePublicKeyOutput structure.

Attributes

e_tag class-attribute instance-attribute
e_tag: str | None = ...

The identifier of the current version of the public key.

public_key class-attribute instance-attribute
public_key: PublicKey | None = ...

The public key.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.