listRunsInBatch method

Future<ListRunsInBatchResponse> listRunsInBatch({ required String batchId, int? maxItems, String? runId, String? runSettingId, String? startingToken, SubmissionStatus? submissionStatus, })

Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

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.

Parameter maxItems : The maximum number of runs to return.

Parameter runId : Filter runs by the HealthOmics-generated run ID.

Parameter runSettingId : Filter runs by the customer-provided run setting ID.

Parameter startingToken : A pagination token returned from a prior ListRunsInBatch call.

Parameter submissionStatus : Filter runs by submission status.

Implementation

Future<ListRunsInBatchResponse> listRunsInBatch({
  required String batchId,
  int? maxItems,
  String? runId,
  String? runSettingId,
  String? startingToken,
  SubmissionStatus? submissionStatus,
}) async {
  final $query = <String, List<String>>{
    if (maxItems != null) 'maxItems': [maxItems.toString()],
    if (runId != null) 'runId': [runId],
    if (runSettingId != null) 'runSettingId': [runSettingId],
    if (startingToken != null) 'startingToken': [startingToken],
    if (submissionStatus != null)
      'submissionStatus': [submissionStatus.value],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/runBatch/${Uri.encodeComponent(batchId)}/run',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListRunsInBatchResponse.fromJson(response);
}