GetRun
Gets information about a workflow run.
If a workflow is shared with you, you cannot export information about the run.
Request Syntax
GET /run/id
?export=export
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
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",
"digest": "string",
"failureReason": "string",
"id": "string",
"logLevel": "string",
"logLocation": {
"engineLogStream": "string",
"runLogStream": "string"
},
"name": "string",
"outputUri": "string",
"parameters": JSON value,
"priority": number,
"resourceDigests": {
"string" : "string"
},
"retentionMode": "string",
"roleArn": "string",
"runGroupId": "string",
"runId": "string",
"runOutputUri": "string",
"startedBy": "string",
"startTime": "string",
"status": "string",
"statusMessage": "string",
"stopTime": "string",
"storageCapacity": number,
"storageType": "string",
"tags": {
"string" : "string"
},
"uuid": "string",
"workflowId": "string",
"workflowOwnerId": "string",
"workflowType": "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 used to run the workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
GPU
- arn
-
The run's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+
- creationTime
-
When the run was created.
Type: Timestamp
- definition
-
The run'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}]+
- digest
-
The run's digest.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- failureReason
-
The reason a run has failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
- id
-
The run's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
- logLevel
-
The run's log level.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
OFF | FATAL | ERROR | ALL
- logLocation
-
The location of the run log.
Type: RunLogLocation object
- name
-
The run'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}]+
- outputUri
-
The run's output URI.
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}]+
- parameters
-
The run's parameters.
Type: JSON value
- priority
-
The run's priority.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
- resourceDigests
-
The run's resource digests.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
Value Length Constraints: Minimum length of 0. Maximum length of 64.
Value Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
- retentionMode
-
The run's retention mode.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
RETAIN | REMOVE
- roleArn
-
The run's service role ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:.+
- runGroupId
-
The run's group ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
- runId
-
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}]+
- startedBy
-
Who started the run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- startTime
-
When the run started.
Type: Timestamp
- 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
- statusMessage
-
The run's status message.
Type: String
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
- stopTime
-
The run's stop time.
Type: Timestamp
- storageCapacity
-
The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100000.
- storageType
-
The run's storage type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Valid Values:
STATIC | DYNAMIC
-
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}]+
- workflowId
-
The run's workflow ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 18.
Pattern:
[0-9]+
- workflowOwnerId
-
The ID of the workflow owner.
Type: String
Pattern:
[0-9]{12}
- workflowType
-
The run's workflow 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: