matflow.cancel#

matflow.cancel(workflow_ref, ref_is_path=None, status=True)#

Cancel the execution of a workflow submission.

Parameters:
  • workflow_ref (int | str | Path) – Which workflow to cancel, by ID or path.

  • ref_is_path (str) – One of “id”, “path” or “assume-id” (the default)

  • status (bool) – Whether to show a live status during cancel.

Return type:

None