Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.
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 filters.
key-pair-id
- The ID of the key pair.
fingerprint
- The fingerprint of the key pair.
key-name
- The name of the key pair.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
Type: Array of Filter objects
Required: No
If true
, the public key material is included in the response.
Default: false
Type: Boolean
Required: No
The key pair names.
Default: Describes all of your key pairs.
Type: Array of strings
Required: No
The IDs of the key pairs.
Type: Array of strings
Required: No
The following elements are returned by the service.
Information about the key pairs.
Type: Array of KeyPairInfo objects
The ID of the request.
Type: String
For information about the errors that are common to all actions, see Common client error codes.
Examples ExampleThis example describes the key pair with name my-key-pair.
Sample Requesthttps://ec2.amazonaws.com/?Action=DescribeKeyPairs
&KeyName.1=my-key-pair
&AUTHPARAMS
Sample Response
<DescribeKeyPairsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<keySet>
<item>
<keyName>my-key-pair</keyName>
<keyFingerprint>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFingerprint>
</item>
</keySet>
</DescribeKeyPairsResponse>
Example
This example filters the response to include only key pairs whose names include the string Dave
.
https://ec2.amazonaws.com/?Action=DescribeKeyPairs
&Filter.1.Name=key-name
&Filter.1.Value.1=*Dave*
&AUTHPARAMS
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