DeadlineCloud / Client / update_task

update_task#

DeadlineCloud.Client.update_task(**kwargs)#

Updates a task.

See also: AWS API Documentation

Request Syntax

response = client.update_task(
    clientToken='string',
    farmId='string',
    queueId='string',
    jobId='string',
    stepId='string',
    taskId='string',
    targetRunStatus='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 to update.

  • queueId (string) –

    [REQUIRED]

    The queue ID to update.

  • jobId (string) –

    [REQUIRED]

    The job ID to update.

  • stepId (string) –

    [REQUIRED]

    The step ID to update.

  • taskId (string) –

    [REQUIRED]

    The task ID to update.

  • targetRunStatus (string) –

    [REQUIRED]

    The run status with which to start the task.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions