Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWatchlist

Describes the specified watchlist.

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 that you are describing.

Type: String

Length Constraints: Fixed length of 22.

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

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.

Watchlist

Information about the specified watchlist.

Type: Watchlist object

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

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