Connect / Client / list_workspace_pages

list_workspace_pages

Connect.Client.list_workspace_pages(**kwargs)

Lists the page configurations in a workspace, including the views assigned to each page.

See also: AWS API Documentation

Request Syntax

response = client.list_workspace_pages(
    InstanceId='string',
    WorkspaceId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the workspace.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'WorkspacePageList': [
        {
            'ResourceArn': 'string',
            'Page': 'string',
            'Slug': 'string',
            'InputData': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

    • WorkspacePageList (list) –

      A list of page configurations in the workspace.

      • (dict) –

        Contains information about a page configuration in a workspace, including the view assigned to the page.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the view associated with this page.

        • Page (string) –

          The page identifier. System pages include HOME and AGENT_EXPERIENCE.

        • Slug (string) –

          The URL-friendly identifier for the page.

        • InputData (string) –

          A JSON string containing input parameters passed to the view when the page is rendered.

Exceptions