Skip to content

Get Run

omics_get_run R Documentation

Gets information about a workflow run

Description

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide.

Usage

omics_get_run(id, export)

Arguments

id

[required] The run's ID.

export

The run's export format.

Value

A list with the following syntax:

list(
  arn = "string",
  id = "string",
  cacheId = "string",
  cacheBehavior = "CACHE_ON_FAILURE"|"CACHE_ALWAYS",
  engineVersion = "string",
  status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"DELETED"|"CANCELLED"|"FAILED",
  workflowId = "string",
  workflowType = "PRIVATE"|"READY2RUN",
  runId = "string",
  roleArn = "string",
  name = "string",
  runGroupId = "string",
  priority = 123,
  definition = "string",
  digest = "string",
  parameters = list(),
  storageCapacity = 123,
  outputUri = "string",
  logLevel = "OFF"|"FATAL"|"ERROR"|"ALL",
  resourceDigests = list(
    "string"
  ),
  startedBy = "string",
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  stopTime = as.POSIXct(
    "2015-01-01"
  ),
  statusMessage = "string",
  tags = list(
    "string"
  ),
  accelerators = "GPU",
  retentionMode = "RETAIN"|"REMOVE",
  failureReason = "string",
  logLocation = list(
    engineLogStream = "string",
    runLogStream = "string"
  ),
  uuid = "string",
  runOutputUri = "string",
  storageType = "STATIC"|"DYNAMIC",
  workflowOwnerId = "string"
)

Request syntax

svc$get_run(
  id = "string",
  export = list(
    "DEFINITION"
  )
)