DeadlineCloud / Client / batch_update_task

batch_update_task

DeadlineCloud.Client.batch_update_task(**kwargs)

Updates multiple tasks in a single request. This is a batch version of the UpdateTask API.

The result of updating each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_task(
    clientToken='string',
    tasks=[
        {
            '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.

• tasks (list) –

  [REQUIRED]

  The list of tasks to update. You can specify up to 100 tasks per request.

  • (dict) –

    The details of a task to update in a batch update operation.

    • farmId (string) – [REQUIRED]

      The farm ID of the task to update.

    • queueId (string) – [REQUIRED]

      The queue ID of the task to update.

    • jobId (string) – [REQUIRED]

      The job ID of the task to update.

    • stepId (string) – [REQUIRED]

      The step ID of the task to update.

    • taskId (string) – [REQUIRED]

      The task ID of the task to update.

    • targetRunStatus (string) – [REQUIRED]

      The run status with which to start the task.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'taskId': 'string',
            'code': 'ConflictException'|'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • errors (list) –

    A list of errors for tasks that could not be updated.

    • (dict) –

      The error details for a task that could not be updated in a batch update operation.

      • farmId (string) –

        The farm ID of the task that could not be updated.

      • queueId (string) –

        The queue ID of the task that could not be updated.

      • jobId (string) –

        The job ID of the task that could not be updated.

      • stepId (string) –

        The step ID of the task that could not be updated.

      • taskId (string) –

        The task ID of the task that could not be updated.

      • code (string) –

        The error code.

      • message (string) –

        The error message.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException