Connect / Client / create_workspace_page

create_workspace_page

Connect.Client.create_workspace_page(**kwargs)

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

See also: AWS API Documentation

Request Syntax

response = client.create_workspace_page(
    InstanceId='string',
    WorkspaceId='string',
    ResourceArn='string',
    Page='string',
    Slug='string',
    InputData='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.

  • ResourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the view to associate with the page.

  • Page (string) –

    [REQUIRED]

    The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use the aws: or connect: prefixes.

  • Slug (string) – The URL-friendly identifier for the page.

  • InputData (string) – A JSON string containing input parameters for the view, validated against the view’s input schema.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions