Omics / Client / cancel_run_batch

cancel_run_batch¶

Omics.Client.cancel_run_batch(**kwargs)¶

Cancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits CancelRun 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 GetBatch to review successfulCancelSubmissionCount and failedCancelSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Request Syntax

response = client.cancel_run_batch(
    batchId='string'
)

Parameters:

batchId (string) –

[REQUIRED]

The identifier portion of the run batch ARN.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException