IoTSiteWise / Paginator / ListDatasetDataSegmentRelationships

ListDatasetDataSegmentRelationships

class IoTSiteWise.Paginator.ListDatasetDataSegmentRelationships

paginator = client.get_paginator('list_dataset_data_segment_relationships')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_dataset_data_segment_relationships().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetId='string',
    workspaceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• datasetId (string) –

  [REQUIRED]

  The ID of the session dataset to list data segment relationships for.

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace that contains the dataset.

• 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

{
    'dataSegmentRelationshipSummaries': [
        {
            'targetDatasetId': 'string',
            'sourceDatasetId': 'string',
            'timeSeriesId': 'string',
            'startTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'endTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • dataSegmentRelationshipSummaries (list) –

    A list that summarizes each data segment relationship.

    • (dict) –

      Contains summary information about a data segment relationship between a source session dataset that contains the data and a curated dataset that references it, including the time series and timestamp range.

      • targetDatasetId (string) –

        The ID of the curated dataset that references the data segment.

      • sourceDatasetId (string) –

        The ID of the source session dataset that contains the data segment.

      • timeSeriesId (string) –

        The ID of the time series.

      • startTimestamp (dict) –

        The nanosecond-precision start time of the data segment.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

      • endTimestamp (dict) –

        The nanosecond-precision end time of the data segment.

        • timeInSeconds (integer) –

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

        • offsetInNanos (integer) –

          The nanosecond offset from timeInSeconds.

  • NextToken (string) –

    A token to resume pagination.