@aws-sdk/client-cloudwatch 3.693.0 → 3.696.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.
- package/README.md +13 -13
- package/dist-cjs/index.js +110 -17
- package/dist-es/protocols/Aws_query.js +112 -16
- package/dist-types/CloudWatch.d.ts +13 -13
- package/dist-types/CloudWatchClient.d.ts +13 -13
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +18 -16
- package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +5 -10
- package/dist-types/commands/DeleteDashboardsCommand.d.ts +4 -4
- package/dist-types/commands/DeleteInsightRulesCommand.d.ts +2 -3
- package/dist-types/commands/DeleteMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +7 -5
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +6 -5
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +2 -2
- package/dist-types/commands/DisableAlarmActionsCommand.d.ts +2 -2
- package/dist-types/commands/DisableInsightRulesCommand.d.ts +2 -2
- package/dist-types/commands/EnableInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/GetDashboardCommand.d.ts +5 -4
- package/dist-types/commands/GetInsightRuleReportCommand.d.ts +23 -14
- package/dist-types/commands/GetMetricDataCommand.d.ts +50 -34
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +38 -27
- package/dist-types/commands/GetMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +9 -8
- package/dist-types/commands/ListDashboardsCommand.d.ts +9 -9
- package/dist-types/commands/ListManagedInsightRulesCommand.d.ts +3 -6
- package/dist-types/commands/ListMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +10 -11
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +8 -6
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +33 -31
- package/dist-types/commands/PutDashboardCommand.d.ts +15 -12
- package/dist-types/commands/PutInsightRuleCommand.d.ts +6 -5
- package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +9 -16
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +32 -35
- package/dist-types/commands/PutMetricDataCommand.d.ts +85 -38
- package/dist-types/commands/PutMetricStreamCommand.d.ts +22 -21
- package/dist-types/commands/SetAlarmStateCommand.d.ts +16 -16
- package/dist-types/commands/StartMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/StopMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +15 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/index.d.ts +13 -13
- package/dist-types/models/models_0.d.ts +1312 -1203
- package/dist-types/ts3.4/models/models_0.d.ts +28 -18
- package/package.json +37 -37
|
@@ -75,85 +75,87 @@ export interface AlarmHistoryItem {
|
|
|
75
75
|
HistoryData?: string | undefined;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* <p>Specifies one range of days or times to exclude from use for training an
|
|
79
|
-
*
|
|
78
|
+
* <p>Specifies one range of days or times to exclude from use for training an anomaly
|
|
79
|
+
* detection model.</p>
|
|
80
80
|
* @public
|
|
81
81
|
*/
|
|
82
82
|
export interface Range {
|
|
83
83
|
/**
|
|
84
|
-
* <p>The start time of the range to exclude. The format is
|
|
85
|
-
*
|
|
84
|
+
* <p>The start time of the range to exclude. The format is
|
|
85
|
+
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
86
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
86
87
|
* @public
|
|
87
88
|
*/
|
|
88
89
|
StartTime: Date | undefined;
|
|
89
90
|
/**
|
|
90
|
-
* <p>The end time of the range to exclude. The format is
|
|
91
|
-
*
|
|
91
|
+
* <p>The end time of the range to exclude. The format is
|
|
92
|
+
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
93
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
92
94
|
* @public
|
|
93
95
|
*/
|
|
94
96
|
EndTime: Date | undefined;
|
|
95
97
|
}
|
|
96
98
|
/**
|
|
97
|
-
* <p>The configuration specifies details about how the anomaly detection model is to be
|
|
98
|
-
*
|
|
99
|
-
*
|
|
99
|
+
* <p>The configuration specifies details about how the anomaly detection model is to be
|
|
100
|
+
* trained, including time ranges to exclude from use for training the model and the time
|
|
101
|
+
* zone to use for the metric.</p>
|
|
100
102
|
* @public
|
|
101
103
|
*/
|
|
102
104
|
export interface AnomalyDetectorConfiguration {
|
|
103
105
|
/**
|
|
104
|
-
* <p>An array of time ranges to exclude from use when the anomaly detection model is
|
|
105
|
-
*
|
|
106
|
-
*
|
|
106
|
+
* <p>An array of time ranges to exclude from use when the anomaly detection model is
|
|
107
|
+
* trained. Use this to make sure that events that could cause unusual values for the
|
|
108
|
+
* metric, such as deployments, aren't used when CloudWatch creates the model.</p>
|
|
107
109
|
* @public
|
|
108
110
|
*/
|
|
109
111
|
ExcludedTimeRanges?: Range[] | undefined;
|
|
110
112
|
/**
|
|
111
|
-
* <p>The time zone to use for the metric. This is useful to enable the model to
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* <p>To specify a time zone, use the name of the time zone as specified in the standard
|
|
115
|
-
*
|
|
113
|
+
* <p>The time zone to use for the metric. This is useful to enable the model to
|
|
114
|
+
* automatically account for daylight savings time changes if the metric is sensitive to
|
|
115
|
+
* such time changes.</p>
|
|
116
|
+
* <p>To specify a time zone, use the name of the time zone as specified in the standard
|
|
117
|
+
* tz database. For more information, see <a href="https://en.wikipedia.org/wiki/Tz_database">tz database</a>.</p>
|
|
116
118
|
* @public
|
|
117
119
|
*/
|
|
118
120
|
MetricTimezone?: string | undefined;
|
|
119
121
|
}
|
|
120
122
|
/**
|
|
121
|
-
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
123
|
+
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because
|
|
124
|
+
* dimensions are part of the unique identifier for a metric, whenever you add a unique
|
|
125
|
+
* name/value pair to one of your metrics, you are creating a new variation of that metric.
|
|
126
|
+
* For example, many Amazon EC2 metrics publish <code>InstanceId</code> as a
|
|
127
|
+
* dimension name, and the actual instance ID as the value for that dimension.</p>
|
|
128
|
+
* <p>You can assign up to 30 dimensions to a metric.</p>
|
|
127
129
|
* @public
|
|
128
130
|
*/
|
|
129
131
|
export interface Dimension {
|
|
130
132
|
/**
|
|
131
|
-
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
133
|
+
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must
|
|
134
|
+
* include at least one non-whitespace character, and cannot start with a colon
|
|
135
|
+
* (<code>:</code>). ASCII control characters are not supported as part of dimension
|
|
136
|
+
* names.</p>
|
|
135
137
|
* @public
|
|
136
138
|
*/
|
|
137
139
|
Name: string | undefined;
|
|
138
140
|
/**
|
|
139
|
-
* <p>The value of the dimension. Dimension values must contain only ASCII characters and
|
|
140
|
-
*
|
|
141
|
-
*
|
|
141
|
+
* <p>The value of the dimension. Dimension values must contain only ASCII characters and
|
|
142
|
+
* must include at least one non-whitespace character. ASCII control characters are not
|
|
143
|
+
* supported as part of dimension values.</p>
|
|
142
144
|
* @public
|
|
143
145
|
*/
|
|
144
146
|
Value: string | undefined;
|
|
145
147
|
}
|
|
146
148
|
/**
|
|
147
|
-
* <p>This object includes parameters that you can use to provide information to
|
|
148
|
-
* CloudWatch to help it build more accurate anomaly detection models.</p>
|
|
149
|
+
* <p>This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.</p>
|
|
149
150
|
* @public
|
|
150
151
|
*/
|
|
151
152
|
export interface MetricCharacteristics {
|
|
152
153
|
/**
|
|
153
|
-
* <p>Set this parameter to <code>true</code> if values for this metric consistently include
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
154
|
+
* <p>Set this parameter to <code>true</code> if values for this metric consistently include
|
|
155
|
+
* spikes that should not be considered to be anomalies. With this set to
|
|
156
|
+
* <code>true</code>, CloudWatch will expect to see spikes that occurred
|
|
157
|
+
* consistently during the model training period, and won't flag future similar spikes as
|
|
158
|
+
* anomalies.</p>
|
|
157
159
|
* @public
|
|
158
160
|
*/
|
|
159
161
|
PeriodicSpikes?: boolean | undefined;
|
|
@@ -217,7 +219,8 @@ export declare const StandardUnit: {
|
|
|
217
219
|
*/
|
|
218
220
|
export type StandardUnit = (typeof StandardUnit)[keyof typeof StandardUnit];
|
|
219
221
|
/**
|
|
220
|
-
* <p>This structure defines the metric to be returned, along with the statistics, period,
|
|
222
|
+
* <p>This structure defines the metric to be returned, along with the statistics, period,
|
|
223
|
+
* and units.</p>
|
|
221
224
|
* @public
|
|
222
225
|
*/
|
|
223
226
|
export interface MetricStat {
|
|
@@ -227,173 +230,189 @@ export interface MetricStat {
|
|
|
227
230
|
*/
|
|
228
231
|
Metric: Metric | undefined;
|
|
229
232
|
/**
|
|
230
|
-
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
233
|
+
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
234
|
+
* resolution, a period can be as short as one minute (60 seconds) and must be a multiple
|
|
235
|
+
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
236
|
+
* minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
|
|
237
|
+
* metrics are those metrics stored by a <code>PutMetricData</code> call that includes a
|
|
238
|
+
* <code>StorageResolution</code> of 1 second.</p>
|
|
234
239
|
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
235
|
-
*
|
|
240
|
+
* 3 hours ago, you must specify the period as follows or no data points in that time range
|
|
241
|
+
* is returned:</p>
|
|
236
242
|
* <ul>
|
|
237
243
|
* <li>
|
|
238
|
-
* <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
|
|
244
|
+
* <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
|
|
245
|
+
* (1 minute).</p>
|
|
239
246
|
* </li>
|
|
240
247
|
* <li>
|
|
241
|
-
* <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5
|
|
248
|
+
* <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5
|
|
249
|
+
* minutes).</p>
|
|
242
250
|
* </li>
|
|
243
251
|
* <li>
|
|
244
|
-
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
|
|
252
|
+
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
|
|
253
|
+
* hour).</p>
|
|
245
254
|
* </li>
|
|
246
255
|
* </ul>
|
|
247
256
|
* @public
|
|
248
257
|
*/
|
|
249
258
|
Period: number | undefined;
|
|
250
259
|
/**
|
|
251
|
-
* <p>The statistic to return. It can include any CloudWatch statistic or extended
|
|
260
|
+
* <p>The statistic to return. It can include any CloudWatch statistic or extended
|
|
261
|
+
* statistic.</p>
|
|
252
262
|
* @public
|
|
253
263
|
*/
|
|
254
264
|
Stat: string | undefined;
|
|
255
265
|
/**
|
|
256
|
-
* <p>When you are using a <code>Put</code> operation, this defines what unit you want to
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
266
|
+
* <p>When you are using a <code>Put</code> operation, this defines what unit you want to
|
|
267
|
+
* use when storing the metric.</p>
|
|
268
|
+
* <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that
|
|
269
|
+
* was collected with any unit is returned, along with the corresponding units that were
|
|
270
|
+
* specified when the data was reported to CloudWatch. If you specify a unit, the operation
|
|
271
|
+
* returns only data that was collected with that unit specified. If you specify a unit
|
|
272
|
+
* that does not match the data collected, the results of the operation are null.
|
|
273
|
+
* CloudWatch does not perform unit conversions.</p>
|
|
260
274
|
* @public
|
|
261
275
|
*/
|
|
262
276
|
Unit?: StandardUnit | undefined;
|
|
263
277
|
}
|
|
264
278
|
/**
|
|
265
|
-
* <p>This structure is used in both <code>GetMetricData</code> and
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
279
|
+
* <p>This structure is used in both <code>GetMetricData</code> and
|
|
280
|
+
* <code>PutMetricAlarm</code>. The supported use of this structure is different for
|
|
281
|
+
* those two operations.</p>
|
|
282
|
+
* <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and
|
|
283
|
+
* whether this call is just retrieving a batch set of data for one metric, or is
|
|
284
|
+
* performing a Metrics Insights query or a math expression. A single
|
|
285
|
+
* <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>
|
|
286
|
+
* structures.</p>
|
|
271
287
|
* <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
288
|
+
* metric math expression. Each <code>MetricDataQuery</code> in the array specifies either
|
|
289
|
+
* a metric to retrieve, or a math expression to be performed on retrieved metrics. A
|
|
290
|
+
* single <code>PutMetricAlarm</code> call can include up to 20
|
|
291
|
+
* <code>MetricDataQuery</code> structures in the array. The 20 structures can include
|
|
292
|
+
* as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a
|
|
293
|
+
* metric, and as many as 10 structures that contain the <code>Expression</code> parameter
|
|
294
|
+
* to perform a math expression. Of those <code>Expression</code> structures, one must have
|
|
295
|
+
* <code>true</code> as the value for <code>ReturnData</code>. The result of this
|
|
296
|
+
* expression is the value the alarm watches.</p>
|
|
297
|
+
* <p>Any expression used in a <code>PutMetricAlarm</code> operation must return a single
|
|
298
|
+
* time series. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
|
|
299
|
+
* Guide</i>.</p>
|
|
300
|
+
* <p>Some of the parameters of this structure also have different uses whether you are
|
|
301
|
+
* using this structure in a <code>GetMetricData</code> operation or a
|
|
302
|
+
* <code>PutMetricAlarm</code> operation. These differences are explained in the
|
|
303
|
+
* following parameter list.</p>
|
|
285
304
|
* @public
|
|
286
305
|
*/
|
|
287
306
|
export interface MetricDataQuery {
|
|
288
307
|
/**
|
|
289
308
|
* <p>A short name used to tie this object to the results in the response. This name must be
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
309
|
+
* unique within a single call to <code>GetMetricData</code>. If you are performing math
|
|
310
|
+
* expressions on this set of data, this name represents that data and can serve as a
|
|
311
|
+
* variable in the mathematical expression. The valid characters are letters, numbers, and
|
|
312
|
+
* underscore. The first character must be a lowercase letter.</p>
|
|
294
313
|
* @public
|
|
295
314
|
*/
|
|
296
315
|
Id: string | undefined;
|
|
297
316
|
/**
|
|
298
|
-
* <p>The metric to be returned, along with statistics, period, and units. Use this
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
*
|
|
317
|
+
* <p>The metric to be returned, along with statistics, period, and units. Use this
|
|
318
|
+
* parameter only if this object is retrieving a metric and not performing a math
|
|
319
|
+
* expression on returned data.</p>
|
|
320
|
+
* <p>Within one MetricDataQuery object, you must specify either <code>Expression</code> or
|
|
321
|
+
* <code>MetricStat</code> but not both.</p>
|
|
302
322
|
* @public
|
|
303
323
|
*/
|
|
304
324
|
MetricStat?: MetricStat | undefined;
|
|
305
325
|
/**
|
|
306
|
-
* <p>This field can contain either a Metrics Insights query, or a metric math expression to
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
* <p>A math expression
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
326
|
+
* <p>This field can contain either a Metrics Insights query, or a metric math expression to
|
|
327
|
+
* be performed on the returned data. For more information about Metrics Insights queries,
|
|
328
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage">Metrics Insights query components and syntax</a> in the <i>Amazon
|
|
329
|
+
* CloudWatch User Guide</i>.</p>
|
|
330
|
+
* <p>A math expression can use the <code>Id</code> of the other metrics or queries to refer
|
|
331
|
+
* to those metrics, and can also use the <code>Id</code> of other expressions to use the
|
|
332
|
+
* result of those expressions. For more information about metric math expressions, see
|
|
333
|
+
* <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
|
|
334
|
+
* Guide</i>.</p>
|
|
335
|
+
* <p>Within each MetricDataQuery object, you must specify either <code>Expression</code> or
|
|
336
|
+
* <code>MetricStat</code> but not both.</p>
|
|
318
337
|
* @public
|
|
319
338
|
*/
|
|
320
339
|
Expression?: string | undefined;
|
|
321
340
|
/**
|
|
322
|
-
* <p>A human-readable label for this metric or expression. This is especially useful
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
341
|
+
* <p>A human-readable label for this metric or expression. This is especially useful if
|
|
342
|
+
* this is an expression, so that you know what the value represents. If the metric or
|
|
343
|
+
* expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is
|
|
344
|
+
* omitted, CloudWatch generates a default.</p>
|
|
345
|
+
* <p>You can put dynamic expressions into a label, so that it is more descriptive. For more
|
|
346
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic
|
|
347
|
+
* Labels</a>.</p>
|
|
329
348
|
* @public
|
|
330
349
|
*/
|
|
331
350
|
Label?: string | undefined;
|
|
332
351
|
/**
|
|
333
352
|
* <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* <p>When used in <code>PutMetricAlarm</code>, specify <code>true</code> for the one
|
|
339
|
-
*
|
|
353
|
+
* timestamps and raw data values of this metric. If you are performing this call just to
|
|
354
|
+
* do math expressions and do not also need the raw data returned, you can specify
|
|
355
|
+
* <code>false</code>. If you omit this, the default of <code>true</code> is
|
|
356
|
+
* used.</p>
|
|
357
|
+
* <p>When used in <code>PutMetricAlarm</code>, specify <code>true</code> for the one
|
|
358
|
+
* expression result to use as the alarm. For all other metrics and expressions in the same
|
|
359
|
+
* <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as
|
|
360
|
+
* False.</p>
|
|
340
361
|
* @public
|
|
341
362
|
*/
|
|
342
363
|
ReturnData?: boolean | undefined;
|
|
343
364
|
/**
|
|
344
|
-
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
365
|
+
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
366
|
+
* resolution, a period can be as short as one minute (60 seconds) and must be a multiple
|
|
367
|
+
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
368
|
+
* minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
|
|
369
|
+
* metrics are those metrics stored by a <code>PutMetricData</code> operation that includes
|
|
370
|
+
* a <code>StorageResolution of 1 second</code>.</p>
|
|
349
371
|
* @public
|
|
350
372
|
*/
|
|
351
373
|
Period?: number | undefined;
|
|
352
374
|
/**
|
|
353
375
|
* <p>The ID of the account where the metrics are located.</p>
|
|
354
|
-
* <p>If you are performing a <code>GetMetricData</code> operation in a monitoring account,
|
|
355
|
-
*
|
|
376
|
+
* <p>If you are performing a <code>GetMetricData</code> operation in a monitoring account,
|
|
377
|
+
* use this to specify which account to retrieve this metric from.</p>
|
|
356
378
|
* <p>If you are performing a <code>PutMetricAlarm</code> operation, use this to specify
|
|
357
|
-
*
|
|
379
|
+
* which account contains the metric that the alarm is watching.</p>
|
|
358
380
|
* @public
|
|
359
381
|
*/
|
|
360
382
|
AccountId?: string | undefined;
|
|
361
383
|
}
|
|
362
384
|
/**
|
|
363
|
-
* <p>Indicates the CloudWatch math expression that provides the time series the anomaly
|
|
364
|
-
*
|
|
365
|
-
*
|
|
385
|
+
* <p>Indicates the CloudWatch math expression that provides the time series the anomaly
|
|
386
|
+
* detector uses as input. The designated math expression must return a single time
|
|
387
|
+
* series.</p>
|
|
366
388
|
* @public
|
|
367
389
|
*/
|
|
368
390
|
export interface MetricMathAnomalyDetector {
|
|
369
391
|
/**
|
|
370
|
-
* <p>An array of metric data query structures
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
* for this object in the array.
|
|
379
|
-
* For all other expressions and metrics, set <code>ReturnData</code> to <code>false</code>.
|
|
380
|
-
* The designated expression must return
|
|
381
|
-
* a single time series.</p>
|
|
392
|
+
* <p>An array of metric data query structures that enables you to create an anomaly
|
|
393
|
+
* detector based on the result of a metric math expression. Each item in
|
|
394
|
+
* <code>MetricDataQueries</code> gets a metric or performs a math expression. One item
|
|
395
|
+
* in <code>MetricDataQueries</code> is the expression that provides the time series that
|
|
396
|
+
* the anomaly detector uses as input. Designate the expression by setting
|
|
397
|
+
* <code>ReturnData</code> to <code>true</code> for this object in the array. For all
|
|
398
|
+
* other expressions and metrics, set <code>ReturnData</code> to <code>false</code>. The
|
|
399
|
+
* designated expression must return a single time series.</p>
|
|
382
400
|
* @public
|
|
383
401
|
*/
|
|
384
402
|
MetricDataQueries?: MetricDataQuery[] | undefined;
|
|
385
403
|
}
|
|
386
404
|
/**
|
|
387
|
-
* <p>Designates the CloudWatch metric and statistic that provides the time series the
|
|
388
|
-
*
|
|
389
|
-
*
|
|
405
|
+
* <p>Designates the CloudWatch metric and statistic that provides the time series the
|
|
406
|
+
* anomaly detector uses as input. If you have enabled unified cross-account observability,
|
|
407
|
+
* and this account is a monitoring account, the metric can be in the same account or a
|
|
408
|
+
* source account.</p>
|
|
390
409
|
* @public
|
|
391
410
|
*/
|
|
392
411
|
export interface SingleMetricAnomalyDetector {
|
|
393
412
|
/**
|
|
394
|
-
* <p>If the CloudWatch metric that provides the time series that the anomaly
|
|
395
|
-
*
|
|
396
|
-
*
|
|
413
|
+
* <p>If the CloudWatch metric that provides the time series that the anomaly
|
|
414
|
+
* detector uses as input is in another account, specify that account ID here. If you omit
|
|
415
|
+
* this parameter, the current account is used.</p>
|
|
397
416
|
* @public
|
|
398
417
|
*/
|
|
399
418
|
AccountId?: string | undefined;
|
|
@@ -432,11 +451,11 @@ export declare const AnomalyDetectorStateValue: {
|
|
|
432
451
|
*/
|
|
433
452
|
export type AnomalyDetectorStateValue = (typeof AnomalyDetectorStateValue)[keyof typeof AnomalyDetectorStateValue];
|
|
434
453
|
/**
|
|
435
|
-
* <p>An anomaly detection model associated with a particular CloudWatch metric, statistic,
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
* <p>If you have enabled unified cross-account observability, and this account is a
|
|
439
|
-
*
|
|
454
|
+
* <p>An anomaly detection model associated with a particular CloudWatch metric, statistic,
|
|
455
|
+
* or metric math expression. You can use the model to display a band of expected, normal
|
|
456
|
+
* values when the metric is graphed.</p>
|
|
457
|
+
* <p>If you have enabled unified cross-account observability, and this account is a
|
|
458
|
+
* monitoring account, the metric can be in the same account or a source account.</p>
|
|
440
459
|
* @public
|
|
441
460
|
*/
|
|
442
461
|
export interface AnomalyDetector {
|
|
@@ -469,10 +488,9 @@ export interface AnomalyDetector {
|
|
|
469
488
|
*/
|
|
470
489
|
Stat?: string | undefined;
|
|
471
490
|
/**
|
|
472
|
-
* <p>The configuration specifies details about how the
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
* the metric.</p>
|
|
491
|
+
* <p>The configuration specifies details about how the anomaly detection model is to be
|
|
492
|
+
* trained, including time ranges to exclude from use for training the model, and the time
|
|
493
|
+
* zone to use for the metric.</p>
|
|
476
494
|
* @public
|
|
477
495
|
*/
|
|
478
496
|
Configuration?: AnomalyDetectorConfiguration | undefined;
|
|
@@ -482,9 +500,9 @@ export interface AnomalyDetector {
|
|
|
482
500
|
*/
|
|
483
501
|
StateValue?: AnomalyDetectorStateValue | undefined;
|
|
484
502
|
/**
|
|
485
|
-
* <p>This object includes parameters that you can use to provide information about your
|
|
486
|
-
*
|
|
487
|
-
*
|
|
503
|
+
* <p>This object includes parameters that you can use to provide information about your
|
|
504
|
+
* metric to CloudWatch to help it build more accurate anomaly detection models.
|
|
505
|
+
* Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>
|
|
488
506
|
* @public
|
|
489
507
|
*/
|
|
490
508
|
MetricCharacteristics?: MetricCharacteristics | undefined;
|
|
@@ -512,8 +530,9 @@ export declare const AnomalyDetectorType: {
|
|
|
512
530
|
*/
|
|
513
531
|
export type AnomalyDetectorType = (typeof AnomalyDetectorType)[keyof typeof AnomalyDetectorType];
|
|
514
532
|
/**
|
|
515
|
-
* <p>This array is empty if the API operation was successful for all the rules specified in
|
|
516
|
-
*
|
|
533
|
+
* <p>This array is empty if the API operation was successful for all the rules specified in
|
|
534
|
+
* the request. If the operation could not process one of the rules, the following data is
|
|
535
|
+
* returned for each of those rules.</p>
|
|
517
536
|
* @public
|
|
518
537
|
*/
|
|
519
538
|
export interface PartialFailure {
|
|
@@ -574,12 +593,14 @@ export type StateValue = (typeof StateValue)[keyof typeof StateValue];
|
|
|
574
593
|
*/
|
|
575
594
|
export interface CompositeAlarm {
|
|
576
595
|
/**
|
|
577
|
-
* <p>Indicates whether actions should be executed during any changes to the alarm
|
|
596
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm
|
|
597
|
+
* state.</p>
|
|
578
598
|
* @public
|
|
579
599
|
*/
|
|
580
600
|
ActionsEnabled?: boolean | undefined;
|
|
581
601
|
/**
|
|
582
|
-
* <p>The actions to execute when this alarm transitions to the ALARM state from any other
|
|
602
|
+
* <p>The actions to execute when this alarm transitions to the ALARM state from any other
|
|
603
|
+
* state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
583
604
|
* @public
|
|
584
605
|
*/
|
|
585
606
|
AlarmActions?: string[] | undefined;
|
|
@@ -609,12 +630,14 @@ export interface CompositeAlarm {
|
|
|
609
630
|
*/
|
|
610
631
|
AlarmRule?: string | undefined;
|
|
611
632
|
/**
|
|
612
|
-
* <p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from
|
|
633
|
+
* <p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from
|
|
634
|
+
* any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
613
635
|
* @public
|
|
614
636
|
*/
|
|
615
637
|
InsufficientDataActions?: string[] | undefined;
|
|
616
638
|
/**
|
|
617
|
-
* <p>The actions to execute when this alarm transitions to the OK state from any other
|
|
639
|
+
* <p>The actions to execute when this alarm transitions to the OK state from any other
|
|
640
|
+
* state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
618
641
|
* @public
|
|
619
642
|
*/
|
|
620
643
|
OKActions?: string[] | undefined;
|
|
@@ -629,7 +652,8 @@ export interface CompositeAlarm {
|
|
|
629
652
|
*/
|
|
630
653
|
StateReasonData?: string | undefined;
|
|
631
654
|
/**
|
|
632
|
-
* <p>Tracks the timestamp of any state update, even if <code>StateValue</code> doesn't
|
|
655
|
+
* <p>Tracks the timestamp of any state update, even if <code>StateValue</code> doesn't
|
|
656
|
+
* change.</p>
|
|
633
657
|
* @public
|
|
634
658
|
*/
|
|
635
659
|
StateUpdatedTimestamp?: Date | undefined;
|
|
@@ -639,102 +663,57 @@ export interface CompositeAlarm {
|
|
|
639
663
|
*/
|
|
640
664
|
StateValue?: StateValue | undefined;
|
|
641
665
|
/**
|
|
642
|
-
* <p>
|
|
643
|
-
* The timestamp
|
|
644
|
-
* of the last change
|
|
645
|
-
* to the alarm's <code>StateValue</code>.
|
|
646
|
-
* </p>
|
|
666
|
+
* <p> The timestamp of the last change to the alarm's <code>StateValue</code>. </p>
|
|
647
667
|
* @public
|
|
648
668
|
*/
|
|
649
669
|
StateTransitionedTimestamp?: Date | undefined;
|
|
650
670
|
/**
|
|
651
|
-
* <p>
|
|
652
|
-
*
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
|
-
*
|
|
657
|
-
*
|
|
658
|
-
*
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
*
|
|
662
|
-
* to go
|
|
663
|
-
* into
|
|
664
|
-
* into the <code>ALARM</code> state.
|
|
665
|
-
* The maximum waiting time is as specified
|
|
666
|
-
* in <code>ActionsSuppressorWaitPeriod</code>.
|
|
667
|
-
* After this time,
|
|
668
|
-
* the composite alarm performs its actions.
|
|
669
|
-
* When the value is <code>ExtensionPeriod</code>,
|
|
670
|
-
* it means
|
|
671
|
-
* that the actions are suppressed
|
|
672
|
-
* because the composite alarm is waiting
|
|
673
|
-
* after the suppressor alarm went out
|
|
674
|
-
* of the <code>ALARM</code> state.
|
|
675
|
-
* The maximum waiting time is as specified
|
|
676
|
-
* in <code>ActionsSuppressorExtensionPeriod</code>.
|
|
677
|
-
* After this time,
|
|
678
|
-
* the composite alarm performs its actions.
|
|
679
|
-
* </p>
|
|
671
|
+
* <p> When the value is <code>ALARM</code>, it means that the actions are suppressed
|
|
672
|
+
* because the suppressor alarm is in <code>ALARM</code> When the value is
|
|
673
|
+
* <code>WaitPeriod</code>, it means that the actions are suppressed because the
|
|
674
|
+
* composite alarm is waiting for the suppressor alarm to go into into the
|
|
675
|
+
* <code>ALARM</code> state. The maximum waiting time is as specified in
|
|
676
|
+
* <code>ActionsSuppressorWaitPeriod</code>. After this time, the composite alarm
|
|
677
|
+
* performs its actions. When the value is <code>ExtensionPeriod</code>, it means that the
|
|
678
|
+
* actions are suppressed because the composite alarm is waiting after the suppressor alarm
|
|
679
|
+
* went out of the <code>ALARM</code> state. The maximum waiting time is as specified in
|
|
680
|
+
* <code>ActionsSuppressorExtensionPeriod</code>. After this time, the composite alarm
|
|
681
|
+
* performs its actions. </p>
|
|
680
682
|
* @public
|
|
681
683
|
*/
|
|
682
684
|
ActionsSuppressedBy?: ActionsSuppressedBy | undefined;
|
|
683
685
|
/**
|
|
684
|
-
* <p>
|
|
685
|
-
* Captures the reason for action suppression.
|
|
686
|
-
* </p>
|
|
686
|
+
* <p> Captures the reason for action suppression. </p>
|
|
687
687
|
* @public
|
|
688
688
|
*/
|
|
689
689
|
ActionsSuppressedReason?: string | undefined;
|
|
690
690
|
/**
|
|
691
|
-
* <p>
|
|
692
|
-
*
|
|
693
|
-
*
|
|
694
|
-
* in the <code>ALARM</code> state.
|
|
695
|
-
* <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name (ARN)
|
|
696
|
-
* from an existing alarm.
|
|
697
|
-
* </p>
|
|
691
|
+
* <p> Actions will be suppressed if the suppressor alarm is in the <code>ALARM</code>
|
|
692
|
+
* state. <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name
|
|
693
|
+
* (ARN) from an existing alarm. </p>
|
|
698
694
|
* @public
|
|
699
695
|
*/
|
|
700
696
|
ActionsSuppressor?: string | undefined;
|
|
701
697
|
/**
|
|
702
|
-
* <p>
|
|
703
|
-
*
|
|
704
|
-
*
|
|
705
|
-
* that the composite alarm waits
|
|
706
|
-
* for the suppressor alarm
|
|
707
|
-
* to go
|
|
708
|
-
* into the <code>ALARM</code> state.
|
|
709
|
-
* After this time,
|
|
710
|
-
* the composite alarm performs its actions.
|
|
711
|
-
* </p>
|
|
698
|
+
* <p> The maximum time in seconds that the composite alarm waits for the suppressor alarm
|
|
699
|
+
* to go into the <code>ALARM</code> state. After this time, the composite alarm performs
|
|
700
|
+
* its actions. </p>
|
|
712
701
|
* <important>
|
|
713
702
|
* <p>
|
|
714
|
-
* <code>WaitPeriod</code>
|
|
715
|
-
*
|
|
716
|
-
* when <code>ActionsSuppressor</code> is specified.
|
|
717
|
-
* </p>
|
|
703
|
+
* <code>WaitPeriod</code> is required only when <code>ActionsSuppressor</code> is
|
|
704
|
+
* specified. </p>
|
|
718
705
|
* </important>
|
|
719
706
|
* @public
|
|
720
707
|
*/
|
|
721
708
|
ActionsSuppressorWaitPeriod?: number | undefined;
|
|
722
709
|
/**
|
|
723
|
-
* <p>
|
|
724
|
-
*
|
|
725
|
-
*
|
|
726
|
-
* that the composite alarm waits
|
|
727
|
-
* after suppressor alarm goes out
|
|
728
|
-
* of the <code>ALARM</code> state.
|
|
729
|
-
* After this time,
|
|
730
|
-
* the composite alarm performs its actions.
|
|
731
|
-
* </p>
|
|
710
|
+
* <p> The maximum time in seconds that the composite alarm waits after suppressor alarm
|
|
711
|
+
* goes out of the <code>ALARM</code> state. After this time, the composite alarm performs
|
|
712
|
+
* its actions. </p>
|
|
732
713
|
* <important>
|
|
733
714
|
* <p>
|
|
734
|
-
* <code>ExtensionPeriod</code>
|
|
735
|
-
*
|
|
736
|
-
* when <code>ActionsSuppressor</code> is specified.
|
|
737
|
-
* </p>
|
|
715
|
+
* <code>ExtensionPeriod</code> is required only when <code>ActionsSuppressor</code> is
|
|
716
|
+
* specified. </p>
|
|
738
717
|
* </important>
|
|
739
718
|
* @public
|
|
740
719
|
*/
|
|
@@ -770,7 +749,8 @@ export interface DashboardEntry {
|
|
|
770
749
|
DashboardArn?: string | undefined;
|
|
771
750
|
/**
|
|
772
751
|
* <p>The time stamp of when the dashboard was last modified, either by an API call or
|
|
773
|
-
*
|
|
752
|
+
* through the console. This number is expressed as the number of milliseconds since Jan 1,
|
|
753
|
+
* 1970 00:00:00 UTC.</p>
|
|
774
754
|
* @public
|
|
775
755
|
*/
|
|
776
756
|
LastModified?: Date | undefined;
|
|
@@ -822,7 +802,8 @@ export declare class DashboardNotFoundError extends __BaseException {
|
|
|
822
802
|
constructor(opts: __ExceptionOptionType<DashboardNotFoundError, __BaseException>);
|
|
823
803
|
}
|
|
824
804
|
/**
|
|
825
|
-
* <p>Encapsulates the statistical data that CloudWatch computes from metric
|
|
805
|
+
* <p>Encapsulates the statistical data that CloudWatch computes from metric
|
|
806
|
+
* data.</p>
|
|
826
807
|
* @public
|
|
827
808
|
*/
|
|
828
809
|
export interface Datapoint {
|
|
@@ -832,8 +813,8 @@ export interface Datapoint {
|
|
|
832
813
|
*/
|
|
833
814
|
Timestamp?: Date | undefined;
|
|
834
815
|
/**
|
|
835
|
-
* <p>The number of metric values that contributed to the aggregate value of this
|
|
836
|
-
*
|
|
816
|
+
* <p>The number of metric values that contributed to the aggregate value of this data
|
|
817
|
+
* point.</p>
|
|
837
818
|
* @public
|
|
838
819
|
*/
|
|
839
820
|
SampleCount?: number | undefined;
|
|
@@ -924,8 +905,8 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
924
905
|
Stat?: string | undefined;
|
|
925
906
|
/**
|
|
926
907
|
* <p>A single metric anomaly detector to be deleted.</p>
|
|
927
|
-
* <p>When using <code>SingleMetricAnomalyDetector</code>,
|
|
928
|
-
*
|
|
908
|
+
* <p>When using <code>SingleMetricAnomalyDetector</code>, you cannot include the following
|
|
909
|
+
* parameters in the same operation:</p>
|
|
929
910
|
* <ul>
|
|
930
911
|
* <li>
|
|
931
912
|
* <p>
|
|
@@ -947,18 +928,20 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
947
928
|
* </p>
|
|
948
929
|
* </li>
|
|
949
930
|
* <li>
|
|
950
|
-
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
931
|
+
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
932
|
+
* <code>DeleteAnomalyDetectorInput</code>
|
|
951
933
|
* </p>
|
|
952
934
|
* </li>
|
|
953
935
|
* </ul>
|
|
954
|
-
* <p>Instead, specify the single metric anomaly detector attributes
|
|
955
|
-
*
|
|
936
|
+
* <p>Instead, specify the single metric anomaly detector attributes as part of the
|
|
937
|
+
* <code>SingleMetricAnomalyDetector</code> property.</p>
|
|
956
938
|
* @public
|
|
957
939
|
*/
|
|
958
940
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
|
|
959
941
|
/**
|
|
960
942
|
* <p>The metric math anomaly detector to be deleted.</p>
|
|
961
|
-
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following
|
|
943
|
+
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following
|
|
944
|
+
* parameters in the same operation:</p>
|
|
962
945
|
* <ul>
|
|
963
946
|
* <li>
|
|
964
947
|
* <p>
|
|
@@ -980,12 +963,13 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
980
963
|
* </p>
|
|
981
964
|
* </li>
|
|
982
965
|
* <li>
|
|
983
|
-
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
966
|
+
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
967
|
+
* <code>DeleteAnomalyDetectorInput</code>
|
|
984
968
|
* </p>
|
|
985
969
|
* </li>
|
|
986
970
|
* </ul>
|
|
987
971
|
* <p>Instead, specify the metric math anomaly detector attributes as part of the
|
|
988
|
-
*
|
|
972
|
+
* <code>MetricMathAnomalyDetector</code> property.</p>
|
|
989
973
|
* @public
|
|
990
974
|
*/
|
|
991
975
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
|
|
@@ -996,7 +980,8 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
996
980
|
export interface DeleteAnomalyDetectorOutput {
|
|
997
981
|
}
|
|
998
982
|
/**
|
|
999
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
983
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
984
|
+
* failure.</p>
|
|
1000
985
|
* @public
|
|
1001
986
|
*/
|
|
1002
987
|
export declare class InternalServiceFault extends __BaseException {
|
|
@@ -1083,7 +1068,8 @@ export interface DeleteDashboardsOutput {
|
|
|
1083
1068
|
*/
|
|
1084
1069
|
export interface DeleteInsightRulesInput {
|
|
1085
1070
|
/**
|
|
1086
|
-
* <p>An array of the rule names to delete. If you need to find out the names of your rules,
|
|
1071
|
+
* <p>An array of the rule names to delete. If you need to find out the names of your rules,
|
|
1072
|
+
* use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1087
1073
|
* @public
|
|
1088
1074
|
*/
|
|
1089
1075
|
RuleNames: string[] | undefined;
|
|
@@ -1093,7 +1079,8 @@ export interface DeleteInsightRulesInput {
|
|
|
1093
1079
|
*/
|
|
1094
1080
|
export interface DeleteInsightRulesOutput {
|
|
1095
1081
|
/**
|
|
1096
|
-
* <p>An array listing the rules that could not be deleted. You cannot delete built-in
|
|
1082
|
+
* <p>An array listing the rules that could not be deleted. You cannot delete built-in
|
|
1083
|
+
* rules.</p>
|
|
1097
1084
|
* @public
|
|
1098
1085
|
*/
|
|
1099
1086
|
Failures?: PartialFailure[] | undefined;
|
|
@@ -1135,8 +1122,8 @@ export interface DescribeAlarmHistoryInput {
|
|
|
1135
1122
|
*/
|
|
1136
1123
|
AlarmName?: string | undefined;
|
|
1137
1124
|
/**
|
|
1138
|
-
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1139
|
-
*
|
|
1125
|
+
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1126
|
+
* or composite alarms. If you omit this parameter, only metric alarms are returned.</p>
|
|
1140
1127
|
* @public
|
|
1141
1128
|
*/
|
|
1142
1129
|
AlarmTypes?: AlarmType[] | undefined;
|
|
@@ -1162,13 +1149,15 @@ export interface DescribeAlarmHistoryInput {
|
|
|
1162
1149
|
MaxRecords?: number | undefined;
|
|
1163
1150
|
/**
|
|
1164
1151
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
1165
|
-
*
|
|
1152
|
+
* available.</p>
|
|
1166
1153
|
* @public
|
|
1167
1154
|
*/
|
|
1168
1155
|
NextToken?: string | undefined;
|
|
1169
1156
|
/**
|
|
1170
|
-
* <p>Specified whether to return the newest or oldest alarm history first. Specify
|
|
1171
|
-
*
|
|
1157
|
+
* <p>Specified whether to return the newest or oldest alarm history first. Specify
|
|
1158
|
+
* <code>TimestampDescending</code> to have the newest event history returned first,
|
|
1159
|
+
* and specify <code>TimestampAscending</code> to have the oldest history returned
|
|
1160
|
+
* first.</p>
|
|
1172
1161
|
* @public
|
|
1173
1162
|
*/
|
|
1174
1163
|
ScanBy?: ScanBy | undefined;
|
|
@@ -1210,72 +1199,73 @@ export interface DescribeAlarmsInput {
|
|
|
1210
1199
|
*/
|
|
1211
1200
|
AlarmNames?: string[] | undefined;
|
|
1212
1201
|
/**
|
|
1213
|
-
* <p>An alarm name prefix. If you specify this parameter, you receive information about
|
|
1214
|
-
*
|
|
1215
|
-
* <p>If this parameter
|
|
1216
|
-
*
|
|
1202
|
+
* <p>An alarm name prefix. If you specify this parameter, you receive information about
|
|
1203
|
+
* all alarms that have names that start with this prefix.</p>
|
|
1204
|
+
* <p>If this parameter is specified, you cannot specify
|
|
1205
|
+
* <code>AlarmNames</code>.</p>
|
|
1217
1206
|
* @public
|
|
1218
1207
|
*/
|
|
1219
1208
|
AlarmNamePrefix?: string | undefined;
|
|
1220
1209
|
/**
|
|
1221
|
-
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1222
|
-
*
|
|
1223
|
-
*
|
|
1224
|
-
* <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the
|
|
1225
|
-
*
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1210
|
+
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1211
|
+
* or composite alarms. If you omit this parameter, only metric alarms are returned, even
|
|
1212
|
+
* if composite alarms exist in the account.</p>
|
|
1213
|
+
* <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the
|
|
1214
|
+
* operation returns only a list of metric alarms. It does not return any composite alarms,
|
|
1215
|
+
* even if composite alarms exist in the account.</p>
|
|
1216
|
+
* <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of
|
|
1217
|
+
* composite alarms, and does not return any metric alarms.</p>
|
|
1228
1218
|
* @public
|
|
1229
1219
|
*/
|
|
1230
1220
|
AlarmTypes?: AlarmType[] | undefined;
|
|
1231
1221
|
/**
|
|
1232
|
-
* <p>If you use this parameter and specify the name of a composite alarm, the operation
|
|
1233
|
-
*
|
|
1234
|
-
*
|
|
1235
|
-
*
|
|
1236
|
-
*
|
|
1237
|
-
*
|
|
1238
|
-
* <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other
|
|
1239
|
-
*
|
|
1240
|
-
*
|
|
1241
|
-
* error.</p>
|
|
1222
|
+
* <p>If you use this parameter and specify the name of a composite alarm, the operation
|
|
1223
|
+
* returns information about the "children" alarms of the alarm you specify. These are the
|
|
1224
|
+
* metric alarms and composite alarms referenced in the <code>AlarmRule</code> field of the
|
|
1225
|
+
* composite alarm that you specify in <code>ChildrenOfAlarmName</code>. Information about
|
|
1226
|
+
* the composite alarm that you name in <code>ChildrenOfAlarmName</code> is not
|
|
1227
|
+
* returned.</p>
|
|
1228
|
+
* <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other
|
|
1229
|
+
* parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>.
|
|
1230
|
+
* If you do so, you receive a validation error.</p>
|
|
1242
1231
|
* <note>
|
|
1243
|
-
* <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code>
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1247
|
-
*
|
|
1232
|
+
* <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code>
|
|
1233
|
+
* (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information are
|
|
1234
|
+
* returned by this operation when you use this parameter. To get complete information
|
|
1235
|
+
* about these alarms, perform another <code>DescribeAlarms</code> operation and
|
|
1236
|
+
* specify the parent alarm names in the <code>AlarmNames</code> parameter.</p>
|
|
1248
1237
|
* </note>
|
|
1249
1238
|
* @public
|
|
1250
1239
|
*/
|
|
1251
1240
|
ChildrenOfAlarmName?: string | undefined;
|
|
1252
1241
|
/**
|
|
1253
|
-
* <p>If you use this parameter and specify the name of a metric or composite alarm, the
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1256
|
-
*
|
|
1257
|
-
*
|
|
1258
|
-
*
|
|
1259
|
-
*
|
|
1260
|
-
*
|
|
1261
|
-
* error.</p>
|
|
1242
|
+
* <p>If you use this parameter and specify the name of a metric or composite alarm, the
|
|
1243
|
+
* operation returns information about the "parent" alarms of the alarm you specify. These
|
|
1244
|
+
* are the composite alarms that have <code>AlarmRule</code> parameters that reference the
|
|
1245
|
+
* alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you
|
|
1246
|
+
* specify in <code>ParentsOfAlarmName</code> is not returned.</p>
|
|
1247
|
+
* <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other
|
|
1248
|
+
* parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>.
|
|
1249
|
+
* If you do so, you receive a validation error.</p>
|
|
1262
1250
|
* <note>
|
|
1263
|
-
* <p>Only the Alarm Name and ARN are returned by this operation when you use this
|
|
1264
|
-
*
|
|
1265
|
-
*
|
|
1251
|
+
* <p>Only the Alarm Name and ARN are returned by this operation when you use this
|
|
1252
|
+
* parameter. To get complete information about these alarms, perform another
|
|
1253
|
+
* <code>DescribeAlarms</code> operation and specify the parent alarm names in the
|
|
1254
|
+
* <code>AlarmNames</code> parameter.</p>
|
|
1266
1255
|
* </note>
|
|
1267
1256
|
* @public
|
|
1268
1257
|
*/
|
|
1269
1258
|
ParentsOfAlarmName?: string | undefined;
|
|
1270
1259
|
/**
|
|
1271
|
-
* <p>Specify this parameter to receive information only about alarms that are currently
|
|
1260
|
+
* <p>Specify this parameter to receive information only about alarms that are currently
|
|
1261
|
+
* in the state that you specify.</p>
|
|
1272
1262
|
* @public
|
|
1273
1263
|
*/
|
|
1274
1264
|
StateValue?: StateValue | undefined;
|
|
1275
1265
|
/**
|
|
1276
1266
|
* <p>Use this parameter to filter the results of the operation to only those alarms that
|
|
1277
|
-
*
|
|
1278
|
-
*
|
|
1267
|
+
* use a certain alarm action. For example, you could specify the ARN of an SNS topic to
|
|
1268
|
+
* find all alarms that send notifications to that topic.</p>
|
|
1279
1269
|
* @public
|
|
1280
1270
|
*/
|
|
1281
1271
|
ActionPrefix?: string | undefined;
|
|
@@ -1286,7 +1276,7 @@ export interface DescribeAlarmsInput {
|
|
|
1286
1276
|
MaxRecords?: number | undefined;
|
|
1287
1277
|
/**
|
|
1288
1278
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
1289
|
-
*
|
|
1279
|
+
* available.</p>
|
|
1290
1280
|
* @public
|
|
1291
1281
|
*/
|
|
1292
1282
|
NextToken?: string | undefined;
|
|
@@ -1343,25 +1333,29 @@ export interface MetricAlarm {
|
|
|
1343
1333
|
*/
|
|
1344
1334
|
AlarmConfigurationUpdatedTimestamp?: Date | undefined;
|
|
1345
1335
|
/**
|
|
1346
|
-
* <p>Indicates whether actions should be executed during any changes to the alarm
|
|
1336
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm
|
|
1337
|
+
* state.</p>
|
|
1347
1338
|
* @public
|
|
1348
1339
|
*/
|
|
1349
1340
|
ActionsEnabled?: boolean | undefined;
|
|
1350
1341
|
/**
|
|
1351
1342
|
* <p>The actions to execute when this alarm transitions to the <code>OK</code> state
|
|
1352
|
-
*
|
|
1343
|
+
* from any other state. Each action is specified as an Amazon Resource Name
|
|
1344
|
+
* (ARN).</p>
|
|
1353
1345
|
* @public
|
|
1354
1346
|
*/
|
|
1355
1347
|
OKActions?: string[] | undefined;
|
|
1356
1348
|
/**
|
|
1357
1349
|
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
1358
|
-
*
|
|
1350
|
+
* from any other state. Each action is specified as an Amazon Resource Name
|
|
1351
|
+
* (ARN).</p>
|
|
1359
1352
|
* @public
|
|
1360
1353
|
*/
|
|
1361
1354
|
AlarmActions?: string[] | undefined;
|
|
1362
1355
|
/**
|
|
1363
|
-
* <p>The actions to execute when this alarm transitions to the
|
|
1364
|
-
*
|
|
1356
|
+
* <p>The actions to execute when this alarm transitions to the
|
|
1357
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
1358
|
+
* as an Amazon Resource Name (ARN).</p>
|
|
1365
1359
|
* @public
|
|
1366
1360
|
*/
|
|
1367
1361
|
InsufficientDataActions?: string[] | undefined;
|
|
@@ -1382,13 +1376,13 @@ export interface MetricAlarm {
|
|
|
1382
1376
|
StateReasonData?: string | undefined;
|
|
1383
1377
|
/**
|
|
1384
1378
|
* <p>The time stamp of the last update to the value of either the
|
|
1385
|
-
*
|
|
1379
|
+
* <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
|
|
1386
1380
|
* @public
|
|
1387
1381
|
*/
|
|
1388
1382
|
StateUpdatedTimestamp?: Date | undefined;
|
|
1389
1383
|
/**
|
|
1390
|
-
* <p>The name of the metric associated with the alarm, if this is an alarm
|
|
1391
|
-
*
|
|
1384
|
+
* <p>The name of the metric associated with the alarm, if this is an alarm based on a
|
|
1385
|
+
* single metric.</p>
|
|
1392
1386
|
* @public
|
|
1393
1387
|
*/
|
|
1394
1388
|
MetricName?: string | undefined;
|
|
@@ -1398,14 +1392,14 @@ export interface MetricAlarm {
|
|
|
1398
1392
|
*/
|
|
1399
1393
|
Namespace?: string | undefined;
|
|
1400
1394
|
/**
|
|
1401
|
-
* <p>The statistic for the metric associated with the alarm, other than percentile.
|
|
1402
|
-
*
|
|
1395
|
+
* <p>The statistic for the metric associated with the alarm, other than percentile. For
|
|
1396
|
+
* percentile statistics, use <code>ExtendedStatistic</code>.</p>
|
|
1403
1397
|
* @public
|
|
1404
1398
|
*/
|
|
1405
1399
|
Statistic?: Statistic | undefined;
|
|
1406
1400
|
/**
|
|
1407
|
-
* <p>The percentile statistic for the metric associated with the alarm. Specify a value
|
|
1408
|
-
*
|
|
1401
|
+
* <p>The percentile statistic for the metric associated with the alarm. Specify a value
|
|
1402
|
+
* between p0.0 and p100.</p>
|
|
1409
1403
|
* @public
|
|
1410
1404
|
*/
|
|
1411
1405
|
ExtendedStatistic?: string | undefined;
|
|
@@ -1425,7 +1419,8 @@ export interface MetricAlarm {
|
|
|
1425
1419
|
*/
|
|
1426
1420
|
Unit?: StandardUnit | undefined;
|
|
1427
1421
|
/**
|
|
1428
|
-
* <p>The number of periods over which data is compared to the specified
|
|
1422
|
+
* <p>The number of periods over which data is compared to the specified
|
|
1423
|
+
* threshold.</p>
|
|
1429
1424
|
* @public
|
|
1430
1425
|
*/
|
|
1431
1426
|
EvaluationPeriods?: number | undefined;
|
|
@@ -1440,58 +1435,54 @@ export interface MetricAlarm {
|
|
|
1440
1435
|
*/
|
|
1441
1436
|
Threshold?: number | undefined;
|
|
1442
1437
|
/**
|
|
1443
|
-
* <p>The arithmetic operation to use when comparing the specified
|
|
1444
|
-
*
|
|
1438
|
+
* <p>The arithmetic operation to use when comparing the specified statistic and
|
|
1439
|
+
* threshold. The specified statistic value is used as the first operand.</p>
|
|
1445
1440
|
* @public
|
|
1446
1441
|
*/
|
|
1447
1442
|
ComparisonOperator?: ComparisonOperator | undefined;
|
|
1448
1443
|
/**
|
|
1449
|
-
* <p>Sets how this alarm is to handle missing data points. The valid values
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1453
|
-
*
|
|
1454
|
-
* behavior of <code>missing</code> is used.</p>
|
|
1444
|
+
* <p>Sets how this alarm is to handle missing data points. The valid values are
|
|
1445
|
+
* <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and
|
|
1446
|
+
* <code>missing</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring how CloudWatch alarms treat missing data</a>.</p>
|
|
1447
|
+
* <p>If this parameter is omitted, the default behavior of <code>missing</code> is
|
|
1448
|
+
* used.</p>
|
|
1455
1449
|
* @public
|
|
1456
1450
|
*/
|
|
1457
1451
|
TreatMissingData?: string | undefined;
|
|
1458
1452
|
/**
|
|
1459
|
-
* <p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state
|
|
1460
|
-
*
|
|
1461
|
-
*
|
|
1462
|
-
*
|
|
1453
|
+
* <p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state
|
|
1454
|
+
* does not change during periods with too few data points to be statistically significant.
|
|
1455
|
+
* If <code>evaluate</code> or this parameter is not used, the alarm is always evaluated
|
|
1456
|
+
* and possibly changes state no matter how many data points are available.</p>
|
|
1463
1457
|
* @public
|
|
1464
1458
|
*/
|
|
1465
1459
|
EvaluateLowSampleCountPercentile?: string | undefined;
|
|
1466
1460
|
/**
|
|
1467
|
-
* <p>An array of MetricDataQuery structures, used in an alarm based on a
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1470
|
-
*
|
|
1471
|
-
* One item in the Metrics array is the math expression that the alarm watches.
|
|
1472
|
-
* This expression by designated by having <code>ReturnData</code> set to
|
|
1473
|
-
* true.</p>
|
|
1461
|
+
* <p>An array of MetricDataQuery structures, used in an alarm based on a metric math
|
|
1462
|
+
* expression. Each structure either retrieves a metric or performs a math expression. One
|
|
1463
|
+
* item in the Metrics array is the math expression that the alarm watches. This expression
|
|
1464
|
+
* by designated by having <code>ReturnData</code> set to true.</p>
|
|
1474
1465
|
* @public
|
|
1475
1466
|
*/
|
|
1476
1467
|
Metrics?: MetricDataQuery[] | undefined;
|
|
1477
1468
|
/**
|
|
1478
1469
|
* <p>In an alarm based on an anomaly detection model, this is the ID of the
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1470
|
+
* <code>ANOMALY_DETECTION_BAND</code> function used as the threshold for the
|
|
1471
|
+
* alarm.</p>
|
|
1481
1472
|
* @public
|
|
1482
1473
|
*/
|
|
1483
1474
|
ThresholdMetricId?: string | undefined;
|
|
1484
1475
|
/**
|
|
1485
|
-
* <p>If the value of this field is
|
|
1486
|
-
*
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create alarms on Metrics Insights queries</a>.</p>
|
|
1476
|
+
* <p>If the value of this field is <code>PARTIAL_DATA</code>, the alarm is being evaluated
|
|
1477
|
+
* based on only partial data. This happens if the query used for the alarm returns more
|
|
1478
|
+
* than 10,000 metrics. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create
|
|
1479
|
+
* alarms on Metrics Insights queries</a>.</p>
|
|
1490
1480
|
* @public
|
|
1491
1481
|
*/
|
|
1492
1482
|
EvaluationState?: EvaluationState | undefined;
|
|
1493
1483
|
/**
|
|
1494
|
-
* <p>The date and time that the alarm's <code>StateValue</code> most recently
|
|
1484
|
+
* <p>The date and time that the alarm's <code>StateValue</code> most recently
|
|
1485
|
+
* changed.</p>
|
|
1495
1486
|
* @public
|
|
1496
1487
|
*/
|
|
1497
1488
|
StateTransitionedTimestamp?: Date | undefined;
|
|
@@ -1531,20 +1522,20 @@ export interface DescribeAlarmsForMetricInput {
|
|
|
1531
1522
|
*/
|
|
1532
1523
|
Namespace: string | undefined;
|
|
1533
1524
|
/**
|
|
1534
|
-
* <p>The statistic for the metric, other than percentiles.
|
|
1535
|
-
*
|
|
1525
|
+
* <p>The statistic for the metric, other than percentiles. For percentile statistics,
|
|
1526
|
+
* use <code>ExtendedStatistics</code>.</p>
|
|
1536
1527
|
* @public
|
|
1537
1528
|
*/
|
|
1538
1529
|
Statistic?: Statistic | undefined;
|
|
1539
1530
|
/**
|
|
1540
|
-
* <p>The percentile statistic for the metric. Specify a value between
|
|
1541
|
-
*
|
|
1531
|
+
* <p>The percentile statistic for the metric. Specify a value between p0.0 and
|
|
1532
|
+
* p100.</p>
|
|
1542
1533
|
* @public
|
|
1543
1534
|
*/
|
|
1544
1535
|
ExtendedStatistic?: string | undefined;
|
|
1545
1536
|
/**
|
|
1546
1537
|
* <p>The dimensions associated with the metric. If the metric has any associated
|
|
1547
|
-
*
|
|
1538
|
+
* dimensions, you must specify them in order for the call to succeed.</p>
|
|
1548
1539
|
* @public
|
|
1549
1540
|
*/
|
|
1550
1541
|
Dimensions?: Dimension[] | undefined;
|
|
@@ -1574,41 +1565,43 @@ export interface DescribeAlarmsForMetricOutput {
|
|
|
1574
1565
|
*/
|
|
1575
1566
|
export interface DescribeAnomalyDetectorsInput {
|
|
1576
1567
|
/**
|
|
1577
|
-
* <p>Use the token returned by the previous operation to request the next page of
|
|
1568
|
+
* <p>Use the token returned by the previous operation to request the next page of
|
|
1569
|
+
* results.</p>
|
|
1578
1570
|
* @public
|
|
1579
1571
|
*/
|
|
1580
1572
|
NextToken?: string | undefined;
|
|
1581
1573
|
/**
|
|
1582
|
-
* <p>The maximum number of results to return in one operation. The maximum
|
|
1583
|
-
*
|
|
1574
|
+
* <p>The maximum number of results to return in one operation. The maximum value that you
|
|
1575
|
+
* can specify is 100.</p>
|
|
1584
1576
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1585
|
-
*
|
|
1577
|
+
* <code>NextToken</code> value. </p>
|
|
1586
1578
|
* @public
|
|
1587
1579
|
*/
|
|
1588
1580
|
MaxResults?: number | undefined;
|
|
1589
1581
|
/**
|
|
1590
|
-
* <p>Limits the results to only the anomaly detection models that
|
|
1591
|
-
*
|
|
1582
|
+
* <p>Limits the results to only the anomaly detection models that are associated with the
|
|
1583
|
+
* specified namespace.</p>
|
|
1592
1584
|
* @public
|
|
1593
1585
|
*/
|
|
1594
1586
|
Namespace?: string | undefined;
|
|
1595
1587
|
/**
|
|
1596
1588
|
* <p>Limits the results to only the anomaly detection models that are associated with the
|
|
1597
|
-
*
|
|
1598
|
-
*
|
|
1589
|
+
* specified metric name. If there are multiple metrics with this name in different
|
|
1590
|
+
* namespaces that have anomaly detection models, they're all returned.</p>
|
|
1599
1591
|
* @public
|
|
1600
1592
|
*/
|
|
1601
1593
|
MetricName?: string | undefined;
|
|
1602
1594
|
/**
|
|
1603
1595
|
* <p>Limits the results to only the anomaly detection models that are associated with the
|
|
1604
|
-
*
|
|
1605
|
-
*
|
|
1596
|
+
* specified metric dimensions. If there are multiple metrics that have these dimensions
|
|
1597
|
+
* and have anomaly detection models associated, they're all returned.</p>
|
|
1606
1598
|
* @public
|
|
1607
1599
|
*/
|
|
1608
1600
|
Dimensions?: Dimension[] | undefined;
|
|
1609
1601
|
/**
|
|
1610
|
-
* <p>The anomaly detector types to request when using
|
|
1611
|
-
*
|
|
1602
|
+
* <p>The anomaly detector types to request when using
|
|
1603
|
+
* <code>DescribeAnomalyDetectorsInput</code>. If empty, defaults to
|
|
1604
|
+
* <code>SINGLE_METRIC</code>.</p>
|
|
1612
1605
|
* @public
|
|
1613
1606
|
*/
|
|
1614
1607
|
AnomalyDetectorTypes?: AnomalyDetectorType[] | undefined;
|
|
@@ -1623,8 +1616,8 @@ export interface DescribeAnomalyDetectorsOutput {
|
|
|
1623
1616
|
*/
|
|
1624
1617
|
AnomalyDetectors?: AnomalyDetector[] | undefined;
|
|
1625
1618
|
/**
|
|
1626
|
-
* <p>A token that you can use in a subsequent operation to
|
|
1627
|
-
*
|
|
1619
|
+
* <p>A token that you can use in a subsequent operation to retrieve the next set of
|
|
1620
|
+
* results.</p>
|
|
1628
1621
|
* @public
|
|
1629
1622
|
*/
|
|
1630
1623
|
NextToken?: string | undefined;
|
|
@@ -1634,24 +1627,22 @@ export interface DescribeAnomalyDetectorsOutput {
|
|
|
1634
1627
|
*/
|
|
1635
1628
|
export interface DescribeInsightRulesInput {
|
|
1636
1629
|
/**
|
|
1637
|
-
* <p>Include this value, if it was returned by the previous operation, to get the next set
|
|
1630
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set
|
|
1631
|
+
* of rules.</p>
|
|
1638
1632
|
* @public
|
|
1639
1633
|
*/
|
|
1640
1634
|
NextToken?: string | undefined;
|
|
1641
1635
|
/**
|
|
1642
|
-
* <p>The maximum number of results to return in one operation. If you omit this
|
|
1643
|
-
*
|
|
1636
|
+
* <p>The maximum number of results to return in one operation. If you omit this parameter,
|
|
1637
|
+
* the default of 500 is used.</p>
|
|
1644
1638
|
* @public
|
|
1645
1639
|
*/
|
|
1646
1640
|
MaxResults?: number | undefined;
|
|
1647
1641
|
}
|
|
1648
1642
|
/**
|
|
1649
|
-
* <p>This structure contains the definition
|
|
1650
|
-
*
|
|
1651
|
-
*
|
|
1652
|
-
* see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">
|
|
1653
|
-
* Using Constributor Insights to analyze high-cardinality data</a>
|
|
1654
|
-
* in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1643
|
+
* <p>This structure contains the definition for a Contributor Insights rule. For more
|
|
1644
|
+
* information about this rule, see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html"> Using Constributor Insights to analyze high-cardinality data</a> in the
|
|
1645
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1655
1646
|
* @public
|
|
1656
1647
|
*/
|
|
1657
1648
|
export interface InsightRule {
|
|
@@ -1666,24 +1657,22 @@ export interface InsightRule {
|
|
|
1666
1657
|
*/
|
|
1667
1658
|
State: string | undefined;
|
|
1668
1659
|
/**
|
|
1669
|
-
* <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule",
|
|
1670
|
-
*
|
|
1660
|
+
* <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule",
|
|
1661
|
+
* "Version": 1\}</code>. For managed rules, this is <code>\{"Name": "ServiceLogRule",
|
|
1662
|
+
* "Version": 1\}</code>
|
|
1671
1663
|
* </p>
|
|
1672
1664
|
* @public
|
|
1673
1665
|
*/
|
|
1674
1666
|
Schema: string | undefined;
|
|
1675
1667
|
/**
|
|
1676
|
-
* <p>The definition of the rule, as a JSON object. The definition contains the keywords
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
* Rule Syntax</a>.</p>
|
|
1668
|
+
* <p>The definition of the rule, as a JSON object. The definition contains the keywords
|
|
1669
|
+
* used to define contributors, the value to aggregate on if this rule returns a sum
|
|
1670
|
+
* instead of a count, and the filters. For details on the valid syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights Rule Syntax</a>.</p>
|
|
1680
1671
|
* @public
|
|
1681
1672
|
*/
|
|
1682
1673
|
Definition: string | undefined;
|
|
1683
1674
|
/**
|
|
1684
|
-
* <p>
|
|
1685
|
-
* An optional built-in rule that Amazon Web Services manages.
|
|
1686
|
-
* </p>
|
|
1675
|
+
* <p> An optional built-in rule that Amazon Web Services manages. </p>
|
|
1687
1676
|
* @public
|
|
1688
1677
|
*/
|
|
1689
1678
|
ManagedRule?: boolean | undefined;
|
|
@@ -1693,7 +1682,8 @@ export interface InsightRule {
|
|
|
1693
1682
|
*/
|
|
1694
1683
|
export interface DescribeInsightRulesOutput {
|
|
1695
1684
|
/**
|
|
1696
|
-
* <p>If this parameter is present, it is a token that marks the start of the next batch of
|
|
1685
|
+
* <p>If this parameter is present, it is a token that marks the start of the next batch of
|
|
1686
|
+
* returned results. </p>
|
|
1697
1687
|
* @public
|
|
1698
1688
|
*/
|
|
1699
1689
|
NextToken?: string | undefined;
|
|
@@ -1734,7 +1724,8 @@ export interface DisableAlarmActionsInput {
|
|
|
1734
1724
|
*/
|
|
1735
1725
|
export interface DisableInsightRulesInput {
|
|
1736
1726
|
/**
|
|
1737
|
-
* <p>An array of the rule names to disable. If you need to find out the names of your
|
|
1727
|
+
* <p>An array of the rule names to disable. If you need to find out the names of your
|
|
1728
|
+
* rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1738
1729
|
* @public
|
|
1739
1730
|
*/
|
|
1740
1731
|
RuleNames: string[] | undefined;
|
|
@@ -1744,7 +1735,8 @@ export interface DisableInsightRulesInput {
|
|
|
1744
1735
|
*/
|
|
1745
1736
|
export interface DisableInsightRulesOutput {
|
|
1746
1737
|
/**
|
|
1747
|
-
* <p>An array listing the rules that could not be disabled. You cannot disable built-in
|
|
1738
|
+
* <p>An array listing the rules that could not be disabled. You cannot disable built-in
|
|
1739
|
+
* rules.</p>
|
|
1748
1740
|
* @public
|
|
1749
1741
|
*/
|
|
1750
1742
|
Failures?: PartialFailure[] | undefined;
|
|
@@ -1764,7 +1756,8 @@ export interface EnableAlarmActionsInput {
|
|
|
1764
1756
|
*/
|
|
1765
1757
|
export interface EnableInsightRulesInput {
|
|
1766
1758
|
/**
|
|
1767
|
-
* <p>An array of the rule names to enable. If you need to find out the names of your rules,
|
|
1759
|
+
* <p>An array of the rule names to enable. If you need to find out the names of your rules,
|
|
1760
|
+
* use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1768
1761
|
* @public
|
|
1769
1762
|
*/
|
|
1770
1763
|
RuleNames: string[] | undefined;
|
|
@@ -1774,7 +1767,8 @@ export interface EnableInsightRulesInput {
|
|
|
1774
1767
|
*/
|
|
1775
1768
|
export interface EnableInsightRulesOutput {
|
|
1776
1769
|
/**
|
|
1777
|
-
* <p>An array listing the rules that could not be enabled. You cannot disable or enable
|
|
1770
|
+
* <p>An array listing the rules that could not be enabled. You cannot disable or enable
|
|
1771
|
+
* built-in rules.</p>
|
|
1778
1772
|
* @public
|
|
1779
1773
|
*/
|
|
1780
1774
|
Failures?: PartialFailure[] | undefined;
|
|
@@ -1792,6 +1786,162 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1792
1786
|
*/
|
|
1793
1787
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1794
1788
|
}
|
|
1789
|
+
/**
|
|
1790
|
+
* <p>An entity associated with metrics, to allow for finding related telemetry. An entity
|
|
1791
|
+
* is typically a resource or service within your system. For example, metrics from an
|
|
1792
|
+
* Amazon EC2 instance could be associated with that instance as the entity.
|
|
1793
|
+
* Similarly, metrics from a service that you own could be associated with that service as
|
|
1794
|
+
* the entity.</p>
|
|
1795
|
+
* @public
|
|
1796
|
+
*/
|
|
1797
|
+
export interface Entity {
|
|
1798
|
+
/**
|
|
1799
|
+
* <p>The attributes of the entity which identify the specific entity, as a list of
|
|
1800
|
+
* key-value pairs. Entities with the same <code>KeyAttributes</code> are considered to be
|
|
1801
|
+
* the same entity. For an entity to be valid, the <code>KeyAttributes</code> must exist
|
|
1802
|
+
* and be formatted correctly.</p>
|
|
1803
|
+
* <p>There are five allowed attributes (key names): <code>Type</code>,
|
|
1804
|
+
* <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and
|
|
1805
|
+
* <code>Environment</code>.</p>
|
|
1806
|
+
* <p>For details about how to use the key attributes to specify an entity, see <a href="https://docs.aws.amazon.com/adding-your-own-related-telemetry.html">How to add related
|
|
1807
|
+
* information to telemetry</a> in the <i>CloudWatch User
|
|
1808
|
+
* Guide</i>.</p>
|
|
1809
|
+
* @public
|
|
1810
|
+
*/
|
|
1811
|
+
KeyAttributes?: Record<string, string> | undefined;
|
|
1812
|
+
/**
|
|
1813
|
+
* <p>Additional attributes of the entity that are not used to specify the identity of the
|
|
1814
|
+
* entity. A list of key-value pairs.</p>
|
|
1815
|
+
* <p>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/adding-your-own-related-telemetry.html">How to add related information to
|
|
1816
|
+
* telemetry</a> in the <i>CloudWatch User Guide</i>.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
Attributes?: Record<string, string> | undefined;
|
|
1820
|
+
}
|
|
1821
|
+
/**
|
|
1822
|
+
* <p>Represents a set of statistics that describes a specific metric. </p>
|
|
1823
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
export interface StatisticSet {
|
|
1826
|
+
/**
|
|
1827
|
+
* <p>The number of samples used for the statistic set.</p>
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
SampleCount: number | undefined;
|
|
1831
|
+
/**
|
|
1832
|
+
* <p>The sum of values for the sample set.</p>
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
Sum: number | undefined;
|
|
1836
|
+
/**
|
|
1837
|
+
* <p>The minimum value of the sample set.</p>
|
|
1838
|
+
* @public
|
|
1839
|
+
*/
|
|
1840
|
+
Minimum: number | undefined;
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>The maximum value of the sample set.</p>
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
Maximum: number | undefined;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* <p>Encapsulates the information sent to either create a metric or add new values to be
|
|
1849
|
+
* aggregated into an existing metric.</p>
|
|
1850
|
+
* @public
|
|
1851
|
+
*/
|
|
1852
|
+
export interface MetricDatum {
|
|
1853
|
+
/**
|
|
1854
|
+
* <p>The name of the metric.</p>
|
|
1855
|
+
* @public
|
|
1856
|
+
*/
|
|
1857
|
+
MetricName: string | undefined;
|
|
1858
|
+
/**
|
|
1859
|
+
* <p>The dimensions associated with the metric. </p>
|
|
1860
|
+
* @public
|
|
1861
|
+
*/
|
|
1862
|
+
Dimensions?: Dimension[] | undefined;
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>The time the metric data was received, expressed as the number of milliseconds
|
|
1865
|
+
* since Jan 1, 1970 00:00:00 UTC.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
Timestamp?: Date | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The value for the metric.</p>
|
|
1871
|
+
* <p>Although the parameter accepts numbers of type Double, CloudWatch rejects values
|
|
1872
|
+
* that are either too small or too large. Values must be in the range of -2^360 to 2^360.
|
|
1873
|
+
* In addition, special values (for example, NaN, +Infinity, -Infinity) are not
|
|
1874
|
+
* supported.</p>
|
|
1875
|
+
* @public
|
|
1876
|
+
*/
|
|
1877
|
+
Value?: number | undefined;
|
|
1878
|
+
/**
|
|
1879
|
+
* <p>The statistical values for the metric.</p>
|
|
1880
|
+
* @public
|
|
1881
|
+
*/
|
|
1882
|
+
StatisticValues?: StatisticSet | undefined;
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>Array of numbers representing the values for the metric during the period. Each unique
|
|
1885
|
+
* value is listed just once in this array, and the corresponding number in the
|
|
1886
|
+
* <code>Counts</code> array specifies the number of times that value occurred during
|
|
1887
|
+
* the period. You can include up to 150 unique values in each <code>PutMetricData</code>
|
|
1888
|
+
* action that specifies a <code>Values</code> array.</p>
|
|
1889
|
+
* <p>Although the <code>Values</code> array accepts numbers of type <code>Double</code>,
|
|
1890
|
+
* CloudWatch rejects values that are either too small or too large. Values must be in the
|
|
1891
|
+
* range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
|
|
1892
|
+
* -Infinity) are not supported.</p>
|
|
1893
|
+
* @public
|
|
1894
|
+
*/
|
|
1895
|
+
Values?: number[] | undefined;
|
|
1896
|
+
/**
|
|
1897
|
+
* <p>Array of numbers that is used along with the <code>Values</code> array. Each number in
|
|
1898
|
+
* the <code>Count</code> array is the number of times the corresponding value in the
|
|
1899
|
+
* <code>Values</code> array occurred during the period. </p>
|
|
1900
|
+
* <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for
|
|
1901
|
+
* each count. If you include a <code>Counts</code> array, it must include the same amount
|
|
1902
|
+
* of values as the <code>Values</code> array.</p>
|
|
1903
|
+
* @public
|
|
1904
|
+
*/
|
|
1905
|
+
Counts?: number[] | undefined;
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>When you are using a <code>Put</code> operation, this defines what unit you want to
|
|
1908
|
+
* use when storing the metric.</p>
|
|
1909
|
+
* <p>In a <code>Get</code> operation, this displays the unit that is used for the
|
|
1910
|
+
* metric.</p>
|
|
1911
|
+
* @public
|
|
1912
|
+
*/
|
|
1913
|
+
Unit?: StandardUnit | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* <p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a
|
|
1916
|
+
* high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution
|
|
1917
|
+
* down to one second. Setting this to 60 specifies this metric as a regular-resolution
|
|
1918
|
+
* metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is
|
|
1919
|
+
* available only for custom metrics. For more information about high-resolution metrics,
|
|
1920
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics">High-Resolution Metrics</a> in the <i>Amazon CloudWatch User
|
|
1921
|
+
* Guide</i>. </p>
|
|
1922
|
+
* <p>This field is optional, if you do not specify it the default of 60 is
|
|
1923
|
+
* used.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
StorageResolution?: number | undefined;
|
|
1927
|
+
}
|
|
1928
|
+
/**
|
|
1929
|
+
* <p>A set of metrics that are associated with an entity, such as a specific service
|
|
1930
|
+
* or resource. Contains the entity and the list of metric data associated with it.</p>
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
export interface EntityMetricData {
|
|
1934
|
+
/**
|
|
1935
|
+
* <p>The entity associated with the metrics.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
Entity?: Entity | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* <p>The metric data.</p>
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
MetricData?: MetricDatum[] | undefined;
|
|
1944
|
+
}
|
|
1795
1945
|
/**
|
|
1796
1946
|
* @public
|
|
1797
1947
|
*/
|
|
@@ -1812,9 +1962,9 @@ export interface GetDashboardOutput {
|
|
|
1812
1962
|
*/
|
|
1813
1963
|
DashboardArn?: string | undefined;
|
|
1814
1964
|
/**
|
|
1815
|
-
* <p>The detailed information about the dashboard, including what widgets are included
|
|
1816
|
-
*
|
|
1817
|
-
*
|
|
1965
|
+
* <p>The detailed information about the dashboard, including what widgets are included
|
|
1966
|
+
* and their location on the dashboard. For more information about the
|
|
1967
|
+
* <code>DashboardBody</code> syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>. </p>
|
|
1818
1968
|
* @public
|
|
1819
1969
|
*/
|
|
1820
1970
|
DashboardBody?: string | undefined;
|
|
@@ -1834,79 +1984,89 @@ export interface GetInsightRuleReportInput {
|
|
|
1834
1984
|
*/
|
|
1835
1985
|
RuleName: string | undefined;
|
|
1836
1986
|
/**
|
|
1837
|
-
* <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
1838
|
-
*
|
|
1839
|
-
*
|
|
1987
|
+
* <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
1988
|
+
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
1989
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
1840
1990
|
* @public
|
|
1841
1991
|
*/
|
|
1842
1992
|
StartTime: Date | undefined;
|
|
1843
1993
|
/**
|
|
1844
|
-
* <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
1845
|
-
*
|
|
1846
|
-
*
|
|
1994
|
+
* <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
1995
|
+
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
1996
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
1847
1997
|
* @public
|
|
1848
1998
|
*/
|
|
1849
1999
|
EndTime: Date | undefined;
|
|
1850
2000
|
/**
|
|
1851
|
-
* <p>The period, in seconds, to use for the statistics in the
|
|
2001
|
+
* <p>The period, in seconds, to use for the statistics in the
|
|
2002
|
+
* <code>InsightRuleMetricDatapoint</code> results.</p>
|
|
1852
2003
|
* @public
|
|
1853
2004
|
*/
|
|
1854
2005
|
Period: number | undefined;
|
|
1855
2006
|
/**
|
|
1856
|
-
* <p>The maximum number of contributors to include in the report. The range is 1 to 100. If
|
|
2007
|
+
* <p>The maximum number of contributors to include in the report. The range is 1 to 100. If
|
|
2008
|
+
* you omit this, the default of 10 is used.</p>
|
|
1857
2009
|
* @public
|
|
1858
2010
|
*/
|
|
1859
2011
|
MaxContributorCount?: number | undefined;
|
|
1860
2012
|
/**
|
|
1861
|
-
* <p>Specifies which metrics to use for aggregation of contributor values for the report.
|
|
1862
|
-
*
|
|
2013
|
+
* <p>Specifies which metrics to use for aggregation of contributor values for the report.
|
|
2014
|
+
* You can specify one or more of the following metrics:</p>
|
|
1863
2015
|
* <ul>
|
|
1864
2016
|
* <li>
|
|
1865
2017
|
* <p>
|
|
1866
|
-
* <code>UniqueContributors</code> -- the number of unique contributors for each
|
|
2018
|
+
* <code>UniqueContributors</code> -- the number of unique contributors for each
|
|
2019
|
+
* data point.</p>
|
|
1867
2020
|
* </li>
|
|
1868
2021
|
* <li>
|
|
1869
2022
|
* <p>
|
|
1870
|
-
* <code>MaxContributorValue</code> -- the value of the top contributor for each
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1873
|
-
*
|
|
1874
|
-
*
|
|
2023
|
+
* <code>MaxContributorValue</code> -- the value of the top contributor for each
|
|
2024
|
+
* data point. The identity of the contributor might change for each data point in
|
|
2025
|
+
* the graph.</p>
|
|
2026
|
+
* <p>If this rule aggregates by COUNT, the top contributor for each data point is
|
|
2027
|
+
* the contributor with the most occurrences in that period. If the rule aggregates
|
|
2028
|
+
* by SUM, the top contributor is the contributor with the highest sum in the log
|
|
2029
|
+
* field specified by the rule's <code>Value</code>, during that period.</p>
|
|
1875
2030
|
* </li>
|
|
1876
2031
|
* <li>
|
|
1877
2032
|
* <p>
|
|
1878
|
-
* <code>SampleCount</code> -- the number of data points matched by the
|
|
2033
|
+
* <code>SampleCount</code> -- the number of data points matched by the
|
|
2034
|
+
* rule.</p>
|
|
1879
2035
|
* </li>
|
|
1880
2036
|
* <li>
|
|
1881
2037
|
* <p>
|
|
1882
|
-
* <code>Sum</code> -- the sum of the values from all contributors during the
|
|
2038
|
+
* <code>Sum</code> -- the sum of the values from all contributors during the
|
|
2039
|
+
* time period represented by that data point.</p>
|
|
1883
2040
|
* </li>
|
|
1884
2041
|
* <li>
|
|
1885
2042
|
* <p>
|
|
1886
|
-
* <code>Minimum</code> -- the minimum value from a single observation during the
|
|
2043
|
+
* <code>Minimum</code> -- the minimum value from a single observation during the
|
|
2044
|
+
* time period represented by that data point.</p>
|
|
1887
2045
|
* </li>
|
|
1888
2046
|
* <li>
|
|
1889
2047
|
* <p>
|
|
1890
|
-
* <code>Maximum</code> -- the maximum value from a single observation during the
|
|
2048
|
+
* <code>Maximum</code> -- the maximum value from a single observation during the
|
|
2049
|
+
* time period represented by that data point.</p>
|
|
1891
2050
|
* </li>
|
|
1892
2051
|
* <li>
|
|
1893
2052
|
* <p>
|
|
1894
|
-
* <code>Average</code> -- the average value from all contributors during the
|
|
2053
|
+
* <code>Average</code> -- the average value from all contributors during the
|
|
2054
|
+
* time period represented by that data point.</p>
|
|
1895
2055
|
* </li>
|
|
1896
2056
|
* </ul>
|
|
1897
2057
|
* @public
|
|
1898
2058
|
*/
|
|
1899
2059
|
Metrics?: string[] | undefined;
|
|
1900
2060
|
/**
|
|
1901
|
-
* <p>Determines what statistic to use to rank the contributors. Valid values are
|
|
2061
|
+
* <p>Determines what statistic to use to rank the contributors. Valid values are
|
|
2062
|
+
* <code>Sum</code> and <code>Maximum</code>.</p>
|
|
1902
2063
|
* @public
|
|
1903
2064
|
*/
|
|
1904
2065
|
OrderBy?: string | undefined;
|
|
1905
2066
|
}
|
|
1906
2067
|
/**
|
|
1907
2068
|
* <p>One data point related to one contributor.</p>
|
|
1908
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a> and
|
|
1909
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html">InsightRuleContributor</a>.</p>
|
|
2069
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html">InsightRuleContributor</a>.</p>
|
|
1910
2070
|
* @public
|
|
1911
2071
|
*/
|
|
1912
2072
|
export interface InsightRuleContributorDatapoint {
|
|
@@ -1922,15 +2082,18 @@ export interface InsightRuleContributorDatapoint {
|
|
|
1922
2082
|
ApproximateValue: number | undefined;
|
|
1923
2083
|
}
|
|
1924
2084
|
/**
|
|
1925
|
-
* <p>One of the unique contributors found by a Contributor Insights rule. If the rule
|
|
1926
|
-
*
|
|
1927
|
-
*
|
|
2085
|
+
* <p>One of the unique contributors found by a Contributor Insights rule. If the rule
|
|
2086
|
+
* contains multiple keys, then a unique contributor is a unique combination of values from
|
|
2087
|
+
* all the keys in the rule.</p>
|
|
2088
|
+
* <p>If the rule contains a single key, then each unique contributor is each unique value
|
|
2089
|
+
* for this key.</p>
|
|
1928
2090
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
|
|
1929
2091
|
* @public
|
|
1930
2092
|
*/
|
|
1931
2093
|
export interface InsightRuleContributor {
|
|
1932
2094
|
/**
|
|
1933
|
-
* <p>One of the log entry field keywords that is used to define contributors for this
|
|
2095
|
+
* <p>One of the log entry field keywords that is used to define contributors for this
|
|
2096
|
+
* rule.</p>
|
|
1934
2097
|
* @public
|
|
1935
2098
|
*/
|
|
1936
2099
|
Keys: string[] | undefined;
|
|
@@ -1940,13 +2103,15 @@ export interface InsightRuleContributor {
|
|
|
1940
2103
|
*/
|
|
1941
2104
|
ApproximateAggregateValue: number | undefined;
|
|
1942
2105
|
/**
|
|
1943
|
-
* <p>An array of the data points where this contributor is present. Only the data points
|
|
2106
|
+
* <p>An array of the data points where this contributor is present. Only the data points
|
|
2107
|
+
* when this contributor appeared are included in the array.</p>
|
|
1944
2108
|
* @public
|
|
1945
2109
|
*/
|
|
1946
2110
|
Datapoints: InsightRuleContributorDatapoint[] | undefined;
|
|
1947
2111
|
}
|
|
1948
2112
|
/**
|
|
1949
|
-
* <p>One data point from the metric time series returned in a Contributor Insights rule
|
|
2113
|
+
* <p>One data point from the metric time series returned in a Contributor Insights rule
|
|
2114
|
+
* report.</p>
|
|
1950
2115
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
|
|
1951
2116
|
* @public
|
|
1952
2117
|
*/
|
|
@@ -1958,45 +2123,56 @@ export interface InsightRuleMetricDatapoint {
|
|
|
1958
2123
|
Timestamp: Date | undefined;
|
|
1959
2124
|
/**
|
|
1960
2125
|
* <p>The number of unique contributors who published data during this timestamp.</p>
|
|
1961
|
-
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2126
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2127
|
+
* in your request.</p>
|
|
1962
2128
|
* @public
|
|
1963
2129
|
*/
|
|
1964
2130
|
UniqueContributors?: number | undefined;
|
|
1965
2131
|
/**
|
|
1966
|
-
* <p>The maximum value provided by one contributor during this timestamp. Each timestamp is
|
|
1967
|
-
*
|
|
1968
|
-
*
|
|
1969
|
-
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2132
|
+
* <p>The maximum value provided by one contributor during this timestamp. Each timestamp is
|
|
2133
|
+
* evaluated separately, so the identity of the max contributor could be different for each
|
|
2134
|
+
* timestamp.</p>
|
|
2135
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2136
|
+
* in your request.</p>
|
|
1970
2137
|
* @public
|
|
1971
2138
|
*/
|
|
1972
2139
|
MaxContributorValue?: number | undefined;
|
|
1973
2140
|
/**
|
|
1974
2141
|
* <p>The number of occurrences that matched the rule during this data point.</p>
|
|
1975
|
-
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2142
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2143
|
+
* in your request.</p>
|
|
1976
2144
|
* @public
|
|
1977
2145
|
*/
|
|
1978
2146
|
SampleCount?: number | undefined;
|
|
1979
2147
|
/**
|
|
1980
|
-
* <p>The average value from all contributors during the time period represented by that
|
|
1981
|
-
*
|
|
2148
|
+
* <p>The average value from all contributors during the time period represented by that
|
|
2149
|
+
* data point.</p>
|
|
2150
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2151
|
+
* in your request.</p>
|
|
1982
2152
|
* @public
|
|
1983
2153
|
*/
|
|
1984
2154
|
Average?: number | undefined;
|
|
1985
2155
|
/**
|
|
1986
|
-
* <p>The sum of the values from all contributors during the time period represented by that
|
|
1987
|
-
*
|
|
2156
|
+
* <p>The sum of the values from all contributors during the time period represented by that
|
|
2157
|
+
* data point.</p>
|
|
2158
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2159
|
+
* in your request.</p>
|
|
1988
2160
|
* @public
|
|
1989
2161
|
*/
|
|
1990
2162
|
Sum?: number | undefined;
|
|
1991
2163
|
/**
|
|
1992
|
-
* <p>The minimum value from a single contributor during the time period represented by that
|
|
1993
|
-
*
|
|
2164
|
+
* <p>The minimum value from a single contributor during the time period represented by that
|
|
2165
|
+
* data point.</p>
|
|
2166
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2167
|
+
* in your request.</p>
|
|
1994
2168
|
* @public
|
|
1995
2169
|
*/
|
|
1996
2170
|
Minimum?: number | undefined;
|
|
1997
2171
|
/**
|
|
1998
|
-
* <p>The maximum value from a single occurence from a single contributor during the time
|
|
1999
|
-
*
|
|
2172
|
+
* <p>The maximum value from a single occurence from a single contributor during the time
|
|
2173
|
+
* period represented by that data point.</p>
|
|
2174
|
+
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array
|
|
2175
|
+
* in your request.</p>
|
|
2000
2176
|
* @public
|
|
2001
2177
|
*/
|
|
2002
2178
|
Maximum?: number | undefined;
|
|
@@ -2006,8 +2182,9 @@ export interface InsightRuleMetricDatapoint {
|
|
|
2006
2182
|
*/
|
|
2007
2183
|
export interface GetInsightRuleReportOutput {
|
|
2008
2184
|
/**
|
|
2009
|
-
* <p>An array of the strings used as the keys for this rule. The keys are the dimensions
|
|
2010
|
-
*
|
|
2185
|
+
* <p>An array of the strings used as the keys for this rule. The keys are the dimensions
|
|
2186
|
+
* used to classify contributors. If the rule contains more than one key, then each unique
|
|
2187
|
+
* combination of values for the keys is counted as a unique contributor.</p>
|
|
2011
2188
|
* @public
|
|
2012
2189
|
*/
|
|
2013
2190
|
KeyLabels?: string[] | undefined;
|
|
@@ -2022,39 +2199,42 @@ export interface GetInsightRuleReportOutput {
|
|
|
2022
2199
|
*/
|
|
2023
2200
|
AggregateValue?: number | undefined;
|
|
2024
2201
|
/**
|
|
2025
|
-
* <p>An approximate count of the unique contributors found by this rule in this time
|
|
2202
|
+
* <p>An approximate count of the unique contributors found by this rule in this time
|
|
2203
|
+
* period.</p>
|
|
2026
2204
|
* @public
|
|
2027
2205
|
*/
|
|
2028
2206
|
ApproximateUniqueCount?: number | undefined;
|
|
2029
2207
|
/**
|
|
2030
|
-
* <p>An array of the unique contributors found by this rule in this time period. If the
|
|
2031
|
-
*
|
|
2208
|
+
* <p>An array of the unique contributors found by this rule in this time period. If the
|
|
2209
|
+
* rule contains multiple keys, each combination of values for the keys counts as a unique
|
|
2210
|
+
* contributor.</p>
|
|
2032
2211
|
* @public
|
|
2033
2212
|
*/
|
|
2034
2213
|
Contributors?: InsightRuleContributor[] | undefined;
|
|
2035
2214
|
/**
|
|
2036
|
-
* <p>A time series of metric data points that matches the time period in the rule
|
|
2215
|
+
* <p>A time series of metric data points that matches the time period in the rule
|
|
2216
|
+
* request.</p>
|
|
2037
2217
|
* @public
|
|
2038
2218
|
*/
|
|
2039
2219
|
MetricDatapoints?: InsightRuleMetricDatapoint[] | undefined;
|
|
2040
2220
|
}
|
|
2041
2221
|
/**
|
|
2042
|
-
* <p>This structure includes the <code>Timezone</code> parameter, which you can use
|
|
2043
|
-
*
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2046
|
-
*
|
|
2047
|
-
*
|
|
2048
|
-
*
|
|
2222
|
+
* <p>This structure includes the <code>Timezone</code> parameter, which you can use to
|
|
2223
|
+
* specify your time zone so that the labels that are associated with returned metrics
|
|
2224
|
+
* display the correct time for your time zone. </p>
|
|
2225
|
+
* <p>The <code>Timezone</code> value affects a label only if you have a time-based dynamic
|
|
2226
|
+
* expression in the label. For more information about dynamic expressions in labels, see
|
|
2227
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic
|
|
2228
|
+
* Labels</a>.</p>
|
|
2049
2229
|
* @public
|
|
2050
2230
|
*/
|
|
2051
2231
|
export interface LabelOptions {
|
|
2052
2232
|
/**
|
|
2053
|
-
* <p>The time zone to use for metric data return in this operation.
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2057
|
-
*
|
|
2233
|
+
* <p>The time zone to use for metric data return in this operation. The format is
|
|
2234
|
+
* <code>+</code> or <code>-</code> followed by four digits. The first two digits
|
|
2235
|
+
* indicate the number of hours ahead or behind of UTC, and the final two digits are the
|
|
2236
|
+
* number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
|
|
2237
|
+
* minutes ahead of UTC. The default is +0000. </p>
|
|
2058
2238
|
* @public
|
|
2059
2239
|
*/
|
|
2060
2240
|
Timezone?: string | undefined;
|
|
@@ -2065,92 +2245,96 @@ export interface LabelOptions {
|
|
|
2065
2245
|
export interface GetMetricDataInput {
|
|
2066
2246
|
/**
|
|
2067
2247
|
* <p>The metric queries to be returned. A single <code>GetMetricData</code> call can
|
|
2068
|
-
*
|
|
2069
|
-
*
|
|
2070
|
-
*
|
|
2248
|
+
* include as many as 500 <code>MetricDataQuery</code> structures. Each of these structures
|
|
2249
|
+
* can specify either a metric to retrieve, a Metrics Insights query, or a math expression
|
|
2250
|
+
* to perform on retrieved data. </p>
|
|
2071
2251
|
* @public
|
|
2072
2252
|
*/
|
|
2073
2253
|
MetricDataQueries: MetricDataQuery[] | undefined;
|
|
2074
2254
|
/**
|
|
2075
2255
|
* <p>The time stamp indicating the earliest data to be returned.</p>
|
|
2076
|
-
* <p>The value specified is inclusive; results include data points with the specified
|
|
2256
|
+
* <p>The value specified is inclusive; results include data points with the specified
|
|
2257
|
+
* time stamp. </p>
|
|
2077
2258
|
* <p>CloudWatch rounds the specified time stamp as follows:</p>
|
|
2078
2259
|
* <ul>
|
|
2079
2260
|
* <li>
|
|
2080
2261
|
* <p>Start time less than 15 days ago - Round down to the nearest whole minute.
|
|
2081
|
-
*
|
|
2262
|
+
* For example, 12:32:34 is rounded down to 12:32:00.</p>
|
|
2082
2263
|
* </li>
|
|
2083
2264
|
* <li>
|
|
2084
|
-
* <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute
|
|
2085
|
-
*
|
|
2265
|
+
* <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute
|
|
2266
|
+
* clock interval. For example, 12:32:34 is rounded down to 12:30:00.</p>
|
|
2086
2267
|
* </li>
|
|
2087
2268
|
* <li>
|
|
2088
|
-
* <p>Start time greater than 63 days ago - Round down to the nearest 1-hour
|
|
2089
|
-
*
|
|
2269
|
+
* <p>Start time greater than 63 days ago - Round down to the nearest 1-hour
|
|
2270
|
+
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2090
2271
|
* </li>
|
|
2091
2272
|
* </ul>
|
|
2092
2273
|
* <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is
|
|
2093
|
-
*
|
|
2094
|
-
*
|
|
2095
|
-
*
|
|
2096
|
-
*
|
|
2097
|
-
*
|
|
2098
|
-
*
|
|
2099
|
-
*
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2102
|
-
*
|
|
2103
|
-
*
|
|
2104
|
-
* from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>
|
|
2274
|
+
* rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second
|
|
2275
|
+
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2276
|
+
* previous 10-second period, the start time of your request is rounded down and you
|
|
2277
|
+
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
2278
|
+
* 5 minutes of data, using a period of 5 seconds, you receive data timestamped between
|
|
2279
|
+
* 15:02:15 and 15:07:15. </p>
|
|
2280
|
+
* <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values
|
|
2281
|
+
* that align with the value of the metric's <code>Period</code> and sync up with the
|
|
2282
|
+
* beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5
|
|
2283
|
+
* minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response
|
|
2284
|
+
* from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>
|
|
2105
2285
|
* @public
|
|
2106
2286
|
*/
|
|
2107
2287
|
StartTime: Date | undefined;
|
|
2108
2288
|
/**
|
|
2109
2289
|
* <p>The time stamp indicating the latest data to be returned.</p>
|
|
2110
|
-
* <p>The value specified is exclusive; results include data points up to the specified
|
|
2111
|
-
*
|
|
2112
|
-
*
|
|
2113
|
-
*
|
|
2114
|
-
*
|
|
2115
|
-
*
|
|
2290
|
+
* <p>The value specified is exclusive; results include data points up to the specified
|
|
2291
|
+
* time stamp.</p>
|
|
2292
|
+
* <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code> values
|
|
2293
|
+
* that align with the value of the metric's <code>Period</code> and sync up with the
|
|
2294
|
+
* beginning and end of an hour. For example, if the <code>Period</code> of a metric is 5
|
|
2295
|
+
* minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response
|
|
2296
|
+
* from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>
|
|
2116
2297
|
* @public
|
|
2117
2298
|
*/
|
|
2118
2299
|
EndTime: Date | undefined;
|
|
2119
2300
|
/**
|
|
2120
|
-
* <p>Include this value, if it was returned by the previous <code>GetMetricData</code>
|
|
2121
|
-
*
|
|
2301
|
+
* <p>Include this value, if it was returned by the previous <code>GetMetricData</code>
|
|
2302
|
+
* operation, to get the next set of data points.</p>
|
|
2122
2303
|
* @public
|
|
2123
2304
|
*/
|
|
2124
2305
|
NextToken?: string | undefined;
|
|
2125
2306
|
/**
|
|
2126
|
-
* <p>The order in which data points should be returned. <code>TimestampDescending</code>
|
|
2127
|
-
*
|
|
2128
|
-
*
|
|
2129
|
-
*
|
|
2307
|
+
* <p>The order in which data points should be returned. <code>TimestampDescending</code>
|
|
2308
|
+
* returns the newest data first and paginates when the <code>MaxDatapoints</code> limit is
|
|
2309
|
+
* reached. <code>TimestampAscending</code> returns the oldest data first and paginates
|
|
2310
|
+
* when the <code>MaxDatapoints</code> limit is reached.</p>
|
|
2311
|
+
* <p>If you omit this parameter, the default of <code>TimestampDescending</code> is
|
|
2312
|
+
* used.</p>
|
|
2130
2313
|
* @public
|
|
2131
2314
|
*/
|
|
2132
2315
|
ScanBy?: ScanBy | undefined;
|
|
2133
2316
|
/**
|
|
2134
|
-
* <p>The maximum number of data points the request should return before paginating. If you
|
|
2135
|
-
*
|
|
2317
|
+
* <p>The maximum number of data points the request should return before paginating. If you
|
|
2318
|
+
* omit this, the default of 100,800 is used.</p>
|
|
2136
2319
|
* @public
|
|
2137
2320
|
*/
|
|
2138
2321
|
MaxDatapoints?: number | undefined;
|
|
2139
2322
|
/**
|
|
2140
|
-
* <p>This structure includes the <code>Timezone</code> parameter, which you can use
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
* for your time zone. </p>
|
|
2323
|
+
* <p>This structure includes the <code>Timezone</code> parameter, which you can use to
|
|
2324
|
+
* specify your time zone so that the labels of returned data display the correct time for
|
|
2325
|
+
* your time zone. </p>
|
|
2144
2326
|
* @public
|
|
2145
2327
|
*/
|
|
2146
2328
|
LabelOptions?: LabelOptions | undefined;
|
|
2147
2329
|
}
|
|
2148
2330
|
/**
|
|
2149
|
-
* <p>A message returned by the <code>GetMetricData</code>API, including a code and a
|
|
2150
|
-
*
|
|
2151
|
-
*
|
|
2152
|
-
*
|
|
2153
|
-
*
|
|
2331
|
+
* <p>A message returned by the <code>GetMetricData</code>API, including a code and a
|
|
2332
|
+
* description.</p>
|
|
2333
|
+
* <p>If a cross-Region <code>GetMetricData</code> operation fails with a code of
|
|
2334
|
+
* <code>Forbidden</code> and a value of <code>Authentication too complex to retrieve
|
|
2335
|
+
* cross region data</code>, you can correct the problem by running the
|
|
2336
|
+
* <code>GetMetricData</code> operation in the same Region where the metric data
|
|
2337
|
+
* is.</p>
|
|
2154
2338
|
* @public
|
|
2155
2339
|
*/
|
|
2156
2340
|
export interface MessageData {
|
|
@@ -2181,8 +2365,8 @@ export declare const StatusCode: {
|
|
|
2181
2365
|
export type StatusCode = (typeof StatusCode)[keyof typeof StatusCode];
|
|
2182
2366
|
/**
|
|
2183
2367
|
* <p>A <code>GetMetricData</code> call returns an array of <code>MetricDataResult</code>
|
|
2184
|
-
*
|
|
2185
|
-
*
|
|
2368
|
+
* structures. Each of these structures includes the data points for that metric, along
|
|
2369
|
+
* with the timestamps of those data points and other identifying information.</p>
|
|
2186
2370
|
* @public
|
|
2187
2371
|
*/
|
|
2188
2372
|
export interface MetricDataResult {
|
|
@@ -2198,24 +2382,26 @@ export interface MetricDataResult {
|
|
|
2198
2382
|
Label?: string | undefined;
|
|
2199
2383
|
/**
|
|
2200
2384
|
* <p>The timestamps for the data points, formatted in Unix timestamp format. The number of
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2385
|
+
* timestamps always matches the number of values and the value for Timestamps[x] is
|
|
2386
|
+
* Values[x].</p>
|
|
2203
2387
|
* @public
|
|
2204
2388
|
*/
|
|
2205
2389
|
Timestamps?: Date[] | undefined;
|
|
2206
2390
|
/**
|
|
2207
2391
|
* <p>The data points for the metric corresponding to <code>Timestamps</code>. The number of
|
|
2208
|
-
*
|
|
2209
|
-
*
|
|
2392
|
+
* values always matches the number of timestamps and the timestamp for Values[x] is
|
|
2393
|
+
* Timestamps[x].</p>
|
|
2210
2394
|
* @public
|
|
2211
2395
|
*/
|
|
2212
2396
|
Values?: number[] | undefined;
|
|
2213
2397
|
/**
|
|
2214
|
-
* <p>The status of the returned data. <code>Complete</code> indicates that all data points
|
|
2215
|
-
*
|
|
2216
|
-
*
|
|
2217
|
-
*
|
|
2218
|
-
*
|
|
2398
|
+
* <p>The status of the returned data. <code>Complete</code> indicates that all data points
|
|
2399
|
+
* in the requested time range were returned. <code>PartialData</code> means that an
|
|
2400
|
+
* incomplete set of data points were returned. You can use the <code>NextToken</code>
|
|
2401
|
+
* value that was returned and repeat your request to get more data points.
|
|
2402
|
+
* <code>NextToken</code> is not returned if you are performing a math expression.
|
|
2403
|
+
* <code>InternalError</code> indicates that an error occurred. Retry your request
|
|
2404
|
+
* using <code>NextToken</code>, if present.</p>
|
|
2219
2405
|
* @public
|
|
2220
2406
|
*/
|
|
2221
2407
|
StatusCode?: StatusCode | undefined;
|
|
@@ -2230,7 +2416,8 @@ export interface MetricDataResult {
|
|
|
2230
2416
|
*/
|
|
2231
2417
|
export interface GetMetricDataOutput {
|
|
2232
2418
|
/**
|
|
2233
|
-
* <p>The metrics that are returned, including the metric name, namespace, and
|
|
2419
|
+
* <p>The metrics that are returned, including the metric name, namespace, and
|
|
2420
|
+
* dimensions.</p>
|
|
2234
2421
|
* @public
|
|
2235
2422
|
*/
|
|
2236
2423
|
MetricDataResults?: MetricDataResult[] | undefined;
|
|
@@ -2240,12 +2427,13 @@ export interface GetMetricDataOutput {
|
|
|
2240
2427
|
*/
|
|
2241
2428
|
NextToken?: string | undefined;
|
|
2242
2429
|
/**
|
|
2243
|
-
* <p>Contains a message about this <code>GetMetricData</code> operation, if the operation
|
|
2244
|
-
*
|
|
2245
|
-
*
|
|
2246
|
-
*
|
|
2247
|
-
* <p>A message appears here only if it is related to the global <code>GetMetricData</code>
|
|
2248
|
-
*
|
|
2430
|
+
* <p>Contains a message about this <code>GetMetricData</code> operation, if the operation
|
|
2431
|
+
* results in such a message. An example of a message that might be returned is
|
|
2432
|
+
* <code>Maximum number of allowed metrics exceeded</code>. If there is a message, as
|
|
2433
|
+
* much of the operation as possible is still executed.</p>
|
|
2434
|
+
* <p>A message appears here only if it is related to the global <code>GetMetricData</code>
|
|
2435
|
+
* operation. Any message about a specific metric returned by the operation appears in the
|
|
2436
|
+
* <code>MetricDataResult</code> object returned for that metric.</p>
|
|
2249
2437
|
* @public
|
|
2250
2438
|
*/
|
|
2251
2439
|
Messages?: MessageData[] | undefined;
|
|
@@ -2265,93 +2453,105 @@ export interface GetMetricStatisticsInput {
|
|
|
2265
2453
|
*/
|
|
2266
2454
|
MetricName: string | undefined;
|
|
2267
2455
|
/**
|
|
2268
|
-
* <p>The dimensions. If the metric contains multiple dimensions, you must include a
|
|
2269
|
-
*
|
|
2270
|
-
*
|
|
2271
|
-
*
|
|
2272
|
-
*
|
|
2273
|
-
*
|
|
2456
|
+
* <p>The dimensions. If the metric contains multiple dimensions, you must include a
|
|
2457
|
+
* value for each dimension. CloudWatch treats each unique combination of dimensions as a
|
|
2458
|
+
* separate metric. If a specific combination of dimensions was not published, you can't
|
|
2459
|
+
* retrieve statistics for it. You must specify the same dimensions that were used when the
|
|
2460
|
+
* metrics were created. For an example, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations">Dimension Combinations</a> in the <i>Amazon CloudWatch User
|
|
2461
|
+
* Guide</i>. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the <i>Amazon CloudWatch User
|
|
2462
|
+
* Guide</i>.</p>
|
|
2274
2463
|
* @public
|
|
2275
2464
|
*/
|
|
2276
2465
|
Dimensions?: Dimension[] | undefined;
|
|
2277
2466
|
/**
|
|
2278
2467
|
* <p>The time stamp that determines the first data point to return. Start times are
|
|
2279
|
-
*
|
|
2280
|
-
* <p>The value specified is inclusive; results include data points with the specified
|
|
2281
|
-
*
|
|
2468
|
+
* evaluated relative to the time that CloudWatch receives the request.</p>
|
|
2469
|
+
* <p>The value specified is inclusive; results include data points with the specified
|
|
2470
|
+
* time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for
|
|
2471
|
+
* example, 2016-10-03T23:00:00Z).</p>
|
|
2282
2472
|
* <p>CloudWatch rounds the specified time stamp as follows:</p>
|
|
2283
2473
|
* <ul>
|
|
2284
2474
|
* <li>
|
|
2285
2475
|
* <p>Start time less than 15 days ago - Round down to the nearest whole minute.
|
|
2286
|
-
*
|
|
2476
|
+
* For example, 12:32:34 is rounded down to 12:32:00.</p>
|
|
2287
2477
|
* </li>
|
|
2288
2478
|
* <li>
|
|
2289
|
-
* <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute
|
|
2290
|
-
*
|
|
2479
|
+
* <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute
|
|
2480
|
+
* clock interval. For example, 12:32:34 is rounded down to 12:30:00.</p>
|
|
2291
2481
|
* </li>
|
|
2292
2482
|
* <li>
|
|
2293
|
-
* <p>Start time greater than 63 days ago - Round down to the nearest 1-hour
|
|
2294
|
-
*
|
|
2483
|
+
* <p>Start time greater than 63 days ago - Round down to the nearest 1-hour
|
|
2484
|
+
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2295
2485
|
* </li>
|
|
2296
2486
|
* </ul>
|
|
2297
2487
|
* <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is
|
|
2298
|
-
*
|
|
2299
|
-
*
|
|
2300
|
-
*
|
|
2301
|
-
*
|
|
2302
|
-
*
|
|
2303
|
-
*
|
|
2304
|
-
* </p>
|
|
2488
|
+
* rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second
|
|
2489
|
+
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2490
|
+
* previous 10-second period, the start time of your request is rounded down and you
|
|
2491
|
+
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
2492
|
+
* 5 minutes of data, using a period of 5 seconds, you receive data timestamped between
|
|
2493
|
+
* 15:02:15 and 15:07:15. </p>
|
|
2305
2494
|
* @public
|
|
2306
2495
|
*/
|
|
2307
2496
|
StartTime: Date | undefined;
|
|
2308
2497
|
/**
|
|
2309
2498
|
* <p>The time stamp that determines the last data point to return.</p>
|
|
2310
|
-
* <p>The value specified is exclusive; results include data points up to the specified
|
|
2311
|
-
*
|
|
2499
|
+
* <p>The value specified is exclusive; results include data points up to the specified
|
|
2500
|
+
* time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for
|
|
2501
|
+
* example, 2016-10-10T23:00:00Z).</p>
|
|
2312
2502
|
* @public
|
|
2313
2503
|
*/
|
|
2314
2504
|
EndTime: Date | undefined;
|
|
2315
2505
|
/**
|
|
2316
|
-
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
2317
|
-
*
|
|
2318
|
-
*
|
|
2319
|
-
*
|
|
2506
|
+
* <p>The granularity, in seconds, of the returned data points. For metrics with regular
|
|
2507
|
+
* resolution, a period can be as short as one minute (60 seconds) and must be a multiple
|
|
2508
|
+
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
2509
|
+
* minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
|
|
2510
|
+
* metrics are those metrics stored by a <code>PutMetricData</code> call that includes a
|
|
2511
|
+
* <code>StorageResolution</code> of 1 second.</p>
|
|
2320
2512
|
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
2321
|
-
*
|
|
2513
|
+
* 3 hours ago, you must specify the period as follows or no data points in that time range
|
|
2514
|
+
* is returned:</p>
|
|
2322
2515
|
* <ul>
|
|
2323
2516
|
* <li>
|
|
2324
|
-
* <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
|
|
2517
|
+
* <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
|
|
2518
|
+
* (1 minute).</p>
|
|
2325
2519
|
* </li>
|
|
2326
2520
|
* <li>
|
|
2327
|
-
* <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5
|
|
2521
|
+
* <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5
|
|
2522
|
+
* minutes).</p>
|
|
2328
2523
|
* </li>
|
|
2329
2524
|
* <li>
|
|
2330
|
-
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
|
|
2525
|
+
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1
|
|
2526
|
+
* hour).</p>
|
|
2331
2527
|
* </li>
|
|
2332
2528
|
* </ul>
|
|
2333
2529
|
* @public
|
|
2334
2530
|
*/
|
|
2335
2531
|
Period: number | undefined;
|
|
2336
2532
|
/**
|
|
2337
|
-
* <p>The metric statistics, other than percentile. For percentile statistics,
|
|
2338
|
-
*
|
|
2339
|
-
*
|
|
2533
|
+
* <p>The metric statistics, other than percentile. For percentile statistics, use
|
|
2534
|
+
* <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you
|
|
2535
|
+
* must specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not
|
|
2536
|
+
* both.</p>
|
|
2340
2537
|
* @public
|
|
2341
2538
|
*/
|
|
2342
2539
|
Statistics?: Statistic[] | undefined;
|
|
2343
2540
|
/**
|
|
2344
|
-
* <p>The percentile statistics. Specify values between p0.0 and p100. When calling
|
|
2345
|
-
*
|
|
2346
|
-
*
|
|
2541
|
+
* <p>The percentile statistics. Specify values between p0.0 and p100. When calling
|
|
2542
|
+
* <code>GetMetricStatistics</code>, you must specify either <code>Statistics</code> or
|
|
2543
|
+
* <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
|
|
2544
|
+
* available for metrics when any of the metric values are negative numbers.</p>
|
|
2347
2545
|
* @public
|
|
2348
2546
|
*/
|
|
2349
2547
|
ExtendedStatistics?: string[] | undefined;
|
|
2350
2548
|
/**
|
|
2351
|
-
* <p>The unit for a given metric.
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
2354
|
-
*
|
|
2549
|
+
* <p>The unit for a given metric. If you omit <code>Unit</code>, all data that was
|
|
2550
|
+
* collected with any unit is returned, along with the corresponding units that were
|
|
2551
|
+
* specified when the data was reported to CloudWatch. If you specify a unit, the operation
|
|
2552
|
+
* returns only data that was collected with that unit specified. If you specify a unit
|
|
2553
|
+
* that does not match the data collected, the results of the operation are null.
|
|
2554
|
+
* CloudWatch does not perform unit conversions.</p>
|
|
2355
2555
|
* @public
|
|
2356
2556
|
*/
|
|
2357
2557
|
Unit?: StandardUnit | undefined;
|
|
@@ -2382,29 +2582,29 @@ export interface GetMetricStreamInput {
|
|
|
2382
2582
|
Name: string | undefined;
|
|
2383
2583
|
}
|
|
2384
2584
|
/**
|
|
2385
|
-
* <p>This structure contains a metric namespace and optionally, a list of metric names,
|
|
2386
|
-
*
|
|
2387
|
-
*
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2390
|
-
*
|
|
2391
|
-
* with 49 metrics specified in each filter.</p>
|
|
2585
|
+
* <p>This structure contains a metric namespace and optionally, a list of metric names, to
|
|
2586
|
+
* either include in a metric stream or exclude from a metric stream.</p>
|
|
2587
|
+
* <p>A metric stream's filters can include up to 1000 total names. This limit applies to
|
|
2588
|
+
* the sum of namespace names and metric names in the filters. For example, this could
|
|
2589
|
+
* include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with
|
|
2590
|
+
* 49 metrics specified in each filter.</p>
|
|
2392
2591
|
* @public
|
|
2393
2592
|
*/
|
|
2394
2593
|
export interface MetricStreamFilter {
|
|
2395
2594
|
/**
|
|
2396
2595
|
* <p>The name of the metric namespace for this filter.</p>
|
|
2397
|
-
* <p>The namespace can contain only ASCII printable characters (ASCII range 32 through
|
|
2398
|
-
*
|
|
2596
|
+
* <p>The namespace can contain only ASCII printable characters (ASCII range 32 through
|
|
2597
|
+
* 126). It must contain at least one non-whitespace character.</p>
|
|
2399
2598
|
* @public
|
|
2400
2599
|
*/
|
|
2401
2600
|
Namespace?: string | undefined;
|
|
2402
2601
|
/**
|
|
2403
2602
|
* <p>The names of the metrics to either include or exclude from the metric stream. </p>
|
|
2404
2603
|
* <p>If you omit this parameter, all metrics in the namespace are included or excluded,
|
|
2405
|
-
*
|
|
2406
|
-
*
|
|
2407
|
-
*
|
|
2604
|
+
* depending on whether this filter is specified as an exclude filter or an include
|
|
2605
|
+
* filter.</p>
|
|
2606
|
+
* <p>Each metric name can contain only ASCII printable characters (ASCII range 32 through
|
|
2607
|
+
* 126). Each metric name must contain at least one non-whitespace character.</p>
|
|
2408
2608
|
* @public
|
|
2409
2609
|
*/
|
|
2410
2610
|
MetricNames?: string[] | undefined;
|
|
@@ -2424,7 +2624,7 @@ export declare const MetricStreamOutputFormat: {
|
|
|
2424
2624
|
export type MetricStreamOutputFormat = (typeof MetricStreamOutputFormat)[keyof typeof MetricStreamOutputFormat];
|
|
2425
2625
|
/**
|
|
2426
2626
|
* <p>This object contains the information for one metric that is to be streamed with
|
|
2427
|
-
*
|
|
2627
|
+
* additional statistics.</p>
|
|
2428
2628
|
* @public
|
|
2429
2629
|
*/
|
|
2430
2630
|
export interface MetricStreamStatisticsMetric {
|
|
@@ -2440,35 +2640,37 @@ export interface MetricStreamStatisticsMetric {
|
|
|
2440
2640
|
MetricName: string | undefined;
|
|
2441
2641
|
}
|
|
2442
2642
|
/**
|
|
2443
|
-
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
2444
|
-
*
|
|
2445
|
-
*
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2448
|
-
*
|
|
2643
|
+
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
2644
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
2645
|
+
* streamed. This structure contains information for one metric that includes additional
|
|
2646
|
+
* statistics in the stream. For more information about statistics, see CloudWatch,
|
|
2647
|
+
* listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2648
|
+
* CloudWatch statistics definitions</a>.</p>
|
|
2449
2649
|
* @public
|
|
2450
2650
|
*/
|
|
2451
2651
|
export interface MetricStreamStatisticsConfiguration {
|
|
2452
2652
|
/**
|
|
2453
|
-
* <p>An array of metric name and namespace pairs that stream the additional statistics
|
|
2454
|
-
*
|
|
2455
|
-
*
|
|
2653
|
+
* <p>An array of metric name and namespace pairs that stream the additional statistics
|
|
2654
|
+
* listed in the value of the <code>AdditionalStatistics</code> parameter. There can be as
|
|
2655
|
+
* many as 100 pairs in the array.</p>
|
|
2456
2656
|
* <p>All metrics that match the combination of metric name and namespace will be streamed
|
|
2457
|
-
*
|
|
2657
|
+
* with the additional statistics, no matter their dimensions.</p>
|
|
2458
2658
|
* @public
|
|
2459
2659
|
*/
|
|
2460
2660
|
IncludeMetrics: MetricStreamStatisticsMetric[] | undefined;
|
|
2461
2661
|
/**
|
|
2462
|
-
* <p>The list of additional statistics that are to be streamed for the metrics listed
|
|
2463
|
-
*
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2466
|
-
*
|
|
2467
|
-
*
|
|
2468
|
-
*
|
|
2469
|
-
*
|
|
2470
|
-
*
|
|
2471
|
-
*
|
|
2662
|
+
* <p>The list of additional statistics that are to be streamed for the metrics listed in
|
|
2663
|
+
* the <code>IncludeMetrics</code> array in this structure. This list can include as many
|
|
2664
|
+
* as 20 statistics.</p>
|
|
2665
|
+
* <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry1.0</code> or
|
|
2666
|
+
* <code>opentelemetry0.7</code>, the only valid values are
|
|
2667
|
+
* <code>p<i>??</i>
|
|
2668
|
+
* </code> percentile statistics such as
|
|
2669
|
+
* <code>p90</code>, <code>p99</code> and so on.</p>
|
|
2670
|
+
* <p>If the <code>OutputFormat</code> for the stream is <code>json</code>, the valid values
|
|
2671
|
+
* include the abbreviations for all of the statistics listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2672
|
+
* CloudWatch statistics definitions</a>. For example, this includes
|
|
2673
|
+
* <code>tm98, </code>
|
|
2472
2674
|
* <code>wm90</code>, <code>PR(:300)</code>, and so on.</p>
|
|
2473
2675
|
* @public
|
|
2474
2676
|
*/
|
|
@@ -2489,22 +2691,21 @@ export interface GetMetricStreamOutput {
|
|
|
2489
2691
|
*/
|
|
2490
2692
|
Name?: string | undefined;
|
|
2491
2693
|
/**
|
|
2492
|
-
* <p>If this array of metric namespaces is present, then these
|
|
2493
|
-
*
|
|
2494
|
-
* metric namespaces that are streamed by this metric stream.</p>
|
|
2694
|
+
* <p>If this array of metric namespaces is present, then these namespaces are the only
|
|
2695
|
+
* metric namespaces that are streamed by this metric stream.</p>
|
|
2495
2696
|
* @public
|
|
2496
2697
|
*/
|
|
2497
2698
|
IncludeFilters?: MetricStreamFilter[] | undefined;
|
|
2498
2699
|
/**
|
|
2499
2700
|
* <p>If this array of metric namespaces is present, then these namespaces are the only
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2701
|
+
* metric namespaces that are not streamed by this metric stream. In this case, all other
|
|
2702
|
+
* metric namespaces in the account are streamed by this metric stream.</p>
|
|
2502
2703
|
* @public
|
|
2503
2704
|
*/
|
|
2504
2705
|
ExcludeFilters?: MetricStreamFilter[] | undefined;
|
|
2505
2706
|
/**
|
|
2506
|
-
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this
|
|
2507
|
-
*
|
|
2707
|
+
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this
|
|
2708
|
+
* metric stream.</p>
|
|
2508
2709
|
* @public
|
|
2509
2710
|
*/
|
|
2510
2711
|
FirehoseArn?: string | undefined;
|
|
@@ -2514,8 +2715,8 @@ export interface GetMetricStreamOutput {
|
|
|
2514
2715
|
*/
|
|
2515
2716
|
RoleArn?: string | undefined;
|
|
2516
2717
|
/**
|
|
2517
|
-
* <p>The state of the metric stream. The possible values are <code>running</code>
|
|
2518
|
-
*
|
|
2718
|
+
* <p>The state of the metric stream. The possible values are <code>running</code> and
|
|
2719
|
+
* <code>stopped</code>.</p>
|
|
2519
2720
|
* @public
|
|
2520
2721
|
*/
|
|
2521
2722
|
State?: string | undefined;
|
|
@@ -2530,24 +2731,24 @@ export interface GetMetricStreamOutput {
|
|
|
2530
2731
|
*/
|
|
2531
2732
|
LastUpdateDate?: Date | undefined;
|
|
2532
2733
|
/**
|
|
2533
|
-
* <p>The output format for the stream.
|
|
2534
|
-
*
|
|
2535
|
-
*
|
|
2536
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">Metric streams output formats</a>.</p>
|
|
2734
|
+
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
2735
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
2736
|
+
* information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">Metric streams output formats</a>.</p>
|
|
2537
2737
|
* @public
|
|
2538
2738
|
*/
|
|
2539
2739
|
OutputFormat?: MetricStreamOutputFormat | undefined;
|
|
2540
2740
|
/**
|
|
2541
|
-
* <p>Each entry in this array displays information about one or more metrics that include
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2741
|
+
* <p>Each entry in this array displays information about one or more metrics that include
|
|
2742
|
+
* additional statistics in the metric stream. For more information about the additional
|
|
2743
|
+
* statistics, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2744
|
+
* CloudWatch statistics definitions</a>. </p>
|
|
2545
2745
|
* @public
|
|
2546
2746
|
*/
|
|
2547
2747
|
StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined;
|
|
2548
2748
|
/**
|
|
2549
|
-
* <p>If this is <code>true</code> and this metric stream is in a monitoring account, then
|
|
2550
|
-
*
|
|
2749
|
+
* <p>If this is <code>true</code> and this metric stream is in a monitoring account, then
|
|
2750
|
+
* the stream includes metrics from source accounts that the monitoring account is linked
|
|
2751
|
+
* to.</p>
|
|
2551
2752
|
* @public
|
|
2552
2753
|
*/
|
|
2553
2754
|
IncludeLinkedAccountsMetrics?: boolean | undefined;
|
|
@@ -2557,56 +2758,57 @@ export interface GetMetricStreamOutput {
|
|
|
2557
2758
|
*/
|
|
2558
2759
|
export interface GetMetricWidgetImageInput {
|
|
2559
2760
|
/**
|
|
2560
|
-
* <p>A JSON string that defines the bitmap graph to be retrieved. The string includes
|
|
2561
|
-
*
|
|
2562
|
-
*
|
|
2563
|
-
*
|
|
2564
|
-
*
|
|
2565
|
-
* <p>If any metric on the graph could not load all the requested data points, an orange
|
|
2566
|
-
*
|
|
2761
|
+
* <p>A JSON string that defines the bitmap graph to be retrieved. The string includes
|
|
2762
|
+
* the metrics to include in the graph, statistics, annotations, title, axis limits, and so
|
|
2763
|
+
* on. You can include only one <code>MetricWidget</code> parameter in each
|
|
2764
|
+
* <code>GetMetricWidgetImage</code> call.</p>
|
|
2765
|
+
* <p>For more information about the syntax of <code>MetricWidget</code> see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html">GetMetricWidgetImage: Metric Widget Structure and Syntax</a>.</p>
|
|
2766
|
+
* <p>If any metric on the graph could not load all the requested data points, an orange
|
|
2767
|
+
* triangle with an exclamation point appears next to the graph legend.</p>
|
|
2567
2768
|
* @public
|
|
2568
2769
|
*/
|
|
2569
2770
|
MetricWidget: string | undefined;
|
|
2570
2771
|
/**
|
|
2571
2772
|
* <p>The format of the resulting image. Only PNG images are supported.</p>
|
|
2572
|
-
* <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns
|
|
2573
|
-
*
|
|
2574
|
-
*
|
|
2773
|
+
* <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns
|
|
2774
|
+
* an HTTP response with the content-type set to <code>text/xml</code>. The image data is
|
|
2775
|
+
* in a <code>MetricWidgetImage</code> field. For example:</p>
|
|
2575
2776
|
* <p>
|
|
2576
|
-
* <code>
|
|
2577
|
-
* <GetMetricWidgetImageResponse xmlns=<URLstring>></code>
|
|
2777
|
+
* <code> <GetMetricWidgetImageResponse xmlns=<URLstring>></code>
|
|
2578
2778
|
* </p>
|
|
2579
2779
|
* <p>
|
|
2580
|
-
* <code>
|
|
2780
|
+
* <code> <GetMetricWidgetImageResult></code>
|
|
2581
2781
|
* </p>
|
|
2582
2782
|
* <p>
|
|
2583
|
-
* <code>
|
|
2783
|
+
* <code> <MetricWidgetImage></code>
|
|
2584
2784
|
* </p>
|
|
2585
2785
|
* <p>
|
|
2586
|
-
* <code>
|
|
2786
|
+
* <code> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...</code>
|
|
2587
2787
|
* </p>
|
|
2588
2788
|
* <p>
|
|
2589
|
-
* <code>
|
|
2789
|
+
* <code> </MetricWidgetImage></code>
|
|
2590
2790
|
* </p>
|
|
2591
2791
|
* <p>
|
|
2592
|
-
* <code>
|
|
2792
|
+
* <code> </GetMetricWidgetImageResult></code>
|
|
2593
2793
|
* </p>
|
|
2594
2794
|
* <p>
|
|
2595
|
-
* <code>
|
|
2795
|
+
* <code> <ResponseMetadata></code>
|
|
2596
2796
|
* </p>
|
|
2597
2797
|
* <p>
|
|
2598
|
-
* <code>
|
|
2798
|
+
* <code>
|
|
2799
|
+
* <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId></code>
|
|
2599
2800
|
* </p>
|
|
2600
2801
|
* <p>
|
|
2601
|
-
* <code>
|
|
2802
|
+
* <code> </ResponseMetadata></code>
|
|
2602
2803
|
* </p>
|
|
2603
2804
|
* <p>
|
|
2604
2805
|
* <code></GetMetricWidgetImageResponse></code>
|
|
2605
2806
|
* </p>
|
|
2606
|
-
* <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For
|
|
2607
|
-
*
|
|
2608
|
-
*
|
|
2609
|
-
*
|
|
2807
|
+
* <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For
|
|
2808
|
+
* most use cases, and all actions using an Amazon Web Services SDK, you should use
|
|
2809
|
+
* <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a
|
|
2810
|
+
* content-type set to <code>image/png</code>, and the body of the response is a PNG
|
|
2811
|
+
* image.</p>
|
|
2610
2812
|
* @public
|
|
2611
2813
|
*/
|
|
2612
2814
|
OutputFormat?: string | undefined;
|
|
@@ -2616,7 +2818,8 @@ export interface GetMetricWidgetImageInput {
|
|
|
2616
2818
|
*/
|
|
2617
2819
|
export interface GetMetricWidgetImageOutput {
|
|
2618
2820
|
/**
|
|
2619
|
-
* <p>The image of the graph, in the output format specified. The output is
|
|
2821
|
+
* <p>The image of the graph, in the output format specified. The output is
|
|
2822
|
+
* base64-encoded.</p>
|
|
2620
2823
|
* @public
|
|
2621
2824
|
*/
|
|
2622
2825
|
MetricWidgetImage?: Uint8Array | undefined;
|
|
@@ -2626,16 +2829,15 @@ export interface GetMetricWidgetImageOutput {
|
|
|
2626
2829
|
*/
|
|
2627
2830
|
export interface ListDashboardsInput {
|
|
2628
2831
|
/**
|
|
2629
|
-
* <p>If you specify this parameter, only
|
|
2630
|
-
*
|
|
2631
|
-
*
|
|
2632
|
-
*
|
|
2633
|
-
* </p>
|
|
2832
|
+
* <p>If you specify this parameter, only the dashboards with names starting with the
|
|
2833
|
+
* specified string are listed. The maximum length is 255, and valid characters are A-Z,
|
|
2834
|
+
* a-z, 0-9, ".", "-", and "_". </p>
|
|
2634
2835
|
* @public
|
|
2635
2836
|
*/
|
|
2636
2837
|
DashboardNamePrefix?: string | undefined;
|
|
2637
2838
|
/**
|
|
2638
|
-
* <p>The token returned by a previous call to indicate that there is more data
|
|
2839
|
+
* <p>The token returned by a previous call to indicate that there is more data
|
|
2840
|
+
* available.</p>
|
|
2639
2841
|
* @public
|
|
2640
2842
|
*/
|
|
2641
2843
|
NextToken?: string | undefined;
|
|
@@ -2660,106 +2862,64 @@ export interface ListDashboardsOutput {
|
|
|
2660
2862
|
*/
|
|
2661
2863
|
export interface ListManagedInsightRulesInput {
|
|
2662
2864
|
/**
|
|
2663
|
-
* <p>
|
|
2664
|
-
*
|
|
2665
|
-
* of an Amazon Web Services resource
|
|
2666
|
-
* that has managed Contributor Insights rules.
|
|
2667
|
-
* </p>
|
|
2865
|
+
* <p> The ARN of an Amazon Web Services resource that has managed Contributor Insights
|
|
2866
|
+
* rules. </p>
|
|
2668
2867
|
* @public
|
|
2669
2868
|
*/
|
|
2670
2869
|
ResourceARN: string | undefined;
|
|
2671
2870
|
/**
|
|
2672
|
-
* <p>
|
|
2673
|
-
*
|
|
2674
|
-
* to get
|
|
2675
|
-
* the next set
|
|
2676
|
-
* of rules
|
|
2677
|
-
* if the value was returned
|
|
2678
|
-
* by the previous operation.
|
|
2679
|
-
* </p>
|
|
2871
|
+
* <p> Include this value to get the next set of rules if the value was returned by the
|
|
2872
|
+
* previous operation. </p>
|
|
2680
2873
|
* @public
|
|
2681
2874
|
*/
|
|
2682
2875
|
NextToken?: string | undefined;
|
|
2683
2876
|
/**
|
|
2684
|
-
* <p>
|
|
2685
|
-
*
|
|
2686
|
-
* of results
|
|
2687
|
-
* to return
|
|
2688
|
-
* in one operation.
|
|
2689
|
-
* If you omit this parameter,
|
|
2690
|
-
* the default number is used.
|
|
2691
|
-
* The default number is <code>100</code>.
|
|
2692
|
-
* </p>
|
|
2877
|
+
* <p> The maximum number of results to return in one operation. If you omit this parameter,
|
|
2878
|
+
* the default number is used. The default number is <code>100</code>. </p>
|
|
2693
2879
|
* @public
|
|
2694
2880
|
*/
|
|
2695
2881
|
MaxResults?: number | undefined;
|
|
2696
2882
|
}
|
|
2697
2883
|
/**
|
|
2698
|
-
* <p>
|
|
2699
|
-
* The status
|
|
2700
|
-
* of a managed Contributor Insights rule.
|
|
2701
|
-
* </p>
|
|
2884
|
+
* <p> The status of a managed Contributor Insights rule. </p>
|
|
2702
2885
|
* @public
|
|
2703
2886
|
*/
|
|
2704
2887
|
export interface ManagedRuleState {
|
|
2705
2888
|
/**
|
|
2706
|
-
* <p>
|
|
2707
|
-
*
|
|
2708
|
-
* of the Contributor Insights rule
|
|
2709
|
-
* that contains data
|
|
2710
|
-
* for the specified Amazon Web Services resource.
|
|
2711
|
-
* </p>
|
|
2889
|
+
* <p> The name of the Contributor Insights rule that contains data for the specified
|
|
2890
|
+
* Amazon Web Services resource. </p>
|
|
2712
2891
|
* @public
|
|
2713
2892
|
*/
|
|
2714
2893
|
RuleName: string | undefined;
|
|
2715
2894
|
/**
|
|
2716
|
-
* <p>
|
|
2717
|
-
* Indicates whether the rule is enabled or disabled.
|
|
2718
|
-
* </p>
|
|
2895
|
+
* <p> Indicates whether the rule is enabled or disabled. </p>
|
|
2719
2896
|
* @public
|
|
2720
2897
|
*/
|
|
2721
2898
|
State: string | undefined;
|
|
2722
2899
|
}
|
|
2723
2900
|
/**
|
|
2724
|
-
* <p>
|
|
2725
|
-
*
|
|
2726
|
-
*
|
|
2727
|
-
* as returned
|
|
2728
|
-
* by <code>ListManagedInsightRules</code>.
|
|
2729
|
-
*
|
|
2730
|
-
* </p>
|
|
2901
|
+
* <p> Contains information about managed Contributor Insights rules, as returned by
|
|
2902
|
+
* <code>ListManagedInsightRules</code>.
|
|
2903
|
+
* </p>
|
|
2731
2904
|
* @public
|
|
2732
2905
|
*/
|
|
2733
2906
|
export interface ManagedRuleDescription {
|
|
2734
2907
|
/**
|
|
2735
|
-
* <p>
|
|
2736
|
-
*
|
|
2737
|
-
* for the managed rule.
|
|
2738
|
-
* Used
|
|
2739
|
-
* to enable managed rules using <code>PutManagedInsightRules</code>.
|
|
2740
|
-
* </p>
|
|
2908
|
+
* <p> The template name for the managed rule. Used to enable managed rules using
|
|
2909
|
+
* <code>PutManagedInsightRules</code>. </p>
|
|
2741
2910
|
* @public
|
|
2742
2911
|
*/
|
|
2743
2912
|
TemplateName?: string | undefined;
|
|
2744
2913
|
/**
|
|
2745
|
-
* <p>
|
|
2746
|
-
*
|
|
2747
|
-
* this is the ARN
|
|
2748
|
-
* for the related Amazon Web Services resource.
|
|
2749
|
-
* </p>
|
|
2914
|
+
* <p> If a managed rule is enabled, this is the ARN for the related Amazon Web Services
|
|
2915
|
+
* resource. </p>
|
|
2750
2916
|
* @public
|
|
2751
2917
|
*/
|
|
2752
2918
|
ResourceARN?: string | undefined;
|
|
2753
2919
|
/**
|
|
2754
|
-
* <p>
|
|
2755
|
-
*
|
|
2756
|
-
*
|
|
2757
|
-
* If present,
|
|
2758
|
-
* it contains information
|
|
2759
|
-
* about the Contributor Insights rule
|
|
2760
|
-
* that contains information
|
|
2761
|
-
* about the related Amazon Web Services resource.
|
|
2762
|
-
* </p>
|
|
2920
|
+
* <p> Describes the state of a managed rule. If present, it contains information about the
|
|
2921
|
+
* Contributor Insights rule that contains information about the related Amazon Web Services
|
|
2922
|
+
* resource. </p>
|
|
2763
2923
|
* @public
|
|
2764
2924
|
*/
|
|
2765
2925
|
RuleState?: ManagedRuleState | undefined;
|
|
@@ -2769,23 +2929,14 @@ export interface ManagedRuleDescription {
|
|
|
2769
2929
|
*/
|
|
2770
2930
|
export interface ListManagedInsightRulesOutput {
|
|
2771
2931
|
/**
|
|
2772
|
-
* <p>
|
|
2773
|
-
*
|
|
2774
|
-
* that are available
|
|
2775
|
-
* for the specified Amazon Web Services resource.
|
|
2776
|
-
* </p>
|
|
2932
|
+
* <p> The managed rules that are available for the specified Amazon Web Services resource.
|
|
2933
|
+
* </p>
|
|
2777
2934
|
* @public
|
|
2778
2935
|
*/
|
|
2779
2936
|
ManagedRules?: ManagedRuleDescription[] | undefined;
|
|
2780
2937
|
/**
|
|
2781
|
-
* <p>
|
|
2782
|
-
*
|
|
2783
|
-
* to get
|
|
2784
|
-
* the next set
|
|
2785
|
-
* of rules
|
|
2786
|
-
* if the value was returned
|
|
2787
|
-
* by the previous operation.
|
|
2788
|
-
* </p>
|
|
2938
|
+
* <p> Include this value to get the next set of rules if the value was returned by the
|
|
2939
|
+
* previous operation. </p>
|
|
2789
2940
|
* @public
|
|
2790
2941
|
*/
|
|
2791
2942
|
NextToken?: string | undefined;
|
|
@@ -2807,50 +2958,49 @@ export type RecentlyActive = (typeof RecentlyActive)[keyof typeof RecentlyActive
|
|
|
2807
2958
|
export interface ListMetricsInput {
|
|
2808
2959
|
/**
|
|
2809
2960
|
* <p>The metric namespace to filter against. Only the namespace that matches exactly
|
|
2810
|
-
*
|
|
2961
|
+
* will be returned.</p>
|
|
2811
2962
|
* @public
|
|
2812
2963
|
*/
|
|
2813
2964
|
Namespace?: string | undefined;
|
|
2814
2965
|
/**
|
|
2815
|
-
* <p>The name of the metric to filter against. Only the metrics with names that match
|
|
2816
|
-
*
|
|
2966
|
+
* <p>The name of the metric to filter against. Only the metrics with names that match
|
|
2967
|
+
* exactly will be returned.</p>
|
|
2817
2968
|
* @public
|
|
2818
2969
|
*/
|
|
2819
2970
|
MetricName?: string | undefined;
|
|
2820
2971
|
/**
|
|
2821
|
-
* <p>The dimensions to filter against.
|
|
2822
|
-
*
|
|
2972
|
+
* <p>The dimensions to filter against. Only the dimensions that match exactly will be
|
|
2973
|
+
* returned.</p>
|
|
2823
2974
|
* @public
|
|
2824
2975
|
*/
|
|
2825
2976
|
Dimensions?: DimensionFilter[] | undefined;
|
|
2826
2977
|
/**
|
|
2827
2978
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
2828
|
-
*
|
|
2979
|
+
* available.</p>
|
|
2829
2980
|
* @public
|
|
2830
2981
|
*/
|
|
2831
2982
|
NextToken?: string | undefined;
|
|
2832
2983
|
/**
|
|
2833
|
-
* <p>To filter the results to show only metrics that have had data points published
|
|
2834
|
-
*
|
|
2835
|
-
*
|
|
2836
|
-
*
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
2839
|
-
* data as much as 40 minutes more than the specified time interval.</p>
|
|
2984
|
+
* <p>To filter the results to show only metrics that have had data points published in the
|
|
2985
|
+
* past three hours, specify this parameter with a value of <code>PT3H</code>. This is the
|
|
2986
|
+
* only valid value for this parameter.</p>
|
|
2987
|
+
* <p>The results that are returned are an approximation of the value you specify. There is
|
|
2988
|
+
* a low probability that the returned results include metrics with last published data as
|
|
2989
|
+
* much as 50 minutes more than the specified time interval.</p>
|
|
2840
2990
|
* @public
|
|
2841
2991
|
*/
|
|
2842
2992
|
RecentlyActive?: RecentlyActive | undefined;
|
|
2843
2993
|
/**
|
|
2844
|
-
* <p>If you are using this operation in a monitoring account,
|
|
2845
|
-
*
|
|
2994
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to
|
|
2995
|
+
* include metrics from source accounts in the returned data.</p>
|
|
2846
2996
|
* <p>The default is <code>false</code>.</p>
|
|
2847
2997
|
* @public
|
|
2848
2998
|
*/
|
|
2849
2999
|
IncludeLinkedAccounts?: boolean | undefined;
|
|
2850
3000
|
/**
|
|
2851
|
-
* <p>When you use this operation in a monitoring account, use this field to return metrics
|
|
2852
|
-
*
|
|
2853
|
-
*
|
|
3001
|
+
* <p>When you use this operation in a monitoring account, use this field to return metrics
|
|
3002
|
+
* only from one source account. To do so, specify that source account ID in this field,
|
|
3003
|
+
* and also specify <code>true</code> for <code>IncludeLinkedAccounts</code>.</p>
|
|
2854
3004
|
* @public
|
|
2855
3005
|
*/
|
|
2856
3006
|
OwningAccount?: string | undefined;
|
|
@@ -2870,10 +3020,11 @@ export interface ListMetricsOutput {
|
|
|
2870
3020
|
*/
|
|
2871
3021
|
NextToken?: string | undefined;
|
|
2872
3022
|
/**
|
|
2873
|
-
* <p>If you are using this operation in a monitoring account, this array contains the
|
|
2874
|
-
*
|
|
2875
|
-
*
|
|
2876
|
-
* <p>This field is a 1:1 mapping between each metric that is returned and the ID of the
|
|
3023
|
+
* <p>If you are using this operation in a monitoring account, this array contains the
|
|
3024
|
+
* account IDs of the source accounts where the metrics in the returned data are
|
|
3025
|
+
* from.</p>
|
|
3026
|
+
* <p>This field is a 1:1 mapping between each metric that is returned and the ID of the
|
|
3027
|
+
* owning account.</p>
|
|
2877
3028
|
* @public
|
|
2878
3029
|
*/
|
|
2879
3030
|
OwningAccounts?: string[] | undefined;
|
|
@@ -2883,7 +3034,8 @@ export interface ListMetricsOutput {
|
|
|
2883
3034
|
*/
|
|
2884
3035
|
export interface ListMetricStreamsInput {
|
|
2885
3036
|
/**
|
|
2886
|
-
* <p>Include this value, if it was returned by the previous call, to get the next set of
|
|
3037
|
+
* <p>Include this value, if it was returned by the previous call, to get the next set of
|
|
3038
|
+
* metric streams.</p>
|
|
2887
3039
|
* @public
|
|
2888
3040
|
*/
|
|
2889
3041
|
NextToken?: string | undefined;
|
|
@@ -2909,7 +3061,8 @@ export interface MetricStreamEntry {
|
|
|
2909
3061
|
*/
|
|
2910
3062
|
CreationDate?: Date | undefined;
|
|
2911
3063
|
/**
|
|
2912
|
-
* <p>The date that the configuration of this metric stream was most recently
|
|
3064
|
+
* <p>The date that the configuration of this metric stream was most recently
|
|
3065
|
+
* updated.</p>
|
|
2913
3066
|
* @public
|
|
2914
3067
|
*/
|
|
2915
3068
|
LastUpdateDate?: Date | undefined;
|
|
@@ -2919,19 +3072,20 @@ export interface MetricStreamEntry {
|
|
|
2919
3072
|
*/
|
|
2920
3073
|
Name?: string | undefined;
|
|
2921
3074
|
/**
|
|
2922
|
-
* <p>The ARN of the Kinesis Firehose devlivery stream that is used for this metric
|
|
3075
|
+
* <p>The ARN of the Kinesis Firehose devlivery stream that is used for this metric
|
|
3076
|
+
* stream.</p>
|
|
2923
3077
|
* @public
|
|
2924
3078
|
*/
|
|
2925
3079
|
FirehoseArn?: string | undefined;
|
|
2926
3080
|
/**
|
|
2927
|
-
* <p>The current state of this stream. Valid values are <code>running</code> and
|
|
3081
|
+
* <p>The current state of this stream. Valid values are <code>running</code> and
|
|
3082
|
+
* <code>stopped</code>.</p>
|
|
2928
3083
|
* @public
|
|
2929
3084
|
*/
|
|
2930
3085
|
State?: string | undefined;
|
|
2931
3086
|
/**
|
|
2932
|
-
* <p>The output format of this metric stream. Valid values are
|
|
2933
|
-
*
|
|
2934
|
-
* and <code>opentelemetry0.7</code>.</p>
|
|
3087
|
+
* <p>The output format of this metric stream. Valid values are <code>json</code>,
|
|
3088
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>.</p>
|
|
2935
3089
|
* @public
|
|
2936
3090
|
*/
|
|
2937
3091
|
OutputFormat?: MetricStreamOutputFormat | undefined;
|
|
@@ -2941,8 +3095,8 @@ export interface MetricStreamEntry {
|
|
|
2941
3095
|
*/
|
|
2942
3096
|
export interface ListMetricStreamsOutput {
|
|
2943
3097
|
/**
|
|
2944
|
-
* <p>The token that marks the start of the next batch of returned results. You can use
|
|
2945
|
-
*
|
|
3098
|
+
* <p>The token that marks the start of the next batch of returned results. You can use
|
|
3099
|
+
* this token in a subsequent operation to get the next batch of results.</p>
|
|
2946
3100
|
* @public
|
|
2947
3101
|
*/
|
|
2948
3102
|
NextToken?: string | undefined;
|
|
@@ -2959,16 +3113,15 @@ export interface ListTagsForResourceInput {
|
|
|
2959
3113
|
/**
|
|
2960
3114
|
* <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
|
|
2961
3115
|
* <p>The ARN format of an alarm is
|
|
2962
|
-
*
|
|
3116
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
2963
3117
|
* </code>
|
|
2964
3118
|
* </p>
|
|
2965
3119
|
* <p>The ARN format of a Contributor Insights rule is
|
|
2966
|
-
*
|
|
3120
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
2967
3121
|
* </code>
|
|
2968
3122
|
* </p>
|
|
2969
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
2970
|
-
*
|
|
2971
|
-
* Reference</i>.</p>
|
|
3123
|
+
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|
|
3124
|
+
* Services General Reference</i>.</p>
|
|
2972
3125
|
* @public
|
|
2973
3126
|
*/
|
|
2974
3127
|
ResourceARN: string | undefined;
|
|
@@ -2979,8 +3132,8 @@ export interface ListTagsForResourceInput {
|
|
|
2979
3132
|
*/
|
|
2980
3133
|
export interface Tag {
|
|
2981
3134
|
/**
|
|
2982
|
-
* <p>A string that you can use to assign a value. The combination of tag keys and values
|
|
2983
|
-
*
|
|
3135
|
+
* <p>A string that you can use to assign a value. The combination of tag keys and values
|
|
3136
|
+
* can help you organize and categorize your resources.</p>
|
|
2984
3137
|
* @public
|
|
2985
3138
|
*/
|
|
2986
3139
|
Key: string | undefined;
|
|
@@ -3033,26 +3186,24 @@ export interface PutAnomalyDetectorInput {
|
|
|
3033
3186
|
*/
|
|
3034
3187
|
Stat?: string | undefined;
|
|
3035
3188
|
/**
|
|
3036
|
-
* <p>The configuration specifies details about how the
|
|
3037
|
-
*
|
|
3038
|
-
*
|
|
3039
|
-
*
|
|
3040
|
-
* <p>The configuration can also include the time zone to use for
|
|
3041
|
-
* the metric.</p>
|
|
3189
|
+
* <p>The configuration specifies details about how the anomaly detection model is to be
|
|
3190
|
+
* trained, including time ranges to exclude when training and updating the model. You can
|
|
3191
|
+
* specify as many as 10 time ranges.</p>
|
|
3192
|
+
* <p>The configuration can also include the time zone to use for the metric.</p>
|
|
3042
3193
|
* @public
|
|
3043
3194
|
*/
|
|
3044
3195
|
Configuration?: AnomalyDetectorConfiguration | undefined;
|
|
3045
3196
|
/**
|
|
3046
3197
|
* <p>Use this object to include parameters to provide information about your metric to
|
|
3047
|
-
*
|
|
3048
|
-
*
|
|
3198
|
+
* CloudWatch to help it build more accurate anomaly detection models.
|
|
3199
|
+
* Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>
|
|
3049
3200
|
* @public
|
|
3050
3201
|
*/
|
|
3051
3202
|
MetricCharacteristics?: MetricCharacteristics | undefined;
|
|
3052
3203
|
/**
|
|
3053
3204
|
* <p>A single metric anomaly detector to be created.</p>
|
|
3054
|
-
* <p>When using <code>SingleMetricAnomalyDetector</code>,
|
|
3055
|
-
*
|
|
3205
|
+
* <p>When using <code>SingleMetricAnomalyDetector</code>, you cannot include the following
|
|
3206
|
+
* parameters in the same operation:</p>
|
|
3056
3207
|
* <ul>
|
|
3057
3208
|
* <li>
|
|
3058
3209
|
* <p>
|
|
@@ -3075,18 +3226,20 @@ export interface PutAnomalyDetectorInput {
|
|
|
3075
3226
|
* </p>
|
|
3076
3227
|
* </li>
|
|
3077
3228
|
* <li>
|
|
3078
|
-
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
3229
|
+
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
3230
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3079
3231
|
* </p>
|
|
3080
3232
|
* </li>
|
|
3081
3233
|
* </ul>
|
|
3082
|
-
* <p>Instead, specify the single metric anomaly detector attributes
|
|
3083
|
-
*
|
|
3234
|
+
* <p>Instead, specify the single metric anomaly detector attributes as part of the property
|
|
3235
|
+
* <code>SingleMetricAnomalyDetector</code>.</p>
|
|
3084
3236
|
* @public
|
|
3085
3237
|
*/
|
|
3086
3238
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
|
|
3087
3239
|
/**
|
|
3088
3240
|
* <p>The metric math anomaly detector to be created.</p>
|
|
3089
|
-
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following
|
|
3241
|
+
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following
|
|
3242
|
+
* parameters in the same operation:</p>
|
|
3090
3243
|
* <ul>
|
|
3091
3244
|
* <li>
|
|
3092
3245
|
* <p>
|
|
@@ -3109,12 +3262,13 @@ export interface PutAnomalyDetectorInput {
|
|
|
3109
3262
|
* </p>
|
|
3110
3263
|
* </li>
|
|
3111
3264
|
* <li>
|
|
3112
|
-
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
3265
|
+
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
3266
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3113
3267
|
* </p>
|
|
3114
3268
|
* </li>
|
|
3115
3269
|
* </ul>
|
|
3116
|
-
* <p>Instead, specify the metric math anomaly detector attributes
|
|
3117
|
-
*
|
|
3270
|
+
* <p>Instead, specify the metric math anomaly detector attributes as part of the property
|
|
3271
|
+
* <code>MetricMathAnomalyDetector</code>.</p>
|
|
3118
3272
|
* @public
|
|
3119
3273
|
*/
|
|
3120
3274
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
|
|
@@ -3141,14 +3295,15 @@ export declare class LimitExceededFault extends __BaseException {
|
|
|
3141
3295
|
*/
|
|
3142
3296
|
export interface PutCompositeAlarmInput {
|
|
3143
3297
|
/**
|
|
3144
|
-
* <p>Indicates whether actions should be executed during any changes to the alarm state of
|
|
3145
|
-
*
|
|
3298
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm state of
|
|
3299
|
+
* the composite alarm. The default is <code>TRUE</code>.</p>
|
|
3146
3300
|
* @public
|
|
3147
3301
|
*/
|
|
3148
3302
|
ActionsEnabled?: boolean | undefined;
|
|
3149
3303
|
/**
|
|
3150
|
-
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
3151
|
-
*
|
|
3304
|
+
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
3305
|
+
* from any other state. Each action is specified as an Amazon Resource Name
|
|
3306
|
+
* (ARN).</p>
|
|
3152
3307
|
* <p>Valid Values: ]</p>
|
|
3153
3308
|
* <p>
|
|
3154
3309
|
* <b>Amazon SNS actions:</b>
|
|
@@ -3162,17 +3317,20 @@ export interface PutCompositeAlarmInput {
|
|
|
3162
3317
|
* </p>
|
|
3163
3318
|
* <ul>
|
|
3164
3319
|
* <li>
|
|
3165
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3320
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3321
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3166
3322
|
* </code>
|
|
3167
3323
|
* </p>
|
|
3168
3324
|
* </li>
|
|
3169
3325
|
* <li>
|
|
3170
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
3326
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
3327
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3171
3328
|
* </code>
|
|
3172
3329
|
* </p>
|
|
3173
3330
|
* </li>
|
|
3174
3331
|
* <li>
|
|
3175
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
3332
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
3333
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3176
3334
|
* </code>
|
|
3177
3335
|
* </p>
|
|
3178
3336
|
* </li>
|
|
@@ -3193,34 +3351,39 @@ export interface PutCompositeAlarmInput {
|
|
|
3193
3351
|
*/
|
|
3194
3352
|
AlarmDescription?: string | undefined;
|
|
3195
3353
|
/**
|
|
3196
|
-
* <p>The name for the composite alarm. This name must be unique within the
|
|
3354
|
+
* <p>The name for the composite alarm. This name must be unique within the
|
|
3355
|
+
* Region.</p>
|
|
3197
3356
|
* @public
|
|
3198
3357
|
*/
|
|
3199
3358
|
AlarmName: string | undefined;
|
|
3200
3359
|
/**
|
|
3201
3360
|
* <p>An expression that specifies which other alarms are to be evaluated to determine this
|
|
3202
|
-
*
|
|
3203
|
-
*
|
|
3204
|
-
*
|
|
3205
|
-
*
|
|
3206
|
-
*
|
|
3207
|
-
* <p>You can use either alarm names or ARNs to reference the other alarms that are to be
|
|
3361
|
+
* composite alarm's state. For each alarm that you reference, you designate a function
|
|
3362
|
+
* that specifies whether that alarm needs to be in ALARM state, OK state, or
|
|
3363
|
+
* INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple
|
|
3364
|
+
* functions in a single expression. You can use parenthesis to logically group the
|
|
3365
|
+
* functions in your expression.</p>
|
|
3366
|
+
* <p>You can use either alarm names or ARNs to reference the other alarms that are to be
|
|
3367
|
+
* evaluated.</p>
|
|
3208
3368
|
* <p>Functions can include the following:</p>
|
|
3209
3369
|
* <ul>
|
|
3210
3370
|
* <li>
|
|
3211
3371
|
* <p>
|
|
3212
|
-
* <code>ALARM("<i>alarm-name</i> or
|
|
3213
|
-
*
|
|
3372
|
+
* <code>ALARM("<i>alarm-name</i> or
|
|
3373
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3374
|
+
* ALARM state.</p>
|
|
3214
3375
|
* </li>
|
|
3215
3376
|
* <li>
|
|
3216
3377
|
* <p>
|
|
3217
|
-
* <code>OK("<i>alarm-name</i> or
|
|
3218
|
-
*
|
|
3378
|
+
* <code>OK("<i>alarm-name</i> or
|
|
3379
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in OK
|
|
3380
|
+
* state.</p>
|
|
3219
3381
|
* </li>
|
|
3220
3382
|
* <li>
|
|
3221
3383
|
* <p>
|
|
3222
|
-
* <code>INSUFFICIENT_DATA("<i>alarm-name</i> or
|
|
3223
|
-
*
|
|
3384
|
+
* <code>INSUFFICIENT_DATA("<i>alarm-name</i> or
|
|
3385
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3386
|
+
* INSUFFICIENT_DATA state.</p>
|
|
3224
3387
|
* </li>
|
|
3225
3388
|
* <li>
|
|
3226
3389
|
* <p>
|
|
@@ -3232,41 +3395,44 @@ export interface PutCompositeAlarmInput {
|
|
|
3232
3395
|
* </li>
|
|
3233
3396
|
* </ul>
|
|
3234
3397
|
* <p>TRUE and FALSE are useful for testing a complex <code>AlarmRule</code> structure, and
|
|
3235
|
-
*
|
|
3236
|
-
* <p>Alarm names specified in <code>AlarmRule</code> can be surrounded with double-quotes
|
|
3237
|
-
*
|
|
3238
|
-
*
|
|
3398
|
+
* for testing your alarm actions.</p>
|
|
3399
|
+
* <p>Alarm names specified in <code>AlarmRule</code> can be surrounded with double-quotes
|
|
3400
|
+
* ("), but do not have to be.</p>
|
|
3401
|
+
* <p>The following are some examples of <code>AlarmRule</code>:</p>
|
|
3239
3402
|
* <ul>
|
|
3240
3403
|
* <li>
|
|
3241
3404
|
* <p>
|
|
3242
|
-
* <code>ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)</code>
|
|
3243
|
-
*
|
|
3405
|
+
* <code>ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)</code>
|
|
3406
|
+
* specifies that the composite alarm goes into ALARM state only if both
|
|
3407
|
+
* CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.</p>
|
|
3244
3408
|
* </li>
|
|
3245
3409
|
* <li>
|
|
3246
3410
|
* <p>
|
|
3247
3411
|
* <code>ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)</code>
|
|
3248
|
-
*
|
|
3249
|
-
*
|
|
3250
|
-
*
|
|
3412
|
+
* specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in
|
|
3413
|
+
* ALARM state and DeploymentInProgress is not in ALARM state. This example reduces
|
|
3414
|
+
* alarm noise during a known deployment window.</p>
|
|
3251
3415
|
* </li>
|
|
3252
3416
|
* <li>
|
|
3253
3417
|
* <p>
|
|
3254
|
-
* <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
|
|
3255
|
-
*
|
|
3256
|
-
*
|
|
3257
|
-
*
|
|
3418
|
+
* <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
|
|
3419
|
+
* OK(NetworkOutTooHigh)</code> goes into ALARM state if CPUUtilizationTooHigh
|
|
3420
|
+
* OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
|
|
3421
|
+
* state. This provides another example of using a composite alarm to prevent
|
|
3422
|
+
* noise. This rule ensures that you are not notified with an alarm action on high
|
|
3423
|
+
* CPU or disk usage if a known network problem is also occurring.</p>
|
|
3258
3424
|
* </li>
|
|
3259
3425
|
* </ul>
|
|
3260
|
-
* <p>The <code>AlarmRule</code> can specify as many as 100
|
|
3261
|
-
*
|
|
3262
|
-
*
|
|
3263
|
-
* parentheses.</p>
|
|
3426
|
+
* <p>The <code>AlarmRule</code> can specify as many as 100 "children" alarms. The
|
|
3427
|
+
* <code>AlarmRule</code> expression can have as many as 500 elements. Elements are
|
|
3428
|
+
* child alarms, TRUE or FALSE statements, and parentheses.</p>
|
|
3264
3429
|
* @public
|
|
3265
3430
|
*/
|
|
3266
3431
|
AlarmRule: string | undefined;
|
|
3267
3432
|
/**
|
|
3268
|
-
* <p>The actions to execute when this alarm transitions to the
|
|
3269
|
-
*
|
|
3433
|
+
* <p>The actions to execute when this alarm transitions to the
|
|
3434
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
3435
|
+
* as an Amazon Resource Name (ARN).</p>
|
|
3270
3436
|
* <p>Valid Values: ]</p>
|
|
3271
3437
|
* <p>
|
|
3272
3438
|
* <b>Amazon SNS actions:</b>
|
|
@@ -3280,17 +3446,20 @@ export interface PutCompositeAlarmInput {
|
|
|
3280
3446
|
* </p>
|
|
3281
3447
|
* <ul>
|
|
3282
3448
|
* <li>
|
|
3283
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3449
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3450
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3284
3451
|
* </code>
|
|
3285
3452
|
* </p>
|
|
3286
3453
|
* </li>
|
|
3287
3454
|
* <li>
|
|
3288
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
3455
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
3456
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3289
3457
|
* </code>
|
|
3290
3458
|
* </p>
|
|
3291
3459
|
* </li>
|
|
3292
3460
|
* <li>
|
|
3293
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
3461
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
3462
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3294
3463
|
* </code>
|
|
3295
3464
|
* </p>
|
|
3296
3465
|
* </li>
|
|
@@ -3299,8 +3468,8 @@ export interface PutCompositeAlarmInput {
|
|
|
3299
3468
|
*/
|
|
3300
3469
|
InsufficientDataActions?: string[] | undefined;
|
|
3301
3470
|
/**
|
|
3302
|
-
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state
|
|
3303
|
-
*
|
|
3471
|
+
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state from
|
|
3472
|
+
* any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
3304
3473
|
* <p>Valid Values: ]</p>
|
|
3305
3474
|
* <p>
|
|
3306
3475
|
* <b>Amazon SNS actions:</b>
|
|
@@ -3314,17 +3483,20 @@ export interface PutCompositeAlarmInput {
|
|
|
3314
3483
|
* </p>
|
|
3315
3484
|
* <ul>
|
|
3316
3485
|
* <li>
|
|
3317
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3486
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3487
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3318
3488
|
* </code>
|
|
3319
3489
|
* </p>
|
|
3320
3490
|
* </li>
|
|
3321
3491
|
* <li>
|
|
3322
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
3492
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
3493
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3323
3494
|
* </code>
|
|
3324
3495
|
* </p>
|
|
3325
3496
|
* </li>
|
|
3326
3497
|
* <li>
|
|
3327
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
3498
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
3499
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3328
3500
|
* </code>
|
|
3329
3501
|
* </p>
|
|
3330
3502
|
* </li>
|
|
@@ -3333,67 +3505,44 @@ export interface PutCompositeAlarmInput {
|
|
|
3333
3505
|
*/
|
|
3334
3506
|
OKActions?: string[] | undefined;
|
|
3335
3507
|
/**
|
|
3336
|
-
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3339
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
3340
|
-
*
|
|
3341
|
-
*
|
|
3342
|
-
* <p>If you are using this operation to update an existing alarm, any tags
|
|
3343
|
-
*
|
|
3344
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>
|
|
3345
|
-
* or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
3508
|
+
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as
|
|
3509
|
+
* 50 tags with an alarm. To be able to associate tags with the alarm when you create the
|
|
3510
|
+
* alarm, you must have the <code>cloudwatch:TagResource</code> permission.</p>
|
|
3511
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
3512
|
+
* scope user permissions by granting a user permission to access or change only resources
|
|
3513
|
+
* with certain tag values.</p>
|
|
3514
|
+
* <p>If you are using this operation to update an existing alarm, any tags you specify in
|
|
3515
|
+
* this parameter are ignored. To change the tags of an existing alarm, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
3346
3516
|
* @public
|
|
3347
3517
|
*/
|
|
3348
3518
|
Tags?: Tag[] | undefined;
|
|
3349
3519
|
/**
|
|
3350
|
-
* <p>
|
|
3351
|
-
*
|
|
3352
|
-
*
|
|
3353
|
-
* in the <code>ALARM</code> state.
|
|
3354
|
-
* <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name (ARN)
|
|
3355
|
-
* from an existing alarm.
|
|
3356
|
-
* </p>
|
|
3520
|
+
* <p> Actions will be suppressed if the suppressor alarm is in the <code>ALARM</code>
|
|
3521
|
+
* state. <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name
|
|
3522
|
+
* (ARN) from an existing alarm. </p>
|
|
3357
3523
|
* @public
|
|
3358
3524
|
*/
|
|
3359
3525
|
ActionsSuppressor?: string | undefined;
|
|
3360
3526
|
/**
|
|
3361
|
-
* <p>
|
|
3362
|
-
*
|
|
3363
|
-
*
|
|
3364
|
-
* that the composite alarm waits
|
|
3365
|
-
* for the suppressor alarm
|
|
3366
|
-
* to go
|
|
3367
|
-
* into the <code>ALARM</code> state.
|
|
3368
|
-
* After this time,
|
|
3369
|
-
* the composite alarm performs its actions.
|
|
3370
|
-
* </p>
|
|
3527
|
+
* <p> The maximum time in seconds that the composite alarm waits for the suppressor alarm
|
|
3528
|
+
* to go into the <code>ALARM</code> state. After this time, the composite alarm performs
|
|
3529
|
+
* its actions. </p>
|
|
3371
3530
|
* <important>
|
|
3372
3531
|
* <p>
|
|
3373
|
-
* <code>WaitPeriod</code>
|
|
3374
|
-
*
|
|
3375
|
-
* when <code>ActionsSuppressor</code> is specified.
|
|
3376
|
-
* </p>
|
|
3532
|
+
* <code>WaitPeriod</code> is required only when <code>ActionsSuppressor</code> is
|
|
3533
|
+
* specified. </p>
|
|
3377
3534
|
* </important>
|
|
3378
3535
|
* @public
|
|
3379
3536
|
*/
|
|
3380
3537
|
ActionsSuppressorWaitPeriod?: number | undefined;
|
|
3381
3538
|
/**
|
|
3382
|
-
* <p>
|
|
3383
|
-
*
|
|
3384
|
-
*
|
|
3385
|
-
* that the composite alarm waits
|
|
3386
|
-
* after suppressor alarm goes out
|
|
3387
|
-
* of the <code>ALARM</code> state.
|
|
3388
|
-
* After this time,
|
|
3389
|
-
* the composite alarm performs its actions.
|
|
3390
|
-
* </p>
|
|
3539
|
+
* <p> The maximum time in seconds that the composite alarm waits after suppressor alarm
|
|
3540
|
+
* goes out of the <code>ALARM</code> state. After this time, the composite alarm performs
|
|
3541
|
+
* its actions. </p>
|
|
3391
3542
|
* <important>
|
|
3392
3543
|
* <p>
|
|
3393
|
-
* <code>ExtensionPeriod</code>
|
|
3394
|
-
*
|
|
3395
|
-
* when <code>ActionsSuppressor</code> is specified.
|
|
3396
|
-
* </p>
|
|
3544
|
+
* <code>ExtensionPeriod</code> is required only when <code>ActionsSuppressor</code> is
|
|
3545
|
+
* specified. </p>
|
|
3397
3546
|
* </important>
|
|
3398
3547
|
* @public
|
|
3399
3548
|
*/
|
|
@@ -3404,17 +3553,17 @@ export interface PutCompositeAlarmInput {
|
|
|
3404
3553
|
*/
|
|
3405
3554
|
export interface PutDashboardInput {
|
|
3406
3555
|
/**
|
|
3407
|
-
* <p>The name of the dashboard. If a dashboard with this name already exists, this call
|
|
3408
|
-
*
|
|
3409
|
-
*
|
|
3556
|
+
* <p>The name of the dashboard. If a dashboard with this name already exists, this call
|
|
3557
|
+
* modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is
|
|
3558
|
+
* created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and
|
|
3559
|
+
* "_". This parameter is required.</p>
|
|
3410
3560
|
* @public
|
|
3411
3561
|
*/
|
|
3412
3562
|
DashboardName: string | undefined;
|
|
3413
3563
|
/**
|
|
3414
|
-
* <p>The detailed information about the dashboard in JSON format, including the widgets
|
|
3415
|
-
*
|
|
3416
|
-
* <p>For more information about the syntax,
|
|
3417
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
|
|
3564
|
+
* <p>The detailed information about the dashboard in JSON format, including the widgets
|
|
3565
|
+
* to include and their location on the dashboard. This parameter is required.</p>
|
|
3566
|
+
* <p>For more information about the syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
|
|
3418
3567
|
* @public
|
|
3419
3568
|
*/
|
|
3420
3569
|
DashboardBody: string | undefined;
|
|
@@ -3424,11 +3573,13 @@ export interface PutDashboardInput {
|
|
|
3424
3573
|
*/
|
|
3425
3574
|
export interface PutDashboardOutput {
|
|
3426
3575
|
/**
|
|
3427
|
-
* <p>If the input for <code>PutDashboard</code> was correct and the dashboard was
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
3430
|
-
*
|
|
3431
|
-
*
|
|
3576
|
+
* <p>If the input for <code>PutDashboard</code> was correct and the dashboard was
|
|
3577
|
+
* successfully created or modified, this result is empty.</p>
|
|
3578
|
+
* <p>If this result includes only warning messages, then the input was valid enough for
|
|
3579
|
+
* the dashboard to be created or modified, but some elements of the dashboard might not
|
|
3580
|
+
* render.</p>
|
|
3581
|
+
* <p>If this result includes error messages, the input was not valid and the operation
|
|
3582
|
+
* failed.</p>
|
|
3432
3583
|
* @public
|
|
3433
3584
|
*/
|
|
3434
3585
|
DashboardValidationMessages?: DashboardValidationMessage[] | undefined;
|
|
@@ -3449,23 +3600,22 @@ export interface PutInsightRuleInput {
|
|
|
3449
3600
|
RuleState?: string | undefined;
|
|
3450
3601
|
/**
|
|
3451
3602
|
* <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
|
|
3452
|
-
*
|
|
3453
|
-
* Rule Syntax</a>.</p>
|
|
3603
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights Rule Syntax</a>.</p>
|
|
3454
3604
|
* @public
|
|
3455
3605
|
*/
|
|
3456
3606
|
RuleDefinition: string | undefined;
|
|
3457
3607
|
/**
|
|
3458
|
-
* <p>A list of key-value pairs to associate with the Contributor Insights rule.
|
|
3459
|
-
*
|
|
3460
|
-
* <p>Tags can help you organize and categorize your
|
|
3461
|
-
*
|
|
3462
|
-
*
|
|
3463
|
-
*
|
|
3464
|
-
*
|
|
3465
|
-
*
|
|
3466
|
-
* <p>If you are using this operation to update an existing Contributor Insights rule, any
|
|
3467
|
-
*
|
|
3468
|
-
*
|
|
3608
|
+
* <p>A list of key-value pairs to associate with the Contributor Insights rule. You can
|
|
3609
|
+
* associate as many as 50 tags with a rule.</p>
|
|
3610
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
3611
|
+
* scope user permissions, by granting a user permission to access or change only the
|
|
3612
|
+
* resources that have certain tag values.</p>
|
|
3613
|
+
* <p>To be able to associate tags with a rule, you must have the
|
|
3614
|
+
* <code>cloudwatch:TagResource</code> permission in addition to the
|
|
3615
|
+
* <code>cloudwatch:PutInsightRule</code> permission.</p>
|
|
3616
|
+
* <p>If you are using this operation to update an existing Contributor Insights rule, any
|
|
3617
|
+
* tags you specify in this parameter are ignored. To change the tags of an existing rule,
|
|
3618
|
+
* use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
3469
3619
|
* @public
|
|
3470
3620
|
*/
|
|
3471
3621
|
Tags?: Tag[] | undefined;
|
|
@@ -3476,63 +3626,35 @@ export interface PutInsightRuleInput {
|
|
|
3476
3626
|
export interface PutInsightRuleOutput {
|
|
3477
3627
|
}
|
|
3478
3628
|
/**
|
|
3479
|
-
* <p>
|
|
3480
|
-
*
|
|
3481
|
-
* that's required
|
|
3482
|
-
* to enable a managed Contributor Insights rule
|
|
3483
|
-
* for an Amazon Web Services resource.
|
|
3629
|
+
* <p> Contains the information that's required to enable a managed Contributor Insights
|
|
3630
|
+
* rule for an Amazon Web Services resource.
|
|
3484
3631
|
*
|
|
3485
|
-
*
|
|
3632
|
+
* </p>
|
|
3486
3633
|
* @public
|
|
3487
3634
|
*/
|
|
3488
3635
|
export interface ManagedRule {
|
|
3489
3636
|
/**
|
|
3490
|
-
* <p>
|
|
3491
|
-
*
|
|
3492
|
-
* for the managed Contributor Insights rule,
|
|
3493
|
-
* as returned
|
|
3494
|
-
* by <code>ListManagedInsightRules</code>.
|
|
3495
|
-
* </p>
|
|
3637
|
+
* <p> The template name for the managed Contributor Insights rule, as returned by
|
|
3638
|
+
* <code>ListManagedInsightRules</code>. </p>
|
|
3496
3639
|
* @public
|
|
3497
3640
|
*/
|
|
3498
3641
|
TemplateName: string | undefined;
|
|
3499
3642
|
/**
|
|
3500
|
-
* <p>
|
|
3501
|
-
*
|
|
3502
|
-
* of an Amazon Web Services resource
|
|
3503
|
-
* that has managed Contributor Insights rules.
|
|
3504
|
-
* </p>
|
|
3643
|
+
* <p> The ARN of an Amazon Web Services resource that has managed Contributor Insights
|
|
3644
|
+
* rules. </p>
|
|
3505
3645
|
* @public
|
|
3506
3646
|
*/
|
|
3507
3647
|
ResourceARN: string | undefined;
|
|
3508
3648
|
/**
|
|
3509
|
-
* <p>
|
|
3510
|
-
*
|
|
3511
|
-
*
|
|
3512
|
-
*
|
|
3513
|
-
*
|
|
3514
|
-
*
|
|
3515
|
-
*
|
|
3516
|
-
*
|
|
3517
|
-
*
|
|
3518
|
-
* to scope user permissions
|
|
3519
|
-
* by granting a user permission
|
|
3520
|
-
* to access or change only the resources
|
|
3521
|
-
* that have certain tag values.
|
|
3522
|
-
* To associate tags
|
|
3523
|
-
* with a rule,
|
|
3524
|
-
* you must have the <code>cloudwatch:TagResource</code> permission
|
|
3525
|
-
* in addition
|
|
3526
|
-
* to the <code>cloudwatch:PutInsightRule</code> permission.
|
|
3527
|
-
* If you are using this operation
|
|
3528
|
-
* to update an existing Contributor Insights rule,
|
|
3529
|
-
* any tags
|
|
3530
|
-
* that you specify
|
|
3531
|
-
* in this parameter are ignored.
|
|
3532
|
-
* To change the tags
|
|
3533
|
-
* of an existing rule,
|
|
3534
|
-
* use <code>TagResource</code>.
|
|
3535
|
-
* </p>
|
|
3649
|
+
* <p> A list of key-value pairs that you can associate with a managed Contributor Insights
|
|
3650
|
+
* rule. You can associate as many as 50 tags with a rule. Tags can help you organize and
|
|
3651
|
+
* categorize your resources. You also can use them to scope user permissions by granting a
|
|
3652
|
+
* user permission to access or change only the resources that have certain tag values. To
|
|
3653
|
+
* associate tags with a rule, you must have the <code>cloudwatch:TagResource</code>
|
|
3654
|
+
* permission in addition to the <code>cloudwatch:PutInsightRule</code> permission. If you
|
|
3655
|
+
* are using this operation to update an existing Contributor Insights rule, any tags that
|
|
3656
|
+
* you specify in this parameter are ignored. To change the tags of an existing rule, use
|
|
3657
|
+
* <code>TagResource</code>. </p>
|
|
3536
3658
|
* @public
|
|
3537
3659
|
*/
|
|
3538
3660
|
Tags?: Tag[] | undefined;
|
|
@@ -3542,11 +3664,7 @@ export interface ManagedRule {
|
|
|
3542
3664
|
*/
|
|
3543
3665
|
export interface PutManagedInsightRulesInput {
|
|
3544
3666
|
/**
|
|
3545
|
-
* <p>
|
|
3546
|
-
* A list
|
|
3547
|
-
* of <code>ManagedRules</code>
|
|
3548
|
-
* to enable.
|
|
3549
|
-
* </p>
|
|
3667
|
+
* <p> A list of <code>ManagedRules</code> to enable. </p>
|
|
3550
3668
|
* @public
|
|
3551
3669
|
*/
|
|
3552
3670
|
ManagedRules: ManagedRule[] | undefined;
|
|
@@ -3556,11 +3674,7 @@ export interface PutManagedInsightRulesInput {
|
|
|
3556
3674
|
*/
|
|
3557
3675
|
export interface PutManagedInsightRulesOutput {
|
|
3558
3676
|
/**
|
|
3559
|
-
* <p>
|
|
3560
|
-
* An array
|
|
3561
|
-
* that lists the rules
|
|
3562
|
-
* that could not be enabled.
|
|
3563
|
-
* </p>
|
|
3677
|
+
* <p> An array that lists the rules that could not be enabled. </p>
|
|
3564
3678
|
* @public
|
|
3565
3679
|
*/
|
|
3566
3680
|
Failures?: PartialFailure[] | undefined;
|
|
@@ -3571,8 +3685,8 @@ export interface PutManagedInsightRulesOutput {
|
|
|
3571
3685
|
export interface PutMetricAlarmInput {
|
|
3572
3686
|
/**
|
|
3573
3687
|
* <p>The name for the alarm. This name must be unique within the Region.</p>
|
|
3574
|
-
* <p>The name must contain only UTF-8
|
|
3575
|
-
*
|
|
3688
|
+
* <p>The name must contain only UTF-8 characters, and can't contain ASCII control
|
|
3689
|
+
* characters</p>
|
|
3576
3690
|
* @public
|
|
3577
3691
|
*/
|
|
3578
3692
|
AlarmName: string | undefined;
|
|
@@ -3582,14 +3696,15 @@ export interface PutMetricAlarmInput {
|
|
|
3582
3696
|
*/
|
|
3583
3697
|
AlarmDescription?: string | undefined;
|
|
3584
3698
|
/**
|
|
3585
|
-
* <p>Indicates whether actions should be executed during any changes to the alarm state.
|
|
3586
|
-
*
|
|
3699
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm state.
|
|
3700
|
+
* The default is <code>TRUE</code>.</p>
|
|
3587
3701
|
* @public
|
|
3588
3702
|
*/
|
|
3589
3703
|
ActionsEnabled?: boolean | undefined;
|
|
3590
3704
|
/**
|
|
3591
|
-
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state
|
|
3592
|
-
*
|
|
3705
|
+
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state from
|
|
3706
|
+
* any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
|
|
3707
|
+
* values:</p>
|
|
3593
3708
|
* <p>
|
|
3594
3709
|
* <b>EC2 actions:</b>
|
|
3595
3710
|
* </p>
|
|
@@ -3651,17 +3766,20 @@ export interface PutMetricAlarmInput {
|
|
|
3651
3766
|
* </p>
|
|
3652
3767
|
* <ul>
|
|
3653
3768
|
* <li>
|
|
3654
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3769
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3770
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3655
3771
|
* </code>
|
|
3656
3772
|
* </p>
|
|
3657
3773
|
* </li>
|
|
3658
3774
|
* <li>
|
|
3659
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
3775
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
3776
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3660
3777
|
* </code>
|
|
3661
3778
|
* </p>
|
|
3662
3779
|
* </li>
|
|
3663
3780
|
* <li>
|
|
3664
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
3781
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
3782
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3665
3783
|
* </code>
|
|
3666
3784
|
* </p>
|
|
3667
3785
|
* </li>
|
|
@@ -3698,8 +3816,9 @@ export interface PutMetricAlarmInput {
|
|
|
3698
3816
|
*/
|
|
3699
3817
|
OKActions?: string[] | undefined;
|
|
3700
3818
|
/**
|
|
3701
|
-
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
3702
|
-
*
|
|
3819
|
+
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
3820
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
|
|
3821
|
+
* values:</p>
|
|
3703
3822
|
* <p>
|
|
3704
3823
|
* <b>EC2 actions:</b>
|
|
3705
3824
|
* </p>
|
|
@@ -3761,17 +3880,20 @@ export interface PutMetricAlarmInput {
|
|
|
3761
3880
|
* </p>
|
|
3762
3881
|
* <ul>
|
|
3763
3882
|
* <li>
|
|
3764
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3883
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3884
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3765
3885
|
* </code>
|
|
3766
3886
|
* </p>
|
|
3767
3887
|
* </li>
|
|
3768
3888
|
* <li>
|
|
3769
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
3889
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
3890
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3770
3891
|
* </code>
|
|
3771
3892
|
* </p>
|
|
3772
3893
|
* </li>
|
|
3773
3894
|
* <li>
|
|
3774
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
3895
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
3896
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3775
3897
|
* </code>
|
|
3776
3898
|
* </p>
|
|
3777
3899
|
* </li>
|
|
@@ -3808,8 +3930,9 @@ export interface PutMetricAlarmInput {
|
|
|
3808
3930
|
*/
|
|
3809
3931
|
AlarmActions?: string[] | undefined;
|
|
3810
3932
|
/**
|
|
3811
|
-
* <p>The actions to execute when this alarm transitions to the
|
|
3812
|
-
*
|
|
3933
|
+
* <p>The actions to execute when this alarm transitions to the
|
|
3934
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
3935
|
+
* as an Amazon Resource Name (ARN). Valid values:</p>
|
|
3813
3936
|
* <p>
|
|
3814
3937
|
* <b>EC2 actions:</b>
|
|
3815
3938
|
* </p>
|
|
@@ -3871,17 +3994,20 @@ export interface PutMetricAlarmInput {
|
|
|
3871
3994
|
* </p>
|
|
3872
3995
|
* <ul>
|
|
3873
3996
|
* <li>
|
|
3874
|
-
* <p>Invoke the latest version of a Lambda function:
|
|
3997
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
3998
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3875
3999
|
* </code>
|
|
3876
4000
|
* </p>
|
|
3877
4001
|
* </li>
|
|
3878
4002
|
* <li>
|
|
3879
|
-
* <p>Invoke a specific version of a Lambda function:
|
|
4003
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4004
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3880
4005
|
* </code>
|
|
3881
4006
|
* </p>
|
|
3882
4007
|
* </li>
|
|
3883
4008
|
* <li>
|
|
3884
|
-
* <p>Invoke a function by using an alias Lambda function:
|
|
4009
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4010
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3885
4011
|
* </code>
|
|
3886
4012
|
* </p>
|
|
3887
4013
|
* </li>
|
|
@@ -3918,33 +4044,36 @@ export interface PutMetricAlarmInput {
|
|
|
3918
4044
|
*/
|
|
3919
4045
|
InsufficientDataActions?: string[] | undefined;
|
|
3920
4046
|
/**
|
|
3921
|
-
* <p>The name for the metric associated with the alarm. For each
|
|
3922
|
-
*
|
|
3923
|
-
*
|
|
3924
|
-
*
|
|
3925
|
-
*
|
|
3926
|
-
*
|
|
4047
|
+
* <p>The name for the metric associated with the alarm. For each
|
|
4048
|
+
* <code>PutMetricAlarm</code> operation, you must specify either
|
|
4049
|
+
* <code>MetricName</code> or a <code>Metrics</code> array.</p>
|
|
4050
|
+
* <p>If you are creating an alarm based on a math expression, you cannot specify this
|
|
4051
|
+
* parameter, or any of the <code>Namespace</code>, <code>Dimensions</code>,
|
|
4052
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
4053
|
+
* <code>ExtendedStatistic</code> parameters. Instead, you specify all this information
|
|
4054
|
+
* in the <code>Metrics</code> array.</p>
|
|
3927
4055
|
* @public
|
|
3928
4056
|
*/
|
|
3929
4057
|
MetricName?: string | undefined;
|
|
3930
4058
|
/**
|
|
3931
|
-
* <p>The namespace for the metric associated specified in
|
|
4059
|
+
* <p>The namespace for the metric associated specified in
|
|
4060
|
+
* <code>MetricName</code>.</p>
|
|
3932
4061
|
* @public
|
|
3933
4062
|
*/
|
|
3934
4063
|
Namespace?: string | undefined;
|
|
3935
4064
|
/**
|
|
3936
|
-
* <p>The statistic for the metric specified in <code>MetricName</code>, other than
|
|
3937
|
-
*
|
|
3938
|
-
*
|
|
3939
|
-
*
|
|
4065
|
+
* <p>The statistic for the metric specified in <code>MetricName</code>, other than
|
|
4066
|
+
* percentile. For percentile statistics, use <code>ExtendedStatistic</code>. When you call
|
|
4067
|
+
* <code>PutMetricAlarm</code> and specify a <code>MetricName</code>, you must specify
|
|
4068
|
+
* either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
|
|
3940
4069
|
* @public
|
|
3941
4070
|
*/
|
|
3942
4071
|
Statistic?: Statistic | undefined;
|
|
3943
4072
|
/**
|
|
3944
|
-
* <p>The extended statistic for the metric specified in <code>MetricName</code>. When
|
|
3945
|
-
*
|
|
3946
|
-
*
|
|
3947
|
-
*
|
|
4073
|
+
* <p>The extended statistic for the metric specified in <code>MetricName</code>. When
|
|
4074
|
+
* you call <code>PutMetricAlarm</code> and specify a <code>MetricName</code>, you must
|
|
4075
|
+
* specify either <code>Statistic</code> or <code>ExtendedStatistic</code> but not
|
|
4076
|
+
* both.</p>
|
|
3948
4077
|
* <p>If you specify <code>ExtendedStatistic</code>, the following are valid values:</p>
|
|
3949
4078
|
* <ul>
|
|
3950
4079
|
* <li>
|
|
@@ -3979,32 +4108,31 @@ export interface PutMetricAlarmInput {
|
|
|
3979
4108
|
* </li>
|
|
3980
4109
|
* <li>
|
|
3981
4110
|
* <p>
|
|
3982
|
-
* <code>PR(<i>n</i>:<i>m</i>)</code> where n and m
|
|
3983
|
-
*
|
|
4111
|
+
* <code>PR(<i>n</i>:<i>m</i>)</code> where n and m
|
|
4112
|
+
* are values of the metric</p>
|
|
3984
4113
|
* </li>
|
|
3985
4114
|
* <li>
|
|
3986
4115
|
* <p>
|
|
3987
|
-
* <code>TC(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
3988
|
-
*
|
|
4116
|
+
* <code>TC(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
4117
|
+
* between 10 and 90 inclusive.</p>
|
|
3989
4118
|
* </li>
|
|
3990
4119
|
* <li>
|
|
3991
4120
|
* <p>
|
|
3992
|
-
* <code>TM(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
3993
|
-
*
|
|
4121
|
+
* <code>TM(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
4122
|
+
* between 10 and 90 inclusive.</p>
|
|
3994
4123
|
* </li>
|
|
3995
4124
|
* <li>
|
|
3996
4125
|
* <p>
|
|
3997
|
-
* <code>TS(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
3998
|
-
*
|
|
4126
|
+
* <code>TS(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
4127
|
+
* between 10 and 90 inclusive.</p>
|
|
3999
4128
|
* </li>
|
|
4000
4129
|
* <li>
|
|
4001
4130
|
* <p>
|
|
4002
|
-
* <code>WM(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
4003
|
-
*
|
|
4131
|
+
* <code>WM(<i>X</i>%:<i>X</i>%)</code> where X is
|
|
4132
|
+
* between 10 and 90 inclusive.</p>
|
|
4004
4133
|
* </li>
|
|
4005
4134
|
* </ul>
|
|
4006
|
-
* <p>For more information about these extended statistics, see
|
|
4007
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
4135
|
+
* <p>For more information about these extended statistics, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
4008
4136
|
* @public
|
|
4009
4137
|
*/
|
|
4010
4138
|
ExtendedStatistic?: string | undefined;
|
|
@@ -4014,260 +4142,243 @@ export interface PutMetricAlarmInput {
|
|
|
4014
4142
|
*/
|
|
4015
4143
|
Dimensions?: Dimension[] | undefined;
|
|
4016
4144
|
/**
|
|
4017
|
-
* <p>The length, in seconds, used each time the metric specified in
|
|
4018
|
-
*
|
|
4145
|
+
* <p>The length, in seconds, used each time the metric specified in
|
|
4146
|
+
* <code>MetricName</code> is evaluated. Valid values are 10, 30, and any multiple of
|
|
4147
|
+
* 60.</p>
|
|
4019
4148
|
* <p>
|
|
4020
|
-
* <code>Period</code> is required for alarms based on static thresholds. If
|
|
4021
|
-
*
|
|
4022
|
-
*
|
|
4023
|
-
* <p>Be sure to specify 10 or 30 only for metrics that are stored by a
|
|
4024
|
-
*
|
|
4025
|
-
*
|
|
4026
|
-
*
|
|
4027
|
-
*
|
|
4028
|
-
*
|
|
4029
|
-
*
|
|
4030
|
-
*
|
|
4149
|
+
* <code>Period</code> is required for alarms based on static thresholds. If you are
|
|
4150
|
+
* creating an alarm based on a metric math expression, you specify the period for each
|
|
4151
|
+
* metric within the objects in the <code>Metrics</code> array.</p>
|
|
4152
|
+
* <p>Be sure to specify 10 or 30 only for metrics that are stored by a
|
|
4153
|
+
* <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you
|
|
4154
|
+
* specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the
|
|
4155
|
+
* alarm still attempts to gather data at the period rate that you specify. In this case,
|
|
4156
|
+
* it does not receive data for the attempts that do not correspond to a one-minute data
|
|
4157
|
+
* resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10
|
|
4158
|
+
* or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than
|
|
4159
|
+
* other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
4160
|
+
* Pricing</a>.</p>
|
|
4161
|
+
* <p>An alarm's total current evaluation period can be no longer than one day, so
|
|
4162
|
+
* <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than
|
|
4163
|
+
* 86,400 seconds.</p>
|
|
4031
4164
|
* @public
|
|
4032
4165
|
*/
|
|
4033
4166
|
Period?: number | undefined;
|
|
4034
4167
|
/**
|
|
4035
4168
|
* <p>The unit of measure for the statistic. For example, the units for the Amazon EC2
|
|
4036
|
-
*
|
|
4037
|
-
*
|
|
4038
|
-
*
|
|
4039
|
-
*
|
|
4040
|
-
*
|
|
4041
|
-
*
|
|
4042
|
-
* <p>If you don't specify <code>Unit</code>, CloudWatch retrieves all unit types that
|
|
4043
|
-
*
|
|
4044
|
-
*
|
|
4045
|
-
*
|
|
4046
|
-
*
|
|
4047
|
-
*
|
|
4048
|
-
*
|
|
4049
|
-
*
|
|
4050
|
-
*
|
|
4051
|
-
* specify an incorrect unit that is not published for this metric. Doing so
|
|
4052
|
-
* causes the alarm to be stuck in the <code>INSUFFICIENT DATA</code> state.</p>
|
|
4169
|
+
* NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
|
|
4170
|
+
* receives on all network interfaces. You can also specify a unit when you create a custom
|
|
4171
|
+
* metric. Units help provide conceptual meaning to your data. Metric data points that
|
|
4172
|
+
* specify a unit of measure, such as Percent, are aggregated separately. If you are
|
|
4173
|
+
* creating an alarm based on a metric math expression, you can specify the unit for each
|
|
4174
|
+
* metric (if needed) within the objects in the <code>Metrics</code> array.</p>
|
|
4175
|
+
* <p>If you don't specify <code>Unit</code>, CloudWatch retrieves all unit types that
|
|
4176
|
+
* have been published for the metric and attempts to evaluate the alarm. Usually, metrics
|
|
4177
|
+
* are published with only one unit, so the alarm works as intended.</p>
|
|
4178
|
+
* <p>However, if the metric is published with multiple types of units and you don't
|
|
4179
|
+
* specify a unit, the alarm's behavior is not defined and it behaves
|
|
4180
|
+
* unpredictably.</p>
|
|
4181
|
+
* <p>We recommend omitting <code>Unit</code> so that you don't inadvertently specify an
|
|
4182
|
+
* incorrect unit that is not published for this metric. Doing so causes the alarm to be
|
|
4183
|
+
* stuck in the <code>INSUFFICIENT DATA</code> state.</p>
|
|
4053
4184
|
* @public
|
|
4054
4185
|
*/
|
|
4055
4186
|
Unit?: StandardUnit | undefined;
|
|
4056
4187
|
/**
|
|
4057
|
-
* <p>The number of periods over which data is compared to the specified threshold. If
|
|
4058
|
-
*
|
|
4059
|
-
*
|
|
4060
|
-
*
|
|
4061
|
-
* <p>An alarm's total current evaluation period can
|
|
4062
|
-
*
|
|
4188
|
+
* <p>The number of periods over which data is compared to the specified threshold. If
|
|
4189
|
+
* you are setting an alarm that requires that a number of consecutive data points be
|
|
4190
|
+
* breaching to trigger the alarm, this value specifies that number. If you are setting an
|
|
4191
|
+
* "M out of N" alarm, this value is the N.</p>
|
|
4192
|
+
* <p>An alarm's total current evaluation period can be no longer than one day, so this
|
|
4193
|
+
* number multiplied by <code>Period</code> cannot be more than 86,400 seconds.</p>
|
|
4063
4194
|
* @public
|
|
4064
4195
|
*/
|
|
4065
4196
|
EvaluationPeriods: number | undefined;
|
|
4066
4197
|
/**
|
|
4067
|
-
* <p>The number of data points that must be breaching to trigger the alarm. This is used
|
|
4068
|
-
*
|
|
4069
|
-
*
|
|
4070
|
-
*
|
|
4198
|
+
* <p>The number of data points that must be breaching to trigger the alarm. This is used
|
|
4199
|
+
* only if you are setting an "M out of N" alarm. In that case, this value is the M. For
|
|
4200
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation">Evaluating an Alarm</a> in the <i>Amazon CloudWatch User
|
|
4201
|
+
* Guide</i>.</p>
|
|
4071
4202
|
* @public
|
|
4072
4203
|
*/
|
|
4073
4204
|
DatapointsToAlarm?: number | undefined;
|
|
4074
4205
|
/**
|
|
4075
4206
|
* <p>The value against which the specified statistic is compared.</p>
|
|
4076
|
-
* <p>This parameter is required for alarms based on static thresholds, but should
|
|
4077
|
-
*
|
|
4207
|
+
* <p>This parameter is required for alarms based on static thresholds, but should not be
|
|
4208
|
+
* used for alarms based on anomaly detection models.</p>
|
|
4078
4209
|
* @public
|
|
4079
4210
|
*/
|
|
4080
4211
|
Threshold?: number | undefined;
|
|
4081
4212
|
/**
|
|
4082
4213
|
* <p> The arithmetic operation to use when comparing the specified statistic and
|
|
4083
|
-
*
|
|
4214
|
+
* threshold. The specified statistic value is used as the first operand.</p>
|
|
4084
4215
|
* <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
|
|
4085
|
-
*
|
|
4086
|
-
*
|
|
4216
|
+
* <code>LessThanLowerThreshold</code>, and <code>GreaterThanUpperThreshold</code> are
|
|
4217
|
+
* used only for alarms based on anomaly detection models.</p>
|
|
4087
4218
|
* @public
|
|
4088
4219
|
*/
|
|
4089
4220
|
ComparisonOperator: ComparisonOperator | undefined;
|
|
4090
4221
|
/**
|
|
4091
|
-
* <p> Sets how this alarm is to handle missing data points. If
|
|
4092
|
-
*
|
|
4093
|
-
*
|
|
4222
|
+
* <p> Sets how this alarm is to handle missing data points. If
|
|
4223
|
+
* <code>TreatMissingData</code> is omitted, the default behavior of
|
|
4224
|
+
* <code>missing</code> is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p>
|
|
4094
4225
|
* <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>
|
|
4095
4226
|
* </p>
|
|
4096
4227
|
* <note>
|
|
4097
|
-
* <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always
|
|
4098
|
-
*
|
|
4099
|
-
*
|
|
4228
|
+
* <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always
|
|
4229
|
+
* <code>ignore</code> missing data even if you choose a different option for
|
|
4230
|
+
* <code>TreatMissingData</code>. When an <code>AWS/DynamoDB</code> metric has
|
|
4231
|
+
* missing data, alarms that evaluate that metric remain in their current state.</p>
|
|
4100
4232
|
* </note>
|
|
4101
4233
|
* @public
|
|
4102
4234
|
*/
|
|
4103
4235
|
TreatMissingData?: string | undefined;
|
|
4104
4236
|
/**
|
|
4105
|
-
* <p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the
|
|
4106
|
-
*
|
|
4107
|
-
*
|
|
4237
|
+
* <p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the
|
|
4238
|
+
* alarm state does not change during periods with too few data points to be statistically
|
|
4239
|
+
* significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is
|
|
4240
|
+
* always evaluated and possibly changes state no matter how many data points are
|
|
4241
|
+
* available. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p>
|
|
4108
4242
|
* <p>Valid Values: <code>evaluate | ignore</code>
|
|
4109
4243
|
* </p>
|
|
4110
4244
|
* @public
|
|
4111
4245
|
*/
|
|
4112
4246
|
EvaluateLowSampleCountPercentile?: string | undefined;
|
|
4113
4247
|
/**
|
|
4114
|
-
* <p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm
|
|
4115
|
-
*
|
|
4116
|
-
*
|
|
4117
|
-
*
|
|
4118
|
-
* <p>
|
|
4119
|
-
*
|
|
4248
|
+
* <p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm
|
|
4249
|
+
* based on the result of a metric math expression. For each <code>PutMetricAlarm</code>
|
|
4250
|
+
* operation, you must specify either <code>MetricName</code> or a <code>Metrics</code>
|
|
4251
|
+
* array.</p>
|
|
4252
|
+
* <p>Each item in the <code>Metrics</code> array either retrieves a metric or performs a
|
|
4253
|
+
* math expression.</p>
|
|
4254
|
+
* <p>One item in the <code>Metrics</code> array is the expression that the alarm watches.
|
|
4255
|
+
* You designate this expression by setting <code>ReturnData</code> to true for this object
|
|
4256
|
+
* in the array. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html">MetricDataQuery</a>.</p>
|
|
4120
4257
|
* <p>If you use the <code>Metrics</code> parameter, you cannot include the
|
|
4121
|
-
*
|
|
4122
|
-
*
|
|
4123
|
-
*
|
|
4124
|
-
*
|
|
4258
|
+
* <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>,
|
|
4259
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
4260
|
+
* <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same
|
|
4261
|
+
* operation. Instead, you retrieve the metrics you are using in your math expression as
|
|
4262
|
+
* part of the <code>Metrics</code> array.</p>
|
|
4125
4263
|
* @public
|
|
4126
4264
|
*/
|
|
4127
4265
|
Metrics?: MetricDataQuery[] | undefined;
|
|
4128
4266
|
/**
|
|
4129
|
-
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as
|
|
4130
|
-
*
|
|
4131
|
-
*
|
|
4132
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
4133
|
-
*
|
|
4134
|
-
*
|
|
4135
|
-
* <p>If you are using this operation to update an existing alarm, any tags
|
|
4136
|
-
*
|
|
4137
|
-
*
|
|
4138
|
-
*
|
|
4267
|
+
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as
|
|
4268
|
+
* 50 tags with an alarm. To be able to associate tags with the alarm when you create the
|
|
4269
|
+
* alarm, you must have the <code>cloudwatch:TagResource</code> permission.</p>
|
|
4270
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
4271
|
+
* scope user permissions by granting a user permission to access or change only resources
|
|
4272
|
+
* with certain tag values.</p>
|
|
4273
|
+
* <p>If you are using this operation to update an existing alarm, any tags you specify in
|
|
4274
|
+
* this parameter are ignored. To change the tags of an existing alarm, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4275
|
+
* <p>To use this field to set tags for an alarm when you create it, you must be signed on
|
|
4276
|
+
* with both the <code>cloudwatch:PutMetricAlarm</code> and
|
|
4277
|
+
* <code>cloudwatch:TagResource</code> permissions.</p>
|
|
4139
4278
|
* @public
|
|
4140
4279
|
*/
|
|
4141
4280
|
Tags?: Tag[] | undefined;
|
|
4142
4281
|
/**
|
|
4143
|
-
* <p>If this is an alarm based on an anomaly detection model, make this value match
|
|
4144
|
-
*
|
|
4145
|
-
*
|
|
4146
|
-
*
|
|
4147
|
-
* <b>Anomaly Detection
|
|
4148
|
-
* Model Alarm</b> example on this page.</p>
|
|
4282
|
+
* <p>If this is an alarm based on an anomaly detection model, make this value match the ID
|
|
4283
|
+
* of the <code>ANOMALY_DETECTION_BAND</code> function.</p>
|
|
4284
|
+
* <p>For an example of how to use this parameter, see the <b>Anomaly
|
|
4285
|
+
* Detection Model Alarm</b> example on this page.</p>
|
|
4149
4286
|
* <p>If your alarm uses this parameter, it cannot have Auto Scaling actions.</p>
|
|
4150
4287
|
* @public
|
|
4151
4288
|
*/
|
|
4152
4289
|
ThresholdMetricId?: string | undefined;
|
|
4153
4290
|
}
|
|
4154
4291
|
/**
|
|
4155
|
-
* <p>Represents a set of statistics that describes a specific metric. </p>
|
|
4156
4292
|
* @public
|
|
4157
4293
|
*/
|
|
4158
|
-
export interface
|
|
4159
|
-
/**
|
|
4160
|
-
* <p>The number of samples used for the statistic set.</p>
|
|
4161
|
-
* @public
|
|
4162
|
-
*/
|
|
4163
|
-
SampleCount: number | undefined;
|
|
4164
|
-
/**
|
|
4165
|
-
* <p>The sum of values for the sample set.</p>
|
|
4166
|
-
* @public
|
|
4167
|
-
*/
|
|
4168
|
-
Sum: number | undefined;
|
|
4169
|
-
/**
|
|
4170
|
-
* <p>The minimum value of the sample set.</p>
|
|
4171
|
-
* @public
|
|
4172
|
-
*/
|
|
4173
|
-
Minimum: number | undefined;
|
|
4174
|
-
/**
|
|
4175
|
-
* <p>The maximum value of the sample set.</p>
|
|
4176
|
-
* @public
|
|
4177
|
-
*/
|
|
4178
|
-
Maximum: number | undefined;
|
|
4179
|
-
}
|
|
4180
|
-
/**
|
|
4181
|
-
* <p>Encapsulates the information sent to either create a metric or add new values
|
|
4182
|
-
* to be aggregated into an existing metric.</p>
|
|
4183
|
-
* @public
|
|
4184
|
-
*/
|
|
4185
|
-
export interface MetricDatum {
|
|
4186
|
-
/**
|
|
4187
|
-
* <p>The name of the metric.</p>
|
|
4188
|
-
* @public
|
|
4189
|
-
*/
|
|
4190
|
-
MetricName: string | undefined;
|
|
4191
|
-
/**
|
|
4192
|
-
* <p>The dimensions associated with the metric. </p>
|
|
4193
|
-
* @public
|
|
4194
|
-
*/
|
|
4195
|
-
Dimensions?: Dimension[] | undefined;
|
|
4196
|
-
/**
|
|
4197
|
-
* <p>The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
|
|
4198
|
-
* @public
|
|
4199
|
-
*/
|
|
4200
|
-
Timestamp?: Date | undefined;
|
|
4201
|
-
/**
|
|
4202
|
-
* <p>The value for the metric.</p>
|
|
4203
|
-
* <p>Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or
|
|
4204
|
-
* too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)
|
|
4205
|
-
* are not supported.</p>
|
|
4206
|
-
* @public
|
|
4207
|
-
*/
|
|
4208
|
-
Value?: number | undefined;
|
|
4209
|
-
/**
|
|
4210
|
-
* <p>The statistical values for the metric.</p>
|
|
4211
|
-
* @public
|
|
4212
|
-
*/
|
|
4213
|
-
StatisticValues?: StatisticSet | undefined;
|
|
4214
|
-
/**
|
|
4215
|
-
* <p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once
|
|
4216
|
-
* in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period.
|
|
4217
|
-
* You can include up to 150 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p>
|
|
4218
|
-
* <p>Although the <code>Values</code> array accepts numbers of type
|
|
4219
|
-
* <code>Double</code>, CloudWatch rejects values that are either too small
|
|
4220
|
-
* or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
|
|
4221
|
-
* -Infinity) are not supported.</p>
|
|
4222
|
-
* @public
|
|
4223
|
-
*/
|
|
4224
|
-
Values?: number[] | undefined;
|
|
4225
|
-
/**
|
|
4226
|
-
* <p>Array of numbers that is used along with the <code>Values</code> array. Each number in the <code>Count</code> array
|
|
4227
|
-
* is the number of times the corresponding value in the <code>Values</code> array occurred during the period. </p>
|
|
4228
|
-
* <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for each count. If you
|
|
4229
|
-
* include a <code>Counts</code> array, it must include the same amount of values as the <code>Values</code> array.</p>
|
|
4230
|
-
* @public
|
|
4231
|
-
*/
|
|
4232
|
-
Counts?: number[] | undefined;
|
|
4294
|
+
export interface PutMetricDataInput {
|
|
4233
4295
|
/**
|
|
4234
|
-
* <p>
|
|
4235
|
-
*
|
|
4236
|
-
*
|
|
4296
|
+
* <p>The namespace for the metric data. You can use ASCII characters for the namespace,
|
|
4297
|
+
* except for control characters which are not supported.</p>
|
|
4298
|
+
* <p>To avoid conflicts with Amazon Web Services service namespaces, you should not
|
|
4299
|
+
* specify a namespace that begins with <code>AWS/</code>
|
|
4300
|
+
* </p>
|
|
4237
4301
|
* @public
|
|
4238
4302
|
*/
|
|
4239
|
-
|
|
4303
|
+
Namespace: string | undefined;
|
|
4240
4304
|
/**
|
|
4241
|
-
* <p>
|
|
4242
|
-
*
|
|
4243
|
-
*
|
|
4244
|
-
*
|
|
4245
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics">High-Resolution Metrics</a> in the
|
|
4246
|
-
* <i>Amazon CloudWatch User Guide</i>.
|
|
4247
|
-
* </p>
|
|
4248
|
-
* <p>This field is optional, if you do not specify it the default of 60 is used.</p>
|
|
4305
|
+
* <p>The data for the metrics. Use this parameter if your metrics do not contain
|
|
4306
|
+
* associated entities. The array can include no more than 1000 metrics per call.</p>
|
|
4307
|
+
* <p>The limit of metrics allowed, 1000, is the sum of both <code>EntityMetricData</code>
|
|
4308
|
+
* and <code>MetricData</code> metrics.</p>
|
|
4249
4309
|
* @public
|
|
4250
4310
|
*/
|
|
4251
|
-
|
|
4252
|
-
}
|
|
4253
|
-
/**
|
|
4254
|
-
* @public
|
|
4255
|
-
*/
|
|
4256
|
-
export interface PutMetricDataInput {
|
|
4311
|
+
MetricData?: MetricDatum[] | undefined;
|
|
4257
4312
|
/**
|
|
4258
|
-
* <p>
|
|
4259
|
-
*
|
|
4260
|
-
*
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
4313
|
+
* <p>Data for metrics that contain associated entity information. You can include up to
|
|
4314
|
+
* two <code>EntityMetricData</code> objects, each of which can contain a single
|
|
4315
|
+
* <code>Entity</code> and associated metrics.</p>
|
|
4316
|
+
* <p>The limit of metrics allowed, 1000, is the sum of both <code>EntityMetricData</code>
|
|
4317
|
+
* and <code>MetricData</code> metrics.</p>
|
|
4263
4318
|
* @public
|
|
4264
4319
|
*/
|
|
4265
|
-
|
|
4320
|
+
EntityMetricData?: EntityMetricData[] | undefined;
|
|
4266
4321
|
/**
|
|
4267
|
-
* <p>
|
|
4322
|
+
* <p>Whether to accept valid metric data when an invalid entity is sent.</p>
|
|
4323
|
+
* <ul>
|
|
4324
|
+
* <li>
|
|
4325
|
+
* <p>When set to <code>true</code>: Any validation error (for entity or metric
|
|
4326
|
+
* data) will fail the entire request, and no data will be ingested. The failed
|
|
4327
|
+
* operation will return a 400 result with the error.</p>
|
|
4328
|
+
* </li>
|
|
4329
|
+
* <li>
|
|
4330
|
+
* <p>When set to <code>false</code>: Validation errors in the entity will not
|
|
4331
|
+
* associate the metric with the entity, but the metric data will still be
|
|
4332
|
+
* accepted and ingested. Validation errors in the metric data will fail the
|
|
4333
|
+
* entire request, and no data will be ingested.</p>
|
|
4334
|
+
* <p>In the case of an invalid entity, the operation will return a
|
|
4335
|
+
* <code>200</code> status, but an additional response header will contain
|
|
4336
|
+
* information about the validation errors. The new header,
|
|
4337
|
+
* <code>X-Amzn-Failure-Message</code> is an enumeration of the following
|
|
4338
|
+
* values:</p>
|
|
4339
|
+
* <ul>
|
|
4340
|
+
* <li>
|
|
4341
|
+
* <p>
|
|
4342
|
+
* <code>InvalidEntity</code> - The provided entity is invalid.</p>
|
|
4343
|
+
* </li>
|
|
4344
|
+
* <li>
|
|
4345
|
+
* <p>
|
|
4346
|
+
* <code>InvalidKeyAttributes</code> - The provided
|
|
4347
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4348
|
+
* </li>
|
|
4349
|
+
* <li>
|
|
4350
|
+
* <p>
|
|
4351
|
+
* <code>InvalidAttributes</code> - The provided <code>Attributes</code>
|
|
4352
|
+
* of an entity is invalid.</p>
|
|
4353
|
+
* </li>
|
|
4354
|
+
* <li>
|
|
4355
|
+
* <p>
|
|
4356
|
+
* <code>InvalidTypeValue</code> - The provided <code>Type</code> in the
|
|
4357
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4358
|
+
* </li>
|
|
4359
|
+
* <li>
|
|
4360
|
+
* <p>
|
|
4361
|
+
* <code>EntitySizeTooLarge</code> - The number of
|
|
4362
|
+
* <code>EntityMetricData</code> objects allowed is 2.</p>
|
|
4363
|
+
* </li>
|
|
4364
|
+
* <li>
|
|
4365
|
+
* <p>
|
|
4366
|
+
* <code>MissingRequiredFields</code> - There are missing required
|
|
4367
|
+
* fields in the <code>KeyAttributes</code> for the provided
|
|
4368
|
+
* <code>Type</code>.</p>
|
|
4369
|
+
* </li>
|
|
4370
|
+
* </ul>
|
|
4371
|
+
* <p>For details of the requirements for specifying an entity, see
|
|
4372
|
+
* <a href="https://docs.aws.amazon.com/adding-your-own-related-telemetry.html">How
|
|
4373
|
+
* to add related information to telemetry</a> in the
|
|
4374
|
+
* <i>CloudWatch User Guide</i>.</p>
|
|
4375
|
+
* </li>
|
|
4376
|
+
* </ul>
|
|
4377
|
+
* <p>This parameter is <i>required</i> when <code>EntityMetricData</code> is
|
|
4378
|
+
* included.</p>
|
|
4268
4379
|
* @public
|
|
4269
4380
|
*/
|
|
4270
|
-
|
|
4381
|
+
StrictEntityValidation?: boolean | undefined;
|
|
4271
4382
|
}
|
|
4272
4383
|
/**
|
|
4273
4384
|
* @public
|
|
@@ -4275,39 +4386,40 @@ export interface PutMetricDataInput {
|
|
|
4275
4386
|
export interface PutMetricStreamInput {
|
|
4276
4387
|
/**
|
|
4277
4388
|
* <p>If you are creating a new metric stream, this is the name for the new stream. The name
|
|
4278
|
-
*
|
|
4389
|
+
* must be different than the names of other metric streams in this account and
|
|
4390
|
+
* Region.</p>
|
|
4279
4391
|
* <p>If you are updating a metric stream, specify the name of that stream here.</p>
|
|
4280
4392
|
* <p>Valid characters are A-Z, a-z, 0-9, "-" and "_".</p>
|
|
4281
4393
|
* @public
|
|
4282
4394
|
*/
|
|
4283
4395
|
Name: string | undefined;
|
|
4284
4396
|
/**
|
|
4285
|
-
* <p>If you specify this parameter, the stream sends only the
|
|
4286
|
-
*
|
|
4287
|
-
* <p>You cannot include <code>IncludeFilters</code> and <code>ExcludeFilters</code>
|
|
4288
|
-
*
|
|
4397
|
+
* <p>If you specify this parameter, the stream sends only the metrics from the metric
|
|
4398
|
+
* namespaces that you specify here.</p>
|
|
4399
|
+
* <p>You cannot include <code>IncludeFilters</code> and <code>ExcludeFilters</code> in the
|
|
4400
|
+
* same operation.</p>
|
|
4289
4401
|
* @public
|
|
4290
4402
|
*/
|
|
4291
4403
|
IncludeFilters?: MetricStreamFilter[] | undefined;
|
|
4292
4404
|
/**
|
|
4293
|
-
* <p>If you specify this parameter, the stream sends metrics from all
|
|
4294
|
-
*
|
|
4295
|
-
* <p>You cannot include <code>ExcludeFilters</code> and <code>IncludeFilters</code> in
|
|
4296
|
-
*
|
|
4405
|
+
* <p>If you specify this parameter, the stream sends metrics from all metric namespaces
|
|
4406
|
+
* except for the namespaces that you specify here.</p>
|
|
4407
|
+
* <p>You cannot include <code>ExcludeFilters</code> and <code>IncludeFilters</code> in the
|
|
4408
|
+
* same operation.</p>
|
|
4297
4409
|
* @public
|
|
4298
4410
|
*/
|
|
4299
4411
|
ExcludeFilters?: MetricStreamFilter[] | undefined;
|
|
4300
4412
|
/**
|
|
4301
|
-
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric
|
|
4302
|
-
*
|
|
4303
|
-
*
|
|
4413
|
+
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric
|
|
4414
|
+
* stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be
|
|
4415
|
+
* in the same account as the metric stream.</p>
|
|
4304
4416
|
* @public
|
|
4305
4417
|
*/
|
|
4306
4418
|
FirehoseArn: string | undefined;
|
|
4307
4419
|
/**
|
|
4308
4420
|
* <p>The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data
|
|
4309
|
-
*
|
|
4310
|
-
*
|
|
4421
|
+
* Firehose resources. This IAM role must already exist and must be in the same account as
|
|
4422
|
+
* the metric stream. This IAM role must include the following permissions:</p>
|
|
4311
4423
|
* <ul>
|
|
4312
4424
|
* <li>
|
|
4313
4425
|
* <p>firehose:PutRecord</p>
|
|
@@ -4320,46 +4432,44 @@ export interface PutMetricStreamInput {
|
|
|
4320
4432
|
*/
|
|
4321
4433
|
RoleArn: string | undefined;
|
|
4322
4434
|
/**
|
|
4323
|
-
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
4324
|
-
*
|
|
4325
|
-
*
|
|
4326
|
-
*
|
|
4327
|
-
* Metric streams output formats</a>.</p>
|
|
4435
|
+
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
4436
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
4437
|
+
* information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">
|
|
4438
|
+
* Metric streams output formats</a>.</p>
|
|
4328
4439
|
* @public
|
|
4329
4440
|
*/
|
|
4330
4441
|
OutputFormat: MetricStreamOutputFormat | undefined;
|
|
4331
4442
|
/**
|
|
4332
4443
|
* <p>A list of key-value pairs to associate with the metric stream. You can associate as
|
|
4333
|
-
*
|
|
4334
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
4335
|
-
*
|
|
4336
|
-
*
|
|
4337
|
-
* <p>You can use this parameter only when you are creating a new metric stream. If you are
|
|
4338
|
-
*
|
|
4339
|
-
*
|
|
4340
|
-
* or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4444
|
+
* many as 50 tags with a metric stream.</p>
|
|
4445
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
4446
|
+
* scope user permissions by granting a user permission to access or change only resources
|
|
4447
|
+
* with certain tag values.</p>
|
|
4448
|
+
* <p>You can use this parameter only when you are creating a new metric stream. If you are
|
|
4449
|
+
* using this operation to update an existing metric stream, any tags you specify in this
|
|
4450
|
+
* parameter are ignored. To change the tags of an existing metric stream, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4341
4451
|
* @public
|
|
4342
4452
|
*/
|
|
4343
4453
|
Tags?: Tag[] | undefined;
|
|
4344
4454
|
/**
|
|
4345
|
-
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
4346
|
-
*
|
|
4347
|
-
*
|
|
4348
|
-
*
|
|
4349
|
-
* <p>For each entry in this array, you specify one or more metrics and the list of
|
|
4350
|
-
*
|
|
4351
|
-
*
|
|
4352
|
-
*
|
|
4353
|
-
*
|
|
4354
|
-
*
|
|
4355
|
-
*
|
|
4356
|
-
*
|
|
4455
|
+
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
4456
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
4457
|
+
* streamed. You can use this parameter to have the metric stream also send additional
|
|
4458
|
+
* statistics in the stream. This array can have up to 100 members.</p>
|
|
4459
|
+
* <p>For each entry in this array, you specify one or more metrics and the list of
|
|
4460
|
+
* additional statistics to stream for those metrics. The additional statistics that you
|
|
4461
|
+
* can stream depend on the stream's <code>OutputFormat</code>. If the
|
|
4462
|
+
* <code>OutputFormat</code> is <code>json</code>, you can stream any additional
|
|
4463
|
+
* statistic that is supported by CloudWatch, listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
4464
|
+
* CloudWatch statistics definitions</a>. If the <code>OutputFormat</code>
|
|
4465
|
+
* is <code>opentelemetry1.0</code> or <code>opentelemetry0.7</code>, you can stream
|
|
4466
|
+
* percentile statistics such as p95, p99.9, and so on.</p>
|
|
4357
4467
|
* @public
|
|
4358
4468
|
*/
|
|
4359
4469
|
StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined;
|
|
4360
4470
|
/**
|
|
4361
|
-
* <p>If you are creating a metric stream in a monitoring account,
|
|
4362
|
-
*
|
|
4471
|
+
* <p>If you are creating a metric stream in a monitoring account, specify <code>true</code>
|
|
4472
|
+
* to include metrics from source accounts in the metric stream.</p>
|
|
4363
4473
|
* @public
|
|
4364
4474
|
*/
|
|
4365
4475
|
IncludeLinkedAccountsMetrics?: boolean | undefined;
|
|
@@ -4407,8 +4517,9 @@ export interface SetAlarmStateInput {
|
|
|
4407
4517
|
StateReason: string | undefined;
|
|
4408
4518
|
/**
|
|
4409
4519
|
* <p>The reason that this alarm is set to this specific state, in JSON format.</p>
|
|
4410
|
-
* <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling
|
|
4411
|
-
*
|
|
4520
|
+
* <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling
|
|
4521
|
+
* or application Auto Scaling alarm actions, the Auto Scaling policy uses the information
|
|
4522
|
+
* in this field to take the correct action.</p>
|
|
4412
4523
|
* @public
|
|
4413
4524
|
*/
|
|
4414
4525
|
StateReasonData?: string | undefined;
|
|
@@ -4419,9 +4530,9 @@ export interface SetAlarmStateInput {
|
|
|
4419
4530
|
export interface StartMetricStreamsInput {
|
|
4420
4531
|
/**
|
|
4421
4532
|
* <p>The array of the names of metric streams to start streaming.</p>
|
|
4422
|
-
* <p>This is an "all or nothing" operation. If you do not have
|
|
4423
|
-
*
|
|
4424
|
-
*
|
|
4533
|
+
* <p>This is an "all or nothing" operation. If you do not have permission to access all of
|
|
4534
|
+
* the metric streams that you list here, then none of the streams that you list in the
|
|
4535
|
+
* operation will start streaming.</p>
|
|
4425
4536
|
* @public
|
|
4426
4537
|
*/
|
|
4427
4538
|
Names: string[] | undefined;
|
|
@@ -4437,9 +4548,9 @@ export interface StartMetricStreamsOutput {
|
|
|
4437
4548
|
export interface StopMetricStreamsInput {
|
|
4438
4549
|
/**
|
|
4439
4550
|
* <p>The array of the names of metric streams to stop streaming.</p>
|
|
4440
|
-
* <p>This is an "all or nothing" operation. If you do not have
|
|
4441
|
-
*
|
|
4442
|
-
*
|
|
4551
|
+
* <p>This is an "all or nothing" operation. If you do not have permission to access all of
|
|
4552
|
+
* the metric streams that you list here, then none of the streams that you list in the
|
|
4553
|
+
* operation will stop streaming.</p>
|
|
4443
4554
|
* @public
|
|
4444
4555
|
*/
|
|
4445
4556
|
Names: string[] | undefined;
|
|
@@ -4456,16 +4567,15 @@ export interface TagResourceInput {
|
|
|
4456
4567
|
/**
|
|
4457
4568
|
* <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
|
|
4458
4569
|
* <p>The ARN format of an alarm is
|
|
4459
|
-
*
|
|
4570
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4460
4571
|
* </code>
|
|
4461
4572
|
* </p>
|
|
4462
4573
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4463
|
-
*
|
|
4574
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4464
4575
|
* </code>
|
|
4465
4576
|
* </p>
|
|
4466
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
4467
|
-
*
|
|
4468
|
-
* Reference</i>.</p>
|
|
4577
|
+
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|
|
4578
|
+
* Services General Reference</i>.</p>
|
|
4469
4579
|
* @public
|
|
4470
4580
|
*/
|
|
4471
4581
|
ResourceARN: string | undefined;
|
|
@@ -4487,16 +4597,15 @@ export interface UntagResourceInput {
|
|
|
4487
4597
|
/**
|
|
4488
4598
|
* <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
|
|
4489
4599
|
* <p>The ARN format of an alarm is
|
|
4490
|
-
*
|
|
4600
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4491
4601
|
* </code>
|
|
4492
4602
|
* </p>
|
|
4493
4603
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4494
|
-
*
|
|
4604
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4495
4605
|
* </code>
|
|
4496
4606
|
* </p>
|
|
4497
|
-
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
|
|
4498
|
-
*
|
|
4499
|
-
* Reference</i>.</p>
|
|
4607
|
+
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|
|
4608
|
+
* Services General Reference</i>.</p>
|
|
4500
4609
|
* @public
|
|
4501
4610
|
*/
|
|
4502
4611
|
ResourceARN: string | undefined;
|