Gets all information about a workflow using its ID¶

Description¶

Gets all information about a workflow using its ID.

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

For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

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"|"WDL_LENIENT",
  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",
  storageType = "STATIC"|"DYNAMIC",
  uuid = "string",
  containerRegistryMap = list(
    registryMappings = list(
      list(
        upstreamRegistryUrl = "string",
        ecrRepositoryPrefix = "string",
        upstreamRepositoryPrefix = "string",
        ecrAccountId = "string"
      )
    ),
    imageMappings = list(
      list(
        sourceImage = "string",
        destinationImage = "string"
      )
    )
  ),
  readme = "string",
  definitionRepositoryDetails = list(
    connectionArn = "string",
    fullRepositoryId = "string",
    sourceReference = list(
      type = "BRANCH"|"TAG"|"COMMIT",
      value = "string"
    ),
    providerType = "string",
    providerEndpoint = "string"
  ),
  readmePath = "string",
  profiles = list(
    "string"
  ),
  profileParameterTemplates = list(
    list(
      list(
        description = "string",
        optional = TRUE|FALSE
      )
    )
  )
)

Request syntax¶

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