DataZone / Client / list_job_runs

list_job_runs#

DataZone.Client.list_job_runs(**kwargs)#

Lists job runs.

Request Syntax

response = client.list_job_runs(
    domainIdentifier='string',
    jobIdentifier='string',
    maxResults=123,
    nextToken='string',
    sortOrder='ASCENDING'|'DESCENDING',
    status='SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED'
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The ID of the domain where you want to list job runs.
jobIdentifier (string) –
[REQUIRED]

The ID of the job run.
maxResults (integer) – 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.
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.
sortOrder (string) – Specifies the order in which job runs are to be sorted.
status (string) – The status of a job run.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- items (list) –
  
  The results of the ListJobRuns action.
  - (dict) –
    
    The job run summary.
    - createdAt (datetime) –
      
      The timestamp at which job run was created.
    - createdBy (string) –
      
      The user who created the job run.
    - domainId (string) –
      
      The domain ID of the job run.
    - endTime (datetime) –
      
      The end time of a job run.
    - error (dict) –
      
      The error of a job run.
      - message (string) –
        
        The job run error message.
    - 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.
    - startTime (datetime) –
      
      The start time of a job run.
    - status (string) –
      
      The status 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

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException