Skip to content

List Run Tasks

omics_list_run_tasks R Documentation

Retrieves a list of tasks for a run

Description

Retrieves a list of tasks for a run.

Usage

omics_list_run_tasks(id, status, startingToken, maxResults)

Arguments

id

[required] The run's ID.

status

Filter the list by status.

startingToken

Specify the pagination token from a previous request to retrieve the next page of results.

maxResults

The maximum number of run tasks to return in one page of results.

Value

A list with the following syntax:

list(
  items = list(
    list(
      taskId = "string",
      status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"CANCELLED"|"FAILED",
      name = "string",
      cpus = 123,
      memory = 123,
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      stopTime = as.POSIXct(
        "2015-01-01"
      ),
      gpus = 123,
      instanceType = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_run_tasks(
  id = "string",
  status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"CANCELLED"|"FAILED",
  startingToken = "string",
  maxResults = 123
)