DataZone / Paginator / ListTimeSeriesDataPoints

ListTimeSeriesDataPoints

class DataZone.Paginator.ListTimeSeriesDataPoints

paginator = client.get_paginator('list_time_series_data_points')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    endedAt=datetime(2015, 1, 1),
    entityIdentifier='string',
    entityType='ASSET'|'LISTING',
    formName='string',
    startedAt=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

• endedAt (datetime) – The timestamp at which the data points that you wanted to list ended.

• entityIdentifier (string) –

  [REQUIRED]

  The ID of the asset for which you want to list data points.

• entityType (string) –

  [REQUIRED]

  The type of the asset for which you want to list data points.

• formName (string) –

  [REQUIRED]

  The name of the time series data points form.

• startedAt (datetime) – The timestamp at which the data points that you want to list started.

• 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': [
        {
            'contentSummary': 'string',
            'formName': 'string',
            'id': 'string',
            'timestamp': datetime(2015, 1, 1),
            'typeIdentifier': 'string',
            'typeRevision': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListTimeSeriesDataPoints action.

    • (dict) –

      The summary of the time series data points form.

      • contentSummary (string) –

        The content of the summary of the time series data points form.

      • formName (string) –

        The name of the time series data points summary form.

      • id (string) –

        The ID of the time series data points summary form.

      • timestamp (datetime) –

        The timestamp of the time series data points summary form.

      • typeIdentifier (string) –

        The type ID of the time series data points summary form.

      • typeRevision (string) –

        The type revision of the time series data points summary form.

  • NextToken (string) –

    A token to resume pagination.