DeadlineCloud / Paginator / ListTasks

ListTasks

class DeadlineCloud.Paginator.ListTasks

paginator = client.get_paginator('list_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    queueId='string',
    jobId='string',
    stepId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID connected to the tasks.

• queueId (string) –

  [REQUIRED]

  The queue ID connected to the tasks.

• jobId (string) –

  [REQUIRED]

  The job ID for the tasks.

• stepId (string) –

  [REQUIRED]

  The step ID for the tasks.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            '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,
            'parameters': {
                'string': {
                    'int': 'string',
                    'float': 'string',
                    'string': 'string',
                    'path': 'string'
                }
            },
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'latestSessionActionId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tasks (list) –

    Tasks for the job.

    • (dict) –

      The details of a 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 on which the started.

      • failureRetryCount (integer) –

        The number of times that the task failed and was retried.

      • parameters (dict) –

        The task parameters.

        • (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. 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.

      • 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.

  • NextToken (string) –

    A token to resume pagination.