class Aws::IoTSiteWise::Types::GetInterpolatedAssetPropertyValuesRequest
@note When making an API call, you may pass GetInterpolatedAssetPropertyValuesRequest
data as a hash: { asset_id: "ID", property_id: "ID", property_alias: "AssetPropertyAlias", start_time_in_seconds: 1, # required start_time_offset_in_nanos: 1, end_time_in_seconds: 1, # required end_time_offset_in_nanos: 1, quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN interval_in_seconds: 1, # required next_token: "NextToken", max_results: 1, type: "InterpolationType", # required interval_window_in_seconds: 1, }
@!attribute [rw] asset_id
The ID of the asset. @return [String]
@!attribute [rw] property_id
The ID of the asset property. @return [String]
@!attribute [rw] property_alias
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][1] in the *IoT SiteWise User Guide*. [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html @return [String]
@!attribute [rw] start_time_in_seconds
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. @return [Integer]
@!attribute [rw] start_time_offset_in_nanos
The nanosecond offset converted from `startTimeInSeconds`. @return [Integer]
@!attribute [rw] end_time_in_seconds
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. @return [Integer]
@!attribute [rw] end_time_offset_in_nanos
The nanosecond offset converted from `endTimeInSeconds`. @return [Integer]
@!attribute [rw] quality
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. @return [String]
@!attribute [rw] interval_in_seconds
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. @return [Integer]
@!attribute [rw] next_token
The token to be used for the next set of paginated results. @return [String]
@!attribute [rw] max_results
The maximum number of results to return for each paginated request. If not specified, the default value is 10. @return [Integer]
@!attribute [rw] type
The interpolation type. Valid values: `LINEAR_INTERPOLATION | LOCF_INTERPOLATION` * `LINEAR_INTERPOLATION` – Estimates missing data using [linear interpolation][1]. 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 on 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 on 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 no data point is found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days. [1]: https://en.wikipedia.org/wiki/Linear_interpolation @return [String]
@!attribute [rw] interval_window_in_seconds
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. <note markdown="1"> * If you specify a value for the `intervalWindowInSeconds` parameter, the `type` parameter must be `LINEAR_INTERPOLATION`. * If no data point is 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. </note> 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. @return [Integer]
Constants
- SENSITIVE