GetInterpolatedAssetPropertyValuesCommand

Suggest an Edit

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:

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTSiteWiseClient, GetInterpolatedAssetPropertyValuesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
// const { IoTSiteWiseClient, GetInterpolatedAssetPropertyValuesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
const client = new IoTSiteWiseClient(config);
const input = { // GetInterpolatedAssetPropertyValuesRequest
  assetId: "STRING_VALUE",
  propertyId: "STRING_VALUE",
  propertyAlias: "STRING_VALUE",
  startTimeInSeconds: Number("long"), // required
  startTimeOffsetInNanos: Number("int"),
  endTimeInSeconds: Number("long"), // required
  endTimeOffsetInNanos: Number("int"),
  quality: "GOOD" || "BAD" || "UNCERTAIN", // required
  intervalInSeconds: Number("long"), // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  type: "STRING_VALUE", // required
  intervalWindowInSeconds: Number("long"),
};
const command = new GetInterpolatedAssetPropertyValuesCommand(input);
const response = await client.send(command);
// { // GetInterpolatedAssetPropertyValuesResponse
//   interpolatedAssetPropertyValues: [ // InterpolatedAssetPropertyValues // required
//     { // InterpolatedAssetPropertyValue
//       timestamp: { // TimeInNanos
//         timeInSeconds: Number("long"), // required
//         offsetInNanos: Number("int"),
//       },
//       value: { // Variant
//         stringValue: "STRING_VALUE",
//         integerValue: Number("int"),
//         doubleValue: Number("double"),
//         booleanValue: true || false,
//         nullValue: { // PropertyValueNullValue
//           valueType: "D" || "B" || "S" || "I" || "U", // required
//         },
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

GetInterpolatedAssetPropertyValuesCommand Input

See GetInterpolatedAssetPropertyValuesCommandInput for more details

Parameter
Type
Description
endTimeInSeconds
Required
number | undefined

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

intervalInSeconds
Required
number | undefined

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

quality
Required
Quality | undefined

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.

startTimeInSeconds
Required
number | undefined

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

type
Required
string | undefined

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.

assetId
string | undefined

The ID of the asset, in UUID format.

endTimeOffsetInNanos
number | undefined

The nanosecond offset converted from endTimeInSeconds.

intervalWindowInSeconds
number | undefined

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.

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

maxResults
number | undefined

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

nextToken
string | undefined

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

propertyAlias
string | undefined

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.

propertyId
string | undefined

The ID of the asset property, in UUID format.

startTimeOffsetInNanos
number | undefined

The nanosecond offset converted from startTimeInSeconds.

GetInterpolatedAssetPropertyValuesCommand Output

See GetInterpolatedAssetPropertyValuesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
interpolatedAssetPropertyValues
Required
InterpolatedAssetPropertyValue[] | undefined

The requested interpolated values.

nextToken
string | undefined

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

Throws

Name
Fault
Details
InternalFailureException
server

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException
client

The requested resource can't be found.

ServiceUnavailableException
server

The requested service is unavailable.

ThrottlingException
client

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas  in the IoT SiteWise User Guide.

IoTSiteWiseServiceException
Base exception class for all service exceptions from IoTSiteWise service.