Connect / Client / describe_view
describe_view#
- Connect.Client.describe_view(**kwargs)#
Retrieves the view for the specified Amazon Connect instance and view identifier.
The view identifier can be supplied as a ViewId or ARN.
$SAVED
needs to be supplied if a view is unpublished.The view identifier can contain an optional qualifier, for example,
<view-id>:$SAVED
, which is either an actual version number or an Amazon Connect managed qualifier$SAVED | $LATEST
. If it is not supplied, then$LATEST
is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.See also: AWS API Documentation
Request Syntax
response = client.describe_view( InstanceId='string', ViewId='string' )
- Parameters:
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
ViewId (string) –
[REQUIRED]
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
- Return type:
dict
- Returns:
Response Syntax
{ 'View': { 'Id': 'string', 'Arn': 'string', 'Name': 'string', 'Status': 'PUBLISHED'|'SAVED', 'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED', 'Description': 'string', 'Version': 123, 'VersionDescription': 'string', 'Content': { 'InputSchema': 'string', 'Template': 'string', 'Actions': [ 'string', ] }, 'Tags': { 'string': 'string' }, 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'ViewContentSha256': 'string' } }
Response Structure
(dict) –
View (dict) –
All view data is contained within the View object.
Id (string) –
The identifier of the view.
Arn (string) –
The Amazon Resource Name (ARN) of the view.
Name (string) –
The name of the view.
Status (string) –
Indicates the view status as either
SAVED
orPUBLISHED
. ThePUBLISHED
status will initiate validation on the content.Type (string) –
The type of the view -
CUSTOMER_MANAGED
.Description (string) –
The description of the view.
Version (integer) –
Current version of the view.
VersionDescription (string) –
The description of the version.
Content (dict) –
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) –
The data schema matching data that the view template must be provided to render.
Template (string) –
The view template representing the structure of the view.
Actions (list) –
A list of possible actions from the view.
(string) –
Tags (dict) –
The tags associated with the view resource (not specific to view version).
(string) –
(string) –
CreatedTime (datetime) –
The timestamp of when the view was created.
LastModifiedTime (datetime) –
Latest timestamp of the
UpdateViewContent
orCreateViewVersion
operations.ViewContentSha256 (string) –
Indicates the checksum value of the latest published view content.
Exceptions
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.TooManyRequestsException