Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeView

Retrieves the view for the specified view token.

For security recommendations, see Amazon Connect Chat security best practices.

Request Syntax


GET /participant/views/ViewToken HTTP/1.1
X-Amz-Bearer: ConnectionToken

URI Request Parameters

The request uses the following URI parameters.

ConnectionToken

The connection token.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

ViewToken

An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "Id": "string",
      "Name": "string",
      "Version": number
   }
}

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.

View

A view resource object. Contains metadata and content necessary to render the view.

Type: View object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the Amazon Connect service.

HTTP Status Code: 500

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by Amazon Connect.

HTTP Status Code: 400