List Runs

omics_list_runs

R Documentation

Retrieves a list of runs

Description

Retrieves a list of runs.

Usage

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

Arguments

name

Filter the list by run name.

runGroupId

Filter the list by run group 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",
      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"
    )
  ),
  nextToken = "string"
)

Request syntax

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