ListKeys
Lists API key resources in your AWS account.
Request Syntax
POST /metadata/v0/list-keys HTTP/1.1
Content-type: application/json
{
"Filter": {
"KeyStatus": "string
"
},
"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.
- Filter
-
Optionally filter the list to only
Active
orExpired
API keys.Type: ApiKeyFilter object
Required: No
- MaxResults
-
An optional limit for the number of resources returned in a single call.
Default value:
100
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value:
null
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Entries": [
{
"CreateTime": "string",
"Description": "string",
"ExpireTime": "string",
"KeyName": "string",
"Restrictions": {
"AllowActions": [ "string" ],
"AllowReferers": [ "string" ],
"AllowResources": [ "string" ]
},
"UpdateTime": "string"
}
],
"NextToken": "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.
- Entries
-
Contains API key resources in your AWS account. Details include API key name, allowed referers and timestamp for when the API key will expire.
Type: Array of ListKeysResponseEntry objects
- NextToken
-
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
HTTP Status Code: 403
- InternalServerException
-
The request has failed to process because of an unknown server error, exception, or failure.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied because of request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: