UpdateJob
Updates a job.
When you change the status of the job to ARCHIVED
, the job can't be
scheduled or archived.
Important
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
Request Syntax
PATCH /2023-10-12/farms/farmId
/queues/queueId
/jobs/jobId
HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"lifecycleStatus": "string
",
"maxFailedTasksCount": number
,
"maxRetriesPerTask": number
,
"maxWorkerCount": number
,
"priority": number
,
"targetTaskRunStatus": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
The unique token which the server uses to recognize retries of the same request.
Length Constraints: Minimum length of 1. Maximum length of 64.
- farmId
-
The farm ID of the job to update.
Pattern:
farm-[0-9a-f]{32}
Required: Yes
- jobId
-
The job ID to update.
Pattern:
job-[0-9a-f]{32}
Required: Yes
- queueId
-
The queue ID of the job to update.
Pattern:
queue-[0-9a-f]{32}
Required: Yes
Request Body
The request accepts the following data in JSON format.
- lifecycleStatus
-
The status of a job in its lifecycle. When you change the status of the job to
ARCHIVED
, the job can't be scheduled or archived.Important
An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.
Type: String
Valid Values:
ARCHIVED
Required: No
- 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.
Required: No
- maxRetriesPerTask
-
The maximum number of retries for a job.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
Required: No
- maxWorkerCount
-
The maximum number of worker hosts that can concurrently process a job. When the
maxWorkerCount
is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.You can't set the
maxWorkerCount
to 0. If you set it to -1, there is no maximum number of workers.If you don't specify the
maxWorkerCount
, the default is -1.The maximum number of workers that can process tasks in the job.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 2147483647.
Required: No
- priority
-
The job priority to update.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- targetTaskRunStatus
-
The task status to update the job's tasks to.
Type: String
Valid Values:
READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 409
- 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: