@aws-sdk/client-cloudwatch 3.229.0 → 3.231.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 (36) hide show
  1. package/README.md +0 -2
  2. package/dist-cjs/endpoint/ruleset.js +1 -10
  3. package/dist-cjs/models/models_0.js +7 -3
  4. package/dist-cjs/protocols/Aws_query.js +8 -0
  5. package/dist-es/endpoint/ruleset.js +1 -10
  6. package/dist-es/models/models_0.js +4 -0
  7. package/dist-es/protocols/Aws_query.js +8 -0
  8. package/dist-types/CloudWatch.d.ts +112 -148
  9. package/dist-types/CloudWatchClient.d.ts +2 -4
  10. package/dist-types/commands/DeleteAlarmsCommand.d.ts +4 -4
  11. package/dist-types/commands/DeleteInsightRulesCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +2 -2
  13. package/dist-types/commands/DescribeAlarmsCommand.d.ts +1 -1
  14. package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +1 -1
  15. package/dist-types/commands/DescribeInsightRulesCommand.d.ts +1 -2
  16. package/dist-types/commands/GetDashboardCommand.d.ts +1 -1
  17. package/dist-types/commands/GetInsightRuleReportCommand.d.ts +17 -17
  18. package/dist-types/commands/GetMetricDataCommand.d.ts +9 -15
  19. package/dist-types/commands/GetMetricStatisticsCommand.d.ts +10 -15
  20. package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +7 -9
  21. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  22. package/dist-types/commands/ListMetricsCommand.d.ts +4 -6
  23. package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +1 -1
  24. package/dist-types/commands/PutCompositeAlarmCommand.d.ts +10 -12
  25. package/dist-types/commands/PutDashboardCommand.d.ts +3 -3
  26. package/dist-types/commands/PutInsightRuleCommand.d.ts +1 -1
  27. package/dist-types/commands/PutMetricAlarmCommand.d.ts +15 -27
  28. package/dist-types/commands/PutMetricDataCommand.d.ts +8 -10
  29. package/dist-types/commands/PutMetricStreamCommand.d.ts +6 -8
  30. package/dist-types/commands/SetAlarmStateCommand.d.ts +3 -3
  31. package/dist-types/commands/TagResourceCommand.d.ts +4 -4
  32. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  33. package/dist-types/models/models_0.d.ts +206 -214
  34. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  35. package/dist-types/ts3.4/models/models_0.d.ts +5 -0
  36. package/package.json +5 -5
package/dist-types/CloudWatch.d.ts CHANGED
@@ -43,15 +43,13 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
43
43
  * applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
44
44
  * metrics, which are the variables you want to measure for your resources and
45
45
  * applications.</p>
46
- *
47
- * <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
46
+ * <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
48
47
  * that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
49
48
  * instances. Then, use this data to determine whether you should launch
50
49
  * additional instances to handle increased load. You can also use this data to stop
51
50
  * under-used instances to save
52
51
  * money.</p>
53
- *
54
- * <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
52
+ * <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
55
53
  * your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
56
54
  * utilization, application performance, and operational health.</p>
57
55
  */
@@ -60,17 +58,17 @@ export declare class CloudWatch extends CloudWatchClient {
60
58
  * <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more
61
59
  * than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't
62
60
  * delete two composite alarms with one operation.</p>
63
- * <p>
61
+ * <p>
64
62
  * In the event of an error, no alarms are
65
63
  * deleted.</p>
66
- * <note>
64
+ * <note>
67
65
  * <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
68
66
  * composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle
69
67
  * because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
70
- * <p>To get out of such a situation, you must
68
+ * <p>To get out of such a situation, you must
71
69
  * break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest
72
70
  * change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
73
- * <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
71
+ * <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
74
72
  * </p>
75
73
  * </note>
76
74
  */
@@ -101,7 +99,7 @@ export declare class CloudWatch extends CloudWatchClient {
101
99
  deleteDashboards(args: DeleteDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardsCommandOutput) => void): void;
102
100
  /**
103
101
  * <p>Permanently deletes the specified Contributor Insights rules.</p>
104
- * <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
102
+ * <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
105
103
  * the rule was created might
106
104
  * not be available.</p>
107
105
  */
@@ -117,8 +115,8 @@ export declare class CloudWatch extends CloudWatchClient {
117
115
  /**
118
116
  * <p>Retrieves the history for the specified alarm. You can filter the results by date range or item type.
119
117
  * If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p>
120
- * <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
121
- * <p>To use this operation and return information about a composite alarm, you must be signed on with
118
+ * <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
119
+ * <p>To use this operation and return information about a composite alarm, you must be signed on with
122
120
  * the <code>cloudwatch:DescribeAlarmHistory</code> permission that is scoped to <code>*</code>. You can't return information
123
121
  * about composite alarms if your <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
124
122
  */
@@ -128,7 +126,7 @@ export declare class CloudWatch extends CloudWatchClient {
128
126
  /**
129
127
  * <p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm
130
128
  * name, the alarm state, or a prefix for any action.</p>
131
- * <p>To use this operation and return information about composite alarms, you must be signed on with
129
+ * <p>To use this operation and return information about composite alarms, you must be signed on with
132
130
  * the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to <code>*</code>. You can't return information
133
131
  * about composite alarms if your <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
134
132
  */
@@ -138,7 +136,7 @@ export declare class CloudWatch extends CloudWatchClient {
138
136
  /**
139
137
  * <p>Retrieves the alarms for the specified metric. To
140
138
  * filter the results, specify a statistic, period, or unit.</p>
141
- * <p>This operation retrieves only standard alarms that are based on
139
+ * <p>This operation retrieves only standard alarms that are based on
142
140
  * the specified metric. It does not return alarms based on math expressions that
143
141
  * use the specified metric, or composite alarms that use the specified metric.</p>
144
142
  */
@@ -159,8 +157,7 @@ export declare class CloudWatch extends CloudWatchClient {
159
157
  describeAnomalyDetectors(args: DescribeAnomalyDetectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAnomalyDetectorsCommandOutput) => void): void;
160
158
  /**
161
159
  * <p>Returns a list of all the Contributor Insights rules in your account.</p>
162
- *
163
- * <p>For more information about Contributor Insights, see
160
+ * <p>For more information about Contributor Insights, see
164
161
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
165
162
  */
166
163
  describeInsightRules(args: DescribeInsightRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInsightRulesCommandOutput>;
@@ -194,7 +191,7 @@ export declare class CloudWatch extends CloudWatchClient {
194
191
  enableInsightRules(args: EnableInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableInsightRulesCommandOutput) => void): void;
195
192
  /**
196
193
  * <p>Displays the details of the dashboard that you specify.</p>
197
- * <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned
194
+ * <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned
198
195
  * within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create
199
196
  * the copy.</p>
200
197
  */
@@ -204,40 +201,40 @@ export declare class CloudWatch extends CloudWatchClient {
204
201
  /**
205
202
  * <p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of
206
203
  * contributors to the log group.</p>
207
- * <p>You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:</p>
208
- * <ul>
204
+ * <p>You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:</p>
205
+ * <ul>
209
206
  * <li>
210
- * <p>
207
+ * <p>
211
208
  * <code>UniqueContributors</code> -- the number of unique contributors for each data point.</p>
212
- * </li>
209
+ * </li>
213
210
  * <li>
214
- * <p>
211
+ * <p>
215
212
  * <code>MaxContributorValue</code> -- the value of the top contributor for each data point. The identity of the
216
213
  * contributor might change for each data point in the graph.</p>
217
- * <p>If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
214
+ * <p>If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
218
215
  * most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified
219
216
  * by the rule's <code>Value</code>, during that period.</p>
220
- * </li>
217
+ * </li>
221
218
  * <li>
222
- * <p>
219
+ * <p>
223
220
  * <code>SampleCount</code> -- the number of data points matched by the rule.</p>
224
- * </li>
221
+ * </li>
225
222
  * <li>
226
- * <p>
223
+ * <p>
227
224
  * <code>Sum</code> -- the sum of the values from all contributors during the time period represented by that data point.</p>
228
- * </li>
225
+ * </li>
229
226
  * <li>
230
- * <p>
227
+ * <p>
231
228
  * <code>Minimum</code> -- the minimum value from a single observation during the time period represented by that data point.</p>
232
- * </li>
229
+ * </li>
233
230
  * <li>
234
- * <p>
231
+ * <p>
235
232
  * <code>Maximum</code> -- the maximum value from a single observation during the time period represented by that data point.</p>
236
- * </li>
233
+ * </li>
237
234
  * <li>
238
- * <p>
235
+ * <p>
239
236
  * <code>Average</code> -- the average value from all contributors during the time period represented by that data point.</p>
240
- * </li>
237
+ * </li>
241
238
  * </ul>
242
239
  */
243
240
  getInsightRuleReport(args: GetInsightRuleReportCommandInput, options?: __HttpHandlerOptions): Promise<GetInsightRuleReportCommandOutput>;
@@ -246,26 +243,22 @@ export declare class CloudWatch extends CloudWatchClient {
246
243
  /**
247
244
  * <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation
248
245
  * can also include a CloudWatch Metrics Insights query, and one or more metric math functions.</p>
249
- * <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
246
+ * <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
250
247
  * metrics in a single request, with a total of as many as 100,800 data points. You can also
251
248
  * optionally perform metric math expressions on the values of the returned statistics, to create
252
249
  * new time series that represent new insights into your data. For example, using Lambda
253
250
  * metrics, you could divide the Errors metric by the Invocations metric to get an error
254
251
  * rate time series. For more information about metric math expressions, 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
255
252
  * Guide</i>.</p>
256
- *
257
- *
258
- * <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
253
+ * <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
259
254
  * query. But the same <code>GetMetricData</code> operation can also retrieve other metrics. Metrics Insights queries
260
255
  * can query only the most recent three hours of metric data. For more information about Metrics Insights,
261
256
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html">Query your metrics with CloudWatch Metrics Insights</a>.</p>
262
- *
263
- * <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
257
+ * <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
264
258
  * calls to <code>GetMetricStatistics</code>. For more information about pricing, see
265
259
  * <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
266
- *
267
- * <p>Amazon CloudWatch retains metric data as follows:</p>
268
- * <ul>
260
+ * <p>Amazon CloudWatch retains metric data as follows:</p>
261
+ * <ul>
269
262
  * <li>
270
263
  * <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
271
264
  * metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
@@ -280,19 +273,17 @@ export declare class CloudWatch extends CloudWatchClient {
280
273
  * <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
281
274
  * </li>
282
275
  * </ul>
283
- * <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
276
+ * <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
284
277
  * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
285
278
  * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
286
279
  * a resolution of 1 hour.</p>
287
- *
288
- * <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
280
+ * <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
289
281
  * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
290
282
  * 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>
291
- *
292
- * <p>
283
+ * <p>
293
284
  * <b>Using Metrics Insights queries with metric math</b>
294
285
  * </p>
295
- * <p>You can't mix a Metric Insights query and metric math syntax in the same expression, but
286
+ * <p>You can't mix a Metric Insights query and metric math syntax in the same expression, but
296
287
  * you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights
297
288
  * query without a <b>GROUP BY</b> clause returns a single time-series (TS),
298
289
  * and can be used as input for a metric math expression that expects a single time series. A Metrics Insights
@@ -304,24 +295,20 @@ export declare class CloudWatch extends CloudWatchClient {
304
295
  getMetricData(args: GetMetricDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMetricDataCommandOutput) => void): void;
305
296
  /**
306
297
  * <p>Gets statistics for the specified metric.</p>
307
- *
308
- *
309
- *
310
- * <p>The maximum number of data points returned from a single call is 1,440. If
298
+ * <p>The maximum number of data points returned from a single call is 1,440. If
311
299
  * you request more than 1,440 data points, CloudWatch returns an error.
312
300
  * To reduce the number of data points, you can narrow the specified time range and make
313
301
  * multiple requests across adjacent time ranges, or you can increase the specified period.
314
302
  * Data points are not returned in chronological order.</p>
315
- *
316
- * <p>CloudWatch aggregates data points based on the length of the period
303
+ * <p>CloudWatch aggregates data points based on the length of the period
317
304
  * that you specify. For example, if you request statistics with a one-hour period,
318
305
  * CloudWatch aggregates all data points with time stamps that fall within each
319
306
  * one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than
320
307
  * the number of data points returned.</p>
321
- * <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
308
+ * <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
322
309
  * data using a statistic set instead, you can only retrieve
323
310
  * percentile statistics for this data if one of the following conditions is true:</p>
324
- * <ul>
311
+ * <ul>
325
312
  * <li>
326
313
  * <p>The SampleCount value of the statistic set is 1.</p>
327
314
  * </li>
@@ -329,9 +316,9 @@ export declare class CloudWatch extends CloudWatchClient {
329
316
  * <p>The Min and the Max values of the statistic set are equal.</p>
330
317
  * </li>
331
318
  * </ul>
332
- * <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
333
- * <p>Amazon CloudWatch retains metric data as follows:</p>
334
- * <ul>
319
+ * <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
320
+ * <p>Amazon CloudWatch retains metric data as follows:</p>
321
+ * <ul>
335
322
  * <li>
336
323
  * <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
337
324
  * metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
@@ -346,13 +333,12 @@ export declare class CloudWatch extends CloudWatchClient {
346
333
  * <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
347
334
  * </li>
348
335
  * </ul>
349
- * <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
336
+ * <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
350
337
  * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
351
338
  * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
352
339
  * a resolution of 1 hour.</p>
353
- * <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
354
- *
355
- * <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
340
+ * <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
341
+ * <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
356
342
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch Metrics and Dimensions Reference</a> in the
357
343
  * <i>Amazon CloudWatch User Guide</i>.</p>
358
344
  */
@@ -371,18 +357,16 @@ export declare class CloudWatch extends CloudWatchClient {
371
357
  * image into your services and products, such as wiki pages, reports, and documents.
372
358
  * You could also retrieve images regularly, such as every minute, and create your own
373
359
  * custom live dashboard.</p>
374
- *
375
- * <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
360
+ * <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
376
361
  * and horizontal and vertical annotations.</p>
377
- *
378
- * <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p>
379
- * <ul>
362
+ * <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p>
363
+ * <ul>
380
364
  * <li>
381
- * <p>As many as 100 metrics in the graph.</p>
382
- * </li>
365
+ * <p>As many as 100 metrics in the graph.</p>
366
+ * </li>
383
367
  * <li>
384
- * <p>Up to 100 KB uncompressed payload.</p>
385
- * </li>
368
+ * <p>Up to 100 KB uncompressed payload.</p>
369
+ * </li>
386
370
  * </ul>
387
371
  */
388
372
  getMetricWidgetImage(args: GetMetricWidgetImageCommandInput, options?: __HttpHandlerOptions): Promise<GetMetricWidgetImageCommandOutput>;
@@ -393,7 +377,7 @@ export declare class CloudWatch extends CloudWatchClient {
393
377
  * those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are
394
378
  * listed.
395
379
  * </p>
396
- * <p>
380
+ * <p>
397
381
  * <code>ListDashboards</code> returns up to 1000 results on one page. If there
398
382
  * are more than 1000 dashboards, you can call <code>ListDashboards</code> again and
399
383
  * include the value you received for <code>NextToken</code> in the first call, to receive
@@ -416,16 +400,14 @@ export declare class CloudWatch extends CloudWatchClient {
416
400
  listManagedInsightRules(args: ListManagedInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedInsightRulesCommandOutput) => void): void;
417
401
  /**
418
402
  * <p>List the specified metrics. You can use the returned metrics with <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> to get statistical data.</p>
419
- * <p>Up to 500 results are returned for any one call. To retrieve additional results,
403
+ * <p>Up to 500 results are returned for any one call. To retrieve additional results,
420
404
  * use the returned token with subsequent calls.</p>
421
- * <p>After you create a metric, allow up to 15 minutes for the metric to appear. To see metric
405
+ * <p>After you create a metric, allow up to 15 minutes for the metric to appear. To see metric
422
406
  * statistics sooner, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
423
- *
424
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
407
+ * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
425
408
  * view metrics from the linked source accounts. For more information, see
426
409
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
427
- *
428
- * <p>
410
+ * <p>
429
411
  * <code>ListMetrics</code> doesn't return information about metrics if those metrics haven't
430
412
  * reported data in the past two weeks. To retrieve those metrics, use
431
413
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
@@ -450,7 +432,7 @@ export declare class CloudWatch extends CloudWatchClient {
450
432
  /**
451
433
  * <p>Creates an anomaly detection model for a CloudWatch metric. You can use the model
452
434
  * to display a band of expected normal values when the metric is graphed.</p>
453
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html">CloudWatch Anomaly Detection</a>.</p>
435
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html">CloudWatch Anomaly Detection</a>.</p>
454
436
  */
455
437
  putAnomalyDetector(args: PutAnomalyDetectorCommandInput, options?: __HttpHandlerOptions): Promise<PutAnomalyDetectorCommandOutput>;
456
438
  putAnomalyDetector(args: PutAnomalyDetectorCommandInput, cb: (err: any, data?: PutAnomalyDetectorCommandOutput) => void): void;
@@ -460,42 +442,40 @@ export declare class CloudWatch extends CloudWatchClient {
460
442
  * alarm, you specify a rule expression for the alarm that takes into account the alarm
461
443
  * states of other alarms that you have created. The composite alarm goes into ALARM state
462
444
  * only if all conditions of the rule are met.</p>
463
- * <p>The alarms specified in a composite alarm's rule expression can include metric alarms
445
+ * <p>The alarms specified in a composite alarm's rule expression can include metric alarms
464
446
  * and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms.
465
447
  * Any single alarm can be included in the rule expressions of as many as 150 composite alarms.</p>
466
- * <p>Using composite alarms can reduce
448
+ * <p>Using composite alarms can reduce
467
449
  * alarm noise. You can create multiple metric alarms,
468
450
  * and also create a composite alarm and
469
451
  * set up alerts only
470
452
  * for the composite alarm. For example, you could create a composite
471
453
  * alarm that goes into ALARM state only when more than one of the underlying metric alarms
472
454
  * are in ALARM state.</p>
473
- * <p>Currently, the only alarm actions that can be taken by composite alarms are notifying
455
+ * <p>Currently, the only alarm actions that can be taken by composite alarms are notifying
474
456
  * SNS topics.</p>
475
- * <note>
457
+ * <note>
476
458
  * <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
477
459
  * composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle
478
460
  * because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
479
- * <p>To get out of such a situation, you must
461
+ * <p>To get out of such a situation, you must
480
462
  * break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest
481
463
  * change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
482
- * <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
464
+ * <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
483
465
  * </p>
484
466
  * </note>
485
- * <p>When this operation creates an alarm, the alarm state is immediately set to
467
+ * <p>When this operation creates an alarm, the alarm state is immediately set to
486
468
  * <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
487
469
  * appropriately. Any actions associated with the new state are then executed. For a
488
470
  * composite alarm, this initial time after creation is the only time that
489
471
  * the
490
472
  * alarm can be in <code>INSUFFICIENT_DATA</code> state.</p>
491
- * <p>When you update an existing alarm, its state is left unchanged, but the update
473
+ * <p>When you update an existing alarm, its state is left unchanged, but the update
492
474
  * completely overwrites the previous configuration of the alarm.</p>
493
- *
494
- * <p>To use this operation, you must be signed on with
475
+ * <p>To use this operation, you must be signed on with
495
476
  * the <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a
496
477
  * composite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>
497
- *
498
- * <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
478
+ * <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
499
479
  * a composite alarm that has Systems Manager OpsItem actions.</p>
500
480
  */
501
481
  putCompositeAlarm(args: PutCompositeAlarmCommandInput, options?: __HttpHandlerOptions): Promise<PutCompositeAlarmCommandOutput>;
@@ -504,14 +484,14 @@ export declare class CloudWatch extends CloudWatchClient {
504
484
  /**
505
485
  * <p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,
506
486
  * the entire contents are replaced with what you specify here.</p>
507
- * <p>All dashboards in your account are global, not region-specific.</p>
508
- * <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an
487
+ * <p>All dashboards in your account are global, not region-specific.</p>
488
+ * <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an
509
489
  * existing dashboard. To copy an existing dashboard using the console, you can load the dashboard
510
490
  * and then use the View/edit source command in the Actions menu to display the JSON block
511
491
  * for that dashboard. Another way to copy a dashboard is to
512
492
  * use <code>GetDashboard</code>, and then use the data returned
513
493
  * within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p>
514
- * <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to
494
+ * <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to
515
495
  * add a text widget at the top of the dashboard with a message that the dashboard was created by script and should
516
496
  * not be changed in the console. This message could also point console users to the location
517
497
  * of the <code>DashboardBody</code> script or the CloudFormation template used to create the
@@ -524,7 +504,7 @@ export declare class CloudWatch extends CloudWatchClient {
524
504
  * <p>Creates a Contributor Insights rule. Rules evaluate log events in a
525
505
  * CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information,
526
506
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
527
- * <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
507
+ * <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
528
508
  * the rule was created might not be available.</p>
529
509
  */
530
510
  putInsightRule(args: PutInsightRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutInsightRuleCommandOutput>;
@@ -554,50 +534,38 @@ export declare class CloudWatch extends CloudWatchClient {
554
534
  putManagedInsightRules(args: PutManagedInsightRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutManagedInsightRulesCommandOutput) => void): void;
555
535
  /**
556
536
  * <p>Creates or updates an alarm and associates it with the specified metric, metric math expression,
557
- * or anomaly detection model.</p>
558
- *
559
- *
560
- * <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
561
- * <p>When this operation creates an alarm, the alarm state is immediately set to
537
+ * anomaly detection model, or Metrics Insights query. For more information about using
538
+ * a Metrics Insights query for an alarm, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create alarms on Metrics Insights queries</a>.</p>
539
+ * <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
540
+ * <p>When this operation creates an alarm, the alarm state is immediately set to
562
541
  * <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
563
542
  * appropriately. Any actions associated with the new state are then executed.</p>
564
- * <p>When you update an existing alarm, its state is left unchanged, but the
543
+ * <p>When you update an existing alarm, its state is left unchanged, but the
565
544
  * update completely overwrites the previous configuration of the alarm.</p>
566
- *
567
- * <p>If you are an IAM user, you must have
545
+ * <p>If you are an IAM user, you must have
568
546
  * Amazon EC2 permissions for some alarm operations:</p>
569
- * <ul>
547
+ * <ul>
570
548
  * <li>
571
- * <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
572
- *
573
- * </li>
549
+ * <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
550
+ * </li>
574
551
  * <li>
575
- *
576
- * <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
552
+ * <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
577
553
  * with Systems Manager OpsItem actions.</p>
578
- * </li>
554
+ * </li>
579
555
  * </ul>
580
- *
581
- *
582
- *
583
- *
584
- *
585
- *
586
- * <p>The first time you create an alarm in the
556
+ * <p>The first time you create an alarm in the
587
557
  * Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
588
558
  * creates the necessary service-linked role for you. The service-linked roles
589
559
  * are called <code>AWSServiceRoleForCloudWatchEvents</code> and
590
560
  * <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>.
591
561
  * For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
592
- *
593
- * <p>
562
+ * <p>
594
563
  * <b>Cross-account alarms</b>
595
564
  * </p>
596
- *
597
- * <p>You can set an alarm on metrics in the current account, or in another
565
+ * <p>You can set an alarm on metrics in the current account, or in another
598
566
  * account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following
599
567
  * pre-requisites:</p>
600
- * <ul>
568
+ * <ul>
601
569
  * <li>
602
570
  * <p>The account where the metrics are located (the <i>sharing account</i>) must
603
571
  * already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not already
@@ -626,37 +594,35 @@ export declare class CloudWatch extends CloudWatchClient {
626
594
  * the data points with the specified metric. If the specified metric does not exist,
627
595
  * CloudWatch creates the metric. When CloudWatch creates a metric, it can
628
596
  * take up to fifteen minutes for the metric to appear in calls to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
629
- *
630
- * <p>You can publish either individual data points in the <code>Value</code> field, or
597
+ * <p>You can publish either individual data points in the <code>Value</code> field, or
631
598
  * arrays of values and the number of times each value occurred during the period by using the
632
599
  * <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using
633
600
  * the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric
634
601
  * with one <code>PutMetricData</code> request, and
635
602
  * supports retrieving percentile statistics on this data.</p>
636
- * <p>Each <code>PutMetricData</code> request is limited to 1 MB in size for HTTP POST requests. You can
603
+ * <p>Each <code>PutMetricData</code> request is limited to 1 MB in size for HTTP POST requests. You can
637
604
  * send a payload compressed by gzip. Each request
638
605
  * is also limited to no more than 1000 different metrics.</p>
639
- * <p>Although the <code>Value</code> parameter accepts numbers of type
606
+ * <p>Although the <code>Value</code> parameter accepts numbers of type
640
607
  * <code>Double</code>, CloudWatch rejects values that are either too small
641
608
  * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
642
609
  * -Infinity) are not supported.</p>
643
- * <p>You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension
610
+ * <p>You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension
644
611
  * consists of a Name and Value pair. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the
645
612
  * <i>Amazon CloudWatch User Guide</i>.</p>
646
- *
647
- * <p>You specify the time stamp to be associated with each data point. You can specify
613
+ * <p>You specify the time stamp to be associated with each data point. You can specify
648
614
  * time stamps that are as much as two weeks before the current date, and as much as 2 hours after
649
615
  * the current day and time.</p>
650
- * <p>Data points with time stamps from 24 hours ago or longer can take at least 48
616
+ * <p>Data points with time stamps from 24 hours ago or longer can take at least 48
651
617
  * hours to become available for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
652
618
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> from the time they
653
619
  * are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available
654
620
  * for for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
655
621
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
656
- * <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
622
+ * <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
657
623
  * data using a statistic set instead, you can only retrieve
658
624
  * percentile statistics for this data if one of the following conditions is true:</p>
659
- * <ul>
625
+ * <ul>
660
626
  * <li>
661
627
  * <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>,
662
628
  * <code>Max</code>, and <code>Sum</code> are all equal.</p>
@@ -675,14 +641,14 @@ export declare class CloudWatch extends CloudWatchClient {
675
641
  * <p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
676
642
  * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
677
643
  * solutions.</p>
678
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html">
644
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html">
679
645
  * Using Metric Streams</a>.</p>
680
- * <p>To create a metric stream, you must be signed in to an account that has the
646
+ * <p>To create a metric stream, you must be signed in to an account that has the
681
647
  * <code>iam:PassRole</code> permission and either the
682
648
  * <code>CloudWatchFullAccess</code> policy or the
683
649
  * <code>cloudwatch:PutMetricStream</code> permission.</p>
684
- * <p>When you create or update a metric stream, you choose one of the following:</p>
685
- * <ul>
650
+ * <p>When you create or update a metric stream, you choose one of the following:</p>
651
+ * <ul>
686
652
  * <li>
687
653
  * <p>Stream metrics from all metric namespaces in the account.</p>
688
654
  * </li>
@@ -695,14 +661,12 @@ export declare class CloudWatch extends CloudWatchClient {
695
661
  * <code>IncludeFilters</code>.</p>
696
662
  * </li>
697
663
  * </ul>
698
- *
699
- * <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
664
+ * <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
700
665
  * <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
701
666
  * streamed. You can use the <code>StatisticsConfigurations</code> parameter to have the
702
667
  * metric stream send additional statistics in the stream. Streaming additional statistics
703
668
  * incurs additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
704
- *
705
- * <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
669
+ * <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
706
670
  * is created in the <code>running</code> state. If you use it to update an existing stream,
707
671
  * the state of the stream is not changed.</p>
708
672
  */
@@ -715,16 +679,16 @@ export declare class CloudWatch extends CloudWatchClient {
715
679
  * the appropriate state is invoked. For example, if your alarm is configured to send an
716
680
  * Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to
717
681
  * <code>ALARM</code> sends an SNS message.</p>
718
- * <p>Metric alarms
682
+ * <p>Metric alarms
719
683
  * returns to their actual state quickly, often within seconds. Because the metric alarm state change
720
684
  * happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through
721
685
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html">DescribeAlarmHistory</a>.</p>
722
- * <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is not guaranteed to return
686
+ * <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is not guaranteed to return
723
687
  * to its actual state. It
724
688
  * returns to its actual state only once any of its children alarms change state. It is also
725
689
  * reevaluated if you update its
726
690
  * configuration.</p>
727
- * <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include
691
+ * <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include
728
692
  * information in the <code>StateReasonData</code> parameter to enable the policy to take the correct action.</p>
729
693
  */
730
694
  setAlarmState(args: SetAlarmStateCommandInput, options?: __HttpHandlerOptions): Promise<SetAlarmStateCommandOutput>;
@@ -745,15 +709,15 @@ export declare class CloudWatch extends CloudWatchClient {
745
709
  /**
746
710
  * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that
747
711
  * can be tagged are alarms and Contributor Insights rules.</p>
748
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
712
+ * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
749
713
  * permissions by granting a user
750
714
  * permission to access or change only resources with certain tag values.</p>
751
- * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
752
- * <p>You can use the <code>TagResource</code> action with an alarm that already has tags. If you specify a new tag key for the alarm,
715
+ * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
716
+ * <p>You can use the <code>TagResource</code> action with an alarm that already has tags. If you specify a new tag key for the alarm,
753
717
  * this tag is appended to the list of tags associated
754
718
  * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
755
719
  * the previous value for that tag.</p>
756
- * <p>You can associate as many as 50 tags with a CloudWatch resource.</p>
720
+ * <p>You can associate as many as 50 tags with a CloudWatch resource.</p>
757
721
  */
758
722
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
759
723
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;