DescribeKeyPairs
Description
Returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.
Request Parameters
| Name | Description | Required |
|---|---|---|
|
Type: |
Ancestor: None
Children: keySet
keySet
Set of key pairs.
Type: DescribeKeyPairsInfoType
Ancestor: DescribeKeyPairs
Children: item
Yes, but can be empty
item
Information for a key pair.
Type: DescribeKeyPairsItemType
Ancestor: keySet
Children: keyName
No
keyName
Key pair to describe.
Type: xsd:string
Default: Describes all key pairs available to the account.
Ancestor: item
Children: None
No
Response Elements
| Name | Description |
|---|---|
|
|
Type: DescribeKeyPairsResponse Ancestor: None Children: |
|
The ID of the request. Type: xsd:string Ancestor: Children: None |
|
Information for a key pair. Type: DescribeKeyPairsResponseInfoType Ancestor: Children: |
|
Information for a key pair. Type: DescribeKeyPairsResponseItemType Ancestor: Children: |
|
The key pair name provided in the original request. Type: xsd:string Ancestor: Children: None |
|
A SHA-1 digest of the DER encoded private key. Type: xsd:string Ancestor: Children: None |
Examples
Example Request
This example describes the state of the gsg-keypair key.
<DescribeKeyPairs xmlns="http://ec2.amazonaws.com/doc/2009-04-04/">
<keySet>
<item>
<keyName>gsg-keypair</keyName>
</item>
</keySet>
</DescribeKeyPairs>
Example Response
<DescribeKeyPairsResponse xmlns="http://ec2.amazonaws.com/doc/2009-04-04/">
<keySet>
<item>
<keyName>gsg-keypair</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>