Post workflowworkflowidversion — omics

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

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.

post/workflow/{workflowId}/version

Path parameters

workflowIdstring required

The ID of the workflow where you are creating the new version. The <code>workflowId</code> is not the UUID.

Request body

versionNamestring 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.

definitionZipstring

A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.

definitionUristring

The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.

accelerators'GPU'

The computational accelerator for this workflow version.

descriptionstring

A description for this workflow version.

engine'WDL' | 'NEXTFLOW' | 'CWL' | 'WDL_LENIENT'

The workflow engine for this workflow version. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

mainstring

The path of the main definition file for this workflow version. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: <code>workflow-definition/main-file.wdl</code>.

parameterTemplateobject

A parameter template for this workflow version. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see <a href="https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html">Parameter template files</a> in the Amazon Web Services HealthOmics User Guide.

requestIdstring required

An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.

storageType'STATIC' | 'DYNAMIC'

The default storage type for runs that use this workflow version. The <code>storageType</code> can be overridden at run time. <code>DYNAMIC</code> storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the Amazon Web Services HealthOmics User Guide.

storageCapacityinteger

The default static storage capacity (in gibibytes) for runs that use this workflow version. The <code>storageCapacity</code> can be overwritten at run time. The storage capacity is not required for runs with a <code>DYNAMIC</code> storage type.

tagsobject

Tags for this workflow version. You can define up to 50 tags for the workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html">Adding a tag</a> in the Amazon Web Services HealthOmics User Guide.

workflowBucketOwnerIdstring

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.

containerRegistryMapUristring

(Optional) URI of the S3 location for the registry mapping file.

readmeMarkdownstring

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

parameterTemplatePathstring

The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.

readmePathstring

The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the <code>README.md</code> file from the root directory of the repository will be used.

readmeUristring

The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include: <ul> <li> The S3 URI must begin with <code>s3://USER-OWNED-BUCKET/</code> </li> <li> The requester must have access to the S3 bucket and object. </li> <li> The max README content length is 500 KiB. </li> </ul>

Response

Success

arnstring

ARN of the workflow version.

workflowIdstring

The workflow's ID.

versionNamestring

The workflow version name.

The workflow version status.

tagsobject

The workflow version's tags.

uuidstring

The universally unique identifier (UUID) value for this workflow version.