AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::TumblingWindow

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 TumblingWindow data as a hash:

{
  interval: "Interval", # required
  offset: "Offset",
}

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You use this window in metrics to aggregate data from properties and other assets.

You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, and w represents weeks. You can also use s to represent seconds in offset.

The interval and offset parameters support the ISO 8601 format. For example, PT5S represents five seconds, PT5M represents five minutes, and PT5H represents five hours.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#intervalString

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

Returns:

  • (String)


5998
5999
6000
6001
6002
6003
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5998

class TumblingWindow < Struct.new(
  :interval,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end

#offsetString

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

    For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The ISO 8601 format.

    For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

    • If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

  • The 24-hour clock.

    For example, if you specify 00:03:00 for offset and 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

    For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    • If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.

    • If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

Returns:

  • (String)


5998
5999
6000
6001
6002
6003
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5998

class TumblingWindow < Struct.new(
  :interval,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end