Create Workflow Version

omics_create_workflow_version

R Documentation

Creates a new workflow version for the workflow that you specify with the workflowId parameter

Description

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Usage

omics_create_workflow_version(workflowId, versionName, definitionZip,
  definitionUri, accelerators, description, engine, main,
  parameterTemplate, requestId, storageType, storageCapacity, tags,
  workflowBucketOwnerId)

Arguments

workflowId	[required] The ID of the workflow where you are creating the new version.
versionName	[required] A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.
definitionZip	A zip archive containing the workflow definition for this workflow version.
definitionUri	The URI specifies the location of the workflow definition for this workflow version.
accelerators	The computational accelerator for this workflow version.
description	A description for this workflow version.
engine	The workflow engine for this workflow version.
main	The path of the main definition file for this workflow version.
parameterTemplate	The parameter template defines the input parameters for runs that use this workflow version.
requestId	[required] To ensure that requests don't run multiple times, specify a unique ID for each request.
storageType	The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.
storageCapacity	The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
tags	Optional tags to associate with this workflow version.
workflowBucketOwnerId	Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

Value

A list with the following syntax:

list(
  arn = "string",
  workflowId = "string",
  versionName = "string",
  status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETED"|"FAILED"|"INACTIVE",
  tags = list(
    "string"
  ),
  uuid = "string"
)

Request syntax

svc$create_workflow_version(
  workflowId = "string",
  versionName = "string",
  definitionZip = raw,
  definitionUri = "string",
  accelerators = "GPU",
  description = "string",
  engine = "WDL"|"NEXTFLOW"|"CWL",
  main = "string",
  parameterTemplate = list(
    list(
      description = "string",
      optional = TRUE|FALSE
    )
  ),
  requestId = "string",
  storageType = "STATIC"|"DYNAMIC",
  storageCapacity = 123,
  tags = list(
    "string"
  ),
  workflowBucketOwnerId = "string"
)