GetWorkflowVersion - HealthOmics API Reference
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetWorkflowVersion

Gets information about a workflow version. For more information, see Workflow versioning in AWS HealthOmics in the AWS HealthOmics User Guide.

Request Syntax

GET /workflow/workflowId/version/versionName?export=export&type=type&workflowOwnerId=workflowOwnerId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

export

The export format for the workflow.

Array Members: Minimum number of 0 items. Maximum number of 32 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: DEFINITION | README

type

The workflow's type.

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: PRIVATE | READY2RUN

versionName

The workflow version name.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

Required: Yes

workflowId

The workflow's ID.

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: Yes

workflowOwnerId

AWS Id of the owner of the workflow.

Pattern: [0-9]{12}

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "accelerators": "string",
   "arn": "string",
   "creationTime": "string",
   "definition": "string",
   "definitionRepositoryDetails": { 
      "connectionArn": "string",
      "fullRepositoryId": "string",
      "providerEndpoint": "string",
      "providerType": "string",
      "sourceReference": { 
         "type": "string",
         "value": "string"
      }
   },
   "description": "string",
   "digest": "string",
   "engine": "string",
   "main": "string",
   "metadata": { 
      "string" : "string" 
   },
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "readme": "string",
   "readmePath": "string",
   "status": "string",
   "statusMessage": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "uuid": "string",
   "versionName": "string",
   "workflowBucketOwnerId": "string",
   "workflowId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

accelerators

The accelerator for this workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: GPU

arn

ARN of the workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: arn:.+

creationTime

When the workflow version was created.

Type: Timestamp

definition

Definition of the workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

definitionRepositoryDetails

Details about the source code repository that hosts the workflow version definition files.

Type: DefinitionRepositoryDetails object

description

Description of the workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

digest

The workflow version's digest.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

engine

The workflow engine for this workflow version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: WDL | NEXTFLOW | CWL

main

The path of the main definition file for the workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

metadata

The metadata for the workflow version.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

parameterTemplate

The parameter template for the workflow version.

Type: String to WorkflowParameter object map

Map Entries: Maximum number of 1000 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

readme

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

readmePath

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 README.md file from the root directory of the repository will be used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

status

The workflow version status

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE

statusMessage

The workflow version status message

Type: String

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

storageCapacity

The default run storage capacity for static storage.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

storageType

The default storage type for the run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: STATIC | DYNAMIC

tags

The workflow version tags

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

type

The workflow version type

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: PRIVATE | READY2RUN

uuid

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

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

versionName

The workflow version name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

workflowBucketOwnerId

AWS Id of the owner of the bucket.

Type: String

Pattern: [0-9]{12}

workflowId

The workflow's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: