Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

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 in the Amazon Web Services HealthOmics User Guide.

get/workflow/{id}

Path parameters

idstring required

The workflow's ID.

Query parameters

type'PRIVATE' | 'READY2RUN'

The workflow's type.

exportWorkflowExport[]

The export format for the workflow.

workflowOwnerIdstring

The ID of the workflow owner.

Response

Success

arnstring

The workflow's ARN.

idstring

The workflow's ID.

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

The workflow's status.

type'PRIVATE' | 'READY2RUN'

The workflow's type.

namestring

The workflow's name.

descriptionstring

The workflow's description.

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

The workflow's engine.

definitionstring

The workflow's definition.

mainstring

The path of the main definition file for the workflow.

digeststring

The workflow's digest.

parameterTemplateobject

The workflow's parameter template.

storageCapacityinteger

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

creationTimestring date-time

When the workflow was created.

statusMessagestring

The workflow's status message.

tagsobject

The workflow's tags.

metadataobject

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.

uuidstring

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

readmestring

The README content for the workflow, providing documentation and usage information.

readmePathstring

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.

profilesWorkflowProfileName[]

The list of Nextflow profiles that are available for this workflow. 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.