Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

Gets information about a workflow version. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.

get/workflow/{workflowId}/version/{versionName}

Path parameters

workflowIdstring required

The workflow's ID. The <code>workflowId</code> is not the UUID.

versionNamestring required

The workflow version name.

Query parameters

type'PRIVATE' | 'READY2RUN'

The workflow's type.

exportWorkflowExport[]

The export format for the workflow.

workflowOwnerIdstring

The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the <code>GetShare</code> API operation. If you are the workflow owner, you do not need to include this ID.

Response

Success

arnstring

ARN of the workflow version.

workflowIdstring

The workflow's ID.

versionNamestring

The workflow version name.

accelerators'GPU'

The accelerator for this workflow version.

creationTimestring date-time

When the workflow version was created.

descriptionstring

Description of the workflow version.

definitionstring

Definition of the workflow version.

digeststring

The workflow version's digest.

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

The workflow engine for this workflow version.

mainstring

The path of the main definition file for the workflow.

metadataobject

The metadata for the workflow version.

parameterTemplateobject

The parameter template for the workflow version.

status'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETED' | 'FAILED' | 'INACTIVE'

The workflow version status

statusMessagestring

The workflow version status message

storageType'STATIC' | 'DYNAMIC'

The default storage type for the run.

storageCapacityinteger

The default run storage capacity for static storage.

type'PRIVATE' | 'READY2RUN'

The workflow version type

tagsobject

The workflow version tags

uuidstring

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

workflowBucketOwnerIdstring

Amazon Web Services Id of the owner of the bucket.

readmestring

The README content for the workflow version, providing documentation and usage information specific to this version.

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.

profilesWorkflowProfileName[]

The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime.

profileParameterTemplatesobject

A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile.