:doc:`DataZone <../../datazone>` / Client / list_job_runs

*************
list_job_runs
*************



.. py:method:: DataZone.Client.list_job_runs(**kwargs)

  

  Lists job runs.

  

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


  **Request Syntax**
  ::

    response = client.list_job_runs(
        domainIdentifier='string',
        jobIdentifier='string',
        status='SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED',
        sortOrder='ASCENDING'|'DESCENDING',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.

    

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

        When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  