Creates a watchlist that fraudsters can be a part of.
Request Syntax
{
"ClientToken": "string",
"Description": "string",
"DomainId": "string",
"Name": "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.
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_]+Required: No
- Description
-
A brief description of this watchlist.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)Required: No
- DomainId
-
The identifier of the domain that contains the watchlist.
Type: String
Length Constraints: Fixed length of 22.
Pattern:
[a-zA-Z0-9]{22}Required: Yes
- Name
-
The name of the watchlist.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: Yes
Response Syntax
{
"Watchlist": {
"CreatedAt": number,
"DefaultWatchlist": boolean,
"Description": "string",
"DomainId": "string",
"Name": "string",
"UpdatedAt": number,
"WatchlistId": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action. Check the error message and try again.
HTTP Status Code: 400
- ConflictException
-
The request failed due to a conflict. Check the
ConflictTypeand error message for more details.HTTP Status Code: 400
- InternalServerException
-
The request failed due to an unknown error on the server side.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found. Check the
ResourceTypeand error message for more details.HTTP Status Code: 400
- ServiceQuotaExceededException
-
The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
HTTP Status Code: 400
- ValidationException
-
The request failed one or more validations; check the error message for more details.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
