GetListsMetadata
Gets the metadata of either all the lists under the account or the specified list.
Request Syntax
{
"maxResults": number,
"name": "string",
"nextToken": "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.
- maxResults
-
The maximum number of objects to return for the request.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 50.
Required: No
- name
-
The name of the list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_]+$Required: No
- nextToken
-
The next token for the subsequent request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
Response Syntax
{
"lists": [
{
"arn": "string",
"createdTime": "string",
"description": "string",
"name": "string",
"updatedTime": "string",
"variableType": "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.
- lists
-
The metadata of the specified list or all lists under the account.
Type: Array of AllowDenyList objects
- nextToken
-
The next page token.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as
PutExternalModel, that specifies a role that is not in your account.HTTP Status Code: 400
- InternalServerException
-
An exception indicating an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
An exception indicating the specified resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
An exception indicating a throttling error.
HTTP Status Code: 400
- ValidationException
-
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
