associate_workspace `async` ¶

associate_workspace(
    instance_id: InstanceId,
    workspace_id: WorkspaceId,
    resource_arns: WorkspaceResourceArnList,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> AssociateWorkspaceResponse

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

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.
workspace_id (WorkspaceId) –

The identifier of the workspace.
resource_arns (WorkspaceResourceArnList) –

The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.

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.
ResourceNotFoundException –

The specified resource was not found.
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 associate_workspace(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId",
    resource_arns: "capo_connect.types.workspace_resource_arn_list.WorkspaceResourceArnList",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.associate_workspace_response.AssociateWorkspaceResponse":
    """<p>Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.</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>
        workspace_id: <p>The identifier of the workspace.</p>
        resource_arns: <p>The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</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.associate_workspace_request.AssociateWorkspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.associate_workspace_response.AssociateWorkspaceResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.associate_workspace

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateWorkspace")
    )
    input_: capo_connect.types.associate_workspace_request.AssociateWorkspaceRequest = {
        "instance_id": instance_id,
        "workspace_id": workspace_id,
        "resource_arns": resource_arns,
    }

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

associate_workspace async ¶

associate_workspace `async` ¶