DeleteKeyPair - Amazon Elastic Compute Cloud
Request ParametersResponse ElementsErrorsExamplesSee Also

DeleteKeyPair

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

KeyName

The name of the key pair.

Type: String

Required: No

KeyPairId

The ID of the key pair.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

keyPairId

The ID of the key pair.

Type: String

requestId

The ID of the request.

Type: String

return

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example request deletes the key pair named my-key-pair.

Sample Request

https://ec2.amazonaws.com/?Action=DeleteKeyPair
&KeyName=my-key-pair
&AUTHPARAMS

Sample Response

<DeleteKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <return>true</return>
  <keyPairId>key-12345abcdeEXAMPLE</keyPairId>
</DeleteKeyPairResponse>

Example 2

This example request deletes a key pair with the ID key-abcd12345eEXAMPLE.

Sample Request

https://ec2.amazonaws.com/?Action=DeleteKeyPair
&KeyPairId=key-abcd12345eEXAMPLE
&AUTHPARAMS

Sample Response

<DeleteKeyPairResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <return>true</return>
  <keyPairId>key-abcd12345eEXAMPLE</keyPairId> 
</DeleteKeyPairResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: