---
title: "GET /workflow/{workflowId}/version/{versionName}"
method: GET
path: "/workflow/{workflowId}/version/{versionName}"
---

# GET /workflow/{workflowId}/version/{versionName}

`GET /workflow/{workflowId}/version/{versionName}`

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

## Path parameters

- `workflowId` string, required
- `versionName` string, required

## Query parameters

- `type` 'PRIVATE' | 'READY2RUN'
- `export` WorkflowExport[]
- `workflowOwnerId` string

## Response `200`

Success

- GetWorkflowVersionResponse
  - `arn` string — ARN of the workflow version.
  - `workflowId` string — The workflow's ID.
  - `versionName` string — The workflow version name.
  - `accelerators` 'GPU' — The accelerator for this workflow version.
  - `creationTime` string, date-time — When the workflow version was created.
  - `description` string — Description of the workflow version.
  - `definition` string — Definition of the workflow version.
  - `digest` string — The workflow version's digest.
  - `engine` 'WDL' | 'NEXTFLOW' | 'CWL' | 'WDL_LENIENT' — The workflow engine for this workflow version.
  - `main` string — The path of the main definition file for the workflow.
  - `metadata` object — The metadata for the workflow version.
  - `parameterTemplate` object — The parameter template for the workflow version.
  - `status` 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETED' | 'FAILED' | 'INACTIVE' — The workflow version status
  - `statusMessage` string — The workflow version status message
  - `storageType` 'STATIC' | 'DYNAMIC' — The default storage type for the run.
  - `storageCapacity` integer — The default run storage capacity for static storage.
  - `type` 'PRIVATE' | 'READY2RUN' — The workflow version type
  - `tags` object — The workflow version tags
  - `uuid` string — The universally unique identifier (UUID) value for this workflow version
  - `workflowBucketOwnerId` string — Amazon Web Services Id of the owner of the bucket.
  - `containerRegistryMap` object — The registry map that this workflow version uses.
    - `registryMappings` RegistryMapping[] — Mapping that provides the ECR repository path where upstream container images are pulled and synchronized.
      - `upstreamRegistryUrl` string — The URI of the upstream registry.
      - `ecrRepositoryPrefix` string — The repository prefix to use in the ECR private repository.
      - `upstreamRepositoryPrefix` string — The repository prefix of the corresponding repository in the upstream registry.
      - `ecrAccountId` string — Account ID of the account that owns the upstream container image.
    - `imageMappings` ImageMapping[] — Image mappings specify path mappings between the ECR private repository and their corresponding external repositories.
      - `sourceImage` string — Specifies the URI of the source image in the upstream registry.
      - `destinationImage` string — Specifies the URI of the corresponding image in the private ECR registry.
  - `readme` string — The README content for the workflow version, providing documentation and usage information specific to this version.
  - `definitionRepositoryDetails` object — Details about the source code repository that hosts the workflow version definition files.
    - `connectionArn` string — The Amazon Resource Name (ARN) of the connection to the source code repository.
    - `fullRepositoryId` string — The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.
    - `sourceReference` object — The source reference for the repository, such as a branch name, tag, or commit ID.
      - `type` 'BRANCH' | 'TAG' | 'COMMIT', required — The type of source reference, such as branch, tag, or commit.
      - `value` string, required — The value of the source reference, such as the branch name, tag name, or commit ID.
    - `providerType` string — The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.
    - `providerEndpoint` string — The endpoint URL of the source code repository provider.
  - `readmePath` string — 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.
  - `profiles` WorkflowProfileName[] — The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime.
  - `profileParameterTemplates` object — 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.

## Other responses

- `480` — InternalServerException
- `481` — ServiceQuotaExceededException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — ConflictException
- `485` — ResourceNotFoundException
- `486` — AccessDeniedException
- `487` — RequestTimeoutException

---

[API](https://skmtc.net/aws/apis/omics.md) · [All operations](https://skmtc.net/aws/apis/omics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/omics/versions/e9df1bcc0813/schema)
