GetKeyPairs
Returns information about all key pairs in the user's account.
Request Syntax
{
"includeDefaultKeyPair": boolean,
"pageToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- includeDefaultKeyPair
-
A Boolean value that indicates whether to include the default key pair in the response of your request.
Type: Boolean
Required: No
- pageToken
-
The token to advance to the next page of results from your request.
To get a page token, perform an initial
GetKeyPairsrequest. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.Type: String
Required: No
Response Syntax
{
"keyPairs": [
{
"arn": "string",
"createdAt": number,
"fingerprint": "string",
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"name": "string",
"resourceType": "string",
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"nextPageToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- keyPairs
-
An array of key-value pairs containing information about the key pairs.
Type: Array of KeyPair objects
- nextPageToken
-
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
GetKeyPairsrequest and specify the next page token using thepageTokenparameter.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- AccountSetupInProgressException
-
Lightsail throws this exception when an account is still in the setup in progress state.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- OperationFailureException
-
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
