@aws-sdk/client-cloudwatch 3.40.0 → 3.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/dist-cjs/endpoints.js +17 -0
  3. package/dist-cjs/models/models_0.js +44 -27
  4. package/dist-cjs/protocols/Aws_query.js +146 -0
  5. package/dist-es/endpoints.js +17 -0
  6. package/dist-es/models/models_0.js +29 -16
  7. package/dist-es/protocols/Aws_query.js +322 -158
  8. package/dist-types/CloudWatch.d.ts +19 -5
  9. package/dist-types/commands/DeleteAlarmsCommand.d.ts +1 -1
  10. package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +1 -1
  11. package/dist-types/commands/DeleteDashboardsCommand.d.ts +1 -1
  12. package/dist-types/commands/DeleteInsightRulesCommand.d.ts +1 -1
  13. package/dist-types/commands/DeleteMetricStreamCommand.d.ts +1 -1
  14. package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +4 -1
  15. package/dist-types/commands/DescribeAlarmsCommand.d.ts +4 -1
  16. package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +1 -1
  17. package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +8 -4
  18. package/dist-types/commands/DescribeInsightRulesCommand.d.ts +1 -1
  19. package/dist-types/commands/DisableAlarmActionsCommand.d.ts +1 -1
  20. package/dist-types/commands/DisableInsightRulesCommand.d.ts +1 -1
  21. package/dist-types/commands/EnableAlarmActionsCommand.d.ts +1 -1
  22. package/dist-types/commands/EnableInsightRulesCommand.d.ts +1 -1
  23. package/dist-types/commands/GetDashboardCommand.d.ts +1 -1
  24. package/dist-types/commands/GetInsightRuleReportCommand.d.ts +1 -1
  25. package/dist-types/commands/GetMetricDataCommand.d.ts +1 -1
  26. package/dist-types/commands/GetMetricStatisticsCommand.d.ts +1 -1
  27. package/dist-types/commands/GetMetricStreamCommand.d.ts +1 -1
  28. package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +1 -1
  29. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  30. package/dist-types/commands/ListMetricStreamsCommand.d.ts +1 -1
  31. package/dist-types/commands/ListMetricsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +1 -1
  34. package/dist-types/commands/PutCompositeAlarmCommand.d.ts +5 -1
  35. package/dist-types/commands/PutDashboardCommand.d.ts +1 -1
  36. package/dist-types/commands/PutInsightRuleCommand.d.ts +1 -1
  37. package/dist-types/commands/PutMetricAlarmCommand.d.ts +2 -2
  38. package/dist-types/commands/PutMetricDataCommand.d.ts +1 -1
  39. package/dist-types/commands/PutMetricStreamCommand.d.ts +2 -2
  40. package/dist-types/commands/SetAlarmStateCommand.d.ts +1 -1
  41. package/dist-types/commands/StartMetricStreamsCommand.d.ts +1 -1
  42. package/dist-types/commands/StopMetricStreamsCommand.d.ts +1 -1
  43. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  44. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  45. package/dist-types/models/models_0.d.ts +432 -189
  46. package/dist-types/ts3.4/models/models_0.d.ts +109 -67
  47. package/package.json +6 -6
@@ -109,26 +109,251 @@ export declare namespace Dimension {
109
109
  */
110
110
  const filterSensitiveLog: (obj: Dimension) => any;
111
111
  }
112
+ /**
113
+ * <p>Represents a specific metric.</p>
114
+ */
115
+ export interface Metric {
116
+ /**
117
+ * <p>The namespace of the metric.</p>
118
+ */
119
+ Namespace?: string;
120
+ /**
121
+ * <p>The name of the metric. This is a required field.</p>
122
+ */
123
+ MetricName?: string;
124
+ /**
125
+ * <p>The dimensions for the metric.</p>
126
+ */
127
+ Dimensions?: Dimension[];
128
+ }
129
+ export declare namespace Metric {
130
+ /**
131
+ * @internal
132
+ */
133
+ const filterSensitiveLog: (obj: Metric) => any;
134
+ }
135
+ export declare type StandardUnit = "Bits" | "Bits/Second" | "Bytes" | "Bytes/Second" | "Count" | "Count/Second" | "Gigabits" | "Gigabits/Second" | "Gigabytes" | "Gigabytes/Second" | "Kilobits" | "Kilobits/Second" | "Kilobytes" | "Kilobytes/Second" | "Megabits" | "Megabits/Second" | "Megabytes" | "Megabytes/Second" | "Microseconds" | "Milliseconds" | "None" | "Percent" | "Seconds" | "Terabits" | "Terabits/Second" | "Terabytes" | "Terabytes/Second";
136
+ /**
137
+ * <p>This structure defines the metric to be returned, along with the statistics, period, and units.</p>
138
+ */
139
+ export interface MetricStat {
140
+ /**
141
+ * <p>The metric to return, including the metric name, namespace, and dimensions.</p>
142
+ */
143
+ Metric: Metric | undefined;
144
+ /**
145
+ * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
146
+ * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
147
+ * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
148
+ * are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
149
+ * <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
150
+ * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p>
151
+ * <ul>
152
+ * <li>
153
+ * <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p>
154
+ * </li>
155
+ * <li>
156
+ * <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p>
157
+ * </li>
158
+ * <li>
159
+ * <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
160
+ * </li>
161
+ * </ul>
162
+ */
163
+ Period: number | undefined;
164
+ /**
165
+ * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic.</p>
166
+ */
167
+ Stat: string | undefined;
168
+ /**
169
+ * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
170
+ * <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
171
+ * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
172
+ * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
173
+ */
174
+ Unit?: StandardUnit | string;
175
+ }
176
+ export declare namespace MetricStat {
177
+ /**
178
+ * @internal
179
+ */
180
+ const filterSensitiveLog: (obj: MetricStat) => any;
181
+ }
182
+ /**
183
+ * <p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported
184
+ * use of this structure is different for those two operations.</p>
185
+ * <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving
186
+ * a batch set of data for one metric, or is performing a math expression on metric data. A
187
+ * single <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>
188
+ * structures.</p>
189
+ * <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a
190
+ * metric math expression. Each <code>MetricDataQuery</code> in the array specifies either
191
+ * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
192
+ * single <code>PutMetricAlarm</code> call can include up to 20
193
+ * <code>MetricDataQuery</code> structures in the array. The 20 structures can include
194
+ * as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a
195
+ * metric, and as many as 10 structures that contain the <code>Expression</code> parameter
196
+ * to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code>
197
+ * as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p>
198
+ *
199
+ * <p>Any expression used in a <code>PutMetricAlarm</code>
200
+ * operation must return a single time series. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
201
+ * Guide</i>.</p>
202
+ *
203
+ * <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>
204
+ * operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>
205
+ */
206
+ export interface MetricDataQuery {
207
+ /**
208
+ * <p>A short name used to tie this object to the results in the response. This name must be
209
+ * unique within a single call to <code>GetMetricData</code>. If you are performing math
210
+ * expressions on this set of data, this name represents that data and can serve as a
211
+ * variable in the mathematical expression. The valid characters are letters, numbers, and
212
+ * underscore. The first character must be a lowercase letter.</p>
213
+ */
214
+ Id: string | undefined;
215
+ /**
216
+ * <p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric
217
+ * and not performing a math expression on returned data.</p>
218
+ * <p>Within one MetricDataQuery object, you must specify either
219
+ * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
220
+ */
221
+ MetricStat?: MetricStat;
222
+ /**
223
+ * <p>The math expression to be performed on the returned data, if this object is performing a math expression. This expression
224
+ * can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other
225
+ * expressions to use the result of those expressions. For more information about metric math expressions, see
226
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the
227
+ * <i>Amazon CloudWatch User Guide</i>.</p>
228
+ * <p>Within each MetricDataQuery object, you must specify either
229
+ * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
230
+ */
231
+ Expression?: string;
232
+ /**
233
+ * <p>A human-readable label for this metric or expression. This is especially useful
234
+ * if this is an expression, so that you know
235
+ * what the value represents. If the metric or expression is shown in a
236
+ * CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch
237
+ * generates a default.</p>
238
+ * <p>You can put dynamic expressions into a label, so that it is more descriptive.
239
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
240
+ */
241
+ Label?: string;
242
+ /**
243
+ * <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
244
+ * timestamps and raw data values of this metric. If you are performing this call just to
245
+ * do math expressions and do not also need the raw data returned, you can specify
246
+ * <code>False</code>. If you omit this, the default of <code>True</code> is
247
+ * used.</p>
248
+ * <p>When used in <code>PutMetricAlarm</code>, specify <code>True</code> for the one expression result to use as the alarm. For all
249
+ * other metrics and expressions in the same <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as False.</p>
250
+ */
251
+ ReturnData?: boolean;
252
+ /**
253
+ * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
254
+ * period can be as short as one minute (60 seconds) and must be a multiple of 60.
255
+ * For high-resolution metrics that are collected at intervals of less than one minute,
256
+ * the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics
257
+ * stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p>
258
+ */
259
+ Period?: number;
260
+ /**
261
+ * <p>The ID of the account where the metrics are located, if this is a cross-account alarm.</p>
262
+ * <p>Use this field only for <code>PutMetricAlarm</code> operations. It is not used in
263
+ * <code>GetMetricData</code> operations.</p>
264
+ */
265
+ AccountId?: string;
266
+ }
267
+ export declare namespace MetricDataQuery {
268
+ /**
269
+ * @internal
270
+ */
271
+ const filterSensitiveLog: (obj: MetricDataQuery) => any;
272
+ }
273
+ /**
274
+ * <p>Indicates the CloudWatch math expression that provides the time series the anomaly detector
275
+ * uses as input.
276
+ * The designated math expression must return a single time series.</p>
277
+ */
278
+ export interface MetricMathAnomalyDetector {
279
+ /**
280
+ * <p>An array of metric data query structures
281
+ * that enables you to create an anomaly detector
282
+ * based on the result of a metric math expression.
283
+ * Each item in <code>MetricDataQueries</code> gets a metric or performs a math expression.
284
+ * One item in <code>MetricDataQueries</code> is the expression
285
+ * that provides the time series
286
+ * that the anomaly detector uses as input.
287
+ * Designate the expression by setting <code>ReturnData</code> to <code>True</code>
288
+ * for this object in the array.
289
+ * For all other expressions and metrics, set <code>ReturnData</code> to <code>False</code>.
290
+ * The designated expression must return
291
+ * a single time series.</p>
292
+ */
293
+ MetricDataQueries?: MetricDataQuery[];
294
+ }
295
+ export declare namespace MetricMathAnomalyDetector {
296
+ /**
297
+ * @internal
298
+ */
299
+ const filterSensitiveLog: (obj: MetricMathAnomalyDetector) => any;
300
+ }
301
+ /**
302
+ * <p>Designates the CloudWatch metric and statistic that provides the time series the anomaly detector
303
+ * uses as input.</p>
304
+ */
305
+ export interface SingleMetricAnomalyDetector {
306
+ /**
307
+ * <p>The namespace of the metric to create the anomaly detection model for.</p>
308
+ */
309
+ Namespace?: string;
310
+ /**
311
+ * <p>The name of the metric to create the anomaly detection model for.</p>
312
+ */
313
+ MetricName?: string;
314
+ /**
315
+ * <p>The metric dimensions to create the anomaly detection model for.</p>
316
+ */
317
+ Dimensions?: Dimension[];
318
+ /**
319
+ * <p>The statistic to use for the metric and anomaly detection model.</p>
320
+ */
321
+ Stat?: string;
322
+ }
323
+ export declare namespace SingleMetricAnomalyDetector {
324
+ /**
325
+ * @internal
326
+ */
327
+ const filterSensitiveLog: (obj: SingleMetricAnomalyDetector) => any;
328
+ }
112
329
  export declare type AnomalyDetectorStateValue = "PENDING_TRAINING" | "TRAINED" | "TRAINED_INSUFFICIENT_DATA";
113
330
  /**
114
- * <p>An anomaly detection model associated with a particular CloudWatch metric and statistic. You
115
- * can use the model to display a band of expected normal values when the metric is
116
- * graphed.</p>
331
+ * <p>An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression.
332
+ * You can use the model to display a band of expected, normal values
333
+ * when the metric is graphed.</p>
117
334
  */
118
335
  export interface AnomalyDetector {
119
336
  /**
337
+ * @deprecated
338
+ *
120
339
  * <p>The namespace of the metric associated with the anomaly detection model.</p>
121
340
  */
122
341
  Namespace?: string;
123
342
  /**
343
+ * @deprecated
344
+ *
124
345
  * <p>The name of the metric associated with the anomaly detection model.</p>
125
346
  */
126
347
  MetricName?: string;
127
348
  /**
349
+ * @deprecated
350
+ *
128
351
  * <p>The metric dimensions associated with the anomaly detection model.</p>
129
352
  */
130
353
  Dimensions?: Dimension[];
131
354
  /**
355
+ * @deprecated
356
+ *
132
357
  * <p>The statistic associated with the anomaly detection model.</p>
133
358
  */
134
359
  Stat?: string;
@@ -144,6 +369,14 @@ export interface AnomalyDetector {
144
369
  * </p>
145
370
  */
146
371
  StateValue?: AnomalyDetectorStateValue | string;
372
+ /**
373
+ * <p>The CloudWatch metric and statistic for this anomaly detector.</p>
374
+ */
375
+ SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
376
+ /**
377
+ * <p>The CloudWatch metric math expression for this anomaly detector.</p>
378
+ */
379
+ MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
147
380
  }
148
381
  export declare namespace AnomalyDetector {
149
382
  /**
@@ -151,6 +384,10 @@ export declare namespace AnomalyDetector {
151
384
  */
152
385
  const filterSensitiveLog: (obj: AnomalyDetector) => any;
153
386
  }
387
+ export declare enum AnomalyDetectorType {
388
+ METRIC_MATH = "METRIC_MATH",
389
+ SINGLE_METRIC = "SINGLE_METRIC"
390
+ }
154
391
  /**
155
392
  * <p>This array is empty if the API operation was successful for all the rules specified in the request. If the operation could
156
393
  * not process one of the rules, the following data is returned for each of those rules.</p>
@@ -334,7 +571,6 @@ export declare namespace DashboardNotFoundError {
334
571
  */
335
572
  const filterSensitiveLog: (obj: DashboardNotFoundError) => any;
336
573
  }
337
- export declare type StandardUnit = "Bits" | "Bits/Second" | "Bytes" | "Bytes/Second" | "Count" | "Count/Second" | "Gigabits" | "Gigabits/Second" | "Gigabytes" | "Gigabytes/Second" | "Kilobits" | "Kilobits/Second" | "Kilobytes" | "Kilobytes/Second" | "Megabits" | "Megabits/Second" | "Megabytes" | "Megabytes/Second" | "Microseconds" | "Milliseconds" | "None" | "Percent" | "Seconds" | "Terabits" | "Terabits/Second" | "Terabytes" | "Terabytes/Second";
338
574
  /**
339
575
  * <p>Encapsulates the statistical data that CloudWatch computes from metric data.</p>
340
576
  */
@@ -412,21 +648,98 @@ export declare namespace ResourceNotFound {
412
648
  }
413
649
  export interface DeleteAnomalyDetectorInput {
414
650
  /**
651
+ * @deprecated
652
+ *
415
653
  * <p>The namespace associated with the anomaly detection model to delete.</p>
416
654
  */
417
- Namespace: string | undefined;
655
+ Namespace?: string;
418
656
  /**
657
+ * @deprecated
658
+ *
419
659
  * <p>The metric name associated with the anomaly detection model to delete.</p>
420
660
  */
421
- MetricName: string | undefined;
661
+ MetricName?: string;
422
662
  /**
663
+ * @deprecated
664
+ *
423
665
  * <p>The metric dimensions associated with the anomaly detection model to delete.</p>
424
666
  */
425
667
  Dimensions?: Dimension[];
426
668
  /**
669
+ * @deprecated
670
+ *
427
671
  * <p>The statistic associated with the anomaly detection model to delete.</p>
428
672
  */
429
- Stat: string | undefined;
673
+ Stat?: string;
674
+ /**
675
+ * <p>A single metric anomaly detector to be deleted.</p>
676
+ * <p>When using <code>SingleMetricAnomalyDetector</code>,
677
+ * you cannot include the following parameters in the same operation:</p>
678
+ *
679
+ * <ul>
680
+ * <li>
681
+ * <p>
682
+ * <code>Dimensions</code>,</p>
683
+ * </li>
684
+ * <li>
685
+ * <p>
686
+ * <code>MetricName</code>
687
+ * </p>
688
+ * </li>
689
+ * <li>
690
+ * <p>
691
+ * <code>Namespace</code>
692
+ * </p>
693
+ * </li>
694
+ * <li>
695
+ * <p>
696
+ * <code>Stat</code>
697
+ * </p>
698
+ * </li>
699
+ * <li>
700
+ * <p>the <code>MetricMathAnomalyDetector</code> parameters of <code>DeleteAnomalyDetectorInput</code>
701
+ * </p>
702
+ * </li>
703
+ * </ul>
704
+ *
705
+ * <p>Instead, specify the single metric anomaly detector attributes
706
+ * as part of the <code>SingleMetricAnomalyDetector</code> property.</p>
707
+ */
708
+ SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
709
+ /**
710
+ * <p>The metric math anomaly detector to be deleted.</p>
711
+ * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following parameters in the same operation:</p>
712
+ *
713
+ * <ul>
714
+ * <li>
715
+ * <p>
716
+ * <code>Dimensions</code>,</p>
717
+ * </li>
718
+ * <li>
719
+ * <p>
720
+ * <code>MetricName</code>
721
+ * </p>
722
+ * </li>
723
+ * <li>
724
+ * <p>
725
+ * <code>Namespace</code>
726
+ * </p>
727
+ * </li>
728
+ * <li>
729
+ * <p>
730
+ * <code>Stat</code>
731
+ * </p>
732
+ * </li>
733
+ * <li>
734
+ * <p>the <code>SingleMetricAnomalyDetector</code> parameters of <code>DeleteAnomalyDetectorInput</code>
735
+ * </p>
736
+ * </li>
737
+ * </ul>
738
+ *
739
+ * <p>Instead, specify the metric math anomaly detector attributes as part of the
740
+ * <code>MetricMathAnomalyDetector</code> property.</p>
741
+ */
742
+ MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
430
743
  }
431
744
  export declare namespace DeleteAnomalyDetectorInput {
432
745
  /**
@@ -459,6 +772,23 @@ export declare namespace InternalServiceFault {
459
772
  */
460
773
  const filterSensitiveLog: (obj: InternalServiceFault) => any;
461
774
  }
775
+ /**
776
+ * <p>Parameters were used together that cannot be used together.</p>
777
+ */
778
+ export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
779
+ name: "InvalidParameterCombinationException";
780
+ $fault: "client";
781
+ /**
782
+ * <p></p>
783
+ */
784
+ message?: string;
785
+ }
786
+ export declare namespace InvalidParameterCombinationException {
787
+ /**
788
+ * @internal
789
+ */
790
+ const filterSensitiveLog: (obj: InvalidParameterCombinationException) => any;
791
+ }
462
792
  /**
463
793
  * <p>The value of an input parameter is bad or out-of-range.</p>
464
794
  */
@@ -733,166 +1063,6 @@ export declare namespace DescribeAlarmsInput {
733
1063
  */
734
1064
  const filterSensitiveLog: (obj: DescribeAlarmsInput) => any;
735
1065
  }
736
- /**
737
- * <p>Represents a specific metric.</p>
738
- */
739
- export interface Metric {
740
- /**
741
- * <p>The namespace of the metric.</p>
742
- */
743
- Namespace?: string;
744
- /**
745
- * <p>The name of the metric. This is a required field.</p>
746
- */
747
- MetricName?: string;
748
- /**
749
- * <p>The dimensions for the metric.</p>
750
- */
751
- Dimensions?: Dimension[];
752
- }
753
- export declare namespace Metric {
754
- /**
755
- * @internal
756
- */
757
- const filterSensitiveLog: (obj: Metric) => any;
758
- }
759
- /**
760
- * <p>This structure defines the metric to be returned, along with the statistics, period, and units.</p>
761
- */
762
- export interface MetricStat {
763
- /**
764
- * <p>The metric to return, including the metric name, namespace, and dimensions.</p>
765
- */
766
- Metric: Metric | undefined;
767
- /**
768
- * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
769
- * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
770
- * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
771
- * are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
772
- * <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
773
- * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p>
774
- * <ul>
775
- * <li>
776
- * <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p>
777
- * </li>
778
- * <li>
779
- * <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p>
780
- * </li>
781
- * <li>
782
- * <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
783
- * </li>
784
- * </ul>
785
- */
786
- Period: number | undefined;
787
- /**
788
- * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic.</p>
789
- */
790
- Stat: string | undefined;
791
- /**
792
- * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
793
- * <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
794
- * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
795
- * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
796
- */
797
- Unit?: StandardUnit | string;
798
- }
799
- export declare namespace MetricStat {
800
- /**
801
- * @internal
802
- */
803
- const filterSensitiveLog: (obj: MetricStat) => any;
804
- }
805
- /**
806
- * <p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported
807
- * use of this structure is different for those two operations.</p>
808
- * <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving
809
- * a batch set of data for one metric, or is performing a math expression on metric data. A
810
- * single <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>
811
- * structures.</p>
812
- * <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a
813
- * metric math expression. Each <code>MetricDataQuery</code> in the array specifies either
814
- * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
815
- * single <code>PutMetricAlarm</code> call can include up to 20
816
- * <code>MetricDataQuery</code> structures in the array. The 20 structures can include
817
- * as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a
818
- * metric, and as many as 10 structures that contain the <code>Expression</code> parameter
819
- * to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code>
820
- * as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p>
821
- *
822
- * <p>Any expression used in a <code>PutMetricAlarm</code>
823
- * operation must return a single time series. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
824
- * Guide</i>.</p>
825
- *
826
- * <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>
827
- * operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>
828
- */
829
- export interface MetricDataQuery {
830
- /**
831
- * <p>A short name used to tie this object to the results in the response. This name must be
832
- * unique within a single call to <code>GetMetricData</code>. If you are performing math
833
- * expressions on this set of data, this name represents that data and can serve as a
834
- * variable in the mathematical expression. The valid characters are letters, numbers, and
835
- * underscore. The first character must be a lowercase letter.</p>
836
- */
837
- Id: string | undefined;
838
- /**
839
- * <p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric
840
- * and not performing a math expression on returned data.</p>
841
- * <p>Within one MetricDataQuery object, you must specify either
842
- * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
843
- */
844
- MetricStat?: MetricStat;
845
- /**
846
- * <p>The math expression to be performed on the returned data, if this object is performing a math expression. This expression
847
- * can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other
848
- * expressions to use the result of those expressions. For more information about metric math expressions, see
849
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the
850
- * <i>Amazon CloudWatch User Guide</i>.</p>
851
- * <p>Within each MetricDataQuery object, you must specify either
852
- * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
853
- */
854
- Expression?: string;
855
- /**
856
- * <p>A human-readable label for this metric or expression. This is especially useful
857
- * if this is an expression, so that you know
858
- * what the value represents. If the metric or expression is shown in a
859
- * CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch
860
- * generates a default.</p>
861
- * <p>You can put dynamic expressions into a label, so that it is more descriptive.
862
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
863
- */
864
- Label?: string;
865
- /**
866
- * <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
867
- * timestamps and raw data values of this metric. If you are performing this call just to
868
- * do math expressions and do not also need the raw data returned, you can specify
869
- * <code>False</code>. If you omit this, the default of <code>True</code> is
870
- * used.</p>
871
- * <p>When used in <code>PutMetricAlarm</code>, specify <code>True</code> for the one expression result to use as the alarm. For all
872
- * other metrics and expressions in the same <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as False.</p>
873
- */
874
- ReturnData?: boolean;
875
- /**
876
- * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
877
- * period can be as short as one minute (60 seconds) and must be a multiple of 60.
878
- * For high-resolution metrics that are collected at intervals of less than one minute,
879
- * the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics
880
- * stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p>
881
- */
882
- Period?: number;
883
- /**
884
- * <p>The ID of the account where the metrics are located, if this is a cross-account alarm.</p>
885
- * <p>Use this field only for <code>PutMetricAlarm</code> operations. It is not used in
886
- * <code>GetMetricData</code> operations.</p>
887
- */
888
- AccountId?: string;
889
- }
890
- export declare namespace MetricDataQuery {
891
- /**
892
- * @internal
893
- */
894
- const filterSensitiveLog: (obj: MetricDataQuery) => any;
895
- }
896
1066
  export declare type Statistic = "Average" | "Maximum" | "Minimum" | "SampleCount" | "Sum";
897
1067
  /**
898
1068
  * <p>The details about a metric alarm.</p>
@@ -1131,6 +1301,11 @@ export interface DescribeAnomalyDetectorsInput {
1131
1301
  * and have anomaly detection models associated, they're all returned.</p>
1132
1302
  */
1133
1303
  Dimensions?: Dimension[];
1304
+ /**
1305
+ * <p>The anomaly detector types to request when using <code>DescribeAnomalyDetectorsInput</code>.
1306
+ * If empty, defaults to <code>SINGLE_METRIC</code>.</p>
1307
+ */
1308
+ AnomalyDetectorTypes?: (AnomalyDetectorType | string)[];
1134
1309
  }
1135
1310
  export declare namespace DescribeAnomalyDetectorsInput {
1136
1311
  /**
@@ -1173,7 +1348,12 @@ export declare namespace DescribeInsightRulesInput {
1173
1348
  const filterSensitiveLog: (obj: DescribeInsightRulesInput) => any;
1174
1349
  }
1175
1350
  /**
1176
- * <p>This structure contains the definition for a Contributor Insights rule.</p>
1351
+ * <p>This structure contains the definition
1352
+ * for a Contributor Insights rule.
1353
+ * For more information about this rule,
1354
+ * see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">
1355
+ * Using Constributor Insights to analyze high-cardinality data</a>
1356
+ * in the <i>Amazon CloudWatch User Guide</i>.</p>
1177
1357
  */
1178
1358
  export interface InsightRule {
1179
1359
  /**
@@ -1185,7 +1365,7 @@ export interface InsightRule {
1185
1365
  */
1186
1366
  State: string | undefined;
1187
1367
  /**
1188
- * <p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For built-in rules,
1368
+ * <p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For managed rules,
1189
1369
  * this is <code>{"Name": "ServiceLogRule", "Version": 1}</code>
1190
1370
  * </p>
1191
1371
  */
@@ -1886,23 +2066,6 @@ export declare namespace GetMetricStatisticsOutput {
1886
2066
  */
1887
2067
  const filterSensitiveLog: (obj: GetMetricStatisticsOutput) => any;
1888
2068
  }
1889
- /**
1890
- * <p>Parameters were used together that cannot be used together.</p>
1891
- */
1892
- export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
1893
- name: "InvalidParameterCombinationException";
1894
- $fault: "client";
1895
- /**
1896
- * <p></p>
1897
- */
1898
- message?: string;
1899
- }
1900
- export declare namespace InvalidParameterCombinationException {
1901
- /**
1902
- * @internal
1903
- */
1904
- const filterSensitiveLog: (obj: InvalidParameterCombinationException) => any;
1905
- }
1906
2069
  export interface GetMetricStreamInput {
1907
2070
  /**
1908
2071
  * <p>The name of the metric stream to retrieve information about.</p>
@@ -2289,21 +2452,29 @@ export declare namespace ListTagsForResourceOutput {
2289
2452
  }
2290
2453
  export interface PutAnomalyDetectorInput {
2291
2454
  /**
2455
+ * @deprecated
2456
+ *
2292
2457
  * <p>The namespace of the metric to create the anomaly detection model for.</p>
2293
2458
  */
2294
- Namespace: string | undefined;
2459
+ Namespace?: string;
2295
2460
  /**
2461
+ * @deprecated
2462
+ *
2296
2463
  * <p>The name of the metric to create the anomaly detection model for.</p>
2297
2464
  */
2298
- MetricName: string | undefined;
2465
+ MetricName?: string;
2299
2466
  /**
2467
+ * @deprecated
2468
+ *
2300
2469
  * <p>The metric dimensions to create the anomaly detection model for.</p>
2301
2470
  */
2302
2471
  Dimensions?: Dimension[];
2303
2472
  /**
2473
+ * @deprecated
2474
+ *
2304
2475
  * <p>The statistic to use for the metric and the anomaly detection model.</p>
2305
2476
  */
2306
- Stat: string | undefined;
2477
+ Stat?: string;
2307
2478
  /**
2308
2479
  * <p>The configuration specifies details about how the
2309
2480
  * anomaly detection model is to be trained, including
@@ -2313,6 +2484,78 @@ export interface PutAnomalyDetectorInput {
2313
2484
  * the metric.</p>
2314
2485
  */
2315
2486
  Configuration?: AnomalyDetectorConfiguration;
2487
+ /**
2488
+ * <p>A single metric anomaly detector to be created.</p>
2489
+ * <p>When using <code>SingleMetricAnomalyDetector</code>,
2490
+ * you cannot include the following parameters in the same operation:</p>
2491
+ *
2492
+ * <ul>
2493
+ * <li>
2494
+ * <p>
2495
+ * <code>Dimensions</code>
2496
+ * </p>
2497
+ * </li>
2498
+ * <li>
2499
+ * <p>
2500
+ * <code>MetricName</code>
2501
+ * </p>
2502
+ * </li>
2503
+ * <li>
2504
+ * <p>
2505
+ * <code>Namespace</code>
2506
+ * </p>
2507
+ * </li>
2508
+ * <li>
2509
+ * <p>
2510
+ * <code>Stat</code>
2511
+ * </p>
2512
+ * </li>
2513
+ * <li>
2514
+ * <p>the <code>MetricMatchAnomalyDetector</code> parameters of <code>PutAnomalyDetectorInput</code>
2515
+ * </p>
2516
+ * </li>
2517
+ * </ul>
2518
+ *
2519
+ * <p>Instead, specify the single metric anomaly detector attributes
2520
+ * as part of the property <code>SingleMetricAnomalyDetector</code>.</p>
2521
+ */
2522
+ SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
2523
+ /**
2524
+ * <p>The metric math anomaly detector to be created.</p>
2525
+ *
2526
+ * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following parameters in the same operation:</p>
2527
+ *
2528
+ * <ul>
2529
+ * <li>
2530
+ * <p>
2531
+ * <code>Dimensions</code>
2532
+ * </p>
2533
+ * </li>
2534
+ * <li>
2535
+ * <p>
2536
+ * <code>MetricName</code>
2537
+ * </p>
2538
+ * </li>
2539
+ * <li>
2540
+ * <p>
2541
+ * <code>Namespace</code>
2542
+ * </p>
2543
+ * </li>
2544
+ * <li>
2545
+ * <p>
2546
+ * <code>Stat</code>
2547
+ * </p>
2548
+ * </li>
2549
+ * <li>
2550
+ * <p>the <code>SingleMetricAnomalyDetector</code> parameters of <code>PutAnomalyDetectorInput</code>
2551
+ * </p>
2552
+ * </li>
2553
+ * </ul>
2554
+ *
2555
+ * <p>Instead, specify the metric math anomaly detector attributes
2556
+ * as part of the property <code>MetricMathAnomalyDetector</code>.</p>
2557
+ */
2558
+ MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
2316
2559
  }
2317
2560
  export declare namespace PutAnomalyDetectorInput {
2318
2561
  /**