Skip to content

Commit dc02127

Browse files
author
AWS
committed
Amazon CloudWatch Update: This release adds support for Metric Characteristics for CloudWatch Anomaly Detection. Anomaly Detector now takes Metric Characteristics object with Periodic Spikes boolean field that tells Anomaly Detection that spikes that repeat at the same time every week are part of the expected pattern.
1 parent 56bca49 commit dc02127

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon CloudWatch",
4+
"contributor": "",
5+
"description": "This release adds support for Metric Characteristics for CloudWatch Anomaly Detection. Anomaly Detector now takes Metric Characteristics object with Periodic Spikes boolean field that tells Anomaly Detection that spikes that repeat at the same time every week are part of the expected pattern."
6+
}

services/cloudwatch/src/main/resources/codegen-resources/service-2.json

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,11 @@
781781
},
782782
"StateValue":{
783783
"shape":"AnomalyDetectorStateValue",
784-
"documentation":"<p>The current status of the anomaly detector's training. The possible values are <code>TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA</code> </p>"
784+
"documentation":"<p>The current status of the anomaly detector's training.</p>"
785+
},
786+
"MetricCharacteristics":{
787+
"shape":"MetricCharacteristics",
788+
"documentation":"<p>This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>"
785789
},
786790
"SingleMetricAnomalyDetector":{
787791
"shape":"SingleMetricAnomalyDetector",
@@ -2662,6 +2666,16 @@
26622666
"type":"list",
26632667
"member":{"shape":"MetricAlarm"}
26642668
},
2669+
"MetricCharacteristics":{
2670+
"type":"structure",
2671+
"members":{
2672+
"PeriodicSpikes":{
2673+
"shape":"PeriodicSpikes",
2674+
"documentation":"<p>Set this parameter to <code>true</code> if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to <code>true</code>, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.</p>"
2675+
}
2676+
},
2677+
"documentation":"<p>This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.</p>"
2678+
},
26652679
"MetricData":{
26662680
"type":"list",
26672681
"member":{"shape":"MetricDatum"}
@@ -3029,6 +3043,7 @@
30293043
"type":"integer",
30303044
"min":1
30313045
},
3046+
"PeriodicSpikes":{"type":"boolean"},
30323047
"PutAnomalyDetectorInput":{
30333048
"type":"structure",
30343049
"members":{
@@ -3060,6 +3075,10 @@
30603075
"shape":"AnomalyDetectorConfiguration",
30613076
"documentation":"<p>The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.</p> <p>The configuration can also include the time zone to use for the metric.</p>"
30623077
},
3078+
"MetricCharacteristics":{
3079+
"shape":"MetricCharacteristics",
3080+
"documentation":"<p>Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>"
3081+
},
30633082
"SingleMetricAnomalyDetector":{
30643083
"shape":"SingleMetricAnomalyDetector",
30653084
"documentation":"<p>A single metric anomaly detector to be created.</p> <p>When using <code>SingleMetricAnomalyDetector</code>, you cannot include the following parameters in the same operation:</p> <ul> <li> <p> <code>Dimensions</code> </p> </li> <li> <p> <code>MetricName</code> </p> </li> <li> <p> <code>Namespace</code> </p> </li> <li> <p> <code>Stat</code> </p> </li> <li> <p>the <code>MetricMathAnomalyDetector</code> parameters of <code>PutAnomalyDetectorInput</code> </p> </li> </ul> <p>Instead, specify the single metric anomaly detector attributes as part of the property <code>SingleMetricAnomalyDetector</code>.</p>"

0 commit comments

Comments
 (0)