List Batch

omics_list_batch

R Documentation

Returns a list of run batches in your account, with optional filtering by status, name, or run group¶

Description¶

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

Usage¶

omics_list_batch(maxItems, startingToken, status, name, runGroupId)

Arguments¶

maxItems

The maximum number of batches to return. If not specified, defaults to 100.

startingToken

A pagination token returned from a prior list_batch call.

status

Filter batches by status.

name

Filter batches by name.

runGroupId

Filter batches by run group ID.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      id = "string",
      name = "string",
      status = "CREATING"|"PENDING"|"SUBMITTING"|"INPROGRESS"|"STOPPING"|"CANCELLED"|"FAILED"|"PROCESSED"|"RUNS_DELETING"|"RUNS_DELETED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      totalRuns = 123,
      workflowId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_batch(
  maxItems = 123,
  startingToken = "string",
  status = "CREATING"|"PENDING"|"SUBMITTING"|"INPROGRESS"|"STOPPING"|"CANCELLED"|"FAILED"|"PROCESSED"|"RUNS_DELETING"|"RUNS_DELETED",
  name = "string",
  runGroupId = "string"
)