IoTSiteWise / Client / get_asset_property_aggregates

get_asset_property_aggregates#

IoTSiteWise.Client.get_asset_property_aggregates(**kwargs)#

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide .

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property’s alias, see UpdateAssetProperty.

See also: AWS API Documentation

Request Syntax

response = client.get_asset_property_aggregates(
    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',
    nextToken='string',
    maxResults=123
)
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

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

  • maxResults (integer) –

    The maximum number of results to return for each paginated request.

    Default: 100

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

      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

  • IoTSiteWise.Client.exceptions.ServiceUnavailableException