List Runs In Batch

omics_list_runs_in_batch

R Documentation

Returns a paginated list of individual workflow runs within a specific batch¶

Description¶

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.

Usage¶

omics_list_runs_in_batch(batchId, maxItems, startingToken,
  submissionStatus, runSettingId, runId)

Arguments¶

batchId

[required] The identifier portion of the run batch ARN.

maxItems

The maximum number of runs to return.

startingToken

A pagination token returned from a prior list_runs_in_batch call.

submissionStatus

Filter runs by submission status.

runSettingId

Filter runs by the customer-provided run setting ID.

runId

Filter runs by the HealthOmics-generated run ID.

Value¶

A list with the following syntax:

list(
  runs = list(
    list(
      runSettingId = "string",
      runId = "string",
      runInternalUuid = "string",
      runArn = "string",
      submissionStatus = "SUCCESS"|"FAILED"|"CANCEL_SUCCESS"|"CANCEL_FAILED"|"DELETE_SUCCESS"|"DELETE_FAILED",
      submissionFailureReason = "string",
      submissionFailureMessage = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_runs_in_batch(
  batchId = "string",
  maxItems = 123,
  startingToken = "string",
  submissionStatus = "SUCCESS"|"FAILED"|"CANCEL_SUCCESS"|"CANCEL_FAILED"|"DELETE_SUCCESS"|"DELETE_FAILED",
  runSettingId = "string",
  runId = "string"
)