Omics / Client / delete_run_batch

delete_run_batch¶

Omics.Client.delete_run_batch(**kwargs)¶

Deletes the individual workflow runs within a batch. This operation is separate from DeleteBatch, which removes the batch metadata.

Delete is only allowed on batches in PROCESSED or CANCELLED state. Delete operations are non-atomic and may be partially successful. Use GetBatch to review successfulDeleteSubmissionCount and failedDeleteSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

Request Syntax

response = client.delete_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