Skip to content

CreateWorkspacePageRequest

Source code in docs_src/capo_connect/types/create_workspace_page_request.py
class CreateWorkspacePageRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId"
    """<p>The identifier of the workspace.</p>"""
    resource_arn: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the view to associate with the page.</p>"""
    page: "capo_connect.types.page.Page"
    """<p>The page identifier. Valid system pages include <code>HOME</code> and <code>AGENT_EXPERIENCE</code>. Custom pages cannot use the <code>aws:</code> or <code>connect:</code> prefixes.</p>"""
    slug: NotRequired["capo_connect.types.slug.Slug"]
    """<p>The URL-friendly identifier for the page.</p>"""
    input_data: NotRequired["capo_connect.types.input_data.InputData"]
    """<p>A JSON string containing input parameters for the view, validated against the view's input schema.</p>"""

input_data instance-attribute

input_data: NotRequired[InputData]

A JSON string containing input parameters for the view, validated against the view's input schema.

instance_id instance-attribute

instance_id: InstanceId

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

page instance-attribute

page: Page

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

resource_arn instance-attribute

resource_arn: ARN

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

slug instance-attribute

slug: NotRequired[Slug]

The URL-friendly identifier for the page.

workspace_id instance-attribute

workspace_id: WorkspaceId

The identifier of the workspace.