IoTSiteWise / Client / list_dataset_data_segment_relationships

list_dataset_data_segment_relationships

IoTSiteWise.Client.list_dataset_data_segment_relationships(**kwargs)

Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_data_segment_relationships(
    datasetId='string',
    workspaceName='string',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of results to return for each paginated request. Default: 50.

  • nextToken (string) – The token to be used for the next set of paginated results.

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

      The token for the next set of results, or null if there are no additional results.

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException