views
Creates, updates, deletes, gets or lists a views resource.
Overview
| Name | views |
| Type | Resource |
| Id | aws.connectparticipant.views |
Fields
The following fields are returned by SELECT queries:
- describe_view
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) of the view. |
content | object | View content containing all content necessary to render a view except for runtime input data. |
id | string | The identifier of the view. (pattern: <code>^[a-zA-Z0-9_-:/$]+$</code>) |
name | string | The name of the view. (pattern: <code>^([\p{L}\p{N}.:/=+-@()']+[\p{L}\p{Z}\p{N}.:/=+-@()']*)$</code>) |
version | integer | The current version of the view. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_view | select | view_token, X-Amz-Bearer, region | Retrieves the view for the specified view token. For security recommendations, see Connect Customer Chat security best practices. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
X-Amz-Bearer | string | The connection token. |
region | string | AWS region (default: us-east-1) |
view_token | string | An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view. |
SELECT examples
- describe_view
Retrieves the view for the specified view token. For security recommendations, see Connect Customer Chat security best practices.
SELECT
arn,
content,
id,
name,
version
FROM aws.connectparticipant.views
WHERE view_token = '{{ view_token }}' -- required
AND `X-Amz-Bearer` = '{{ X-Amz-Bearer }}' -- required
AND region = '{{ region }}' -- required
;