Skip to main content

views

Creates, updates, deletes, gets or lists a views resource.

Overview

Nameviews
TypeResource
Idaws.connectparticipant.views

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the view.
contentobjectView content containing all content necessary to render a view except for runtime input data.
idstringThe identifier of the view. (pattern: <code>^[a-zA-Z0-9_-:/$]+$</code>)
namestringThe name of the view. (pattern: <code>^([\p{L}\p{N}.:/=+-@()']+[\p{L}\p{Z}\p{N}.:/=+-@()']*)$</code>)
versionintegerThe current version of the view.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_viewselectview_token, X-Amz-Bearer, regionRetrieves 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.

NameDatatypeDescription
X-Amz-BearerstringThe connection token.
regionstringAWS region (default: us-east-1)
view_tokenstringAn encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.

SELECT examples

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
;