ConnectParticipant / Client / describe_view

describe_view#

ConnectParticipant.Client.describe_view(**kwargs)#

Retrieves the view for the specified view token.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_view(
    ViewToken='string',
    ConnectionToken='string'
)
Parameters:

  • ViewToken (string) –

    [REQUIRED]

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

  • ConnectionToken (string) –

    [REQUIRED]

    The connection token.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • View (dict) –

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

      • Id (string) –

        The identifier of the view.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the view.

      • Name (string) –

        The name of the view.

      • Version (integer) –

        The current version of the view.

      • Content (dict) –

        View content containing all content necessary to render a view except for runtime input data.

        • InputSchema (string) –

          The schema representing the input data that the view template must be supplied to render.

        • Template (string) –

          The view template representing the structure of the view.

        • Actions (list) –

          A list of actions possible from the view

          • (string) –

Exceptions