Class: Aws::IoTSiteWise::Types::GetInterpolatedAssetPropertyValuesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the asset.

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#end_time_in_secondsInteger

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

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#end_time_offset_in_nanosInteger

The nanosecond offset converted from endTimeInSeconds.

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#interval_in_secondsInteger

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

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#interval_window_in_secondsInteger

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.

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#property_aliasString

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.

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#property_idString

The ID of the asset property.

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#qualityString

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.

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_in_secondsInteger

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

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_offset_in_nanosInteger

The nanosecond offset converted from startTimeInSeconds.

Returns:

  • (Integer)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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.

Returns:

  • (String)


4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4921

class GetInterpolatedAssetPropertyValuesRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :start_time_in_seconds,
  :start_time_offset_in_nanos,
  :end_time_in_seconds,
  :end_time_offset_in_nanos,
  :quality,
  :interval_in_seconds,
  :next_token,
  :max_results,
  :type,
  :interval_window_in_seconds)
  SENSITIVE = []
  include Aws::Structure
end