update_workspace_metadata ¶

def update_workspace_metadata(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    name: Optional["capo_connect.types.workspace_name.WorkspaceName"] = None,
    description: Optional[
        "capo_connect.types.workspace_description.WorkspaceDescription"
    ] = None,
    title: Optional["capo_connect.types.workspace_title.WorkspaceTitle"] = None,
) -> "capo_connect.types.update_workspace_metadata_response.UpdateWorkspaceMetadataResponse":
    """<p>Updates the metadata of a workspace, such as its name and description.</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>
        name: <p>The name of the workspace.</p>
        description: <p>The description of the workspace.</p>
        title: <p>The title displayed for 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.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.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.update_workspace_metadata_request.UpdateWorkspaceMetadataRequest]",
    ) -> OperationResponse[
        "capo_connect.types.update_workspace_metadata_response.UpdateWorkspaceMetadataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_workspace_metadata

        output, http_response = (
            capo_connect._operations.amazon_connect_service.update_workspace_metadata.update_workspace_metadata(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkspaceMetadata")
    )
    input_: capo_connect.types.update_workspace_metadata_request.UpdateWorkspaceMetadataRequest = {
        "instance_id": instance_id,
        "workspace_id": workspace_id,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if title is not None:
        input_["title"] = title

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output