Skip to content

Commit

Permalink
AWS IoT SiteWise Update: My AWS Service (placeholder) - This release …
Browse files Browse the repository at this point in the history
…introduces custom Intervals and offset for tumbling window in metric for AWS IoT SiteWise.
  • Loading branch information
AWS committed Aug 3, 2021
1 parent 8698e9c commit 166742f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AWSIoTSiteWise-d79b215.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "feature",
"category": "AWS IoT SiteWise",
"contributor": "",
"description": "My AWS Service (placeholder) - This release introduces custom Intervals and offset for tumbling window in metric for AWS IoT SiteWise."
}
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@
{"shape":"LimitExceededException"},
{"shape":"ConflictingOperationException"}
],
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p> <note> <p>Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.</p> </note>",
"documentation":"<p>Retrieves information about the storage configuration for IoT SiteWise.</p>",
"endpoint":{"hostPrefix":"api."}
},
"DisassociateAssets":{
Expand Down Expand Up @@ -890,7 +890,7 @@
{"shape":"LimitExceededException"},
{"shape":"ConflictingOperationException"}
],
"documentation":"<p>Configures storage settings for IoT SiteWise.</p> <note> <p>Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.</p> </note>",
"documentation":"<p>Configures storage settings for IoT SiteWise.</p>",
"endpoint":{"hostPrefix":"api."}
},
"TagResource":{
Expand Down Expand Up @@ -4086,9 +4086,8 @@
},
"Interval":{
"type":"string",
"max":3,
"min":2,
"pattern":"1w|1d|1h|15m|5m|1m"
"max":23,
"min":2
},
"IntervalInSeconds":{
"type":"long",
Expand Down Expand Up @@ -4704,6 +4703,11 @@
"min":1,
"pattern":"[A-Za-z0-9+/=]+"
},
"Offset":{
"type":"string",
"max":25,
"min":2
},
"OffsetInNanos":{
"type":"integer",
"max":999999999,
Expand Down Expand Up @@ -5331,10 +5335,14 @@
"members":{
"interval":{
"shape":"Interval",
"documentation":"<p>The time interval for the tumbling window. Note that <code>w</code> represents weeks, <code>d</code> represents days, <code>h</code> represents hours, and <code>m</code> represents minutes. IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight each week (UTC), the <code>1d</code> interval at the end of each day at midnight (UTC), the <code>1h</code> interval at the end of each hour, and so on. </p> <p>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.</p>"
"documentation":"<p>The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.</p> <p>IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight each week (UTC), the <code>1d</code> interval at the end of each day at midnight (UTC), the <code>1h</code> interval at the end of each hour, and so on. </p> <p>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.</p>"
},
"offset":{
"shape":"Offset",
"documentation":"<p>The offset for the tumbling window. The <code>offset</code> parameter accepts the following:</p> <ul> <li> <p>The offset time.</p> <p>For example, if you specify <code>18h</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6:00 p.m. (UTC), you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6:00 p.m. (UTC), you get the first aggregation result at 6 p.m. (UTC) the next day.</p> </li> </ul> </li> <li> <p>The ISO 8601 format.</p> <p>For example, if you specify <code>PT18H</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6:00 p.m. (UTC), you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6:00 p.m. (UTC), you get the first aggregation result at 6 p.m. (UTC) the next day.</p> </li> </ul> </li> <li> <p>The 24-hour clock.</p> <p>For example, if you specify <code>00:03:00</code> for <code>offset</code> and <code>5m</code> for <code>interval</code>, and you create the metric at 2 p.m. (UTC), you get the first aggregation result at 2:03 p.m. (UTC). You get the second aggregation result at 2:08 p.m. (UTC). </p> </li> <li> <p>The offset time zone.</p> <p>For example, if you specify <code>2021-07-23T18:00-08</code> for <code>offset</code> and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p> <ul> <li> <p>If you create the metric before or at 6:00 p.m. (PST), you get the first aggregation result at 6 p.m. (PST) on the day when you create the metric.</p> </li> <li> <p>If you create the metric after 6:00 p.m. (PST), you get the first aggregation result at 6 p.m. (PST) the next day.</p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.</p>"
"documentation":"<p>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.</p> <p>You can use <code>m</code>, <code>h</code>, <code>d</code>, and <code>w</code> when you specify an interval or offset. Note that <code>m</code> represents minutes, and <code>w</code> represents weeks. You can also use <code>s</code> to represent seconds in <code>offset</code>.</p> <p>The <code>interval</code> and <code>offset</code> parameters support the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601 format</a>. For example, <code>PT5S</code> represents five seconds, <code>PT5M</code> represents five minutes, and <code>PT5H</code> represents five hours.</p>"
},
"UnauthorizedException":{
"type":"structure",
Expand Down

0 comments on commit 166742f

Please sign in to comment.