Connect / Client / list_views

list_views#

Connect.Client.list_views(**kwargs)#

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

See also: AWS API Documentation

Request Syntax

response = client.list_views(
    InstanceId='string',
    Type='CUSTOMER_MANAGED'|'AWS_MANAGED',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

  • Type (string) – The type of the view.

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100.

Return type:

dict

Returns:

Response Syntax

{
    'ViewsSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
            'Status': 'PUBLISHED'|'SAVED',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ViewsSummaryList (list) –

      A list of view summaries.

      • (dict) –

        A summary of a view’s metadata.

        • Id (string) –

          The identifier of the view.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the view.

        • Name (string) –

          The name of the view.

        • Type (string) –

          The type of the view.

        • Status (string) –

          Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

        • Description (string) –

          The description of the view.

    • NextToken (string) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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