Skip to content

delete_workspace_instance

delete_workspace_instance(
    workspace_instance_id: WorkspaceInstanceId,
    *,
    config_overrides: Optional[WorkspacesInstancesClientConfig] = None,
) -> DeleteWorkspaceInstanceResponse

Deletes the specified WorkSpace

Usage of this API will result in deletion of the resource in question.

Parameters:

  • workspace_instance_id (WorkspaceInstanceId) –

    Unique identifier of the WorkSpaces Instance targeted for deletion.

Raises:

Source code in docs_src/capo_workspaces_instances/_services/workspaces_instances.py
def delete_workspace_instance(
    self,
    workspace_instance_id: "capo_workspaces_instances.types.workspace_instance_id.WorkspaceInstanceId",
    *,
    config_overrides: Optional[WorkspacesInstancesClientConfig] = None,
) -> "capo_workspaces_instances.types.delete_workspace_instance_response.DeleteWorkspaceInstanceResponse":
    """<p>Deletes the specified WorkSpace</p> <important> <p>Usage of this API will result in deletion of the resource in question.</p> </important>

    Args:
        workspace_instance_id: <p>Unique identifier of the WorkSpaces Instance targeted for deletion.</p>

    Raises:
        capo_workspaces_instances.errors.access_denied_exception.AccessDeniedException: <p>Indicates insufficient permissions to perform the requested action.</p>
        capo_workspaces_instances.errors.conflict_exception.ConflictException: <p>Signals a conflict with the current state of the resource.</p>
        capo_workspaces_instances.errors.internal_server_exception.InternalServerException: <p>Indicates an unexpected server-side error occurred.</p>
        capo_workspaces_instances.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates the requested resource could not be found.</p>
        capo_workspaces_instances.errors.throttling_exception.ThrottlingException: <p>Indicates the request rate has exceeded limits.</p>
        capo_workspaces_instances.errors.validation_exception.ValidationException: <p>Indicates invalid input parameters in the request.</p>
        capo_workspaces_instances.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_instances.types.delete_workspace_instance_request.DeleteWorkspaceInstanceRequest]",
    ) -> OperationResponse[
        "capo_workspaces_instances.types.delete_workspace_instance_response.DeleteWorkspaceInstanceResponse"
    ]:
        import capo_workspaces_instances._operations.eucmi_frontend_api_service.delete_workspace_instance

        output, http_response = (
            capo_workspaces_instances._operations.eucmi_frontend_api_service.delete_workspace_instance.delete_workspace_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkspaceInstance")
    )
    input_: capo_workspaces_instances.types.delete_workspace_instance_request.DeleteWorkspaceInstanceRequest = {
        "workspace_instance_id": workspace_instance_id
    }

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