CreateWorkflow
Creates a workflow.
Request Syntax
POST /workflow HTTP/1.1
Content-type: application/json
{
"accelerators": "string
",
"definitionUri": "string
",
"definitionZip": blob
,
"description": "string
",
"engine": "string
",
"main": "string
",
"name": "string
",
"parameterTemplate": {
"string
" : {
"description": "string
",
"optional": boolean
}
},
"requestId": "string
",
"storageCapacity": number
,
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- accelerators
-
The computational accelerator specified to run the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
GPU
Required: No
- definitionUri
-
The URI of a definition for the workflow.
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}]+
Required: No
- definitionZip
-
A ZIP archive for the workflow.
Type: Base64-encoded binary data object
Required: No
- description
-
A description for the workflow.
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}]+
Required: No
- engine
-
An engine for the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
WDL | NEXTFLOW | CWL
Required: No
- 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}]+
Required: No
- name
-
A name 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}]+
Required: No
- parameterTemplate
-
A parameter template for the workflow.
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}]+
Required: No
- requestId
-
To ensure that requests don't run multiple times, specify a unique ID for each request.
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}]+
Required: Yes
- storageCapacity
-
The default storage capacity for the workflow runs, in gibibytes.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No
-
Tags for the 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.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"id": "string",
"status": "string",
"tags": {
"string" : "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- arn
-
The workflow's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+
- id
-
The workflow's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
- status
-
The workflow's status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
CREATING | ACTIVE | UPDATING | DELETED | FAILED | INACTIVE
-
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.
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: