StartRun
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.
The total number of runs in your account is subject to a quota per Region. To avoid
needing to delete runs manually, you can set the retention mode to REMOVE
.
Runs with this setting are deleted automatically when the run quoata is exceeded.
Request Syntax
POST /run HTTP/1.1
Content-type: application/json
{
"logLevel": "string
",
"name": "string
",
"outputUri": "string
",
"parameters": JSON value
,
"priority": number
,
"requestId": "string
",
"retentionMode": "string
",
"roleArn": "string
",
"runGroupId": "string
",
"runId": "string
",
"storageCapacity": number
,
"tags": {
"string
" : "string
"
},
"workflowId": "string
",
"workflowType": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- logLevel
-
A log level for the run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
OFF | FATAL | ERROR | ALL
Required: No
- name
-
A name for the run.
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
- outputUri
-
An output URI for the run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 750.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
Required: No
- parameters
-
Parameters for the run.
Type: JSON value
Required: No
- priority
-
A priority for the run.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
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
- retentionMode
-
The retention mode for the run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
RETAIN | REMOVE
Required: No
- roleArn
-
A service role for the run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+
Required: Yes
- runGroupId
-
The run's group ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
Required: No
- runId
-
The ID of a run to duplicate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
Required: No
- storageCapacity
-
A storage capacity for the run in gibibytes.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No
-
Tags for the run.
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
- workflowId
-
The run's workflow ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
Required: No
- workflowType
-
The run's workflow type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
PRIVATE | READY2RUN
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"id": "string",
"runOutputUri": "string",
"status": "string",
"tags": {
"string" : "string"
},
"uuid": "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 run's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+
- id
-
The run's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
- runOutputUri
-
The destination for workflow outputs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 750.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
- status
-
The run's status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED
-
The run'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.
- uuid
-
The universally unique identifier for a run.
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}]+
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: