Get Workflow

omics_get_workflow

R Documentation

Gets information about a workflow

Description

Gets information about a workflow.

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

Usage

omics_get_workflow(id, type, export, workflowOwnerId)

Arguments

id

[required] The workflow's ID.

type

The workflow's type.

export

The export format for the workflow.

workflowOwnerId

The ID of the workflow owner.

Value

A list with the following syntax:

list(
  arn = "string",
  id = "string",
  status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETED"|"FAILED"|"INACTIVE",
  type = "PRIVATE"|"READY2RUN",
  name = "string",
  description = "string",
  engine = "WDL"|"NEXTFLOW"|"CWL",
  definition = "string",
  main = "string",
  digest = "string",
  parameterTemplate = list(
    list(
      description = "string",
      optional = TRUE|FALSE
    )
  ),
  storageCapacity = 123,
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  statusMessage = "string",
  tags = list(
    "string"
  ),
  metadata = list(
    "string"
  ),
  accelerators = "GPU"
)

Request syntax

svc$get_workflow(
  id = "string",
  type = "PRIVATE"|"READY2RUN",
  export = list(
    "DEFINITION"
  ),
  workflowOwnerId = "string"
)