Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetWorkflow

Gets information about a workflow.

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

Request Syntax


GET /workflow/id?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

id

The workflow's ID.

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

Pattern: [0-9]+

Required: Yes

type

The workflow's type.

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

Valid Values: PRIVATE | READY2RUN

workflowOwnerId

The ID of the workflow owner.

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",
   "description": "string",
   "digest": "string",
   "engine": "string",
   "id": "string",
   "main": "string",
   "metadata": { 
      "string" : "string" 
   },
   "name": "string",
   "parameterTemplate": { 
      "string" : { 
         "description": "string",
         "optional": boolean
      }
   },
   "status": "string",
   "statusMessage": "string",
   "storageCapacity": number,
   "tags": { 
      "string" : "string" 
   },
   "type": "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 computational accelerator specified to run the workflow.

Type: String

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

Valid Values: GPU

arn

The workflow's ARN.

Type: String

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

Pattern: arn:.+

creationTime

When the workflow was created.

Type: Timestamp

definition

The workflow's definition.

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}]+

description

The workflow's description.

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's digest.

Type: String

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

engine

The workflow's engine.

Type: String

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

Valid Values: WDL | NEXTFLOW | CWL

id

The workflow's ID.

Type: String

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

Pattern: [0-9]+

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

Gets metadata for workflow.

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.

name

The workflow's name.

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}]+

parameterTemplate

The workflow's parameter template.

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}]+

status

The workflow's status.

Type: String

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

statusMessage

The workflow's status message.

Type: String

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

storageCapacity

The workflow's default run storage capacity in gibibytes.

Type: Integer

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

tags

The workflow's 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's type.

Type: String

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

Valid Values: PRIVATE | READY2RUN

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