DeadlineCloud / Client / batch_get_task

batch_get_task

DeadlineCloud.Client.batch_get_task(**kwargs)

Retrieves multiple tasks in a single request. This is a batch version of the GetTask API.

The result of getting 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_get_task(
    identifiers=[
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'taskId': 'string'
        },
    ]
)

Parameters:

identifiers (list) –

[REQUIRED]

The list of task identifiers to retrieve. You can specify up to 100 identifiers per request.

• (dict) –

  The identifiers for a task.

  • farmId (string) – [REQUIRED]

    The farm ID of the task.

  • queueId (string) – [REQUIRED]

    The queue ID of the task.

  • jobId (string) – [REQUIRED]

    The job ID of the task.

  • stepId (string) – [REQUIRED]

    The step ID of the task.

  • taskId (string) – [REQUIRED]

    The task ID.

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'taskId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'failureRetryCount': 123,
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'latestSessionActionId': 'string',
            'parameters': {
                'string': {
                    'int': 'string',
                    'float': 'string',
                    'string': 'string',
                    'path': 'string',
                    'chunkInt': 'string'
                }
            }
        },
    ],
    'errors': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'stepId': 'string',
            'taskId': 'string',
            'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • tasks (list) –

    A list of tasks that were successfully retrieved.

    • (dict) –

      The details of a task returned in a batch get operation.

      • farmId (string) –

        The farm ID of the task.

      • queueId (string) –

        The queue ID of the task.

      • jobId (string) –

        The job ID of the task.

      • stepId (string) –

        The step ID of the task.

      • taskId (string) –

        The task ID.

      • createdAt (datetime) –

        The date and time the resource was created.

      • createdBy (string) –

        The user or system that created this resource.

      • runStatus (string) –

        The run status of the task.

      • targetRunStatus (string) –

        The run status with which to start the task.

      • failureRetryCount (integer) –

        The number of times the task failed and was retried.

      • startedAt (datetime) –

        The date and time the resource started running.

      • endedAt (datetime) –

        The date and time the resource ended running.

      • updatedAt (datetime) –

        The date and time the resource was updated.

      • updatedBy (string) –

        The user or system that updated this resource.

      • latestSessionActionId (string) –

        The latest session action for the task.

      • parameters (dict) –

        The parameters for the task.

        • (string) –

          • (dict) –

            The data types for the task parameters.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: int, float, string, path, chunkInt. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • int (string) –

              A signed integer represented as a string.

            • float (string) –

              A double precision IEEE-754 floating point number represented as a string.

            • string (string) –

              A UTF-8 string.

            • path (string) –

              A file system path represented as a string.

            • chunkInt (string) –

              A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.

  • errors (list) –

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

    • (dict) –

      The error details for a task that could not be retrieved in a batch get operation.

      • farmId (string) –

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

      • queueId (string) –

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

      • jobId (string) –

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

      • stepId (string) –

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

      • taskId (string) –

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

      • 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