Get Workflow Version

omics_get_workflow_version

R Documentation

Gets information about a workflow version

Description

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Usage

omics_get_workflow_version(workflowId, versionName, type, export,
  workflowOwnerId)

Arguments

workflowId	[required] The workflow's ID. The workflowId is not the UUID.
versionName	[required] The workflow version name.
type	The workflow's type.
export	The export format for the workflow.
workflowOwnerId	The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the get_share API operation. If you are the workflow owner, you do not need to include this ID.

Value

A list with the following syntax:

list(
  arn = "string",
  workflowId = "string",
  versionName = "string",
  accelerators = "GPU",
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  description = "string",
  definition = "string",
  digest = "string",
  engine = "WDL"|"NEXTFLOW"|"CWL"|"WDL_LENIENT",
  main = "string",
  metadata = list(
    "string"
  ),
  parameterTemplate = list(
    list(
      description = "string",
      optional = TRUE|FALSE
    )
  ),
  status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETED"|"FAILED"|"INACTIVE",
  statusMessage = "string",
  storageType = "STATIC"|"DYNAMIC",
  storageCapacity = 123,
  type = "PRIVATE"|"READY2RUN",
  tags = list(
    "string"
  ),
  uuid = "string",
  workflowBucketOwnerId = "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"
)

Request syntax

svc$get_workflow_version(
  workflowId = "string",
  versionName = "string",
  type = "PRIVATE"|"READY2RUN",
  export = list(
    "DEFINITION"|"README"
  ),
  workflowOwnerId = "string"
)