         | Did this page help you? Yes No Tell us about it... |
ec2-describe-keypairs
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 your key pairs is returned.
You can filter the results to return information only about key pairs that match criteria you specify. For example, you could filter the results to return only the key pairs whose names include the string Dave. You can specify multiple values for a filter. A key pair must match at least one of the specified values for it to be included in the results.
You can specify multiple filters (e.g., the key pair name includes the string Dave, and the fingerprint equals a certain value). The result includes information for a particular key pair only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
| Filter Name | Description |
|---|---|
|
|
Fingerprint of the key pair. Type: String |
|
|
Name of the key pair. Type: String |
The short version of this command is ec2dkey.
Syntax
ec2-describe-keypairs [
keypair_name ...]
[[--filter name=value] ...]
Options
| Name | Description | Required |
|---|---|---|
|
|
Name of the key pair to describe. Type: String Default: Describes all key pairs you own, or only those otherwise specified. Example: gsg-keypair |
No |
|
|
A filter for limiting the results. See the preceding table for a list of allowed filter names and values. If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "name=value"). Type: String Default: Describes all key pairs you own, or only those otherwise specified. Example: --filter "tag-name=*Dave*" |
No |
Common Options
| Option | Description |
|---|---|
|
|
Overrides the Region specified in the Default: The Example: |
|
|
Default: The Example: |
|
|
The private key to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
Specifies a connection timeout (in seconds). Example: --connection-timeout 30 |
|
|
Specifies a request timeout (in seconds). Example: --request-timeout 45 |
|
|
Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API. |
|
|
Displays column headers in the output. |
|
|
Shows empty columns as |
|
|
Do not display tags for tagged resources. |
|
|
Prints internal debugging information. This is useful to assist us when troubleshooting problems. |
|
|
Displays Help. |
|
|
If Example: |
Output
The command returns a table that contains the following information:
KEYPAIR identifier
Key pair name
Private key fingerprint
Amazon EC2 command line tools display errors on stderr.
Examples
Example Request
This example describes the keypair with name gsg-keypair.
PROMPT>ec2-describe-keypairs gsg-keypairKEYPAIR gsg-keypair 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f
Example Request
This example filters the results to display only key pairs whose names include the string Dave.
PROMPT> ec2-describe-keypairs --filter "key-name=*Dave*"
