DeadlineCloud / Client / update_job

update_job#

DeadlineCloud.Client.update_job(**kwargs)#

Updates a job.

See also: AWS API Documentation

Request Syntax

response = client.update_job(
    clientToken='string',
    farmId='string',
    jobId='string',
    lifecycleStatus='ARCHIVED',
    maxFailedTasksCount=123,
    maxRetriesPerTask=123,
    priority=123,
    queueId='string',
    targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING'
)
Parameters:

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID of the job to update.

  • jobId (string) –

    [REQUIRED]

    The job ID to update.

  • lifecycleStatus (string) – The status of a job in its lifecycle.

  • maxFailedTasksCount (integer) – The number of task failures before the job stops running and is marked as FAILED.

  • maxRetriesPerTask (integer) – The maximum number of retries for a job.

  • priority (integer) – The job priority to update.

  • queueId (string) –

    [REQUIRED]

    The queue ID of the job to update.

  • targetTaskRunStatus (string) – The task status to update the job’s tasks to.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions