DataZone / Paginator / ListDataSourceRuns

ListDataSourceRuns

class DataZone.Paginator.ListDataSourceRuns

paginator = client.get_paginator('list_data_source_runs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    dataSourceIdentifier='string',
    domainIdentifier='string',
    status='REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• dataSourceIdentifier (string) –

  [REQUIRED]

  The identifier of the data source.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

• status (string) – The status of the data source.

• 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),
            'dataSourceId': 'string',
            'errorMessage': {
                'errorDetail': 'string',
                'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION'
            },
            'id': 'string',
            'projectId': 'string',
            'runStatisticsForAssets': {
                'added': 123,
                'failed': 123,
                'skipped': 123,
                'unchanged': 123,
                'updated': 123
            },
            'startedAt': datetime(2015, 1, 1),
            'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS',
            'stoppedAt': datetime(2015, 1, 1),
            'type': 'PRIORITIZED'|'SCHEDULED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListDataSourceRuns action.

    • (dict) –

      The details of a data source run.

      • createdAt (datetime) –

        The timestamp of when a data source run was created.

      • dataSourceId (string) –

        The identifier of the data source of the data source run.

      • errorMessage (dict) –

        The details of the error message that is returned if the operation cannot be successfully completed.

        • errorDetail (string) –

          The details of the error message that is returned if the operation cannot be successfully completed.

        • errorType (string) –

          The type of the error message that is returned if the operation cannot be successfully completed.

      • id (string) –

        The identifier of the data source run.

      • projectId (string) –

        The project ID of the data source run.

      • runStatisticsForAssets (dict) –

        The asset statistics from the data source run.

        • added (integer) –

          The added statistic for the data source run.

        • failed (integer) –

          The failed statistic for the data source run.

        • skipped (integer) –

          The skipped statistic for the data source run.

        • unchanged (integer) –

          The unchanged statistic for the data source run.

        • updated (integer) –

          The updated statistic for the data source run.

      • startedAt (datetime) –

        The timestamp of when a data source run was started.

      • status (string) –

        The status of the data source run.

      • stoppedAt (datetime) –

        The timestamp of when a data source run was stopped.

      • type (string) –

        The type of the data source run.

      • updatedAt (datetime) –

        The timestamp of when a data source run was updated.

  • NextToken (string) –

    A token to resume pagination.