Sign In to the Console
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

AWS Documentation » Amazon EC2 » API Reference » Actions » DescribeKeyPairs

DescribeKeyPairs

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud 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, 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

Filter.N

The filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

Type: Array of Filter objects

Required: No

KeyName.N

The key pair names.

Default: Describes all your 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 of KeyPairInfo objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example

This example describes the keypair with name my-key-pair.

Sample Request

https://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.

Sample Request

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: