create_workspace `async` ¶

create_workspace(
    instance_id: InstanceId,
    name: WorkspaceName,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[WorkspaceDescription] = None,
    theme: Optional[WorkspaceTheme] = None,
    title: Optional[WorkspaceTitle] = None,
    tags: Optional[TagMap] = None,
) -> CreateWorkspaceResponse

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Parameters:

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 (WorkspaceName) –

The name of the workspace. Must be unique within the instance and can contain 1-127 characters.
description (Optional[WorkspaceDescription], default: None ) –

The description of the workspace. Maximum length is 250 characters.
theme (Optional[WorkspaceTheme], default: None ) –

The theme configuration for the workspace, including colors and styling.
title (Optional[WorkspaceTitle], default: None ) –

The title displayed for the workspace.
tags (Optional[TagMap], default: None ) –

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

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
DuplicateResourceException –

A resource with the specified name already exists.
InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
InvalidRequestException –

The request is not valid.
LimitExceededException –

The allowed limit for the resource has been exceeded.
ResourceNotFoundException –

The specified resource was not found.
ServiceQuotaExceededException –

The service quota has been exceeded.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connect/_services/async_connect.py

async def create_workspace(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    name: "capo_connect.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[
        "capo_connect.types.workspace_description.WorkspaceDescription"
    ] = None,
    theme: Optional["capo_connect.types.workspace_theme.WorkspaceTheme"] = None,
    title: Optional["capo_connect.types.workspace_title.WorkspaceTitle"] = None,
    tags: Optional["capo_connect.types.tag_map.TagMap"] = None,
) -> "capo_connect.types.create_workspace_response.CreateWorkspaceResponse":
    """<p>Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.</p>

    Args:
        instance_id: <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: <p>The name of the workspace. Must be unique within the instance and can contain 1-127 characters.</p>
        description: <p>The description of the workspace. Maximum length is 250 characters.</p>
        theme: <p>The theme configuration for the workspace, including colors and styling.</p>
        title: <p>The title displayed for the workspace.</p>
        tags: <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.create_workspace_request.CreateWorkspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.create_workspace_response.CreateWorkspaceResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.create_workspace

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.create_workspace.async_create_workspace(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkspace")
    )
    input_: capo_connect.types.create_workspace_request.CreateWorkspaceRequest = {
        "instance_id": instance_id,
        "name": name,
    }
    if description is not None:
        input_["description"] = description
    if theme is not None:
        input_["theme"] = theme
    if title is not None:
        input_["title"] = title
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_workspace async ¶

create_workspace `async` ¶