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