ListPublicKeys
Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
Request Syntax
POST /ListPublicKeys HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- maxResults
-
Maximum number of results to return. Default: 50.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
The first public key to retrieve. This is used for pagination; see the
nextTokenresponse field.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[a-zA-Z0-9+/=_-]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"publicKeys": [
{
"arn": "string",
"name": "string",
"tags": {
"string" : "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.
- nextToken
-
If there are more public keys than
maxResults, usenextTokenin the request to get the next set.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[a-zA-Z0-9+/=_-]* - publicKeys
-
List of the matching public keys (summary information only).
Type: Array of PublicKeySummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
