deleteRunBatch method

Future<void> deleteRunBatch({ required String batchId, })

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.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw RequestTimeoutException. May throw ResourceNotFoundException. May throw ServiceQuotaExceededException. May throw ThrottlingException. May throw ValidationException.

Parameter batchId : The identifier portion of the run batch ARN.

Implementation

Future<void> deleteRunBatch({
  required String batchId,
}) async {
  final $payload = <String, dynamic>{
    'batchId': batchId,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/runBatch/delete',
    exceptionFnMap: _exceptionFns,
  );
}