Returns information about all key pairs in the user’s account.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-key-pairs
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: keyPairs
get-key-pairs
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get information about all key pairs
The following get-key-pairs
example displays details about all of the key pairs in the configured AWS Region.
aws lightsail get-key-pairs
Output:
{
"keyPairs": [
{
"name": "MyKey1",
"arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf",
"supportCode": "6EXAMPLE3362/MyKey1",
"createdAt": 1571255026.975,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"resourceType": "KeyPair",
"tags": [],
"fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj"
}
]
}
keyPairs -> (list)
An array of key-value pairs containing information about the key pairs.
(structure)
Describes an SSH key pair.
name -> (string)
The friendly name of the SSH key pair.
arn -> (string)
The Amazon Resource Name (ARN) of the key pair (e.g.,
arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE
).supportCode -> (string)
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
createdAt -> (timestamp)
The timestamp when the key pair was created (e.g.,
1479816991.349
).location -> (structure)
The region name and Availability Zone where the key pair was created.
availabilityZone -> (string)
The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName -> (string)
The AWS Region name.
resourceType -> (string)
The resource type (usually
KeyPair
).tags -> (list)
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .
(structure)
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide .
key -> (string)
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value -> (string)
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
fingerprint -> (string)
The RSA fingerprint of the key pair.
nextPageToken -> (string)
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another
GetKeyPairs
request and specify the next page token using thepageToken
parameter.