GetTask
Gets a task.
Request Syntax
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/steps/stepId/tasks/taskId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- farmId
-
The farm ID of the farm connected to the task.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- jobId
-
The job ID of the job connected to the task.
Pattern:
job-[0-9a-f]{32}Required: Yes
- queueId
-
The queue ID for the queue connected to the task.
Pattern:
queue-[0-9a-f]{32}Required: Yes
- stepId
-
The step ID for the step connected to the task.
Pattern:
step-[0-9a-f]{32}Required: Yes
- taskId
-
The task ID.
Pattern:
task-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"createdBy": "string",
"endedAt": "string",
"failureRetryCount": number,
"latestSessionActionId": "string",
"parameters": {
"string" : { ... }
},
"runStatus": "string",
"startedAt": "string",
"targetRunStatus": "string",
"taskId": "string",
"updatedAt": "string",
"updatedBy": "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.
- createdAt
-
The date and time the resource was created.
Type: Timestamp
- createdBy
-
The user or system that created this resource.
Type: String
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
- failureRetryCount
-
The number of times that the task failed and was retried.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
- latestSessionActionId
-
The latest session ID for the task.
Type: String
Pattern:
sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9})) - parameters
-
The parameters for the task.
Type: String to TaskParameterValue object map
- runStatus
-
The run status for the task.
Type: String
Valid Values:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLE - startedAt
-
The date and time the resource started running.
Type: Timestamp
- targetRunStatus
-
The run status with which to start the task.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING - taskId
-
The task ID.
Type: String
Pattern:
task-[0-9a-f]{32}-(0|([1-9][0-9]{0,9})) - updatedAt
-
The date and time the resource was updated.
Type: Timestamp
- updatedBy
-
The user or system that updated this resource.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
HTTP Status Code: 403
- InternalServerErrorException
-
Deadline Cloud can't process your request right now. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Your request exceeded a request rate quota.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
