IoTSiteWise / Client / list_dataset_data_segments

list_dataset_data_segments¶

IoTSiteWise.Client.list_dataset_data_segments(**kwargs)¶

Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.

Request Syntax

response = client.list_dataset_data_segments(
    datasetId='string',
    workspaceName='string',
    datasetVersion='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

datasetId (string) –
[REQUIRED]

The ID of the dataset.
workspaceName (string) –
[REQUIRED]

The name of the workspace that contains the dataset.
datasetVersion (string) – The version of the dataset to list data segments for.
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

{
    'dataSegments': [
        {
            'sourceDatasetId': 'string',
            'timeSeriesId': 'string',
            'startTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'endTimestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'alias': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT'|'VIDEO'|'ANNOTATION'|'JSON',
            'enrichment': {
                'status': 'ENRICHED'|'NOT_ENRICHED',
                'lastEnrichedAt': datetime(2015, 1, 1)
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- dataSegments (list) –
  
  A list that summarizes each data segment.
  - (dict) –
    
    Contains summary information about a data segment, including its source dataset, time series, timestamp range, and enrichment status.
    - sourceDatasetId (string) –
      
      The ID of the source 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.
    - alias (string) –
      
      The alias of the time series.
    - dataType (string) –
      
      The data type of the time series.
    - enrichment (dict) –
      
      The enrichment information for the data segment.
      - status (string) –
        
        The enrichment status of the data segment.
      - lastEnrichedAt (datetime) –
        
        The date the data segment was last enriched, in Unix epoch time.
- 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