Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Updates a job.

When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

patch/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}

Path parameters

farmIdstring required

The farm ID of the job to update.

queueIdstring required

The queue ID of the job to update.

jobIdstring required

The job ID to update.

Headers

X-Amz-Client-Tokenstring

The unique token which the server uses to recognize retries of the same request.

Request body

targetTaskRunStatus'READY' | 'FAILED' | 'SUCCEEDED' | 'CANCELED' | 'SUSPENDED' | 'PENDING'

The task status to update the job's tasks to.

priorityinteger

The updated job priority.

maxFailedTasksCountinteger

The number of task failures before the job stops running and is marked as <code>FAILED</code>.

maxRetriesPerTaskinteger

The maximum number of retries for a job.

lifecycleStatus'ARCHIVED'
<p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>
maxWorkerCountinteger
<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> 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.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p> <p>The maximum number of workers that can process tasks in the job.</p>
namestring

The updated job name.

descriptionstring password

The updated job description.

Response

Success

UpdateJobResponse required