DescribeKeyPairs
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, seeAmazon EC2 key pairs in theAmazon EC2 User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, seeCommon 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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.
Type: Array ofFilter objects
Required: No
- IncludePublicKey
If
true, the public key material is included in the response.Default:
falseType: Boolean
Required: No
- KeyName.N
The key pair names.
Default: Describes all of your key pairs.
Type: Array of strings
Required: No
- KeyPairId.N
The IDs of the key pairs.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- keySet
Information about the key pairs.
Type: Array ofKeyPairInfo objects
- requestId
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, seeCommon client error codes.
Examples
Example
This example describes the key pair with name my-key-pair.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeKeyPairs&KeyName.1=my-key-pair&AUTHPARAMSSample 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 stringDave.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeKeyPairs&Filter.1.Name=key-name&Filter.1.Value.1=*Dave*&AUTHPARAMSSee Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
