:doc:`DataZone <../../datazone>` / Paginator / ListJobRuns

***********
ListJobRuns
***********



.. py:class:: DataZone.Paginator.ListJobRuns

  ::

    
    paginator = client.get_paginator('list_job_runs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_job_runs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListJobRuns>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          jobIdentifier='string',
          status='SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED',
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

      The ID of the domain where you want to list job runs.

      

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

      The ID of the job run.

      

    
    :type status: string
    :param status: 

      The status of a job run.

      

    
    :type sortOrder: string
    :param sortOrder: 

      Specifies the order in which job runs are to be sorted.

      

    
    :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**

      
      ::

        {
            'items': [
                {
                    'domainId': 'string',
                    'jobId': 'string',
                    'jobType': 'LINEAGE',
                    'runId': 'string',
                    'runMode': 'SCHEDULED'|'ON_DEMAND',
                    'status': 'SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED',
                    'error': {
                        'message': 'string'
                    },
                    'createdBy': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The results of the ListJobRuns action.

          
          

          - *(dict) --* 

            The job run summary.

            
            

            - **domainId** *(string) --* 

              The domain ID of the job run.

              
            

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

              The job ID of a job run.

              
            

            - **jobType** *(string) --* 

              The job type of a job run.

              
            

            - **runId** *(string) --* 

              The run ID of a job run.

              
            

            - **runMode** *(string) --* 

              The run mode of a job run.

              
            

            - **status** *(string) --* 

              The status of a job run.

              
            

            - **error** *(dict) --* 

              The error of a job run.

              
              

              - **message** *(string) --* 

                The job run error message.

                
          
            

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

              The user who created the job run.

              
            

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

              The timestamp at which job run was created.

              
            

            - **startTime** *(datetime) --* 

              The start time of a job run.

              
            

            - **endTime** *(datetime) --* 

              The end time of a job run.

              
        
      
        

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

          A token to resume pagination.

          
    