Skip to content

CreateWorkspaceRequest

Source code in docs_src/capo_connect/types/create_workspace_request.py
class CreateWorkspaceRequest(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>"""
    name: "capo_connect.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace. Must be unique within the instance and can contain 1-127 characters.</p>"""
    description: NotRequired[
        "capo_connect.types.workspace_description.WorkspaceDescription"
    ]
    """<p>The description of the workspace. Maximum length is 250 characters.</p>"""
    theme: NotRequired["capo_connect.types.workspace_theme.WorkspaceTheme"]
    """<p>The theme configuration for the workspace, including colors and styling.</p>"""
    title: NotRequired["capo_connect.types.workspace_title.WorkspaceTitle"]
    """<p>The title displayed for the workspace.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>"""

description instance-attribute

description: NotRequired[WorkspaceDescription]

The description of the workspace. Maximum length is 250 characters.

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.

name instance-attribute

The name of the workspace. Must be unique within the instance and can contain 1-127 characters.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

theme instance-attribute

theme: NotRequired[WorkspaceTheme]

The theme configuration for the workspace, including colors and styling.

title instance-attribute

title: NotRequired[WorkspaceTitle]

The title displayed for the workspace.