Skip to content

Get Run

omics_get_run R Documentation

Gets detailed information about a specific run using its ID

Description

Gets detailed information about a specific run using its ID.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If get_run does not return the requested run, 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_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",
  batchId = "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",
  workflowVersionName = "string",
  workflowUuid = "string",
  networkingMode = "RESTRICTED"|"VPC",
  configuration = list(
    name = "string",
    arn = "string",
    uuid = "string"
  ),
  vpcConfig = list(
    securityGroupIds = list(
      "string"
    ),
    subnetIds = list(
      "string"
    ),
    vpcId = "string"
  )
)

Request syntax

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