IoTSiteWise / Paginator / GetInterpolatedAssetPropertyValues

GetInterpolatedAssetPropertyValues

class IoTSiteWise.Paginator.GetInterpolatedAssetPropertyValues

paginator = client.get_paginator('get_interpolated_asset_property_values')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    startTimeInSeconds=123,
    startTimeOffsetInNanos=123,
    endTimeInSeconds=123,
    endTimeOffsetInNanos=123,
    quality='GOOD'|'BAD'|'UNCERTAIN',
    intervalInSeconds=123,
    type='string',
    intervalWindowInSeconds=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• assetId (string) – The ID of the asset, in UUID format.

• propertyId (string) – The ID of the asset property, in UUID format.

• 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.

• startTimeInSeconds (integer) –

  [REQUIRED]

  The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.

• startTimeOffsetInNanos (integer) – The nanosecond offset converted from startTimeInSeconds.

• endTimeInSeconds (integer) –

  [REQUIRED]

  The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.

• endTimeOffsetInNanos (integer) – The nanosecond offset converted from endTimeInSeconds.

• quality (string) –

  [REQUIRED]

  The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.

• intervalInSeconds (integer) –

  [REQUIRED]

  The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.

• type (string) –

  [REQUIRED]

  The interpolation type.

  Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION

  • LINEAR_INTERPOLATION – Estimates missing data using linear interpolation. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.

  • LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found. For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn’t found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

• intervalWindowInSeconds (integer) –

  The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.

  Note

  • If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.

  • If a data point isn’t found during the specified query window, IoT SiteWise won’t return an interpolated value for the interval. This indicates that there’s a gap in the ingested data points.

  For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.

• 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

{
    'interpolatedAssetPropertyValues': [
        {
            'timestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'value': {
                'stringValue': 'string',
                'integerValue': 123,
                'doubleValue': 123.0,
                'booleanValue': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • interpolatedAssetPropertyValues (list) –

    The requested interpolated values.

    • (dict) –

      Contains information about an interpolated asset property value.

      • timestamp (dict) –

        Contains a timestamp with optional nanosecond granularity.

        • 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.

      • value (dict) –

        Contains an asset property value (of a single type only).

        • stringValue (string) –

          Asset property data of type string (sequence of characters).

        • integerValue (integer) –

          Asset property data of type integer (number that’s greater than or equal to zero).

        • doubleValue (float) –

          Asset property data of type double (floating point number).

        • booleanValue (boolean) –

          Asset property data of type Boolean (true or false).

  • NextToken (string) –

    A token to resume pagination.