List Runs

omics_list_runs

R Documentation

Retrieves a list of runs and returns each run's metadata and status

Description

Retrieves a list of runs and returns each run's metadata and status.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the list_runs response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

Usage

omics_list_runs(name, runGroupId, batchId, startingToken, maxResults,
  status)

Arguments

name	Filter the list by run name.
runGroupId	Filter the list by run group ID.
batchId	Filter by batch ID.
startingToken	Specify the pagination token from a previous request to retrieve the next page of results.
maxResults	The maximum number of runs to return in one page of results.
status	The status of a run.

Value

A list with the following syntax:

list(
  items = list(
    list(
      arn = "string",
      id = "string",
      status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"DELETED"|"CANCELLED"|"FAILED",
      workflowId = "string",
      batchId = "string",
      name = "string",
      priority = 123,
      storageCapacity = 123,
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      stopTime = as.POSIXct(
        "2015-01-01"
      ),
      storageType = "STATIC"|"DYNAMIC",
      workflowVersionName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_runs(
  name = "string",
  runGroupId = "string",
  batchId = "string",
  startingToken = "string",
  maxResults = 123,
  status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"DELETED"|"CANCELLED"|"FAILED"
)