GetJob
Gets a Deadline Cloud job.
Request Syntax
GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId 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
{
"attachments": {
"fileSystem": "string",
"manifests": [
{
"fileSystemLocationName": "string",
"inputManifestHash": "string",
"inputManifestPath": "string",
"outputRelativeDirectories": [ "string" ],
"rootPath": "string",
"rootPathFormat": "string"
}
]
},
"createdAt": "string",
"createdBy": "string",
"description": "string",
"endedAt": "string",
"jobId": "string",
"lifecycleStatus": "string",
"lifecycleStatusMessage": "string",
"maxFailedTasksCount": number,
"maxRetriesPerTask": number,
"maxWorkerCount": number,
"name": "string",
"parameters": {
"string" : { ... }
},
"priority": number,
"sourceJobId": "string",
"startedAt": "string",
"storageProfileId": "string",
"targetTaskRunStatus": "string",
"taskRunStatus": "string",
"taskRunStatusCounts": {
"string" : number
},
"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.
- attachments
-
The attachments for the job.
Type: Attachments object
- createdAt
-
The date and time the resource was created.
Type: Timestamp
- createdBy
-
The user or system that created this resource.
Type: String
- description
-
The description of the job.
Important
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- endedAt
-
The date and time the resource ended running.
Type: Timestamp
- jobId
-
The job ID.
Type: String
Pattern:
job-[0-9a-f]{32} - lifecycleStatus
-
The life cycle status for the job.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | UPLOAD_IN_PROGRESS | UPLOAD_FAILED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_SUCCEEDED | ARCHIVED - lifecycleStatusMessage
-
A message that communicates the status of the life cycle for the job.
Type: String
- maxFailedTasksCount
-
The number of task failures before the job stops running and is marked as
FAILED.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
- maxRetriesPerTask
-
The maximum number of retries per failed tasks.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
- maxWorkerCount
-
The maximum number of worker hosts that can concurrently process a job. When the
maxWorkerCountis reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.If you don't set the
maxWorkerCountwhen you create a job, this value is not returned in the response.Type: Integer
Valid Range: Minimum value of -1. Maximum value of 2147483647.
- name
-
The name of the job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
- parameters
-
The parameters for the job.
Type: String to JobParameter object map
- priority
-
The job priority.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
- sourceJobId
-
The job ID for the source job.
Type: String
Pattern:
job-[0-9a-f]{32} - startedAt
-
The date and time the resource started running.
Type: Timestamp
- storageProfileId
-
The storage profile ID associated with the job.
Type: String
Pattern:
sp-[0-9a-f]{32} - targetTaskRunStatus
-
The task status with which the job started.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING - taskRunStatus
-
The task run status for the job.
Type: String
Valid Values:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLE - taskRunStatusCounts
-
The number of tasks running on the job.
Type: String to integer map
Valid Keys:
PENDING | READY | ASSIGNED | STARTING | SCHEDULED | INTERRUPTING | RUNNING | SUSPENDED | CANCELED | FAILED | SUCCEEDED | NOT_COMPATIBLE - 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:
