DeadlineCloud / Paginator / ListTasks


class DeadlineCloud.Paginator.ListTasks#
paginator = client.get_paginator('list_tasks')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID connected to the tasks.

  • jobId (string) –


    The job ID for the tasks.

  • queueId (string) –


    The queue ID connected to the tasks.

  • stepId (string) –


    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:



Response Syntax

    'tasks': [
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'endedAt': datetime(2015, 1, 1),
            'failureRetryCount': 123,
            'latestSessionActionId': 'string',
            'parameters': {
                'string': {
                    'float': 'string',
                    'int': 'string',
                    'path': 'string',
                    'string': 'string'
            'startedAt': datetime(2015, 1, 1),
            'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskId': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • tasks (list) –

      Tasks for the job.

      • (dict) –

        The details of a task.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • failureRetryCount (integer) –

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

        • latestSessionActionId (string) –

          The latest session action for the task.

        • parameters (dict) –

          The task parameters.

          • (string) –

            • (dict) –

              The data types for the task parameters.


              This is a Tagged Union structure. Only one of the following top level keys will be set: float, int, path, string. 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'}
              • float (string) –

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

              • int (string) –

                A signed integer represented as a string.

              • path (string) –

                A file system path represented as a string.

              • string (string) –

                A UTF-8 string.

        • runStatus (string) –

          The run status of the task.

        • startedAt (datetime) –

          The date and time the resource started running.

        • targetRunStatus (string) –

          The run status on which the started.

        • taskId (string) –

          The task ID.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • NextToken (string) –

      A token to resume pagination.