describe_workspace async ¶

async def describe_workspace(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.describe_workspace_response.DescribeWorkspaceResponse":
    """<p>Retrieves details about a workspace, including its configuration and metadata.</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>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</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.describe_workspace_request.DescribeWorkspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.describe_workspace_response.DescribeWorkspaceResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.describe_workspace

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspace")
    )
    input_: capo_connect.types.describe_workspace_request.DescribeWorkspaceRequest = {
        "instance_id": instance_id,
        "workspace_id": workspace_id,
    }

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