TumblingWindow
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can 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, h
represents hours, d
represents days, and w
represents weeks. You can
also use s
to represent seconds in offset
.
The interval
and offset
parameters support the ISO 8601 formatPT5S
represents 5 seconds, PT5M
represents 5 minutes, and
PT5H
represents 5 hours.
Contents
- interval
-
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
AWS IoT SiteWise computes the
1w
interval the end of Sunday at midnight each week (UTC), the1d
interval at the end of each day at midnight (UTC), the1h
interval at the end of each hour, and so on.When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 23.
Required: Yes
- offset
-
The offset for the tumbling window. The
offset
parameter accepts the following:-
The offset time.
For example, if you specify
18h
foroffset
and1d
forinterval
, AWS IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 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 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
foroffset
and1d
forinterval
, AWS IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 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 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
foroffset
,5m
forinterval
, 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
foroffset
and1d
forinterval
, AWS IoT SiteWise aggregates data in one of the following ways:-
If you create the metric before or at 6 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 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
-
Type: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: