GetAssetPropertyAggregates¶

class IoTSiteWise.Paginator.GetAssetPropertyAggregates¶

paginator = client.get_paginator('get_asset_property_aggregates')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    aggregateTypes=[
        'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
    ],
    resolution='string',
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    timeOrdering='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

assetId (string) -- The ID of the asset.
propertyId (string) -- The ID of the asset property.
propertyAlias (string) -- The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .
aggregateTypes (list) --
[REQUIRED]

The data aggregating function.
- (string) --
resolution (string) --
[REQUIRED]

The time interval over which to aggregate data.
qualities (list) --
The quality by which to filter asset data.
- (string) --
startDate (datetime) --
[REQUIRED]

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
endDate (datetime) --
[REQUIRED]

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
timeOrdering (string) --
The chronological sorting order of the requested information.

Default: ASCENDING
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

{
    'aggregatedValues': [
        {
            'timestamp': datetime(2015, 1, 1),
            'quality': 'GOOD'|'BAD'|'UNCERTAIN',
            'value': {
                'average': 123.0,
                'count': 123.0,
                'maximum': 123.0,
                'minimum': 123.0,
                'sum': 123.0,
                'standardDeviation': 123.0
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- aggregatedValues (list) --
  
  The requested aggregated values.
  - (dict) --
    
    Contains aggregated asset property values (for example, average, minimum, and maximum).
    - timestamp (datetime) --
      
      The date the aggregating computations occurred, in Unix epoch time.
    - quality (string) --
      
      The quality of the aggregated data.
    - value (dict) --
      
      The value of the aggregates.
      - average (float) --
        
        The average (mean) value of the time series over a time interval window.
      - count (float) --
        
        The count of data points in the time series over a time interval window.
      - maximum (float) --
        
        The maximum value of the time series over a time interval window.
      - minimum (float) --
        
        The minimum value of the time series over a time interval window.
      - sum (float) --
        
        The sum of the time series over a time interval window.
      - standardDeviation (float) --
        
        The standard deviation of the time series over a time interval window.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

GetAssetPropertyAggregates¶