:doc:`DeadlineCloud <../../deadline>` / Paginator / ListJobs

********
ListJobs
********



.. py:class:: DeadlineCloud.Paginator.ListJobs

  ::

    
    paginator = client.get_paginator('list_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          farmId='string',
          principalId='string',
          queueId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type farmId: string
    :param farmId: **[REQUIRED]** 

      The farm ID for the jobs.

      

    
    :type principalId: string
    :param principalId: 

      The principal ID of the members on the jobs.

      

    
    :type queueId: string
    :param queueId: **[REQUIRED]** 

      The queue ID for the job.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'jobs': [
                {
                    'jobId': 'string',
                    'name': 'string',
                    'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
                    'lifecycleStatusMessage': 'string',
                    'priority': 123,
                    'createdAt': datetime(2015, 1, 1),
                    'createdBy': 'string',
                    'updatedAt': datetime(2015, 1, 1),
                    'updatedBy': 'string',
                    'startedAt': datetime(2015, 1, 1),
                    'endedAt': datetime(2015, 1, 1),
                    'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
                    'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
                    'taskRunStatusCounts': {
                        'string': 123
                    },
                    'taskFailureRetryCount': 123,
                    'maxFailedTasksCount': 123,
                    'maxRetriesPerTask': 123,
                    'maxWorkerCount': 123,
                    'sourceJobId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **jobs** *(list) --* 

          The jobs on the list.

          
          

          - *(dict) --* 

            A summary of job details.

            
            

            - **jobId** *(string) --* 

              The job ID.

              
            

            - **name** *(string) --* 

              The job name.

              
            

            - **lifecycleStatus** *(string) --* 

              The life cycle status.

              
            

            - **lifecycleStatusMessage** *(string) --* 

              The life cycle status message.

              
            

            - **priority** *(integer) --* 

              The job priority.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the resource was created.

              
            

            - **createdBy** *(string) --* 

              The user or system that created this resource.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time the resource was updated.

              
            

            - **updatedBy** *(string) --* 

              The user or system that updated this resource.

              
            

            - **startedAt** *(datetime) --* 

              The date and time the resource started running.

              
            

            - **endedAt** *(datetime) --* 

              The date and time the resource ended running.

              
            

            - **taskRunStatus** *(string) --* 

              The task run status for the job.

               

              
              * ``PENDING``–pending and waiting for resources.
               
              * ``READY``–ready to be processed.
               
              * ``ASSIGNED``–assigned and will run next on a worker.
               
              * ``SCHEDULED``–scheduled to be run on a worker.
               
              * ``INTERRUPTING``–being interrupted.
               
              * ``RUNNING``–running on a worker.
               
              * ``SUSPENDED``–the task is suspended.
               
              * ``CANCELED``–the task has been canceled.
               
              * ``FAILED``–the task has failed.
               
              * ``SUCCEEDED``–the task has succeeded.
              

              
            

            - **targetTaskRunStatus** *(string) --* 

              The task status to update the job's tasks to.

              
            

            - **taskRunStatusCounts** *(dict) --* 

              The number of tasks running on the job.

              
              

              - *(string) --* 
                

                - *(integer) --* 
          
        
            

            - **taskFailureRetryCount** *(integer) --* 

              The total number of times tasks from the job failed and were retried.

              
            

            - **maxFailedTasksCount** *(integer) --* 

              The number of task failures before the job stops running and is marked as ``FAILED``.

              
            

            - **maxRetriesPerTask** *(integer) --* 

              The maximum number of retries for a job.

              
            

            - **maxWorkerCount** *(integer) --* 

              The maximum number of worker hosts that can concurrently process a job. When the ``maxWorkerCount`` is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

               

              You can't set the ``maxWorkerCount`` to 0. If you set it to -1, there is no maximum number of workers.

               

              If you don't specify the ``maxWorkerCount``, the default is -1.

              
            

            - **sourceJobId** *(string) --* 

              The job ID for the source job.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    