Skip to content

EC2  >  Operations  >  delete_key_pair

delete_key_pair

Operation

delete_key_pair async

delete_key_pair(input: DeleteKeyPairInput, plugins: list[Plugin] | None = None) -> DeleteKeyPairOutput

Deletes the specified key pair, by removing the public key from Amazon EC2.

Parameters:

Name Type Description Default
input DeleteKeyPairInput

An instance of DeleteKeyPairInput.

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
DeleteKeyPairOutput

An instance of DeleteKeyPairOutput.

Input

DeleteKeyPairInput dataclass

Bases: _SerdeShape

Dataclass for DeleteKeyPairInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

The name of the key pair.

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

The ID of the key pair.

Output

DeleteKeyPairOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteKeyPairOutput structure.

Attributes

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

The ID of the key pair.

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.

return_ class-attribute instance-attribute
return_: bool | None = ...

Is true if the request succeeds, and an error otherwise.