Delete Batch

omics_delete_batch

R Documentation

Deletes a run batch resource and its associated metadata¶

Description¶

Deletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call delete_run_batch before calling delete_batch.

delete_batch requires the batch to be in a terminal state: PROCESSED, FAILED, CANCELLED, or RUNS_DELETED. After delete_batch completes, the batch metadata is no longer accessible. You cannot call get_batch, list_runs_in_batch, delete_run_batch, or cancel_run_batch on a deleted batch.

Usage¶

omics_delete_batch(batchId)

Arguments¶

batchId

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

Value¶

An empty list.

Request syntax¶

svc$delete_batch(
  batchId = "string"
)