---
title: "GET /workflow/{id}"
method: GET
path: "/workflow/{id}"
---

# GET /workflow/{id}

`GET /workflow/{id}`

Gets all information about a workflow using its ID.

If a workflow is shared with you, you cannot export the workflow.

For more information about your workflow status, see [Verify the workflow status](https://docs.aws.amazon.com/omics/latest/dev/using-get-workflow.html) in the _Amazon Web Services HealthOmics User Guide_.

## Path parameters

- `id` string, required

## Query parameters

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

## Response `200`

Success

- GetWorkflowResponse
  - `arn` string — The workflow's ARN.
  - `id` string — The workflow's ID.
  - `status` 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETED' | 'FAILED' | 'INACTIVE' — The workflow's status.
  - `type` 'PRIVATE' | 'READY2RUN' — The workflow's type.
  - `name` string — The workflow's name.
  - `description` string — The workflow's description.
  - `engine` 'WDL' | 'NEXTFLOW' | 'CWL' | 'WDL_LENIENT' — The workflow's engine.
  - `definition` string — The workflow's definition.
  - `main` string — The path of the main definition file for the workflow.
  - `digest` string — The workflow's digest.
  - `parameterTemplate` object — The workflow's parameter template.
  - `storageCapacity` integer — The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
  - `creationTime` string, date-time — When the workflow was created.
  - `statusMessage` string — The workflow's status message.
  - `tags` object — The workflow's tags.
  - `metadata` object — Gets metadata for the workflow.
  - `accelerators` 'GPU' — The computational accelerator specified to run the workflow.
  - `storageType` 'STATIC' | 'DYNAMIC' — The default storage type for runs using this workflow.
  - `uuid` string — The universally unique identifier (UUID) value for this workflow.
  - `containerRegistryMap` object — The registry map that this workflow is using.
    - `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, providing documentation and usage information.
  - `definitionRepositoryDetails` object — Details about the source code repository that hosts the workflow 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 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. 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)