Connect / Paginator / ListWorkspacePages

ListWorkspacePages

class Connect.Paginator.ListWorkspacePages

paginator = client.get_paginator('list_workspace_pages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_workspace_pages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    WorkspaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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