AWS IoT SiteWise

{'intervalWindowInSeconds': 'long'}

Get interpolated values for an asset property for a specified time interval, during a period of time. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

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

client.get_interpolated_asset_property_values(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    startTimeInSeconds=123,
    startTimeOffsetInNanos=123,
    endTimeInSeconds=123,
    endTimeOffsetInNanos=123,
    quality='GOOD'|'BAD'|'UNCERTAIN',
    intervalInSeconds=123,
    nextToken='string',
    maxResults=123,
    type='string',
    intervalWindowInSeconds=123
)

type assetId:

string

param assetId:

The ID of the asset.

type propertyId:

string

param propertyId:

The ID of the asset property.

type propertyAlias:

string

param propertyAlias:

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.

type startTimeInSeconds:

integer

param startTimeInSeconds:

[REQUIRED]

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

type startTimeOffsetInNanos:

integer

param startTimeOffsetInNanos:

The nanosecond offset converted from startTimeInSeconds.

type endTimeInSeconds:

integer

param endTimeInSeconds:

[REQUIRED]

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

type endTimeOffsetInNanos:

integer

param endTimeOffsetInNanos:

The nanosecond offset converted from endTimeInSeconds.

type quality:

string

param quality:

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

type intervalInSeconds:

integer

param intervalInSeconds:

[REQUIRED]

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

type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

type maxResults:

integer

param maxResults:

The maximum number of results to return for each paginated request. If not specified, the default value is 10.

type type:

string

param type:

[REQUIRED]

The interpolation type.

Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION

For the LOCF_INTERPOLATION interpolation, if no data point is found for an interval, IoT SiteWise returns the same interpolated value calculated for the previous interval and carries forward this interpolated value until a new data point is found.

For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the LOCF_INTERPOLATION interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise uses the data points from July 1, 2021, at 9 AM to July 2, 2021, at 9 AM to compute the first interpolated value. If no data points is found after 9 A.M. on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

type intervalWindowInSeconds:

integer

param intervalWindowInSeconds:

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 is between the start time minus the interval and the end time plus the interval.

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 - 2 hours) to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.

rtype:

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 (whole number).

        • doubleValue (float) --

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

        • booleanValue (boolean) --

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

  • nextToken (string) --

    The token for the next set of results, or null if there are no additional results.