IoTSiteWise / Paginator / ListTimeSeries

ListTimeSeries#

class IoTSiteWise.Paginator.ListTimeSeries#

paginator = client.get_paginator('list_time_series')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    aliasPrefix='string',
    timeSeriesType='ASSOCIATED'|'DISASSOCIATED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

assetId (string) – The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
aliasPrefix (string) – The alias prefix of the time series.
timeSeriesType (string) –
The type of the time series. The time series type can be one of the following values:
- ASSOCIATED – The time series is associated with an asset property.
- DISASSOCIATED – The time series isn’t associated with any asset property.
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

{
    'TimeSeriesSummaries': [
        {
            'assetId': 'string',
            'propertyId': 'string',
            'alias': 'string',
            'timeSeriesId': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
            'dataTypeSpec': 'string',
            'timeSeriesCreationDate': datetime(2015, 1, 1),
            'timeSeriesLastUpdateDate': datetime(2015, 1, 1),
            'timeSeriesArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- TimeSeriesSummaries (list) –
  
  One or more time series summaries to list.
  - (dict) –
    
    Contains a summary of a time series (data stream).
    - assetId (string) –
      
      The ID of the asset in which the asset property was created.
    - propertyId (string) –
      
      The ID of the asset property, in UUID format.
    - alias (string) –
      
      The alias that identifies the time series.
    - timeSeriesId (string) –
      
      The ID of the time series.
    - dataType (string) –
      
      The data type of the time series.
      
      If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.
    - dataTypeSpec (string) –
      
      The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.
      
      The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
    - timeSeriesCreationDate (datetime) –
      
      The date that the time series was created, in Unix epoch time.
    - timeSeriesLastUpdateDate (datetime) –
      
      The date that the time series was last updated, in Unix epoch time.
    - timeSeriesArn (string) –
      
      The ARN of the time series, which has the following format.
      
      arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
- NextToken (string) –
  
  A token to resume pagination.