DataZone / Paginator / ListJobRuns

ListJobRuns

class DataZone.Paginator.ListJobRuns

paginator = client.get_paginator('list_job_runs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_job_runs().

See also: AWS API Documentation

Request Syntax

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

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.

• sortOrder (string) – Specifies the order in which job runs are to be sorted.

• status (string) – The status of a job run.

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

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) –

    A token to resume pagination.