Deletes the specified key pair, by removing the public key from Amazon EC2.
Request ParametersThe 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.
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
The name of the key pair.
Type: String
Required: No
The ID of the key pair.
Type: String
Required: No
The following elements are returned by the service.
The ID of the key pair.
Type: String
The ID of the request.
Type: String
Is true
if the request succeeds, and an error otherwise.
Type: Boolean
For information about the errors that are common to all actions, see Common client error codes.
Examples Example 1This example request deletes the key pair named my-key-pair
.
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
.
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:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4