Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html">Deadline Cloud jobs</a>.

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

Path parameters

farmIdstring required

The farm ID of the farm to connect to the job.

queueIdstring required

The ID of the queue that the job is submitted to.

Headers

X-Amz-Client-Tokenstring

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

Request body

templatestring password

The job template to use for this job.

templateType'JSON' | 'YAML'

The file type for the job template.

priorityinteger required

The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

parametersobject

The parameters for the job.

storageProfileIdstring

The storage profile ID for the storage profile to connect to the job.

targetTaskRunStatus'READY' | 'SUSPENDED'

The initial job status when it is created. Jobs that are created with a <code>SUSPENDED</code> status will not run until manually requeued.

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 each task.

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>, Deadline Cloud won't throttle the number of workers used to process the job.</p>
sourceJobIdstring

The job ID for the source job.

nameOverridestring

A custom name to override the job name derived from the job template.

descriptionOverridestring password

A custom description to override the job description derived from the job template.

tagsobject

The tags to add to your job. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Response

Success

jobIdstring required

The job ID.