Request Syntax Request Parameters Response Elements Errors See Also

DeleteWatchlist

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

Request Syntax


{
   "DomainId": "string",
   "WatchlistId": "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.

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

WatchlistId

The identifier of the watchlist to be deleted.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^[a-zA-Z0-9]{22}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 ConflictType and 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 ResourceType and error message for more details.

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