get_interpolated_asset_property_values(**kwargs)¶Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
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.
To identify an asset property, you must specify one of the following:
assetId and propertyId of an asset property.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_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
)
/company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .[REQUIRED]
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
startTimeInSeconds .[REQUIRED]
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
endTimeInSeconds .[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.
[REQUIRED]
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
[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.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
intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION .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.
dict
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.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingExceptionIoTSiteWise.Client.exceptions.ServiceUnavailableException