@aws-sdk/client-cloudwatch 3.42.0 → 3.47.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.
@@ -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>
@@ -252,12 +489,6 @@ export interface ConcurrentModificationException extends __SmithyException, $Met
252
489
  $fault: "client";
253
490
  Message?: string;
254
491
  }
255
- export declare namespace ConcurrentModificationException {
256
- /**
257
- * @internal
258
- */
259
- const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
260
- }
261
492
  /**
262
493
  * <p>Represents a specific dashboard.</p>
263
494
  */
@@ -314,12 +545,6 @@ export interface DashboardInvalidInputError extends __SmithyException, $Metadata
314
545
  message?: string;
315
546
  dashboardValidationMessages?: DashboardValidationMessage[];
316
547
  }
317
- export declare namespace DashboardInvalidInputError {
318
- /**
319
- * @internal
320
- */
321
- const filterSensitiveLog: (obj: DashboardInvalidInputError) => any;
322
- }
323
548
  /**
324
549
  * <p>The specified dashboard does not exist.</p>
325
550
  */
@@ -328,13 +553,6 @@ export interface DashboardNotFoundError extends __SmithyException, $MetadataBear
328
553
  $fault: "client";
329
554
  message?: string;
330
555
  }
331
- export declare namespace DashboardNotFoundError {
332
- /**
333
- * @internal
334
- */
335
- const filterSensitiveLog: (obj: DashboardNotFoundError) => any;
336
- }
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
556
  /**
339
557
  * <p>Encapsulates the statistical data that CloudWatch computes from metric data.</p>
340
558
  */
@@ -404,29 +622,100 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer {
404
622
  */
405
623
  message?: string;
406
624
  }
407
- export declare namespace ResourceNotFound {
408
- /**
409
- * @internal
410
- */
411
- const filterSensitiveLog: (obj: ResourceNotFound) => any;
412
- }
413
625
  export interface DeleteAnomalyDetectorInput {
414
626
  /**
627
+ * @deprecated
628
+ *
415
629
  * <p>The namespace associated with the anomaly detection model to delete.</p>
416
630
  */
417
- Namespace: string | undefined;
631
+ Namespace?: string;
418
632
  /**
633
+ * @deprecated
634
+ *
419
635
  * <p>The metric name associated with the anomaly detection model to delete.</p>
420
636
  */
421
- MetricName: string | undefined;
637
+ MetricName?: string;
422
638
  /**
639
+ * @deprecated
640
+ *
423
641
  * <p>The metric dimensions associated with the anomaly detection model to delete.</p>
424
642
  */
425
643
  Dimensions?: Dimension[];
426
644
  /**
645
+ * @deprecated
646
+ *
427
647
  * <p>The statistic associated with the anomaly detection model to delete.</p>
428
648
  */
429
- Stat: string | undefined;
649
+ Stat?: string;
650
+ /**
651
+ * <p>A single metric anomaly detector to be deleted.</p>
652
+ * <p>When using <code>SingleMetricAnomalyDetector</code>,
653
+ * you cannot include the following parameters in the same operation:</p>
654
+ *
655
+ * <ul>
656
+ * <li>
657
+ * <p>
658
+ * <code>Dimensions</code>,</p>
659
+ * </li>
660
+ * <li>
661
+ * <p>
662
+ * <code>MetricName</code>
663
+ * </p>
664
+ * </li>
665
+ * <li>
666
+ * <p>
667
+ * <code>Namespace</code>
668
+ * </p>
669
+ * </li>
670
+ * <li>
671
+ * <p>
672
+ * <code>Stat</code>
673
+ * </p>
674
+ * </li>
675
+ * <li>
676
+ * <p>the <code>MetricMathAnomalyDetector</code> parameters of <code>DeleteAnomalyDetectorInput</code>
677
+ * </p>
678
+ * </li>
679
+ * </ul>
680
+ *
681
+ * <p>Instead, specify the single metric anomaly detector attributes
682
+ * as part of the <code>SingleMetricAnomalyDetector</code> property.</p>
683
+ */
684
+ SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
685
+ /**
686
+ * <p>The metric math anomaly detector to be deleted.</p>
687
+ * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following parameters in the same operation:</p>
688
+ *
689
+ * <ul>
690
+ * <li>
691
+ * <p>
692
+ * <code>Dimensions</code>,</p>
693
+ * </li>
694
+ * <li>
695
+ * <p>
696
+ * <code>MetricName</code>
697
+ * </p>
698
+ * </li>
699
+ * <li>
700
+ * <p>
701
+ * <code>Namespace</code>
702
+ * </p>
703
+ * </li>
704
+ * <li>
705
+ * <p>
706
+ * <code>Stat</code>
707
+ * </p>
708
+ * </li>
709
+ * <li>
710
+ * <p>the <code>SingleMetricAnomalyDetector</code> parameters of <code>DeleteAnomalyDetectorInput</code>
711
+ * </p>
712
+ * </li>
713
+ * </ul>
714
+ *
715
+ * <p>Instead, specify the metric math anomaly detector attributes as part of the
716
+ * <code>MetricMathAnomalyDetector</code> property.</p>
717
+ */
718
+ MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
430
719
  }
431
720
  export declare namespace DeleteAnomalyDetectorInput {
432
721
  /**
@@ -453,11 +742,16 @@ export interface InternalServiceFault extends __SmithyException, $MetadataBearer
453
742
  */
454
743
  Message?: string;
455
744
  }
456
- export declare namespace InternalServiceFault {
745
+ /**
746
+ * <p>Parameters were used together that cannot be used together.</p>
747
+ */
748
+ export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
749
+ name: "InvalidParameterCombinationException";
750
+ $fault: "client";
457
751
  /**
458
- * @internal
752
+ * <p></p>
459
753
  */
460
- const filterSensitiveLog: (obj: InternalServiceFault) => any;
754
+ message?: string;
461
755
  }
462
756
  /**
463
757
  * <p>The value of an input parameter is bad or out-of-range.</p>
@@ -470,12 +764,6 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta
470
764
  */
471
765
  message?: string;
472
766
  }
473
- export declare namespace InvalidParameterValueException {
474
- /**
475
- * @internal
476
- */
477
- const filterSensitiveLog: (obj: InvalidParameterValueException) => any;
478
- }
479
767
  /**
480
768
  * <p>An input parameter that is required is missing.</p>
481
769
  */
@@ -487,12 +775,6 @@ export interface MissingRequiredParameterException extends __SmithyException, $M
487
775
  */
488
776
  message?: string;
489
777
  }
490
- export declare namespace MissingRequiredParameterException {
491
- /**
492
- * @internal
493
- */
494
- const filterSensitiveLog: (obj: MissingRequiredParameterException) => any;
495
- }
496
778
  /**
497
779
  * <p>The named resource does not exist.</p>
498
780
  */
@@ -503,12 +785,6 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
503
785
  ResourceId?: string;
504
786
  Message?: string;
505
787
  }
506
- export declare namespace ResourceNotFoundException {
507
- /**
508
- * @internal
509
- */
510
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
511
- }
512
788
  export interface DeleteDashboardsInput {
513
789
  /**
514
790
  * <p>The dashboards to be deleted. This parameter is required.</p>
@@ -647,12 +923,6 @@ export interface InvalidNextToken extends __SmithyException, $MetadataBearer {
647
923
  */
648
924
  message?: string;
649
925
  }
650
- export declare namespace InvalidNextToken {
651
- /**
652
- * @internal
653
- */
654
- const filterSensitiveLog: (obj: InvalidNextToken) => any;
655
- }
656
926
  export interface DescribeAlarmsInput {
657
927
  /**
658
928
  * <p>The names of the alarms to retrieve information about.</p>
@@ -733,166 +1003,6 @@ export declare namespace DescribeAlarmsInput {
733
1003
  */
734
1004
  const filterSensitiveLog: (obj: DescribeAlarmsInput) => any;
735
1005
  }
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
1006
  export declare type Statistic = "Average" | "Maximum" | "Minimum" | "SampleCount" | "Sum";
897
1007
  /**
898
1008
  * <p>The details about a metric alarm.</p>
@@ -1131,6 +1241,11 @@ export interface DescribeAnomalyDetectorsInput {
1131
1241
  * and have anomaly detection models associated, they're all returned.</p>
1132
1242
  */
1133
1243
  Dimensions?: Dimension[];
1244
+ /**
1245
+ * <p>The anomaly detector types to request when using <code>DescribeAnomalyDetectorsInput</code>.
1246
+ * If empty, defaults to <code>SINGLE_METRIC</code>.</p>
1247
+ */
1248
+ AnomalyDetectorTypes?: (AnomalyDetectorType | string)[];
1134
1249
  }
1135
1250
  export declare namespace DescribeAnomalyDetectorsInput {
1136
1251
  /**
@@ -1173,7 +1288,12 @@ export declare namespace DescribeInsightRulesInput {
1173
1288
  const filterSensitiveLog: (obj: DescribeInsightRulesInput) => any;
1174
1289
  }
1175
1290
  /**
1176
- * <p>This structure contains the definition for a Contributor Insights rule.</p>
1291
+ * <p>This structure contains the definition
1292
+ * for a Contributor Insights rule.
1293
+ * For more information about this rule,
1294
+ * see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">
1295
+ * Using Constributor Insights to analyze high-cardinality data</a>
1296
+ * in the <i>Amazon CloudWatch User Guide</i>.</p>
1177
1297
  */
1178
1298
  export interface InsightRule {
1179
1299
  /**
@@ -1185,7 +1305,7 @@ export interface InsightRule {
1185
1305
  */
1186
1306
  State: string | undefined;
1187
1307
  /**
1188
- * <p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For built-in rules,
1308
+ * <p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For managed rules,
1189
1309
  * this is <code>{"Name": "ServiceLogRule", "Version": 1}</code>
1190
1310
  * </p>
1191
1311
  */
@@ -1319,12 +1439,6 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
1319
1439
  $fault: "client";
1320
1440
  Message?: string;
1321
1441
  }
1322
- export declare namespace LimitExceededException {
1323
- /**
1324
- * @internal
1325
- */
1326
- const filterSensitiveLog: (obj: LimitExceededException) => any;
1327
- }
1328
1442
  export interface GetDashboardInput {
1329
1443
  /**
1330
1444
  * <p>The name of the dashboard to be described.</p>
@@ -1886,23 +2000,6 @@ export declare namespace GetMetricStatisticsOutput {
1886
2000
  */
1887
2001
  const filterSensitiveLog: (obj: GetMetricStatisticsOutput) => any;
1888
2002
  }
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
2003
  export interface GetMetricStreamInput {
1907
2004
  /**
1908
2005
  * <p>The name of the metric stream to retrieve information about.</p>
@@ -2289,21 +2386,29 @@ export declare namespace ListTagsForResourceOutput {
2289
2386
  }
2290
2387
  export interface PutAnomalyDetectorInput {
2291
2388
  /**
2389
+ * @deprecated
2390
+ *
2292
2391
  * <p>The namespace of the metric to create the anomaly detection model for.</p>
2293
2392
  */
2294
- Namespace: string | undefined;
2393
+ Namespace?: string;
2295
2394
  /**
2395
+ * @deprecated
2396
+ *
2296
2397
  * <p>The name of the metric to create the anomaly detection model for.</p>
2297
2398
  */
2298
- MetricName: string | undefined;
2399
+ MetricName?: string;
2299
2400
  /**
2401
+ * @deprecated
2402
+ *
2300
2403
  * <p>The metric dimensions to create the anomaly detection model for.</p>
2301
2404
  */
2302
2405
  Dimensions?: Dimension[];
2303
2406
  /**
2407
+ * @deprecated
2408
+ *
2304
2409
  * <p>The statistic to use for the metric and the anomaly detection model.</p>
2305
2410
  */
2306
- Stat: string | undefined;
2411
+ Stat?: string;
2307
2412
  /**
2308
2413
  * <p>The configuration specifies details about how the
2309
2414
  * anomaly detection model is to be trained, including
@@ -2313,6 +2418,78 @@ export interface PutAnomalyDetectorInput {
2313
2418
  * the metric.</p>
2314
2419
  */
2315
2420
  Configuration?: AnomalyDetectorConfiguration;
2421
+ /**
2422
+ * <p>A single metric anomaly detector to be created.</p>
2423
+ * <p>When using <code>SingleMetricAnomalyDetector</code>,
2424
+ * you cannot include the following parameters in the same operation:</p>
2425
+ *
2426
+ * <ul>
2427
+ * <li>
2428
+ * <p>
2429
+ * <code>Dimensions</code>
2430
+ * </p>
2431
+ * </li>
2432
+ * <li>
2433
+ * <p>
2434
+ * <code>MetricName</code>
2435
+ * </p>
2436
+ * </li>
2437
+ * <li>
2438
+ * <p>
2439
+ * <code>Namespace</code>
2440
+ * </p>
2441
+ * </li>
2442
+ * <li>
2443
+ * <p>
2444
+ * <code>Stat</code>
2445
+ * </p>
2446
+ * </li>
2447
+ * <li>
2448
+ * <p>the <code>MetricMatchAnomalyDetector</code> parameters of <code>PutAnomalyDetectorInput</code>
2449
+ * </p>
2450
+ * </li>
2451
+ * </ul>
2452
+ *
2453
+ * <p>Instead, specify the single metric anomaly detector attributes
2454
+ * as part of the property <code>SingleMetricAnomalyDetector</code>.</p>
2455
+ */
2456
+ SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
2457
+ /**
2458
+ * <p>The metric math anomaly detector to be created.</p>
2459
+ *
2460
+ * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following parameters in the same operation:</p>
2461
+ *
2462
+ * <ul>
2463
+ * <li>
2464
+ * <p>
2465
+ * <code>Dimensions</code>
2466
+ * </p>
2467
+ * </li>
2468
+ * <li>
2469
+ * <p>
2470
+ * <code>MetricName</code>
2471
+ * </p>
2472
+ * </li>
2473
+ * <li>
2474
+ * <p>
2475
+ * <code>Namespace</code>
2476
+ * </p>
2477
+ * </li>
2478
+ * <li>
2479
+ * <p>
2480
+ * <code>Stat</code>
2481
+ * </p>
2482
+ * </li>
2483
+ * <li>
2484
+ * <p>the <code>SingleMetricAnomalyDetector</code> parameters of <code>PutAnomalyDetectorInput</code>
2485
+ * </p>
2486
+ * </li>
2487
+ * </ul>
2488
+ *
2489
+ * <p>Instead, specify the metric math anomaly detector attributes
2490
+ * as part of the property <code>MetricMathAnomalyDetector</code>.</p>
2491
+ */
2492
+ MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
2316
2493
  }
2317
2494
  export declare namespace PutAnomalyDetectorInput {
2318
2495
  /**
@@ -2339,12 +2516,6 @@ export interface LimitExceededFault extends __SmithyException, $MetadataBearer {
2339
2516
  */
2340
2517
  message?: string;
2341
2518
  }
2342
- export declare namespace LimitExceededFault {
2343
- /**
2344
- * @internal
2345
- */
2346
- const filterSensitiveLog: (obj: LimitExceededFault) => any;
2347
- }
2348
2519
  export interface PutCompositeAlarmInput {
2349
2520
  /**
2350
2521
  * <p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is
@@ -2994,12 +3165,6 @@ export interface InvalidFormatFault extends __SmithyException, $MetadataBearer {
2994
3165
  */
2995
3166
  message?: string;
2996
3167
  }
2997
- export declare namespace InvalidFormatFault {
2998
- /**
2999
- * @internal
3000
- */
3001
- const filterSensitiveLog: (obj: InvalidFormatFault) => any;
3002
- }
3003
3168
  export interface SetAlarmStateInput {
3004
3169
  /**
3005
3170
  * <p>The name of the alarm.</p>