cancelRunBatch method

Future<void> cancelRunBatch({
  1. required String batchId,
})

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.

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> cancelRunBatch({
  required String batchId,
}) async {
  final $payload = <String, dynamic>{
    'batchId': batchId,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/runBatch/cancel',
    exceptionFnMap: _exceptionFns,
  );
}