Skip to content

Cancels all runs within a specified batch

Description

Cancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits cancel_run requests for runs that have already started.

Cancel is only allowed on batches in PENDING, SUBMITTING, or INPROGRESS state. Cancel operations are non-atomic and may be partially successful. Use get_batch to review successfulCancelSubmissionCount and failedCancelSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Usage

omics_cancel_run_batch(batchId)

Arguments

  • batchId

    [required] The identifier portion of the run batch ARN.

Value

An empty list.

Request syntax

svc$cancel_run_batch(
  batchId = "string"
)