@aws-sdk/client-cloudwatch 3.529.1 → 3.535.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/dist-types/CloudWatch.d.ts +10 -1
- package/dist-types/CloudWatchClient.d.ts +1 -1
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDashboardsCommand.d.ts +2 -1
- package/dist-types/commands/DeleteInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/DisableAlarmActionsCommand.d.ts +2 -1
- package/dist-types/commands/DisableInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/EnableAlarmActionsCommand.d.ts +2 -1
- package/dist-types/commands/EnableInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/GetDashboardCommand.d.ts +2 -1
- package/dist-types/commands/GetInsightRuleReportCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +3 -2
- package/dist-types/commands/ListDashboardsCommand.d.ts +2 -1
- package/dist-types/commands/ListManagedInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/ListMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +2 -1
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +2 -1
- package/dist-types/commands/PutDashboardCommand.d.ts +2 -1
- package/dist-types/commands/PutInsightRuleCommand.d.ts +2 -1
- package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +2 -1
- package/dist-types/commands/PutMetricDataCommand.d.ts +2 -1
- package/dist-types/commands/PutMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/SetAlarmStateCommand.d.ts +2 -1
- 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 +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +427 -427
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/CloudWatch.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAlarmsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAnomalyDetectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDashboardsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMetricStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAlarmHistoryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAlarmsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAlarmsForMetricCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeAnomalyDetectorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableAlarmActionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableAlarmActionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetInsightRuleReportCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricStatisticsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricWidgetImageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListManagedInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListMetricStreamsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutAnomalyDetectorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutCompositeAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutDashboardCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutInsightRuleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutManagedInsightRulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutMetricAlarmCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutMetricDataCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutMetricStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SetAlarmStateCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartMetricStreamsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopMetricStreamsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +42 -42
|
@@ -39,128 +39,128 @@ export declare const HistoryItemType: {
|
|
|
39
39
|
*/
|
|
40
40
|
export type HistoryItemType = (typeof HistoryItemType)[keyof typeof HistoryItemType];
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>Represents the history of a specific alarm.</p>
|
|
43
|
+
* @public
|
|
44
44
|
*/
|
|
45
45
|
export interface AlarmHistoryItem {
|
|
46
46
|
/**
|
|
47
|
-
* @public
|
|
48
47
|
* <p>The descriptive name for the alarm.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
AlarmName?: string;
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>The type of alarm, either metric alarm or composite alarm.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
AlarmType?: AlarmType;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The time stamp for the alarm history item.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
Timestamp?: Date;
|
|
61
61
|
/**
|
|
62
|
-
* @public
|
|
63
62
|
* <p>The type of alarm history item.</p>
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
HistoryItemType?: HistoryItemType;
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>A summary of the alarm history, in text format.</p>
|
|
68
|
+
* @public
|
|
69
69
|
*/
|
|
70
70
|
HistorySummary?: string;
|
|
71
71
|
/**
|
|
72
|
-
* @public
|
|
73
72
|
* <p>Data about the alarm, in JSON format.</p>
|
|
73
|
+
* @public
|
|
74
74
|
*/
|
|
75
75
|
HistoryData?: string;
|
|
76
76
|
}
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>Specifies one range of days or times to exclude from use for training an
|
|
80
79
|
* anomaly detection model.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
export interface Range {
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>The start time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
86
85
|
* <code>2019-07-01T23:59:59</code>.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
StartTime: Date | undefined;
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The end time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
92
91
|
* <code>2019-07-01T23:59:59</code>.</p>
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
EndTime: Date | undefined;
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The configuration specifies details about how the anomaly detection model is to be trained,
|
|
99
98
|
* including time ranges to exclude from use for training the model and the time zone to
|
|
100
99
|
* use for the metric.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export interface AnomalyDetectorConfiguration {
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
104
|
* <p>An array of time ranges to exclude from use when the anomaly detection model is trained. Use
|
|
106
105
|
* this to make sure that events that could cause unusual values for the metric, such as
|
|
107
106
|
* deployments, aren't used when CloudWatch creates the model.</p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
ExcludedTimeRanges?: Range[];
|
|
110
110
|
/**
|
|
111
|
-
* @public
|
|
112
111
|
* <p>The time zone to use for the metric. This is useful to enable the model to automatically
|
|
113
112
|
* account for daylight savings time changes if the metric is sensitive to such time
|
|
114
113
|
* changes.</p>
|
|
115
114
|
* <p>To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information,
|
|
116
115
|
* see <a href="https://en.wikipedia.org/wiki/Tz_database">tz database</a>.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
MetricTimezone?: string;
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
* @public
|
|
122
121
|
* <p>A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique
|
|
123
122
|
* identifier for a metric, whenever you add a unique name/value pair to one of
|
|
124
123
|
* your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish
|
|
125
124
|
* <code>InstanceId</code> as a dimension name, and the actual instance ID as the value for that dimension.</p>
|
|
126
125
|
* <p>You
|
|
127
126
|
* can assign up to 30 dimensions to a metric.</p>
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
export interface Dimension {
|
|
130
130
|
/**
|
|
131
|
-
* @public
|
|
132
131
|
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must include
|
|
133
132
|
* at least one non-whitespace character, and cannot start with a colon (<code>:</code>).
|
|
134
133
|
* ASCII
|
|
135
134
|
* control characters are not supported as part of dimension names.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
Name: string | undefined;
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>The value of the dimension. Dimension values must contain only ASCII characters and must include
|
|
141
140
|
* at least one non-whitespace character. ASCII
|
|
142
141
|
* control characters are not supported as part of dimension values.</p>
|
|
142
|
+
* @public
|
|
143
143
|
*/
|
|
144
144
|
Value: string | undefined;
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
|
-
* @public
|
|
148
147
|
* <p>Represents a specific metric.</p>
|
|
148
|
+
* @public
|
|
149
149
|
*/
|
|
150
150
|
export interface Metric {
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The namespace of the metric.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
Namespace?: string;
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The name of the metric. This is a required field.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
MetricName?: string;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>The dimensions for the metric.</p>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
Dimensions?: Dimension[];
|
|
166
166
|
}
|
|
@@ -202,17 +202,16 @@ export declare const StandardUnit: {
|
|
|
202
202
|
*/
|
|
203
203
|
export type StandardUnit = (typeof StandardUnit)[keyof typeof StandardUnit];
|
|
204
204
|
/**
|
|
205
|
-
* @public
|
|
206
205
|
* <p>This structure defines the metric to be returned, along with the statistics, period, and units.</p>
|
|
206
|
+
* @public
|
|
207
207
|
*/
|
|
208
208
|
export interface MetricStat {
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>The metric to return, including the metric name, namespace, and dimensions.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
Metric: Metric | undefined;
|
|
214
214
|
/**
|
|
215
|
-
* @public
|
|
216
215
|
* <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
|
|
217
216
|
* be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
|
|
218
217
|
* at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
|
|
@@ -230,24 +229,24 @@ export interface MetricStat {
|
|
|
230
229
|
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
|
|
231
230
|
* </li>
|
|
232
231
|
* </ul>
|
|
232
|
+
* @public
|
|
233
233
|
*/
|
|
234
234
|
Period: number | undefined;
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The statistic to return. It can include any CloudWatch statistic or extended statistic.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
Stat: string | undefined;
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
|
|
243
242
|
* <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
|
|
244
243
|
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
|
|
245
244
|
* If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
Unit?: StandardUnit;
|
|
248
248
|
}
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported
|
|
252
251
|
* use of this structure is different for those two operations.</p>
|
|
253
252
|
* <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving
|
|
@@ -268,27 +267,27 @@ export interface MetricStat {
|
|
|
268
267
|
* Guide</i>.</p>
|
|
269
268
|
* <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>
|
|
270
269
|
* operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
export interface MetricDataQuery {
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>A short name used to tie this object to the results in the response. This name must be
|
|
276
275
|
* unique within a single call to <code>GetMetricData</code>. If you are performing math
|
|
277
276
|
* expressions on this set of data, this name represents that data and can serve as a
|
|
278
277
|
* variable in the mathematical expression. The valid characters are letters, numbers, and
|
|
279
278
|
* underscore. The first character must be a lowercase letter.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
Id: string | undefined;
|
|
282
282
|
/**
|
|
283
|
-
* @public
|
|
284
283
|
* <p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric
|
|
285
284
|
* and not performing a math expression on returned data.</p>
|
|
286
285
|
* <p>Within one MetricDataQuery object, you must specify either
|
|
287
286
|
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
MetricStat?: MetricStat;
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>This field can contain either a Metrics Insights query, or a metric math expression to be performed on the
|
|
293
292
|
* returned data. For more information about Metrics Insights queries, see
|
|
294
293
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage">Metrics Insights query components and syntax</a> in the
|
|
@@ -301,10 +300,10 @@ export interface MetricDataQuery {
|
|
|
301
300
|
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
302
301
|
* <p>Within each MetricDataQuery object, you must specify either
|
|
303
302
|
* <code>Expression</code> or <code>MetricStat</code> but not both.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
Expression?: string;
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>A human-readable label for this metric or expression. This is especially useful
|
|
309
308
|
* if this is an expression, so that you know
|
|
310
309
|
* what the value represents. If the metric or expression is shown in a
|
|
@@ -312,10 +311,10 @@ export interface MetricDataQuery {
|
|
|
312
311
|
* generates a default.</p>
|
|
313
312
|
* <p>You can put dynamic expressions into a label, so that it is more descriptive.
|
|
314
313
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
Label?: string;
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
|
|
320
319
|
* timestamps and raw data values of this metric. If you are performing this call just to
|
|
321
320
|
* do math expressions and do not also need the raw data returned, you can specify
|
|
@@ -323,36 +322,36 @@ export interface MetricDataQuery {
|
|
|
323
322
|
* used.</p>
|
|
324
323
|
* <p>When used in <code>PutMetricAlarm</code>, specify <code>true</code> for the one expression result to use as the alarm. For all
|
|
325
324
|
* other metrics and expressions in the same <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as False.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
ReturnData?: boolean;
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
|
|
331
330
|
* period can be as short as one minute (60 seconds) and must be a multiple of 60.
|
|
332
331
|
* For high-resolution metrics that are collected at intervals of less than one minute,
|
|
333
332
|
* the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics
|
|
334
333
|
* stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
Period?: number;
|
|
337
337
|
/**
|
|
338
|
-
* @public
|
|
339
338
|
* <p>The ID of the account where the metrics are located.</p>
|
|
340
339
|
* <p>If you are performing a <code>GetMetricData</code> operation in a monitoring account, use this to specify
|
|
341
340
|
* which account to retrieve this metric from.</p>
|
|
342
341
|
* <p>If you are performing a <code>PutMetricAlarm</code> operation, use this to specify
|
|
343
342
|
* which account contains the metric that the alarm is watching.</p>
|
|
343
|
+
* @public
|
|
344
344
|
*/
|
|
345
345
|
AccountId?: string;
|
|
346
346
|
}
|
|
347
347
|
/**
|
|
348
|
-
* @public
|
|
349
348
|
* <p>Indicates the CloudWatch math expression that provides the time series the anomaly detector
|
|
350
349
|
* uses as input.
|
|
351
350
|
* The designated math expression must return a single time series.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
export interface MetricMathAnomalyDetector {
|
|
354
354
|
/**
|
|
355
|
-
* @public
|
|
356
355
|
* <p>An array of metric data query structures
|
|
357
356
|
* that enables you to create an anomaly detector
|
|
358
357
|
* based on the result of a metric math expression.
|
|
@@ -365,33 +364,34 @@ export interface MetricMathAnomalyDetector {
|
|
|
365
364
|
* For all other expressions and metrics, set <code>ReturnData</code> to <code>false</code>.
|
|
366
365
|
* The designated expression must return
|
|
367
366
|
* a single time series.</p>
|
|
367
|
+
* @public
|
|
368
368
|
*/
|
|
369
369
|
MetricDataQueries?: MetricDataQuery[];
|
|
370
370
|
}
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>Designates the CloudWatch metric and statistic that provides the time series the anomaly detector
|
|
374
373
|
* uses as input.</p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
export interface SingleMetricAnomalyDetector {
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>The namespace of the metric to create the anomaly detection model for.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
Namespace?: string;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The name of the metric to create the anomaly detection model for.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
MetricName?: string;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The metric dimensions to create the anomaly detection model for.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
Dimensions?: Dimension[];
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>The statistic to use for the metric and anomaly detection model.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
Stat?: string;
|
|
397
397
|
}
|
|
@@ -409,62 +409,62 @@ export declare const AnomalyDetectorStateValue: {
|
|
|
409
409
|
*/
|
|
410
410
|
export type AnomalyDetectorStateValue = (typeof AnomalyDetectorStateValue)[keyof typeof AnomalyDetectorStateValue];
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression.
|
|
414
413
|
* You can use the model to display a band of expected, normal values
|
|
415
414
|
* when the metric is graphed.</p>
|
|
415
|
+
* @public
|
|
416
416
|
*/
|
|
417
417
|
export interface AnomalyDetector {
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* @deprecated
|
|
421
420
|
*
|
|
422
421
|
* <p>The namespace of the metric associated with the anomaly detection model.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
Namespace?: string;
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* @deprecated
|
|
428
427
|
*
|
|
429
428
|
* <p>The name of the metric associated with the anomaly detection model.</p>
|
|
429
|
+
* @public
|
|
430
430
|
*/
|
|
431
431
|
MetricName?: string;
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* @deprecated
|
|
435
434
|
*
|
|
436
435
|
* <p>The metric dimensions associated with the anomaly detection model.</p>
|
|
436
|
+
* @public
|
|
437
437
|
*/
|
|
438
438
|
Dimensions?: Dimension[];
|
|
439
439
|
/**
|
|
440
|
-
* @public
|
|
441
440
|
* @deprecated
|
|
442
441
|
*
|
|
443
442
|
* <p>The statistic associated with the anomaly detection model.</p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
Stat?: string;
|
|
446
446
|
/**
|
|
447
|
-
* @public
|
|
448
447
|
* <p>The configuration specifies details about how the
|
|
449
448
|
* anomaly detection model is to be trained, including time ranges to
|
|
450
449
|
* exclude from use for training the model, and the time zone to use for
|
|
451
450
|
* the metric.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
Configuration?: AnomalyDetectorConfiguration;
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>The current status of the anomaly detector's training. The possible values are <code>TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA</code>
|
|
457
456
|
* </p>
|
|
457
|
+
* @public
|
|
458
458
|
*/
|
|
459
459
|
StateValue?: AnomalyDetectorStateValue;
|
|
460
460
|
/**
|
|
461
|
-
* @public
|
|
462
461
|
* <p>The CloudWatch metric and statistic for this anomaly detector.</p>
|
|
462
|
+
* @public
|
|
463
463
|
*/
|
|
464
464
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
|
|
465
465
|
/**
|
|
466
|
-
* @public
|
|
467
466
|
* <p>The CloudWatch metric math expression for this anomaly detector.</p>
|
|
467
|
+
* @public
|
|
468
468
|
*/
|
|
469
469
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
|
|
470
470
|
}
|
|
@@ -481,29 +481,29 @@ export declare const AnomalyDetectorType: {
|
|
|
481
481
|
*/
|
|
482
482
|
export type AnomalyDetectorType = (typeof AnomalyDetectorType)[keyof typeof AnomalyDetectorType];
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>This array is empty if the API operation was successful for all the rules specified in the request. If the operation could
|
|
486
485
|
* not process one of the rules, the following data is returned for each of those rules.</p>
|
|
486
|
+
* @public
|
|
487
487
|
*/
|
|
488
488
|
export interface PartialFailure {
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* <p>The specified rule that could not be deleted.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
FailureResource?: string;
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <p>The type of error.</p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
ExceptionType?: string;
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The code of the error.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
FailureCode?: string;
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>A description of the error.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
FailureDescription?: string;
|
|
509
509
|
}
|
|
@@ -538,86 +538,85 @@ export declare const StateValue: {
|
|
|
538
538
|
*/
|
|
539
539
|
export type StateValue = (typeof StateValue)[keyof typeof StateValue];
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p>The details about a composite alarm.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
export interface CompositeAlarm {
|
|
545
545
|
/**
|
|
546
|
-
* @public
|
|
547
546
|
* <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
|
|
547
|
+
* @public
|
|
548
548
|
*/
|
|
549
549
|
ActionsEnabled?: boolean;
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <p>The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
552
|
+
* @public
|
|
553
553
|
*/
|
|
554
554
|
AlarmActions?: string[];
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>The Amazon Resource Name (ARN) of the alarm.</p>
|
|
557
|
+
* @public
|
|
558
558
|
*/
|
|
559
559
|
AlarmArn?: string;
|
|
560
560
|
/**
|
|
561
|
-
* @public
|
|
562
561
|
* <p>The time stamp of the last update to the alarm configuration.</p>
|
|
562
|
+
* @public
|
|
563
563
|
*/
|
|
564
564
|
AlarmConfigurationUpdatedTimestamp?: Date;
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>The description of the alarm.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
AlarmDescription?: string;
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>The name of the alarm.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
AlarmName?: string;
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>The rule that this alarm uses to evaluate its alarm state.</p>
|
|
577
|
+
* @public
|
|
578
578
|
*/
|
|
579
579
|
AlarmRule?: string;
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
582
|
+
* @public
|
|
583
583
|
*/
|
|
584
584
|
InsufficientDataActions?: string[];
|
|
585
585
|
/**
|
|
586
|
-
* @public
|
|
587
586
|
* <p>The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
587
|
+
* @public
|
|
588
588
|
*/
|
|
589
589
|
OKActions?: string[];
|
|
590
590
|
/**
|
|
591
|
-
* @public
|
|
592
591
|
* <p>An explanation for the alarm state, in text format.</p>
|
|
592
|
+
* @public
|
|
593
593
|
*/
|
|
594
594
|
StateReason?: string;
|
|
595
595
|
/**
|
|
596
|
-
* @public
|
|
597
596
|
* <p>An explanation for the alarm state, in JSON format.</p>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
StateReasonData?: string;
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <p>Tracks the timestamp of any state update, even if <code>StateValue</code> doesn't change.</p>
|
|
602
|
+
* @public
|
|
603
603
|
*/
|
|
604
604
|
StateUpdatedTimestamp?: Date;
|
|
605
605
|
/**
|
|
606
|
-
* @public
|
|
607
606
|
* <p>The state value for the alarm.</p>
|
|
607
|
+
* @public
|
|
608
608
|
*/
|
|
609
609
|
StateValue?: StateValue;
|
|
610
610
|
/**
|
|
611
|
-
* @public
|
|
612
611
|
* <p>
|
|
613
612
|
* The timestamp
|
|
614
613
|
* of the last change
|
|
615
614
|
* to the alarm's <code>StateValue</code>.
|
|
616
615
|
* </p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
StateTransitionedTimestamp?: Date;
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>
|
|
622
621
|
* When the value is <code>ALARM</code>,
|
|
623
622
|
* it means
|
|
@@ -647,17 +646,17 @@ export interface CompositeAlarm {
|
|
|
647
646
|
* After this time,
|
|
648
647
|
* the composite alarm performs its actions.
|
|
649
648
|
* </p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
ActionsSuppressedBy?: ActionsSuppressedBy;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>
|
|
655
654
|
* Captures the reason for action suppression.
|
|
656
655
|
* </p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
ActionsSuppressedReason?: string;
|
|
659
659
|
/**
|
|
660
|
-
* @public
|
|
661
660
|
* <p>
|
|
662
661
|
* Actions will be suppressed
|
|
663
662
|
* if the suppressor alarm is
|
|
@@ -665,10 +664,10 @@ export interface CompositeAlarm {
|
|
|
665
664
|
* <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name (ARN)
|
|
666
665
|
* from an existing alarm.
|
|
667
666
|
* </p>
|
|
667
|
+
* @public
|
|
668
668
|
*/
|
|
669
669
|
ActionsSuppressor?: string;
|
|
670
670
|
/**
|
|
671
|
-
* @public
|
|
672
671
|
* <p>
|
|
673
672
|
* The maximum time
|
|
674
673
|
* in seconds
|
|
@@ -686,10 +685,10 @@ export interface CompositeAlarm {
|
|
|
686
685
|
* when <code>ActionsSuppressor</code> is specified.
|
|
687
686
|
* </p>
|
|
688
687
|
* </important>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
ActionsSuppressorWaitPeriod?: number;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>
|
|
694
693
|
* The maximum time
|
|
695
694
|
* in seconds
|
|
@@ -706,12 +705,13 @@ export interface CompositeAlarm {
|
|
|
706
705
|
* when <code>ActionsSuppressor</code> is specified.
|
|
707
706
|
* </p>
|
|
708
707
|
* </important>
|
|
708
|
+
* @public
|
|
709
709
|
*/
|
|
710
710
|
ActionsSuppressorExtensionPeriod?: number;
|
|
711
711
|
}
|
|
712
712
|
/**
|
|
713
|
-
* @public
|
|
714
713
|
* <p>More than one process tried to modify a resource at the same time.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
717
717
|
readonly name: "ConcurrentModificationException";
|
|
@@ -723,51 +723,51 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
723
723
|
constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
|
|
724
724
|
}
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>Represents a specific dashboard.</p>
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
export interface DashboardEntry {
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>The name of the dashboard.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
DashboardName?: string;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The Amazon Resource Name (ARN) of the dashboard.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
DashboardArn?: string;
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>The time stamp of when the dashboard was last modified, either by an API call or
|
|
743
742
|
* through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
LastModified?: Date;
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The size of the dashboard, in bytes.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
Size?: number;
|
|
751
751
|
}
|
|
752
752
|
/**
|
|
753
|
-
* @public
|
|
754
753
|
* <p>An error or warning for the operation.</p>
|
|
754
|
+
* @public
|
|
755
755
|
*/
|
|
756
756
|
export interface DashboardValidationMessage {
|
|
757
757
|
/**
|
|
758
|
-
* @public
|
|
759
758
|
* <p>The data path related to the message.</p>
|
|
759
|
+
* @public
|
|
760
760
|
*/
|
|
761
761
|
DataPath?: string;
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>A message describing the error or warning.</p>
|
|
764
|
+
* @public
|
|
765
765
|
*/
|
|
766
766
|
Message?: string;
|
|
767
767
|
}
|
|
768
768
|
/**
|
|
769
|
-
* @public
|
|
770
769
|
* <p>Some part of the dashboard data is invalid.</p>
|
|
770
|
+
* @public
|
|
771
771
|
*/
|
|
772
772
|
export declare class DashboardInvalidInputError extends __BaseException {
|
|
773
773
|
readonly name: "DashboardInvalidInputError";
|
|
@@ -779,8 +779,8 @@ export declare class DashboardInvalidInputError extends __BaseException {
|
|
|
779
779
|
constructor(opts: __ExceptionOptionType<DashboardInvalidInputError, __BaseException>);
|
|
780
780
|
}
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The specified dashboard does not exist.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
export declare class DashboardNotFoundError extends __BaseException {
|
|
786
786
|
readonly name: "DashboardNotFoundError";
|
|
@@ -791,49 +791,49 @@ export declare class DashboardNotFoundError extends __BaseException {
|
|
|
791
791
|
constructor(opts: __ExceptionOptionType<DashboardNotFoundError, __BaseException>);
|
|
792
792
|
}
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>Encapsulates the statistical data that CloudWatch computes from metric data.</p>
|
|
795
|
+
* @public
|
|
796
796
|
*/
|
|
797
797
|
export interface Datapoint {
|
|
798
798
|
/**
|
|
799
|
-
* @public
|
|
800
799
|
* <p>The time stamp used for the data point.</p>
|
|
800
|
+
* @public
|
|
801
801
|
*/
|
|
802
802
|
Timestamp?: Date;
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>The number of metric values that contributed to the aggregate value of this
|
|
806
805
|
* data point.</p>
|
|
806
|
+
* @public
|
|
807
807
|
*/
|
|
808
808
|
SampleCount?: number;
|
|
809
809
|
/**
|
|
810
|
-
* @public
|
|
811
810
|
* <p>The average of the metric values that correspond to the data point.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
Average?: number;
|
|
814
814
|
/**
|
|
815
|
-
* @public
|
|
816
815
|
* <p>The sum of the metric values for the data point.</p>
|
|
816
|
+
* @public
|
|
817
817
|
*/
|
|
818
818
|
Sum?: number;
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <p>The minimum metric value for the data point.</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
Minimum?: number;
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>The maximum metric value for the data point.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
Maximum?: number;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>The standard unit for the data point.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
Unit?: StandardUnit;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>The percentile statistic for the data point.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
ExtendedStatistics?: Record<string, number>;
|
|
839
839
|
}
|
|
@@ -842,14 +842,14 @@ export interface Datapoint {
|
|
|
842
842
|
*/
|
|
843
843
|
export interface DeleteAlarmsInput {
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>The alarms to be deleted. Do not enclose the alarm names in quote marks.</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
AlarmNames: string[] | undefined;
|
|
849
849
|
}
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>The named resource does not exist.</p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
export declare class ResourceNotFound extends __BaseException {
|
|
855
855
|
readonly name: "ResourceNotFound";
|
|
@@ -864,35 +864,34 @@ export declare class ResourceNotFound extends __BaseException {
|
|
|
864
864
|
*/
|
|
865
865
|
export interface DeleteAnomalyDetectorInput {
|
|
866
866
|
/**
|
|
867
|
-
* @public
|
|
868
867
|
* @deprecated
|
|
869
868
|
*
|
|
870
869
|
* <p>The namespace associated with the anomaly detection model to delete.</p>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
Namespace?: string;
|
|
873
873
|
/**
|
|
874
|
-
* @public
|
|
875
874
|
* @deprecated
|
|
876
875
|
*
|
|
877
876
|
* <p>The metric name associated with the anomaly detection model to delete.</p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
MetricName?: string;
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* @deprecated
|
|
883
882
|
*
|
|
884
883
|
* <p>The metric dimensions associated with the anomaly detection model to delete.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
Dimensions?: Dimension[];
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* @deprecated
|
|
890
889
|
*
|
|
891
890
|
* <p>The statistic associated with the anomaly detection model to delete.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
Stat?: string;
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>A single metric anomaly detector to be deleted.</p>
|
|
897
896
|
* <p>When using <code>SingleMetricAnomalyDetector</code>,
|
|
898
897
|
* you cannot include the following parameters in the same operation:</p>
|
|
@@ -923,10 +922,10 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
923
922
|
* </ul>
|
|
924
923
|
* <p>Instead, specify the single metric anomaly detector attributes
|
|
925
924
|
* as part of the <code>SingleMetricAnomalyDetector</code> property.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The metric math anomaly detector to be deleted.</p>
|
|
931
930
|
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following parameters in the same operation:</p>
|
|
932
931
|
* <ul>
|
|
@@ -956,6 +955,7 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
956
955
|
* </ul>
|
|
957
956
|
* <p>Instead, specify the metric math anomaly detector attributes as part of the
|
|
958
957
|
* <code>MetricMathAnomalyDetector</code> property.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
|
|
961
961
|
}
|
|
@@ -965,15 +965,15 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
965
965
|
export interface DeleteAnomalyDetectorOutput {
|
|
966
966
|
}
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>Request processing has failed due to some unknown error, exception, or failure.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
export declare class InternalServiceFault extends __BaseException {
|
|
972
972
|
readonly name: "InternalServiceFault";
|
|
973
973
|
readonly $fault: "server";
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p></p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
Message?: string;
|
|
979
979
|
/**
|
|
@@ -982,8 +982,8 @@ export declare class InternalServiceFault extends __BaseException {
|
|
|
982
982
|
constructor(opts: __ExceptionOptionType<InternalServiceFault, __BaseException>);
|
|
983
983
|
}
|
|
984
984
|
/**
|
|
985
|
-
* @public
|
|
986
985
|
* <p>Parameters were used together that cannot be used together.</p>
|
|
986
|
+
* @public
|
|
987
987
|
*/
|
|
988
988
|
export declare class InvalidParameterCombinationException extends __BaseException {
|
|
989
989
|
readonly name: "InvalidParameterCombinationException";
|
|
@@ -994,8 +994,8 @@ export declare class InvalidParameterCombinationException extends __BaseExceptio
|
|
|
994
994
|
constructor(opts: __ExceptionOptionType<InvalidParameterCombinationException, __BaseException>);
|
|
995
995
|
}
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>The value of an input parameter is bad or out-of-range.</p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
export declare class InvalidParameterValueException extends __BaseException {
|
|
1001
1001
|
readonly name: "InvalidParameterValueException";
|
|
@@ -1006,8 +1006,8 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
1006
1006
|
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
|
|
1007
1007
|
}
|
|
1008
1008
|
/**
|
|
1009
|
-
* @public
|
|
1010
1009
|
* <p>An input parameter that is required is missing.</p>
|
|
1010
|
+
* @public
|
|
1011
1011
|
*/
|
|
1012
1012
|
export declare class MissingRequiredParameterException extends __BaseException {
|
|
1013
1013
|
readonly name: "MissingRequiredParameterException";
|
|
@@ -1018,8 +1018,8 @@ export declare class MissingRequiredParameterException extends __BaseException {
|
|
|
1018
1018
|
constructor(opts: __ExceptionOptionType<MissingRequiredParameterException, __BaseException>);
|
|
1019
1019
|
}
|
|
1020
1020
|
/**
|
|
1021
|
-
* @public
|
|
1022
1021
|
* <p>The named resource does not exist.</p>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1025
1025
|
readonly name: "ResourceNotFoundException";
|
|
@@ -1037,8 +1037,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1037
1037
|
*/
|
|
1038
1038
|
export interface DeleteDashboardsInput {
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <p>The dashboards to be deleted. This parameter is required.</p>
|
|
1041
|
+
* @public
|
|
1042
1042
|
*/
|
|
1043
1043
|
DashboardNames: string[] | undefined;
|
|
1044
1044
|
}
|
|
@@ -1052,8 +1052,8 @@ export interface DeleteDashboardsOutput {
|
|
|
1052
1052
|
*/
|
|
1053
1053
|
export interface DeleteInsightRulesInput {
|
|
1054
1054
|
/**
|
|
1055
|
-
* @public
|
|
1056
1055
|
* <p>An array of the rule names to delete. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1056
|
+
* @public
|
|
1057
1057
|
*/
|
|
1058
1058
|
RuleNames: string[] | undefined;
|
|
1059
1059
|
}
|
|
@@ -1062,8 +1062,8 @@ export interface DeleteInsightRulesInput {
|
|
|
1062
1062
|
*/
|
|
1063
1063
|
export interface DeleteInsightRulesOutput {
|
|
1064
1064
|
/**
|
|
1065
|
-
* @public
|
|
1066
1065
|
* <p>An array listing the rules that could not be deleted. You cannot delete built-in rules.</p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
Failures?: PartialFailure[];
|
|
1069
1069
|
}
|
|
@@ -1072,8 +1072,8 @@ export interface DeleteInsightRulesOutput {
|
|
|
1072
1072
|
*/
|
|
1073
1073
|
export interface DeleteMetricStreamInput {
|
|
1074
1074
|
/**
|
|
1075
|
-
* @public
|
|
1076
1075
|
* <p>The name of the metric stream to delete.</p>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
Name: string | undefined;
|
|
1079
1079
|
}
|
|
@@ -1099,46 +1099,46 @@ export type ScanBy = (typeof ScanBy)[keyof typeof ScanBy];
|
|
|
1099
1099
|
*/
|
|
1100
1100
|
export interface DescribeAlarmHistoryInput {
|
|
1101
1101
|
/**
|
|
1102
|
-
* @public
|
|
1103
1102
|
* <p>The name of the alarm.</p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
AlarmName?: string;
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
|
|
1109
1108
|
* only metric alarms are returned.</p>
|
|
1109
|
+
* @public
|
|
1110
1110
|
*/
|
|
1111
1111
|
AlarmTypes?: AlarmType[];
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The type of alarm histories to retrieve.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
HistoryItemType?: HistoryItemType;
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The starting date to retrieve alarm history.</p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
StartDate?: Date;
|
|
1122
1122
|
/**
|
|
1123
|
-
* @public
|
|
1124
1123
|
* <p>The ending date to retrieve alarm history.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
EndDate?: Date;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>The maximum number of alarm history records to retrieve.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
MaxRecords?: number;
|
|
1132
1132
|
/**
|
|
1133
|
-
* @public
|
|
1134
1133
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
1135
1134
|
* available.</p>
|
|
1135
|
+
* @public
|
|
1136
1136
|
*/
|
|
1137
1137
|
NextToken?: string;
|
|
1138
1138
|
/**
|
|
1139
|
-
* @public
|
|
1140
1139
|
* <p>Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest
|
|
1141
1140
|
* event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
ScanBy?: ScanBy;
|
|
1144
1144
|
}
|
|
@@ -1147,19 +1147,19 @@ export interface DescribeAlarmHistoryInput {
|
|
|
1147
1147
|
*/
|
|
1148
1148
|
export interface DescribeAlarmHistoryOutput {
|
|
1149
1149
|
/**
|
|
1150
|
-
* @public
|
|
1151
1150
|
* <p>The alarm histories, in JSON format.</p>
|
|
1151
|
+
* @public
|
|
1152
1152
|
*/
|
|
1153
1153
|
AlarmHistoryItems?: AlarmHistoryItem[];
|
|
1154
1154
|
/**
|
|
1155
|
-
* @public
|
|
1156
1155
|
* <p>The token that marks the start of the next batch of returned results.</p>
|
|
1156
|
+
* @public
|
|
1157
1157
|
*/
|
|
1158
1158
|
NextToken?: string;
|
|
1159
1159
|
}
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p>The next token specified is invalid.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
export declare class InvalidNextToken extends __BaseException {
|
|
1165
1165
|
readonly name: "InvalidNextToken";
|
|
@@ -1174,20 +1174,19 @@ export declare class InvalidNextToken extends __BaseException {
|
|
|
1174
1174
|
*/
|
|
1175
1175
|
export interface DescribeAlarmsInput {
|
|
1176
1176
|
/**
|
|
1177
|
-
* @public
|
|
1178
1177
|
* <p>The names of the alarms to retrieve information about.</p>
|
|
1178
|
+
* @public
|
|
1179
1179
|
*/
|
|
1180
1180
|
AlarmNames?: string[];
|
|
1181
1181
|
/**
|
|
1182
|
-
* @public
|
|
1183
1182
|
* <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names
|
|
1184
1183
|
* that start with this prefix.</p>
|
|
1185
1184
|
* <p>If this parameter
|
|
1186
1185
|
* is specified, you cannot specify <code>AlarmNames</code>.</p>
|
|
1186
|
+
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
AlarmNamePrefix?: string;
|
|
1189
1189
|
/**
|
|
1190
|
-
* @public
|
|
1191
1190
|
* <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
|
|
1192
1191
|
* omit this parameter,
|
|
1193
1192
|
* only metric alarms are returned, even if composite alarms exist in the account.</p>
|
|
@@ -1195,10 +1194,10 @@ export interface DescribeAlarmsInput {
|
|
|
1195
1194
|
* alarms. It does not return any composite alarms, even if composite alarms exist in the account.</p>
|
|
1196
1195
|
* <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of composite
|
|
1197
1196
|
* alarms, and does not return any metric alarms.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
AlarmTypes?: AlarmType[];
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>If you use this parameter and specify the name of a composite alarm, the operation returns
|
|
1203
1202
|
* information about the "children" alarms
|
|
1204
1203
|
* of the alarm you specify. These are the metric alarms and composite alarms referenced in the
|
|
@@ -1216,10 +1215,10 @@ export interface DescribeAlarmsInput {
|
|
|
1216
1215
|
* these alarms, perform another <code>DescribeAlarms</code> operation and specify
|
|
1217
1216
|
* the parent alarm names in the <code>AlarmNames</code> parameter.</p>
|
|
1218
1217
|
* </note>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
ChildrenOfAlarmName?: string;
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>If you use this parameter and specify the name of a metric or composite alarm, the operation returns
|
|
1224
1223
|
* information about the "parent" alarms
|
|
1225
1224
|
* of the alarm you specify. These are the composite alarms that have <code>AlarmRule</code>
|
|
@@ -1234,29 +1233,30 @@ export interface DescribeAlarmsInput {
|
|
|
1234
1233
|
* these alarms, perform another <code>DescribeAlarms</code> operation and specify
|
|
1235
1234
|
* the parent alarm names in the <code>AlarmNames</code> parameter.</p>
|
|
1236
1235
|
* </note>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
ParentsOfAlarmName?: string;
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
StateValue?: StateValue;
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>Use this parameter to filter the results of the operation to only those alarms that
|
|
1247
1246
|
* use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all
|
|
1248
1247
|
* alarms that send notifications to that topic.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
ActionPrefix?: string;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>The maximum number of alarm descriptions to retrieve.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
MaxRecords?: number;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
1259
1258
|
* available.</p>
|
|
1259
|
+
* @public
|
|
1260
1260
|
*/
|
|
1261
1261
|
NextToken?: string;
|
|
1262
1262
|
}
|
|
@@ -1287,153 +1287,152 @@ export declare const Statistic: {
|
|
|
1287
1287
|
*/
|
|
1288
1288
|
export type Statistic = (typeof Statistic)[keyof typeof Statistic];
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>The details about a metric alarm.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
export interface MetricAlarm {
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>The name of the alarm.</p>
|
|
1296
|
+
* @public
|
|
1297
1297
|
*/
|
|
1298
1298
|
AlarmName?: string;
|
|
1299
1299
|
/**
|
|
1300
|
-
* @public
|
|
1301
1300
|
* <p>The Amazon Resource Name (ARN) of the alarm.</p>
|
|
1301
|
+
* @public
|
|
1302
1302
|
*/
|
|
1303
1303
|
AlarmArn?: string;
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <p>The description of the alarm.</p>
|
|
1306
|
+
* @public
|
|
1307
1307
|
*/
|
|
1308
1308
|
AlarmDescription?: string;
|
|
1309
1309
|
/**
|
|
1310
|
-
* @public
|
|
1311
1310
|
* <p>The time stamp of the last update to the alarm configuration.</p>
|
|
1311
|
+
* @public
|
|
1312
1312
|
*/
|
|
1313
1313
|
AlarmConfigurationUpdatedTimestamp?: Date;
|
|
1314
1314
|
/**
|
|
1315
|
-
* @public
|
|
1316
1315
|
* <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
ActionsEnabled?: boolean;
|
|
1319
1319
|
/**
|
|
1320
|
-
* @public
|
|
1321
1320
|
* <p>The actions to execute when this alarm transitions to the <code>OK</code> state
|
|
1322
1321
|
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1322
|
+
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
OKActions?: string[];
|
|
1325
1325
|
/**
|
|
1326
|
-
* @public
|
|
1327
1326
|
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
1328
1327
|
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1328
|
+
* @public
|
|
1329
1329
|
*/
|
|
1330
1330
|
AlarmActions?: string[];
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state
|
|
1334
1333
|
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
InsufficientDataActions?: string[];
|
|
1337
1337
|
/**
|
|
1338
|
-
* @public
|
|
1339
1338
|
* <p>The state value for the alarm.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
StateValue?: StateValue;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>An explanation for the alarm state, in text format.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
StateReason?: string;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>An explanation for the alarm state, in JSON format.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
StateReasonData?: string;
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>The time stamp of the last update to the value of either the
|
|
1355
1354
|
* <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
StateUpdatedTimestamp?: Date;
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>The name of the metric associated with the alarm, if this is an alarm
|
|
1361
1360
|
* based on a single metric.</p>
|
|
1361
|
+
* @public
|
|
1362
1362
|
*/
|
|
1363
1363
|
MetricName?: string;
|
|
1364
1364
|
/**
|
|
1365
|
-
* @public
|
|
1366
1365
|
* <p>The namespace of the metric associated with the alarm.</p>
|
|
1366
|
+
* @public
|
|
1367
1367
|
*/
|
|
1368
1368
|
Namespace?: string;
|
|
1369
1369
|
/**
|
|
1370
|
-
* @public
|
|
1371
1370
|
* <p>The statistic for the metric associated with the alarm, other than percentile.
|
|
1372
1371
|
* For percentile statistics, use <code>ExtendedStatistic</code>.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
Statistic?: Statistic;
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>The percentile statistic for the metric associated with the alarm. Specify a value between
|
|
1378
1377
|
* p0.0 and p100.</p>
|
|
1378
|
+
* @public
|
|
1379
1379
|
*/
|
|
1380
1380
|
ExtendedStatistic?: string;
|
|
1381
1381
|
/**
|
|
1382
|
-
* @public
|
|
1383
1382
|
* <p>The dimensions for the metric associated with the alarm.</p>
|
|
1383
|
+
* @public
|
|
1384
1384
|
*/
|
|
1385
1385
|
Dimensions?: Dimension[];
|
|
1386
1386
|
/**
|
|
1387
|
-
* @public
|
|
1388
1387
|
* <p>The period, in seconds, over which the statistic is applied.</p>
|
|
1388
|
+
* @public
|
|
1389
1389
|
*/
|
|
1390
1390
|
Period?: number;
|
|
1391
1391
|
/**
|
|
1392
|
-
* @public
|
|
1393
1392
|
* <p>The unit of the metric associated with the alarm.</p>
|
|
1393
|
+
* @public
|
|
1394
1394
|
*/
|
|
1395
1395
|
Unit?: StandardUnit;
|
|
1396
1396
|
/**
|
|
1397
|
-
* @public
|
|
1398
1397
|
* <p>The number of periods over which data is compared to the specified threshold.</p>
|
|
1398
|
+
* @public
|
|
1399
1399
|
*/
|
|
1400
1400
|
EvaluationPeriods?: number;
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>The number of data points that must be breaching to trigger the alarm.</p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
DatapointsToAlarm?: number;
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The value to compare with the specified statistic.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
Threshold?: number;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The arithmetic operation to use when comparing the specified
|
|
1414
1413
|
* statistic and threshold. The specified statistic value is used as the first operand.</p>
|
|
1414
|
+
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
ComparisonOperator?: ComparisonOperator;
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>Sets how this alarm is to handle missing data points. The valid values
|
|
1420
1419
|
* are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and
|
|
1421
1420
|
* <code>missing</code>. For more information, see
|
|
1422
1421
|
* <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>
|
|
1423
1422
|
* <p>If this parameter is omitted, the default
|
|
1424
1423
|
* behavior of <code>missing</code> is used.</p>
|
|
1424
|
+
* @public
|
|
1425
1425
|
*/
|
|
1426
1426
|
TreatMissingData?: string;
|
|
1427
1427
|
/**
|
|
1428
|
-
* @public
|
|
1429
1428
|
* <p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state does not change
|
|
1430
1429
|
* during periods with too few data points to be statistically significant. If <code>evaluate</code> or this
|
|
1431
1430
|
* parameter is not used, the alarm is always evaluated and possibly changes state no matter
|
|
1432
1431
|
* how many data points are available.</p>
|
|
1432
|
+
* @public
|
|
1433
1433
|
*/
|
|
1434
1434
|
EvaluateLowSampleCountPercentile?: string;
|
|
1435
1435
|
/**
|
|
1436
|
-
* @public
|
|
1437
1436
|
* <p>An array of MetricDataQuery structures, used in an alarm based on a
|
|
1438
1437
|
* metric math expression. Each structure either retrieves a
|
|
1439
1438
|
* metric or performs a math expression.
|
|
@@ -1441,27 +1440,28 @@ export interface MetricAlarm {
|
|
|
1441
1440
|
* One item in the Metrics array is the math expression that the alarm watches.
|
|
1442
1441
|
* This expression by designated by having <code>ReturnData</code> set to
|
|
1443
1442
|
* true.</p>
|
|
1443
|
+
* @public
|
|
1444
1444
|
*/
|
|
1445
1445
|
Metrics?: MetricDataQuery[];
|
|
1446
1446
|
/**
|
|
1447
|
-
* @public
|
|
1448
1447
|
* <p>In an alarm based on an anomaly detection model, this is the ID of the
|
|
1449
1448
|
* <code>ANOMALY_DETECTION_BAND</code> function
|
|
1450
1449
|
* used as the threshold for the alarm.</p>
|
|
1450
|
+
* @public
|
|
1451
1451
|
*/
|
|
1452
1452
|
ThresholdMetricId?: string;
|
|
1453
1453
|
/**
|
|
1454
|
-
* @public
|
|
1455
1454
|
* <p>If the value of this field is
|
|
1456
1455
|
* <code>PARTIAL_DATA</code>, the alarm is being evaluated based on only partial data. This happens if the
|
|
1457
1456
|
* query used for the alarm returns more than 10,000 metrics. For
|
|
1458
1457
|
* more information, see
|
|
1459
1458
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create alarms on Metrics Insights queries</a>.</p>
|
|
1459
|
+
* @public
|
|
1460
1460
|
*/
|
|
1461
1461
|
EvaluationState?: EvaluationState;
|
|
1462
1462
|
/**
|
|
1463
|
-
* @public
|
|
1464
1463
|
* <p>The date and time that the alarm's <code>StateValue</code> most recently changed.</p>
|
|
1464
|
+
* @public
|
|
1465
1465
|
*/
|
|
1466
1466
|
StateTransitionedTimestamp?: Date;
|
|
1467
1467
|
}
|
|
@@ -1470,18 +1470,18 @@ export interface MetricAlarm {
|
|
|
1470
1470
|
*/
|
|
1471
1471
|
export interface DescribeAlarmsOutput {
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>The information about any composite alarms returned by the operation.</p>
|
|
1474
|
+
* @public
|
|
1475
1475
|
*/
|
|
1476
1476
|
CompositeAlarms?: CompositeAlarm[];
|
|
1477
1477
|
/**
|
|
1478
|
-
* @public
|
|
1479
1478
|
* <p>The information about any metric alarms returned by the operation.</p>
|
|
1479
|
+
* @public
|
|
1480
1480
|
*/
|
|
1481
1481
|
MetricAlarms?: MetricAlarm[];
|
|
1482
1482
|
/**
|
|
1483
|
-
* @public
|
|
1484
1483
|
* <p>The token that marks the start of the next batch of returned results.</p>
|
|
1484
|
+
* @public
|
|
1485
1485
|
*/
|
|
1486
1486
|
NextToken?: string;
|
|
1487
1487
|
}
|
|
@@ -1490,41 +1490,41 @@ export interface DescribeAlarmsOutput {
|
|
|
1490
1490
|
*/
|
|
1491
1491
|
export interface DescribeAlarmsForMetricInput {
|
|
1492
1492
|
/**
|
|
1493
|
-
* @public
|
|
1494
1493
|
* <p>The name of the metric.</p>
|
|
1494
|
+
* @public
|
|
1495
1495
|
*/
|
|
1496
1496
|
MetricName: string | undefined;
|
|
1497
1497
|
/**
|
|
1498
|
-
* @public
|
|
1499
1498
|
* <p>The namespace of the metric.</p>
|
|
1499
|
+
* @public
|
|
1500
1500
|
*/
|
|
1501
1501
|
Namespace: string | undefined;
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>The statistic for the metric, other than percentiles.
|
|
1505
1504
|
* For percentile statistics, use <code>ExtendedStatistics</code>.</p>
|
|
1505
|
+
* @public
|
|
1506
1506
|
*/
|
|
1507
1507
|
Statistic?: Statistic;
|
|
1508
1508
|
/**
|
|
1509
|
-
* @public
|
|
1510
1509
|
* <p>The percentile statistic for the metric. Specify a value between
|
|
1511
1510
|
* p0.0 and p100.</p>
|
|
1511
|
+
* @public
|
|
1512
1512
|
*/
|
|
1513
1513
|
ExtendedStatistic?: string;
|
|
1514
1514
|
/**
|
|
1515
|
-
* @public
|
|
1516
1515
|
* <p>The dimensions associated with the metric. If the metric has any associated
|
|
1517
1516
|
* dimensions, you must specify them in order for the call to succeed.</p>
|
|
1517
|
+
* @public
|
|
1518
1518
|
*/
|
|
1519
1519
|
Dimensions?: Dimension[];
|
|
1520
1520
|
/**
|
|
1521
|
-
* @public
|
|
1522
1521
|
* <p>The period, in seconds, over which the statistic is applied.</p>
|
|
1522
|
+
* @public
|
|
1523
1523
|
*/
|
|
1524
1524
|
Period?: number;
|
|
1525
1525
|
/**
|
|
1526
|
-
* @public
|
|
1527
1526
|
* <p>The unit for the metric.</p>
|
|
1527
|
+
* @public
|
|
1528
1528
|
*/
|
|
1529
1529
|
Unit?: StandardUnit;
|
|
1530
1530
|
}
|
|
@@ -1533,8 +1533,8 @@ export interface DescribeAlarmsForMetricInput {
|
|
|
1533
1533
|
*/
|
|
1534
1534
|
export interface DescribeAlarmsForMetricOutput {
|
|
1535
1535
|
/**
|
|
1536
|
-
* @public
|
|
1537
1536
|
* <p>The information for each alarm with the specified metric.</p>
|
|
1537
|
+
* @public
|
|
1538
1538
|
*/
|
|
1539
1539
|
MetricAlarms?: MetricAlarm[];
|
|
1540
1540
|
}
|
|
@@ -1543,42 +1543,42 @@ export interface DescribeAlarmsForMetricOutput {
|
|
|
1543
1543
|
*/
|
|
1544
1544
|
export interface DescribeAnomalyDetectorsInput {
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>Use the token returned by the previous operation to request the next page of results.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
NextToken?: string;
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>The maximum number of results to return in one operation. The maximum
|
|
1553
1552
|
* value that you can specify is 100.</p>
|
|
1554
1553
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1555
1554
|
* <code>NextToken</code> value. </p>
|
|
1555
|
+
* @public
|
|
1556
1556
|
*/
|
|
1557
1557
|
MaxResults?: number;
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>Limits the results to only the anomaly detection models that
|
|
1561
1560
|
* are associated with the specified namespace.</p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
Namespace?: string;
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>Limits the results to only the anomaly detection models that are associated with the
|
|
1567
1566
|
* specified metric name. If there are multiple metrics with this name in different
|
|
1568
1567
|
* namespaces that have anomaly detection models, they're all returned.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
MetricName?: string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>Limits the results to only the anomaly detection models that are associated with the
|
|
1574
1573
|
* specified metric dimensions. If there are multiple metrics that have these dimensions
|
|
1575
1574
|
* and have anomaly detection models associated, they're all returned.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
Dimensions?: Dimension[];
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>The anomaly detector types to request when using <code>DescribeAnomalyDetectorsInput</code>.
|
|
1581
1580
|
* If empty, defaults to <code>SINGLE_METRIC</code>.</p>
|
|
1581
|
+
* @public
|
|
1582
1582
|
*/
|
|
1583
1583
|
AnomalyDetectorTypes?: AnomalyDetectorType[];
|
|
1584
1584
|
}
|
|
@@ -1587,14 +1587,14 @@ export interface DescribeAnomalyDetectorsInput {
|
|
|
1587
1587
|
*/
|
|
1588
1588
|
export interface DescribeAnomalyDetectorsOutput {
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>The list of anomaly detection models returned by the operation.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
AnomalyDetectors?: AnomalyDetector[];
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>A token that you can use in a subsequent operation to
|
|
1597
1596
|
* retrieve the next set of results.</p>
|
|
1597
|
+
* @public
|
|
1598
1598
|
*/
|
|
1599
1599
|
NextToken?: string;
|
|
1600
1600
|
}
|
|
@@ -1603,57 +1603,57 @@ export interface DescribeAnomalyDetectorsOutput {
|
|
|
1603
1603
|
*/
|
|
1604
1604
|
export interface DescribeInsightRulesInput {
|
|
1605
1605
|
/**
|
|
1606
|
-
* @public
|
|
1607
1606
|
* <p>Include this value, if it was returned by the previous operation, to get the next set of rules.</p>
|
|
1607
|
+
* @public
|
|
1608
1608
|
*/
|
|
1609
1609
|
NextToken?: string;
|
|
1610
1610
|
/**
|
|
1611
|
-
* @public
|
|
1612
1611
|
* <p>The maximum number of results to return in one operation. If you omit this
|
|
1613
1612
|
* parameter, the default of 500 is used.</p>
|
|
1613
|
+
* @public
|
|
1614
1614
|
*/
|
|
1615
1615
|
MaxResults?: number;
|
|
1616
1616
|
}
|
|
1617
1617
|
/**
|
|
1618
|
-
* @public
|
|
1619
1618
|
* <p>This structure contains the definition
|
|
1620
1619
|
* for a Contributor Insights rule.
|
|
1621
1620
|
* For more information about this rule,
|
|
1622
1621
|
* see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">
|
|
1623
1622
|
* Using Constributor Insights to analyze high-cardinality data</a>
|
|
1624
1623
|
* in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
export interface InsightRule {
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>The name of the rule.</p>
|
|
1629
|
+
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
Name: string | undefined;
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>Indicates whether the rule is enabled or disabled.</p>
|
|
1634
|
+
* @public
|
|
1635
1635
|
*/
|
|
1636
1636
|
State: string | undefined;
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule", "Version": 1\}</code>. For managed rules,
|
|
1640
1639
|
* this is <code>\{"Name": "ServiceLogRule", "Version": 1\}</code>
|
|
1641
1640
|
* </p>
|
|
1641
|
+
* @public
|
|
1642
1642
|
*/
|
|
1643
1643
|
Schema: string | undefined;
|
|
1644
1644
|
/**
|
|
1645
|
-
* @public
|
|
1646
1645
|
* <p>The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors,
|
|
1647
1646
|
* the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see
|
|
1648
1647
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
|
|
1649
1648
|
* Rule Syntax</a>.</p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
Definition: string | undefined;
|
|
1652
1652
|
/**
|
|
1653
|
-
* @public
|
|
1654
1653
|
* <p>
|
|
1655
1654
|
* An optional built-in rule that Amazon Web Services manages.
|
|
1656
1655
|
* </p>
|
|
1656
|
+
* @public
|
|
1657
1657
|
*/
|
|
1658
1658
|
ManagedRule?: boolean;
|
|
1659
1659
|
}
|
|
@@ -1662,29 +1662,29 @@ export interface InsightRule {
|
|
|
1662
1662
|
*/
|
|
1663
1663
|
export interface DescribeInsightRulesOutput {
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>If this parameter is present, it is a token that marks the start of the next batch of returned results. </p>
|
|
1666
|
+
* @public
|
|
1667
1667
|
*/
|
|
1668
1668
|
NextToken?: string;
|
|
1669
1669
|
/**
|
|
1670
|
-
* @public
|
|
1671
1670
|
* <p>The rules returned by the operation.</p>
|
|
1671
|
+
* @public
|
|
1672
1672
|
*/
|
|
1673
1673
|
InsightRules?: InsightRule[];
|
|
1674
1674
|
}
|
|
1675
1675
|
/**
|
|
1676
|
-
* @public
|
|
1677
1676
|
* <p>Represents filters for a dimension.</p>
|
|
1677
|
+
* @public
|
|
1678
1678
|
*/
|
|
1679
1679
|
export interface DimensionFilter {
|
|
1680
1680
|
/**
|
|
1681
|
-
* @public
|
|
1682
1681
|
* <p>The dimension name to be matched.</p>
|
|
1682
|
+
* @public
|
|
1683
1683
|
*/
|
|
1684
1684
|
Name: string | undefined;
|
|
1685
1685
|
/**
|
|
1686
|
-
* @public
|
|
1687
1686
|
* <p>The value of the dimension to be matched.</p>
|
|
1687
|
+
* @public
|
|
1688
1688
|
*/
|
|
1689
1689
|
Value?: string;
|
|
1690
1690
|
}
|
|
@@ -1693,8 +1693,8 @@ export interface DimensionFilter {
|
|
|
1693
1693
|
*/
|
|
1694
1694
|
export interface DisableAlarmActionsInput {
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>The names of the alarms.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
AlarmNames: string[] | undefined;
|
|
1700
1700
|
}
|
|
@@ -1703,8 +1703,8 @@ export interface DisableAlarmActionsInput {
|
|
|
1703
1703
|
*/
|
|
1704
1704
|
export interface DisableInsightRulesInput {
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>An array of the rule names to disable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
RuleNames: string[] | undefined;
|
|
1710
1710
|
}
|
|
@@ -1713,8 +1713,8 @@ export interface DisableInsightRulesInput {
|
|
|
1713
1713
|
*/
|
|
1714
1714
|
export interface DisableInsightRulesOutput {
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>An array listing the rules that could not be disabled. You cannot disable built-in rules.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
Failures?: PartialFailure[];
|
|
1720
1720
|
}
|
|
@@ -1723,8 +1723,8 @@ export interface DisableInsightRulesOutput {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface EnableAlarmActionsInput {
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>The names of the alarms.</p>
|
|
1727
|
+
* @public
|
|
1728
1728
|
*/
|
|
1729
1729
|
AlarmNames: string[] | undefined;
|
|
1730
1730
|
}
|
|
@@ -1733,8 +1733,8 @@ export interface EnableAlarmActionsInput {
|
|
|
1733
1733
|
*/
|
|
1734
1734
|
export interface EnableInsightRulesInput {
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>An array of the rule names to enable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
RuleNames: string[] | undefined;
|
|
1740
1740
|
}
|
|
@@ -1743,14 +1743,14 @@ export interface EnableInsightRulesInput {
|
|
|
1743
1743
|
*/
|
|
1744
1744
|
export interface EnableInsightRulesOutput {
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.</p>
|
|
1747
|
+
* @public
|
|
1748
1748
|
*/
|
|
1749
1749
|
Failures?: PartialFailure[];
|
|
1750
1750
|
}
|
|
1751
1751
|
/**
|
|
1752
|
-
* @public
|
|
1753
1752
|
* <p>The operation exceeded one or more limits.</p>
|
|
1753
|
+
* @public
|
|
1754
1754
|
*/
|
|
1755
1755
|
export declare class LimitExceededException extends __BaseException {
|
|
1756
1756
|
readonly name: "LimitExceededException";
|
|
@@ -1766,8 +1766,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1766
1766
|
*/
|
|
1767
1767
|
export interface GetDashboardInput {
|
|
1768
1768
|
/**
|
|
1769
|
-
* @public
|
|
1770
1769
|
* <p>The name of the dashboard to be described.</p>
|
|
1770
|
+
* @public
|
|
1771
1771
|
*/
|
|
1772
1772
|
DashboardName: string | undefined;
|
|
1773
1773
|
}
|
|
@@ -1776,20 +1776,20 @@ export interface GetDashboardInput {
|
|
|
1776
1776
|
*/
|
|
1777
1777
|
export interface GetDashboardOutput {
|
|
1778
1778
|
/**
|
|
1779
|
-
* @public
|
|
1780
1779
|
* <p>The Amazon Resource Name (ARN) of the dashboard.</p>
|
|
1780
|
+
* @public
|
|
1781
1781
|
*/
|
|
1782
1782
|
DashboardArn?: string;
|
|
1783
1783
|
/**
|
|
1784
|
-
* @public
|
|
1785
1784
|
* <p>The detailed information about the dashboard, including what widgets are included and their location
|
|
1786
1785
|
* on the dashboard. For more information about the <code>DashboardBody</code> syntax,
|
|
1787
1786
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>. </p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
DashboardBody?: string;
|
|
1790
1790
|
/**
|
|
1791
|
-
* @public
|
|
1792
1791
|
* <p>The name of the dashboard.</p>
|
|
1792
|
+
* @public
|
|
1793
1793
|
*/
|
|
1794
1794
|
DashboardName?: string;
|
|
1795
1795
|
}
|
|
@@ -1798,36 +1798,35 @@ export interface GetDashboardOutput {
|
|
|
1798
1798
|
*/
|
|
1799
1799
|
export interface GetInsightRuleReportInput {
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>The name of the rule that you want to see data from.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
RuleName: string | undefined;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
|
|
1808
1807
|
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
1809
1808
|
* <code>2019-07-01T23:59:59</code>.</p>
|
|
1809
|
+
* @public
|
|
1810
1810
|
*/
|
|
1811
1811
|
StartTime: Date | undefined;
|
|
1812
1812
|
/**
|
|
1813
|
-
* @public
|
|
1814
1813
|
* <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
|
|
1815
1814
|
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
1816
1815
|
* <code>2019-07-01T23:59:59</code>.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
EndTime: Date | undefined;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The period, in seconds, to use for the statistics in the <code>InsightRuleMetricDatapoint</code> results.</p>
|
|
1821
|
+
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
Period: number | undefined;
|
|
1824
1824
|
/**
|
|
1825
|
-
* @public
|
|
1826
1825
|
* <p>The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.</p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
MaxContributorCount?: number;
|
|
1829
1829
|
/**
|
|
1830
|
-
* @public
|
|
1831
1830
|
* <p>Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more
|
|
1832
1831
|
* of the following metrics:</p>
|
|
1833
1832
|
* <ul>
|
|
@@ -1864,109 +1863,110 @@ export interface GetInsightRuleReportInput {
|
|
|
1864
1863
|
* <code>Average</code> -- the average value from all contributors during the time period represented by that data point.</p>
|
|
1865
1864
|
* </li>
|
|
1866
1865
|
* </ul>
|
|
1866
|
+
* @public
|
|
1867
1867
|
*/
|
|
1868
1868
|
Metrics?: string[];
|
|
1869
1869
|
/**
|
|
1870
|
-
* @public
|
|
1871
1870
|
* <p>Determines what statistic to use to rank the contributors. Valid values are <code>Sum</code> and <code>Maximum</code>.</p>
|
|
1871
|
+
* @public
|
|
1872
1872
|
*/
|
|
1873
1873
|
OrderBy?: string;
|
|
1874
1874
|
}
|
|
1875
1875
|
/**
|
|
1876
|
-
* @public
|
|
1877
1876
|
* <p>One data point related to one contributor.</p>
|
|
1878
1877
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a> and
|
|
1879
1878
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html">InsightRuleContributor</a>.</p>
|
|
1879
|
+
* @public
|
|
1880
1880
|
*/
|
|
1881
1881
|
export interface InsightRuleContributorDatapoint {
|
|
1882
1882
|
/**
|
|
1883
|
-
* @public
|
|
1884
1883
|
* <p>The timestamp of the data point.</p>
|
|
1884
|
+
* @public
|
|
1885
1885
|
*/
|
|
1886
1886
|
Timestamp: Date | undefined;
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>The approximate value that this contributor added during this timestamp.</p>
|
|
1889
|
+
* @public
|
|
1890
1890
|
*/
|
|
1891
1891
|
ApproximateValue: number | undefined;
|
|
1892
1892
|
}
|
|
1893
1893
|
/**
|
|
1894
|
-
* @public
|
|
1895
1894
|
* <p>One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then
|
|
1896
1895
|
* a unique contributor is a unique combination of values from all the keys in the rule.</p>
|
|
1897
1896
|
* <p>If the rule contains a single key, then each unique contributor is each unique value for this key.</p>
|
|
1898
1897
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
|
|
1898
|
+
* @public
|
|
1899
1899
|
*/
|
|
1900
1900
|
export interface InsightRuleContributor {
|
|
1901
1901
|
/**
|
|
1902
|
-
* @public
|
|
1903
1902
|
* <p>One of the log entry field keywords that is used to define contributors for this rule.</p>
|
|
1903
|
+
* @public
|
|
1904
1904
|
*/
|
|
1905
1905
|
Keys: string[] | undefined;
|
|
1906
1906
|
/**
|
|
1907
|
-
* @public
|
|
1908
1907
|
* <p>An approximation of the aggregate value that comes from this contributor.</p>
|
|
1908
|
+
* @public
|
|
1909
1909
|
*/
|
|
1910
1910
|
ApproximateAggregateValue: number | undefined;
|
|
1911
1911
|
/**
|
|
1912
|
-
* @public
|
|
1913
1912
|
* <p>An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.</p>
|
|
1913
|
+
* @public
|
|
1914
1914
|
*/
|
|
1915
1915
|
Datapoints: InsightRuleContributorDatapoint[] | undefined;
|
|
1916
1916
|
}
|
|
1917
1917
|
/**
|
|
1918
|
-
* @public
|
|
1919
1918
|
* <p>One data point from the metric time series returned in a Contributor Insights rule report.</p>
|
|
1920
1919
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
|
|
1920
|
+
* @public
|
|
1921
1921
|
*/
|
|
1922
1922
|
export interface InsightRuleMetricDatapoint {
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>The timestamp of the data point.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
Timestamp: Date | undefined;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The number of unique contributors who published data during this timestamp.</p>
|
|
1931
1930
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
UniqueContributors?: number;
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately,
|
|
1937
1936
|
* so the identity of the max contributor
|
|
1938
1937
|
* could be different for each timestamp.</p>
|
|
1939
1938
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1939
|
+
* @public
|
|
1940
1940
|
*/
|
|
1941
1941
|
MaxContributorValue?: number;
|
|
1942
1942
|
/**
|
|
1943
|
-
* @public
|
|
1944
1943
|
* <p>The number of occurrences that matched the rule during this data point.</p>
|
|
1945
1944
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1945
|
+
* @public
|
|
1946
1946
|
*/
|
|
1947
1947
|
SampleCount?: number;
|
|
1948
1948
|
/**
|
|
1949
|
-
* @public
|
|
1950
1949
|
* <p>The average value from all contributors during the time period represented by that data point.</p>
|
|
1951
1950
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1951
|
+
* @public
|
|
1952
1952
|
*/
|
|
1953
1953
|
Average?: number;
|
|
1954
1954
|
/**
|
|
1955
|
-
* @public
|
|
1956
1955
|
* <p>The sum of the values from all contributors during the time period represented by that data point.</p>
|
|
1957
1956
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1957
|
+
* @public
|
|
1958
1958
|
*/
|
|
1959
1959
|
Sum?: number;
|
|
1960
1960
|
/**
|
|
1961
|
-
* @public
|
|
1962
1961
|
* <p>The minimum value from a single contributor during the time period represented by that data point.</p>
|
|
1963
1962
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1963
|
+
* @public
|
|
1964
1964
|
*/
|
|
1965
1965
|
Minimum?: number;
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>The maximum value from a single occurence from a single contributor during the time period represented by that data point.</p>
|
|
1969
1968
|
* <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
|
|
1969
|
+
* @public
|
|
1970
1970
|
*/
|
|
1971
1971
|
Maximum?: number;
|
|
1972
1972
|
}
|
|
@@ -1975,40 +1975,39 @@ export interface InsightRuleMetricDatapoint {
|
|
|
1975
1975
|
*/
|
|
1976
1976
|
export interface GetInsightRuleReportOutput {
|
|
1977
1977
|
/**
|
|
1978
|
-
* @public
|
|
1979
1978
|
* <p>An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors.
|
|
1980
1979
|
* If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.</p>
|
|
1980
|
+
* @public
|
|
1981
1981
|
*/
|
|
1982
1982
|
KeyLabels?: string[];
|
|
1983
1983
|
/**
|
|
1984
|
-
* @public
|
|
1985
1984
|
* <p>Specifies whether this rule aggregates contributor data by COUNT or SUM.</p>
|
|
1985
|
+
* @public
|
|
1986
1986
|
*/
|
|
1987
1987
|
AggregationStatistic?: string;
|
|
1988
1988
|
/**
|
|
1989
|
-
* @public
|
|
1990
1989
|
* <p>The sum of the values from all individual contributors that match the rule.</p>
|
|
1990
|
+
* @public
|
|
1991
1991
|
*/
|
|
1992
1992
|
AggregateValue?: number;
|
|
1993
1993
|
/**
|
|
1994
|
-
* @public
|
|
1995
1994
|
* <p>An approximate count of the unique contributors found by this rule in this time period.</p>
|
|
1995
|
+
* @public
|
|
1996
1996
|
*/
|
|
1997
1997
|
ApproximateUniqueCount?: number;
|
|
1998
1998
|
/**
|
|
1999
|
-
* @public
|
|
2000
1999
|
* <p>An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values
|
|
2001
2000
|
* for the keys counts as a unique contributor.</p>
|
|
2001
|
+
* @public
|
|
2002
2002
|
*/
|
|
2003
2003
|
Contributors?: InsightRuleContributor[];
|
|
2004
2004
|
/**
|
|
2005
|
-
* @public
|
|
2006
2005
|
* <p>A time series of metric data points that matches the time period in the rule request.</p>
|
|
2006
|
+
* @public
|
|
2007
2007
|
*/
|
|
2008
2008
|
MetricDatapoints?: InsightRuleMetricDatapoint[];
|
|
2009
2009
|
}
|
|
2010
2010
|
/**
|
|
2011
|
-
* @public
|
|
2012
2011
|
* <p>This structure includes the <code>Timezone</code> parameter, which you can use
|
|
2013
2012
|
* to specify your time zone so that the labels that are associated with returned metrics display the
|
|
2014
2013
|
* correct time
|
|
@@ -2016,15 +2015,16 @@ export interface GetInsightRuleReportOutput {
|
|
|
2016
2015
|
* <p>The <code>Timezone</code> value affects a label only if you have a time-based
|
|
2017
2016
|
* dynamic expression in the label. For more information about dynamic expressions in labels,
|
|
2018
2017
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
|
|
2018
|
+
* @public
|
|
2019
2019
|
*/
|
|
2020
2020
|
export interface LabelOptions {
|
|
2021
2021
|
/**
|
|
2022
|
-
* @public
|
|
2023
2022
|
* <p>The time zone to use for metric data return in this operation.
|
|
2024
2023
|
* The format is <code>+</code> or <code>-</code> followed by four digits.
|
|
2025
2024
|
* The first two digits indicate the number of hours ahead or behind of UTC, and
|
|
2026
2025
|
* the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour
|
|
2027
2026
|
* and 30 minutes ahead of UTC. The default is +0000. </p>
|
|
2027
|
+
* @public
|
|
2028
2028
|
*/
|
|
2029
2029
|
Timezone?: string;
|
|
2030
2030
|
}
|
|
@@ -2033,15 +2033,14 @@ export interface LabelOptions {
|
|
|
2033
2033
|
*/
|
|
2034
2034
|
export interface GetMetricDataInput {
|
|
2035
2035
|
/**
|
|
2036
|
-
* @public
|
|
2037
2036
|
* <p>The metric queries to be returned. A single <code>GetMetricData</code> call can
|
|
2038
2037
|
* include as many as 500 <code>MetricDataQuery</code>
|
|
2039
2038
|
* structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,
|
|
2040
2039
|
* or a math expression to perform on retrieved data. </p>
|
|
2040
|
+
* @public
|
|
2041
2041
|
*/
|
|
2042
2042
|
MetricDataQueries: MetricDataQuery[] | undefined;
|
|
2043
2043
|
/**
|
|
2044
|
-
* @public
|
|
2045
2044
|
* <p>The time stamp indicating the earliest data to be returned.</p>
|
|
2046
2045
|
* <p>The value specified is inclusive; results include data points with the specified time stamp. </p>
|
|
2047
2046
|
* <p>CloudWatch rounds the specified time stamp as follows:</p>
|
|
@@ -2072,10 +2071,10 @@ export interface GetMetricDataInput {
|
|
|
2072
2071
|
* the beginning and end of an hour. For example, if the <code>Period</code> of a metric
|
|
2073
2072
|
* is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response
|
|
2074
2073
|
* from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>
|
|
2074
|
+
* @public
|
|
2075
2075
|
*/
|
|
2076
2076
|
StartTime: Date | undefined;
|
|
2077
2077
|
/**
|
|
2078
|
-
* @public
|
|
2079
2078
|
* <p>The time stamp indicating the latest data to be returned.</p>
|
|
2080
2079
|
* <p>The value specified is exclusive; results include data points up to the specified time stamp.</p>
|
|
2081
2080
|
* <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code>
|
|
@@ -2083,53 +2082,54 @@ export interface GetMetricDataInput {
|
|
|
2083
2082
|
* the beginning and end of an hour. For example, if the <code>Period</code> of a metric
|
|
2084
2083
|
* is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response
|
|
2085
2084
|
* from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>
|
|
2085
|
+
* @public
|
|
2086
2086
|
*/
|
|
2087
2087
|
EndTime: Date | undefined;
|
|
2088
2088
|
/**
|
|
2089
|
-
* @public
|
|
2090
2089
|
* <p>Include this value, if it was returned by the previous <code>GetMetricData</code> operation,
|
|
2091
2090
|
* to get the next set of data points.</p>
|
|
2091
|
+
* @public
|
|
2092
2092
|
*/
|
|
2093
2093
|
NextToken?: string;
|
|
2094
2094
|
/**
|
|
2095
|
-
* @public
|
|
2096
2095
|
* <p>The order in which data points should be returned. <code>TimestampDescending</code> returns the newest data first and paginates
|
|
2097
2096
|
* when the <code>MaxDatapoints</code> limit is reached. <code>TimestampAscending</code> returns the oldest data first and paginates
|
|
2098
2097
|
* when the <code>MaxDatapoints</code> limit is reached.</p>
|
|
2098
|
+
* @public
|
|
2099
2099
|
*/
|
|
2100
2100
|
ScanBy?: ScanBy;
|
|
2101
2101
|
/**
|
|
2102
|
-
* @public
|
|
2103
2102
|
* <p>The maximum number of data points the request should return before paginating. If you omit
|
|
2104
2103
|
* this, the default of 100,800 is used.</p>
|
|
2104
|
+
* @public
|
|
2105
2105
|
*/
|
|
2106
2106
|
MaxDatapoints?: number;
|
|
2107
2107
|
/**
|
|
2108
|
-
* @public
|
|
2109
2108
|
* <p>This structure includes the <code>Timezone</code> parameter, which you can use
|
|
2110
2109
|
* to specify your time zone so that the labels of returned data display the
|
|
2111
2110
|
* correct time
|
|
2112
2111
|
* for your time zone. </p>
|
|
2112
|
+
* @public
|
|
2113
2113
|
*/
|
|
2114
2114
|
LabelOptions?: LabelOptions;
|
|
2115
2115
|
}
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>A message returned by the <code>GetMetricData</code>API, including a code and a description.</p>
|
|
2119
2118
|
* <p>If a cross-Region <code>GetMetricData</code> operation fails with a code of <code>Forbidden</code> and a
|
|
2120
2119
|
* value of <code>Authentication too complex to
|
|
2121
2120
|
* retrieve cross region data</code>, you can correct the problem by running the <code>GetMetricData</code>
|
|
2122
2121
|
* operation in the same Region where the metric data is.</p>
|
|
2122
|
+
* @public
|
|
2123
2123
|
*/
|
|
2124
2124
|
export interface MessageData {
|
|
2125
2125
|
/**
|
|
2126
|
-
* @public
|
|
2127
2126
|
* <p>The error code or status code associated with the message.</p>
|
|
2127
|
+
* @public
|
|
2128
2128
|
*/
|
|
2129
2129
|
Code?: string;
|
|
2130
2130
|
/**
|
|
2131
|
-
* @public
|
|
2132
2131
|
* <p>The message text.</p>
|
|
2132
|
+
* @public
|
|
2133
2133
|
*/
|
|
2134
2134
|
Value?: string;
|
|
2135
2135
|
}
|
|
@@ -2148,48 +2148,48 @@ export declare const StatusCode: {
|
|
|
2148
2148
|
*/
|
|
2149
2149
|
export type StatusCode = (typeof StatusCode)[keyof typeof StatusCode];
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>A <code>GetMetricData</code> call returns an array of <code>MetricDataResult</code>
|
|
2153
2152
|
* structures. Each of these structures includes the data points for that metric, along
|
|
2154
2153
|
* with the timestamps of those data points and other identifying information.</p>
|
|
2154
|
+
* @public
|
|
2155
2155
|
*/
|
|
2156
2156
|
export interface MetricDataResult {
|
|
2157
2157
|
/**
|
|
2158
|
-
* @public
|
|
2159
2158
|
* <p>The short name you specified to represent this metric.</p>
|
|
2159
|
+
* @public
|
|
2160
2160
|
*/
|
|
2161
2161
|
Id?: string;
|
|
2162
2162
|
/**
|
|
2163
|
-
* @public
|
|
2164
2163
|
* <p>The human-readable label associated with the data.</p>
|
|
2164
|
+
* @public
|
|
2165
2165
|
*/
|
|
2166
2166
|
Label?: string;
|
|
2167
2167
|
/**
|
|
2168
|
-
* @public
|
|
2169
2168
|
* <p>The timestamps for the data points, formatted in Unix timestamp format. The number of
|
|
2170
2169
|
* timestamps always matches the number of values and the value for Timestamps[x] is
|
|
2171
2170
|
* Values[x].</p>
|
|
2171
|
+
* @public
|
|
2172
2172
|
*/
|
|
2173
2173
|
Timestamps?: Date[];
|
|
2174
2174
|
/**
|
|
2175
|
-
* @public
|
|
2176
2175
|
* <p>The data points for the metric corresponding to <code>Timestamps</code>. The number of
|
|
2177
2176
|
* values always matches the number of timestamps and the timestamp for Values[x] is
|
|
2178
2177
|
* Timestamps[x].</p>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
Values?: number[];
|
|
2181
2181
|
/**
|
|
2182
|
-
* @public
|
|
2183
2182
|
* <p>The status of the returned data. <code>Complete</code> indicates that all data points in the requested time range were returned.
|
|
2184
2183
|
* <code>PartialData</code> means that an incomplete set of data points were returned.
|
|
2185
2184
|
* You can use the <code>NextToken</code> value that was returned and repeat your request to get more data points.
|
|
2186
2185
|
* <code>NextToken</code> is not returned if you are performing a math expression. <code>InternalError</code>
|
|
2187
2186
|
* indicates that an error occurred. Retry your request using <code>NextToken</code>, if present.</p>
|
|
2187
|
+
* @public
|
|
2188
2188
|
*/
|
|
2189
2189
|
StatusCode?: StatusCode;
|
|
2190
2190
|
/**
|
|
2191
|
-
* @public
|
|
2192
2191
|
* <p>A list of messages with additional information about the data returned.</p>
|
|
2192
|
+
* @public
|
|
2193
2193
|
*/
|
|
2194
2194
|
Messages?: MessageData[];
|
|
2195
2195
|
}
|
|
@@ -2198,23 +2198,23 @@ export interface MetricDataResult {
|
|
|
2198
2198
|
*/
|
|
2199
2199
|
export interface GetMetricDataOutput {
|
|
2200
2200
|
/**
|
|
2201
|
-
* @public
|
|
2202
2201
|
* <p>The metrics that are returned, including the metric name, namespace, and dimensions.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
MetricDataResults?: MetricDataResult[];
|
|
2205
2205
|
/**
|
|
2206
|
-
* @public
|
|
2207
2206
|
* <p>A token that marks the next batch of returned results.</p>
|
|
2207
|
+
* @public
|
|
2208
2208
|
*/
|
|
2209
2209
|
NextToken?: string;
|
|
2210
2210
|
/**
|
|
2211
|
-
* @public
|
|
2212
2211
|
* <p>Contains a message about this <code>GetMetricData</code> operation, if the operation results in such a message.
|
|
2213
2212
|
* An example of a message that
|
|
2214
2213
|
* might be returned is <code>Maximum number of allowed metrics exceeded</code>. If there is a message, as much of the
|
|
2215
2214
|
* operation as possible is still executed.</p>
|
|
2216
2215
|
* <p>A message appears here only if it is related to the global <code>GetMetricData</code> operation. Any message
|
|
2217
2216
|
* about a specific metric returned by the operation appears in the <code>MetricDataResult</code> object returned for that metric.</p>
|
|
2217
|
+
* @public
|
|
2218
2218
|
*/
|
|
2219
2219
|
Messages?: MessageData[];
|
|
2220
2220
|
}
|
|
@@ -2223,27 +2223,26 @@ export interface GetMetricDataOutput {
|
|
|
2223
2223
|
*/
|
|
2224
2224
|
export interface GetMetricStatisticsInput {
|
|
2225
2225
|
/**
|
|
2226
|
-
* @public
|
|
2227
2226
|
* <p>The namespace of the metric, with or without spaces.</p>
|
|
2227
|
+
* @public
|
|
2228
2228
|
*/
|
|
2229
2229
|
Namespace: string | undefined;
|
|
2230
2230
|
/**
|
|
2231
|
-
* @public
|
|
2232
2231
|
* <p>The name of the metric, with or without spaces.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
MetricName: string | undefined;
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension.
|
|
2238
2237
|
* CloudWatch treats each unique combination of dimensions as a separate metric.
|
|
2239
2238
|
* If a specific combination of dimensions was not published, you can't retrieve statistics for it.
|
|
2240
2239
|
* You must specify the same dimensions that were used when the metrics were created. For an example,
|
|
2241
2240
|
* 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 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
|
|
2242
2241
|
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
2242
|
+
* @public
|
|
2243
2243
|
*/
|
|
2244
2244
|
Dimensions?: Dimension[];
|
|
2245
2245
|
/**
|
|
2246
|
-
* @public
|
|
2247
2246
|
* <p>The time stamp that determines the first data point to return. Start times are
|
|
2248
2247
|
* evaluated relative to the time that CloudWatch receives the request.</p>
|
|
2249
2248
|
* <p>The value specified is inclusive; results include data points with the specified time stamp.
|
|
@@ -2271,17 +2270,17 @@ export interface GetMetricStatisticsInput {
|
|
|
2271
2270
|
* period of 5 seconds, you receive data
|
|
2272
2271
|
* timestamped between 15:02:15 and 15:07:15.
|
|
2273
2272
|
* </p>
|
|
2273
|
+
* @public
|
|
2274
2274
|
*/
|
|
2275
2275
|
StartTime: Date | undefined;
|
|
2276
2276
|
/**
|
|
2277
|
-
* @public
|
|
2278
2277
|
* <p>The time stamp that determines the last data point to return.</p>
|
|
2279
2278
|
* <p>The value specified is exclusive; results include data points up to the specified time stamp.
|
|
2280
2279
|
* In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).</p>
|
|
2280
|
+
* @public
|
|
2281
2281
|
*/
|
|
2282
2282
|
EndTime: Date | undefined;
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
|
|
2286
2285
|
* be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
|
|
2287
2286
|
* at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
|
|
@@ -2299,28 +2298,29 @@ export interface GetMetricStatisticsInput {
|
|
|
2299
2298
|
* <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
|
|
2300
2299
|
* </li>
|
|
2301
2300
|
* </ul>
|
|
2301
|
+
* @public
|
|
2302
2302
|
*/
|
|
2303
2303
|
Period: number | undefined;
|
|
2304
2304
|
/**
|
|
2305
|
-
* @public
|
|
2306
2305
|
* <p>The metric statistics, other than percentile. For percentile statistics,
|
|
2307
2306
|
* use <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you must
|
|
2308
2307
|
* specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both.</p>
|
|
2308
|
+
* @public
|
|
2309
2309
|
*/
|
|
2310
2310
|
Statistics?: Statistic[];
|
|
2311
2311
|
/**
|
|
2312
|
-
* @public
|
|
2313
2312
|
* <p>The percentile statistics. Specify values between p0.0 and p100. When calling <code>GetMetricStatistics</code>, you must
|
|
2314
2313
|
* specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
|
|
2315
2314
|
* available for metrics when any of the metric values are negative numbers.</p>
|
|
2315
|
+
* @public
|
|
2316
2316
|
*/
|
|
2317
2317
|
ExtendedStatistics?: string[];
|
|
2318
2318
|
/**
|
|
2319
|
-
* @public
|
|
2320
2319
|
* <p>The unit for a given metric.
|
|
2321
2320
|
* If you omit <code>Unit</code>, all data that was collected with any unit is returned, along with the corresponding units that were specified
|
|
2322
2321
|
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
|
|
2323
2322
|
* If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
|
|
2323
|
+
* @public
|
|
2324
2324
|
*/
|
|
2325
2325
|
Unit?: StandardUnit;
|
|
2326
2326
|
}
|
|
@@ -2329,13 +2329,13 @@ export interface GetMetricStatisticsInput {
|
|
|
2329
2329
|
*/
|
|
2330
2330
|
export interface GetMetricStatisticsOutput {
|
|
2331
2331
|
/**
|
|
2332
|
-
* @public
|
|
2333
2332
|
* <p>A label for the specified metric.</p>
|
|
2333
|
+
* @public
|
|
2334
2334
|
*/
|
|
2335
2335
|
Label?: string;
|
|
2336
2336
|
/**
|
|
2337
|
-
* @public
|
|
2338
2337
|
* <p>The data points for the specified metric.</p>
|
|
2338
|
+
* @public
|
|
2339
2339
|
*/
|
|
2340
2340
|
Datapoints?: Datapoint[];
|
|
2341
2341
|
}
|
|
@@ -2344,13 +2344,12 @@ export interface GetMetricStatisticsOutput {
|
|
|
2344
2344
|
*/
|
|
2345
2345
|
export interface GetMetricStreamInput {
|
|
2346
2346
|
/**
|
|
2347
|
-
* @public
|
|
2348
2347
|
* <p>The name of the metric stream to retrieve information about.</p>
|
|
2348
|
+
* @public
|
|
2349
2349
|
*/
|
|
2350
2350
|
Name: string | undefined;
|
|
2351
2351
|
}
|
|
2352
2352
|
/**
|
|
2353
|
-
* @public
|
|
2354
2353
|
* <p>This structure contains a metric namespace and optionally, a list of metric names,
|
|
2355
2354
|
* to either include in a metric stream or exclude from
|
|
2356
2355
|
* a metric stream.</p>
|
|
@@ -2358,22 +2357,23 @@ export interface GetMetricStreamInput {
|
|
|
2358
2357
|
* applies to the sum of namespace names and metric names in the filters. For example,
|
|
2359
2358
|
* this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters
|
|
2360
2359
|
* with 49 metrics specified in each filter.</p>
|
|
2360
|
+
* @public
|
|
2361
2361
|
*/
|
|
2362
2362
|
export interface MetricStreamFilter {
|
|
2363
2363
|
/**
|
|
2364
|
-
* @public
|
|
2365
2364
|
* <p>The name of the metric namespace for this filter.</p>
|
|
2366
2365
|
* <p>The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must
|
|
2367
2366
|
* contain at least one non-whitespace character.</p>
|
|
2367
|
+
* @public
|
|
2368
2368
|
*/
|
|
2369
2369
|
Namespace?: string;
|
|
2370
2370
|
/**
|
|
2371
|
-
* @public
|
|
2372
2371
|
* <p>The names of the metrics to either include or exclude from the metric stream. </p>
|
|
2373
2372
|
* <p>If you omit this parameter, all metrics in the namespace are included or excluded,
|
|
2374
2373
|
* depending on whether this filter is specified as an exclude filter or an include filter.</p>
|
|
2375
2374
|
* <p>Each metric name can contain only ASCII printable characters (ASCII range 32 through 126).
|
|
2376
2375
|
* Each metric name must contain at least one non-whitespace character.</p>
|
|
2376
|
+
* @public
|
|
2377
2377
|
*/
|
|
2378
2378
|
MetricNames?: string[];
|
|
2379
2379
|
}
|
|
@@ -2391,43 +2391,42 @@ export declare const MetricStreamOutputFormat: {
|
|
|
2391
2391
|
*/
|
|
2392
2392
|
export type MetricStreamOutputFormat = (typeof MetricStreamOutputFormat)[keyof typeof MetricStreamOutputFormat];
|
|
2393
2393
|
/**
|
|
2394
|
-
* @public
|
|
2395
2394
|
* <p>This object contains the information for one metric that is to be streamed with
|
|
2396
2395
|
* additional statistics.</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
export interface MetricStreamStatisticsMetric {
|
|
2399
2399
|
/**
|
|
2400
|
-
* @public
|
|
2401
2400
|
* <p>The namespace of the metric.</p>
|
|
2401
|
+
* @public
|
|
2402
2402
|
*/
|
|
2403
2403
|
Namespace: string | undefined;
|
|
2404
2404
|
/**
|
|
2405
|
-
* @public
|
|
2406
2405
|
* <p>The name of the metric.</p>
|
|
2406
|
+
* @public
|
|
2407
2407
|
*/
|
|
2408
2408
|
MetricName: string | undefined;
|
|
2409
2409
|
}
|
|
2410
2410
|
/**
|
|
2411
|
-
* @public
|
|
2412
2411
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
|
|
2413
2412
|
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. This structure contains information for
|
|
2414
2413
|
* one metric that includes additional statistics in the stream. For more information about statistics,
|
|
2415
2414
|
* see CloudWatch, listed in
|
|
2416
2415
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2417
2416
|
* CloudWatch statistics definitions</a>.</p>
|
|
2417
|
+
* @public
|
|
2418
2418
|
*/
|
|
2419
2419
|
export interface MetricStreamStatisticsConfiguration {
|
|
2420
2420
|
/**
|
|
2421
|
-
* @public
|
|
2422
2421
|
* <p>An array of metric name and namespace pairs that stream the additional statistics listed
|
|
2423
2422
|
* in the value of the <code>AdditionalStatistics</code> parameter. There can be as many as
|
|
2424
2423
|
* 100 pairs in the array.</p>
|
|
2425
2424
|
* <p>All metrics that match the combination of metric name and namespace will be streamed
|
|
2426
2425
|
* with the additional statistics, no matter their dimensions.</p>
|
|
2426
|
+
* @public
|
|
2427
2427
|
*/
|
|
2428
2428
|
IncludeMetrics: MetricStreamStatisticsMetric[] | undefined;
|
|
2429
2429
|
/**
|
|
2430
|
-
* @public
|
|
2431
2430
|
* <p>The list of additional statistics that are to be streamed for the metrics listed
|
|
2432
2431
|
* in the <code>IncludeMetrics</code> array in this structure. This list can include as many as 20 statistics.</p>
|
|
2433
2432
|
* <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry1.0</code> or <code>opentelemetry0.7</code>, the only
|
|
@@ -2439,6 +2438,7 @@ export interface MetricStreamStatisticsConfiguration {
|
|
|
2439
2438
|
* CloudWatch statistics definitions</a>. For example, this includes
|
|
2440
2439
|
* <code>tm98, </code>
|
|
2441
2440
|
* <code>wm90</code>, <code>PR(:300)</code>, and so on.</p>
|
|
2441
|
+
* @public
|
|
2442
2442
|
*/
|
|
2443
2443
|
AdditionalStatistics: string[] | undefined;
|
|
2444
2444
|
}
|
|
@@ -2447,76 +2447,76 @@ export interface MetricStreamStatisticsConfiguration {
|
|
|
2447
2447
|
*/
|
|
2448
2448
|
export interface GetMetricStreamOutput {
|
|
2449
2449
|
/**
|
|
2450
|
-
* @public
|
|
2451
2450
|
* <p>The ARN of the metric stream.</p>
|
|
2451
|
+
* @public
|
|
2452
2452
|
*/
|
|
2453
2453
|
Arn?: string;
|
|
2454
2454
|
/**
|
|
2455
|
-
* @public
|
|
2456
2455
|
* <p>The name of the metric stream.</p>
|
|
2456
|
+
* @public
|
|
2457
2457
|
*/
|
|
2458
2458
|
Name?: string;
|
|
2459
2459
|
/**
|
|
2460
|
-
* @public
|
|
2461
2460
|
* <p>If this array of metric namespaces is present, then these
|
|
2462
2461
|
* namespaces are the only
|
|
2463
2462
|
* metric namespaces that are streamed by this metric stream.</p>
|
|
2463
|
+
* @public
|
|
2464
2464
|
*/
|
|
2465
2465
|
IncludeFilters?: MetricStreamFilter[];
|
|
2466
2466
|
/**
|
|
2467
|
-
* @public
|
|
2468
2467
|
* <p>If this array of metric namespaces is present, then these namespaces are the only
|
|
2469
2468
|
* metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in
|
|
2470
2469
|
* the account are streamed by this metric stream.</p>
|
|
2470
|
+
* @public
|
|
2471
2471
|
*/
|
|
2472
2472
|
ExcludeFilters?: MetricStreamFilter[];
|
|
2473
2473
|
/**
|
|
2474
|
-
* @public
|
|
2475
2474
|
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric
|
|
2476
2475
|
* stream.</p>
|
|
2476
|
+
* @public
|
|
2477
2477
|
*/
|
|
2478
2478
|
FirehoseArn?: string;
|
|
2479
2479
|
/**
|
|
2480
|
-
* @public
|
|
2481
2480
|
* <p>The ARN of the IAM role that is used by this metric stream.</p>
|
|
2481
|
+
* @public
|
|
2482
2482
|
*/
|
|
2483
2483
|
RoleArn?: string;
|
|
2484
2484
|
/**
|
|
2485
|
-
* @public
|
|
2486
2485
|
* <p>The state of the metric stream. The possible values are <code>running</code>
|
|
2487
2486
|
* and <code>stopped</code>.</p>
|
|
2487
|
+
* @public
|
|
2488
2488
|
*/
|
|
2489
2489
|
State?: string;
|
|
2490
2490
|
/**
|
|
2491
|
-
* @public
|
|
2492
2491
|
* <p>The date that the metric stream was created.</p>
|
|
2492
|
+
* @public
|
|
2493
2493
|
*/
|
|
2494
2494
|
CreationDate?: Date;
|
|
2495
2495
|
/**
|
|
2496
|
-
* @public
|
|
2497
2496
|
* <p>The date of the most recent update to the metric stream's configuration.</p>
|
|
2497
|
+
* @public
|
|
2498
2498
|
*/
|
|
2499
2499
|
LastUpdateDate?: Date;
|
|
2500
2500
|
/**
|
|
2501
|
-
* @public
|
|
2502
2501
|
* <p>The output format for the stream.
|
|
2503
2502
|
* Valid values are <code>json</code>, <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>.
|
|
2504
2503
|
* For more information about metric stream output formats,
|
|
2505
2504
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">Metric streams output formats</a>.</p>
|
|
2505
|
+
* @public
|
|
2506
2506
|
*/
|
|
2507
2507
|
OutputFormat?: MetricStreamOutputFormat;
|
|
2508
2508
|
/**
|
|
2509
|
-
* @public
|
|
2510
2509
|
* <p>Each entry in this array displays information about one or more metrics that include additional statistics
|
|
2511
2510
|
* in the metric stream. For more information about the additional statistics, see
|
|
2512
2511
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2513
2512
|
* CloudWatch statistics definitions</a>. </p>
|
|
2513
|
+
* @public
|
|
2514
2514
|
*/
|
|
2515
2515
|
StatisticsConfigurations?: MetricStreamStatisticsConfiguration[];
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>If this is <code>true</code> and this metric stream is in a monitoring account, then the stream includes
|
|
2519
2518
|
* metrics from source accounts that the monitoring account is linked to.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
IncludeLinkedAccountsMetrics?: boolean;
|
|
2522
2522
|
}
|
|
@@ -2525,7 +2525,6 @@ export interface GetMetricStreamOutput {
|
|
|
2525
2525
|
*/
|
|
2526
2526
|
export interface GetMetricWidgetImageInput {
|
|
2527
2527
|
/**
|
|
2528
|
-
* @public
|
|
2529
2528
|
* <p>A JSON string that defines the bitmap graph to be retrieved. The string includes the
|
|
2530
2529
|
* metrics to include in the graph, statistics, annotations, title, axis limits, and so on.
|
|
2531
2530
|
* You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p>
|
|
@@ -2533,10 +2532,10 @@ export interface GetMetricWidgetImageInput {
|
|
|
2533
2532
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html">GetMetricWidgetImage: Metric Widget Structure and Syntax</a>.</p>
|
|
2534
2533
|
* <p>If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation
|
|
2535
2534
|
* point appears next to the graph legend.</p>
|
|
2535
|
+
* @public
|
|
2536
2536
|
*/
|
|
2537
2537
|
MetricWidget: string | undefined;
|
|
2538
2538
|
/**
|
|
2539
|
-
* @public
|
|
2540
2539
|
* <p>The format of the resulting image. Only PNG images are supported.</p>
|
|
2541
2540
|
* <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the
|
|
2542
2541
|
* content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code>
|
|
@@ -2576,6 +2575,7 @@ export interface GetMetricWidgetImageInput {
|
|
|
2576
2575
|
* use cases, and all actions using an Amazon Web Services SDK, you should use <code>png</code>. If you specify
|
|
2577
2576
|
* <code>image/png</code>, the HTTP response has a content-type set to <code>image/png</code>,
|
|
2578
2577
|
* and the body of the response is a PNG image. </p>
|
|
2578
|
+
* @public
|
|
2579
2579
|
*/
|
|
2580
2580
|
OutputFormat?: string;
|
|
2581
2581
|
}
|
|
@@ -2584,8 +2584,8 @@ export interface GetMetricWidgetImageInput {
|
|
|
2584
2584
|
*/
|
|
2585
2585
|
export interface GetMetricWidgetImageOutput {
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>The image of the graph, in the output format specified. The output is base64-encoded.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
MetricWidgetImage?: Uint8Array;
|
|
2591
2591
|
}
|
|
@@ -2594,17 +2594,17 @@ export interface GetMetricWidgetImageOutput {
|
|
|
2594
2594
|
*/
|
|
2595
2595
|
export interface ListDashboardsInput {
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>If you specify this parameter, only
|
|
2599
2598
|
* the dashboards with names starting with the specified string are listed. The maximum length is 255, and
|
|
2600
2599
|
* valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
|
|
2601
2600
|
*
|
|
2602
2601
|
* </p>
|
|
2602
|
+
* @public
|
|
2603
2603
|
*/
|
|
2604
2604
|
DashboardNamePrefix?: string;
|
|
2605
2605
|
/**
|
|
2606
|
-
* @public
|
|
2607
2606
|
* <p>The token returned by a previous call to indicate that there is more data available.</p>
|
|
2607
|
+
* @public
|
|
2608
2608
|
*/
|
|
2609
2609
|
NextToken?: string;
|
|
2610
2610
|
}
|
|
@@ -2613,13 +2613,13 @@ export interface ListDashboardsInput {
|
|
|
2613
2613
|
*/
|
|
2614
2614
|
export interface ListDashboardsOutput {
|
|
2615
2615
|
/**
|
|
2616
|
-
* @public
|
|
2617
2616
|
* <p>The list of matching dashboards.</p>
|
|
2617
|
+
* @public
|
|
2618
2618
|
*/
|
|
2619
2619
|
DashboardEntries?: DashboardEntry[];
|
|
2620
2620
|
/**
|
|
2621
|
-
* @public
|
|
2622
2621
|
* <p>The token that marks the start of the next batch of returned results.</p>
|
|
2622
|
+
* @public
|
|
2623
2623
|
*/
|
|
2624
2624
|
NextToken?: string;
|
|
2625
2625
|
}
|
|
@@ -2628,16 +2628,15 @@ export interface ListDashboardsOutput {
|
|
|
2628
2628
|
*/
|
|
2629
2629
|
export interface ListManagedInsightRulesInput {
|
|
2630
2630
|
/**
|
|
2631
|
-
* @public
|
|
2632
2631
|
* <p>
|
|
2633
2632
|
* The ARN
|
|
2634
2633
|
* of an Amazon Web Services resource
|
|
2635
2634
|
* that has managed Contributor Insights rules.
|
|
2636
2635
|
* </p>
|
|
2636
|
+
* @public
|
|
2637
2637
|
*/
|
|
2638
2638
|
ResourceARN: string | undefined;
|
|
2639
2639
|
/**
|
|
2640
|
-
* @public
|
|
2641
2640
|
* <p>
|
|
2642
2641
|
* Include this value
|
|
2643
2642
|
* to get
|
|
@@ -2646,10 +2645,10 @@ export interface ListManagedInsightRulesInput {
|
|
|
2646
2645
|
* if the value was returned
|
|
2647
2646
|
* by the previous operation.
|
|
2648
2647
|
* </p>
|
|
2648
|
+
* @public
|
|
2649
2649
|
*/
|
|
2650
2650
|
NextToken?: string;
|
|
2651
2651
|
/**
|
|
2652
|
-
* @public
|
|
2653
2652
|
* <p>
|
|
2654
2653
|
* The maximum number
|
|
2655
2654
|
* of results
|
|
@@ -2659,37 +2658,37 @@ export interface ListManagedInsightRulesInput {
|
|
|
2659
2658
|
* the default number is used.
|
|
2660
2659
|
* The default number is <code>100</code>.
|
|
2661
2660
|
* </p>
|
|
2661
|
+
* @public
|
|
2662
2662
|
*/
|
|
2663
2663
|
MaxResults?: number;
|
|
2664
2664
|
}
|
|
2665
2665
|
/**
|
|
2666
|
-
* @public
|
|
2667
2666
|
* <p>
|
|
2668
2667
|
* The status
|
|
2669
2668
|
* of a managed Contributor Insights rule.
|
|
2670
2669
|
* </p>
|
|
2670
|
+
* @public
|
|
2671
2671
|
*/
|
|
2672
2672
|
export interface ManagedRuleState {
|
|
2673
2673
|
/**
|
|
2674
|
-
* @public
|
|
2675
2674
|
* <p>
|
|
2676
2675
|
* The name
|
|
2677
2676
|
* of the Contributor Insights rule
|
|
2678
2677
|
* that contains data
|
|
2679
2678
|
* for the specified Amazon Web Services resource.
|
|
2680
2679
|
* </p>
|
|
2680
|
+
* @public
|
|
2681
2681
|
*/
|
|
2682
2682
|
RuleName: string | undefined;
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>
|
|
2686
2685
|
* Indicates whether the rule is enabled or disabled.
|
|
2687
2686
|
* </p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
State: string | undefined;
|
|
2690
2690
|
}
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>
|
|
2694
2693
|
* Contains information
|
|
2695
2694
|
* about managed Contributor Insights rules,
|
|
@@ -2697,29 +2696,29 @@ export interface ManagedRuleState {
|
|
|
2697
2696
|
* by <code>ListManagedInsightRules</code>.
|
|
2698
2697
|
*
|
|
2699
2698
|
* </p>
|
|
2699
|
+
* @public
|
|
2700
2700
|
*/
|
|
2701
2701
|
export interface ManagedRuleDescription {
|
|
2702
2702
|
/**
|
|
2703
|
-
* @public
|
|
2704
2703
|
* <p>
|
|
2705
2704
|
* The template name
|
|
2706
2705
|
* for the managed rule.
|
|
2707
2706
|
* Used
|
|
2708
2707
|
* to enable managed rules using <code>PutManagedInsightRules</code>.
|
|
2709
2708
|
* </p>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
TemplateName?: string;
|
|
2712
2712
|
/**
|
|
2713
|
-
* @public
|
|
2714
2713
|
* <p>
|
|
2715
2714
|
* If a managed rule is enabled,
|
|
2716
2715
|
* this is the ARN
|
|
2717
2716
|
* for the related Amazon Web Services resource.
|
|
2718
2717
|
* </p>
|
|
2718
|
+
* @public
|
|
2719
2719
|
*/
|
|
2720
2720
|
ResourceARN?: string;
|
|
2721
2721
|
/**
|
|
2722
|
-
* @public
|
|
2723
2722
|
* <p>
|
|
2724
2723
|
* Describes the state
|
|
2725
2724
|
* of a managed rule.
|
|
@@ -2729,6 +2728,7 @@ export interface ManagedRuleDescription {
|
|
|
2729
2728
|
* that contains information
|
|
2730
2729
|
* about the related Amazon Web Services resource.
|
|
2731
2730
|
* </p>
|
|
2731
|
+
* @public
|
|
2732
2732
|
*/
|
|
2733
2733
|
RuleState?: ManagedRuleState;
|
|
2734
2734
|
}
|
|
@@ -2737,16 +2737,15 @@ export interface ManagedRuleDescription {
|
|
|
2737
2737
|
*/
|
|
2738
2738
|
export interface ListManagedInsightRulesOutput {
|
|
2739
2739
|
/**
|
|
2740
|
-
* @public
|
|
2741
2740
|
* <p>
|
|
2742
2741
|
* The managed rules
|
|
2743
2742
|
* that are available
|
|
2744
2743
|
* for the specified Amazon Web Services resource.
|
|
2745
2744
|
* </p>
|
|
2745
|
+
* @public
|
|
2746
2746
|
*/
|
|
2747
2747
|
ManagedRules?: ManagedRuleDescription[];
|
|
2748
2748
|
/**
|
|
2749
|
-
* @public
|
|
2750
2749
|
* <p>
|
|
2751
2750
|
* Include this value
|
|
2752
2751
|
* to get
|
|
@@ -2755,6 +2754,7 @@ export interface ListManagedInsightRulesOutput {
|
|
|
2755
2754
|
* if the value was returned
|
|
2756
2755
|
* by the previous operation.
|
|
2757
2756
|
* </p>
|
|
2757
|
+
* @public
|
|
2758
2758
|
*/
|
|
2759
2759
|
NextToken?: string;
|
|
2760
2760
|
}
|
|
@@ -2774,31 +2774,30 @@ export type RecentlyActive = (typeof RecentlyActive)[keyof typeof RecentlyActive
|
|
|
2774
2774
|
*/
|
|
2775
2775
|
export interface ListMetricsInput {
|
|
2776
2776
|
/**
|
|
2777
|
-
* @public
|
|
2778
2777
|
* <p>The metric namespace to filter against. Only the namespace that matches exactly
|
|
2779
2778
|
* will be returned.</p>
|
|
2779
|
+
* @public
|
|
2780
2780
|
*/
|
|
2781
2781
|
Namespace?: string;
|
|
2782
2782
|
/**
|
|
2783
|
-
* @public
|
|
2784
2783
|
* <p>The name of the metric to filter against. Only the metrics with names that match exactly
|
|
2785
2784
|
* will be returned.</p>
|
|
2785
|
+
* @public
|
|
2786
2786
|
*/
|
|
2787
2787
|
MetricName?: string;
|
|
2788
2788
|
/**
|
|
2789
|
-
* @public
|
|
2790
2789
|
* <p>The dimensions to filter against. Only the dimensions that match exactly
|
|
2791
2790
|
* will be returned.</p>
|
|
2791
|
+
* @public
|
|
2792
2792
|
*/
|
|
2793
2793
|
Dimensions?: DimensionFilter[];
|
|
2794
2794
|
/**
|
|
2795
|
-
* @public
|
|
2796
2795
|
* <p>The token returned by a previous call to indicate that there is more data
|
|
2797
2796
|
* available.</p>
|
|
2797
|
+
* @public
|
|
2798
2798
|
*/
|
|
2799
2799
|
NextToken?: string;
|
|
2800
2800
|
/**
|
|
2801
|
-
* @public
|
|
2802
2801
|
* <p>To filter the results to show only metrics that have had data points published
|
|
2803
2802
|
* in the past three hours, specify this parameter
|
|
2804
2803
|
* with a value of <code>PT3H</code>. This is the only valid value
|
|
@@ -2806,20 +2805,21 @@ export interface ListMetricsInput {
|
|
|
2806
2805
|
* <p>The results that are returned are an approximation of the value you specify. There
|
|
2807
2806
|
* is a low probability that the returned results include metrics with last published
|
|
2808
2807
|
* data as much as 40 minutes more than the specified time interval.</p>
|
|
2808
|
+
* @public
|
|
2809
2809
|
*/
|
|
2810
2810
|
RecentlyActive?: RecentlyActive;
|
|
2811
2811
|
/**
|
|
2812
|
-
* @public
|
|
2813
2812
|
* <p>If you are using this operation in a monitoring account,
|
|
2814
2813
|
* specify <code>true</code> to include metrics from source accounts in the returned data.</p>
|
|
2815
2814
|
* <p>The default is <code>false</code>.</p>
|
|
2815
|
+
* @public
|
|
2816
2816
|
*/
|
|
2817
2817
|
IncludeLinkedAccounts?: boolean;
|
|
2818
2818
|
/**
|
|
2819
|
-
* @public
|
|
2820
2819
|
* <p>When you use this operation in a monitoring account, use this field to return metrics only from one source account.
|
|
2821
2820
|
* To do so, specify that source account ID in this field, and also
|
|
2822
2821
|
* specify <code>true</code> for <code>IncludeLinkedAccounts</code>.</p>
|
|
2822
|
+
* @public
|
|
2823
2823
|
*/
|
|
2824
2824
|
OwningAccount?: string;
|
|
2825
2825
|
}
|
|
@@ -2828,21 +2828,21 @@ export interface ListMetricsInput {
|
|
|
2828
2828
|
*/
|
|
2829
2829
|
export interface ListMetricsOutput {
|
|
2830
2830
|
/**
|
|
2831
|
-
* @public
|
|
2832
2831
|
* <p>The metrics that match your request. </p>
|
|
2832
|
+
* @public
|
|
2833
2833
|
*/
|
|
2834
2834
|
Metrics?: Metric[];
|
|
2835
2835
|
/**
|
|
2836
|
-
* @public
|
|
2837
2836
|
* <p>The token that marks the start of the next batch of returned results. </p>
|
|
2837
|
+
* @public
|
|
2838
2838
|
*/
|
|
2839
2839
|
NextToken?: string;
|
|
2840
2840
|
/**
|
|
2841
|
-
* @public
|
|
2842
2841
|
* <p>If you are using this operation in a monitoring account, this array contains the account IDs of the source
|
|
2843
2842
|
* accounts where the metrics in the returned data
|
|
2844
2843
|
* are from.</p>
|
|
2845
2844
|
* <p>This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.</p>
|
|
2845
|
+
* @public
|
|
2846
2846
|
*/
|
|
2847
2847
|
OwningAccounts?: string[];
|
|
2848
2848
|
}
|
|
@@ -2851,56 +2851,56 @@ export interface ListMetricsOutput {
|
|
|
2851
2851
|
*/
|
|
2852
2852
|
export interface ListMetricStreamsInput {
|
|
2853
2853
|
/**
|
|
2854
|
-
* @public
|
|
2855
2854
|
* <p>Include this value, if it was returned by the previous call, to get the next set of metric streams.</p>
|
|
2855
|
+
* @public
|
|
2856
2856
|
*/
|
|
2857
2857
|
NextToken?: string;
|
|
2858
2858
|
/**
|
|
2859
|
-
* @public
|
|
2860
2859
|
* <p>The maximum number of results to return in one operation.</p>
|
|
2860
|
+
* @public
|
|
2861
2861
|
*/
|
|
2862
2862
|
MaxResults?: number;
|
|
2863
2863
|
}
|
|
2864
2864
|
/**
|
|
2865
|
-
* @public
|
|
2866
2865
|
* <p>This structure contains the configuration information about one metric stream.</p>
|
|
2866
|
+
* @public
|
|
2867
2867
|
*/
|
|
2868
2868
|
export interface MetricStreamEntry {
|
|
2869
2869
|
/**
|
|
2870
|
-
* @public
|
|
2871
2870
|
* <p>The ARN of the metric stream.</p>
|
|
2871
|
+
* @public
|
|
2872
2872
|
*/
|
|
2873
2873
|
Arn?: string;
|
|
2874
2874
|
/**
|
|
2875
|
-
* @public
|
|
2876
2875
|
* <p>The date that the metric stream was originally created.</p>
|
|
2876
|
+
* @public
|
|
2877
2877
|
*/
|
|
2878
2878
|
CreationDate?: Date;
|
|
2879
2879
|
/**
|
|
2880
|
-
* @public
|
|
2881
2880
|
* <p>The date that the configuration of this metric stream was most recently updated.</p>
|
|
2881
|
+
* @public
|
|
2882
2882
|
*/
|
|
2883
2883
|
LastUpdateDate?: Date;
|
|
2884
2884
|
/**
|
|
2885
|
-
* @public
|
|
2886
2885
|
* <p>The name of the metric stream.</p>
|
|
2886
|
+
* @public
|
|
2887
2887
|
*/
|
|
2888
2888
|
Name?: string;
|
|
2889
2889
|
/**
|
|
2890
|
-
* @public
|
|
2891
2890
|
* <p>The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.</p>
|
|
2891
|
+
* @public
|
|
2892
2892
|
*/
|
|
2893
2893
|
FirehoseArn?: string;
|
|
2894
2894
|
/**
|
|
2895
|
-
* @public
|
|
2896
2895
|
* <p>The current state of this stream. Valid values are <code>running</code> and <code>stopped</code>.</p>
|
|
2896
|
+
* @public
|
|
2897
2897
|
*/
|
|
2898
2898
|
State?: string;
|
|
2899
2899
|
/**
|
|
2900
|
-
* @public
|
|
2901
2900
|
* <p>The output format of this metric stream. Valid values are
|
|
2902
2901
|
* <code>json</code>, <code>opentelemetry1.0</code>,
|
|
2903
2902
|
* and <code>opentelemetry0.7</code>.</p>
|
|
2903
|
+
* @public
|
|
2904
2904
|
*/
|
|
2905
2905
|
OutputFormat?: MetricStreamOutputFormat;
|
|
2906
2906
|
}
|
|
@@ -2909,14 +2909,14 @@ export interface MetricStreamEntry {
|
|
|
2909
2909
|
*/
|
|
2910
2910
|
export interface ListMetricStreamsOutput {
|
|
2911
2911
|
/**
|
|
2912
|
-
* @public
|
|
2913
2912
|
* <p>The token that marks the start of the next batch of returned results. You can use this
|
|
2914
2913
|
* token in a subsequent operation to get the next batch of results.</p>
|
|
2914
|
+
* @public
|
|
2915
2915
|
*/
|
|
2916
2916
|
NextToken?: string;
|
|
2917
2917
|
/**
|
|
2918
|
-
* @public
|
|
2919
2918
|
* <p>The array of metric stream information.</p>
|
|
2919
|
+
* @public
|
|
2920
2920
|
*/
|
|
2921
2921
|
Entries?: MetricStreamEntry[];
|
|
2922
2922
|
}
|
|
@@ -2925,7 +2925,6 @@ export interface ListMetricStreamsOutput {
|
|
|
2925
2925
|
*/
|
|
2926
2926
|
export interface ListTagsForResourceInput {
|
|
2927
2927
|
/**
|
|
2928
|
-
* @public
|
|
2929
2928
|
* <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
|
|
2930
2929
|
* <p>The ARN format of an alarm is
|
|
2931
2930
|
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
@@ -2938,23 +2937,24 @@ export interface ListTagsForResourceInput {
|
|
|
2938
2937
|
* <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
|
|
2939
2938
|
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
2940
2939
|
* Reference</i>.</p>
|
|
2940
|
+
* @public
|
|
2941
2941
|
*/
|
|
2942
2942
|
ResourceARN: string | undefined;
|
|
2943
2943
|
}
|
|
2944
2944
|
/**
|
|
2945
|
-
* @public
|
|
2946
2945
|
* <p>A key-value pair associated with a CloudWatch resource.</p>
|
|
2946
|
+
* @public
|
|
2947
2947
|
*/
|
|
2948
2948
|
export interface Tag {
|
|
2949
2949
|
/**
|
|
2950
|
-
* @public
|
|
2951
2950
|
* <p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your
|
|
2952
2951
|
* resources.</p>
|
|
2952
|
+
* @public
|
|
2953
2953
|
*/
|
|
2954
2954
|
Key: string | undefined;
|
|
2955
2955
|
/**
|
|
2956
|
-
* @public
|
|
2957
2956
|
* <p>The value for the specified tag key.</p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
Value: string | undefined;
|
|
2960
2960
|
}
|
|
@@ -2963,8 +2963,8 @@ export interface Tag {
|
|
|
2963
2963
|
*/
|
|
2964
2964
|
export interface ListTagsForResourceOutput {
|
|
2965
2965
|
/**
|
|
2966
|
-
* @public
|
|
2967
2966
|
* <p>The list of tag keys and values associated with the resource you specified.</p>
|
|
2967
|
+
* @public
|
|
2968
2968
|
*/
|
|
2969
2969
|
Tags?: Tag[];
|
|
2970
2970
|
}
|
|
@@ -2973,45 +2973,44 @@ export interface ListTagsForResourceOutput {
|
|
|
2973
2973
|
*/
|
|
2974
2974
|
export interface PutAnomalyDetectorInput {
|
|
2975
2975
|
/**
|
|
2976
|
-
* @public
|
|
2977
2976
|
* @deprecated
|
|
2978
2977
|
*
|
|
2979
2978
|
* <p>The namespace of the metric to create the anomaly detection model for.</p>
|
|
2979
|
+
* @public
|
|
2980
2980
|
*/
|
|
2981
2981
|
Namespace?: string;
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* @deprecated
|
|
2985
2984
|
*
|
|
2986
2985
|
* <p>The name of the metric to create the anomaly detection model for.</p>
|
|
2986
|
+
* @public
|
|
2987
2987
|
*/
|
|
2988
2988
|
MetricName?: string;
|
|
2989
2989
|
/**
|
|
2990
|
-
* @public
|
|
2991
2990
|
* @deprecated
|
|
2992
2991
|
*
|
|
2993
2992
|
* <p>The metric dimensions to create the anomaly detection model for.</p>
|
|
2993
|
+
* @public
|
|
2994
2994
|
*/
|
|
2995
2995
|
Dimensions?: Dimension[];
|
|
2996
2996
|
/**
|
|
2997
|
-
* @public
|
|
2998
2997
|
* @deprecated
|
|
2999
2998
|
*
|
|
3000
2999
|
* <p>The statistic to use for the metric and the anomaly detection model.</p>
|
|
3000
|
+
* @public
|
|
3001
3001
|
*/
|
|
3002
3002
|
Stat?: string;
|
|
3003
3003
|
/**
|
|
3004
|
-
* @public
|
|
3005
3004
|
* <p>The configuration specifies details about how the
|
|
3006
3005
|
* anomaly detection model is to be trained, including
|
|
3007
3006
|
* time ranges to exclude when training and updating the model.
|
|
3008
3007
|
* You can specify as many as 10 time ranges.</p>
|
|
3009
3008
|
* <p>The configuration can also include the time zone to use for
|
|
3010
3009
|
* the metric.</p>
|
|
3010
|
+
* @public
|
|
3011
3011
|
*/
|
|
3012
3012
|
Configuration?: AnomalyDetectorConfiguration;
|
|
3013
3013
|
/**
|
|
3014
|
-
* @public
|
|
3015
3014
|
* <p>A single metric anomaly detector to be created.</p>
|
|
3016
3015
|
* <p>When using <code>SingleMetricAnomalyDetector</code>,
|
|
3017
3016
|
* you cannot include the following parameters in the same operation:</p>
|
|
@@ -3043,10 +3042,10 @@ export interface PutAnomalyDetectorInput {
|
|
|
3043
3042
|
* </ul>
|
|
3044
3043
|
* <p>Instead, specify the single metric anomaly detector attributes
|
|
3045
3044
|
* as part of the property <code>SingleMetricAnomalyDetector</code>.</p>
|
|
3045
|
+
* @public
|
|
3046
3046
|
*/
|
|
3047
3047
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
|
|
3048
3048
|
/**
|
|
3049
|
-
* @public
|
|
3050
3049
|
* <p>The metric math anomaly detector to be created.</p>
|
|
3051
3050
|
* <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following parameters in the same operation:</p>
|
|
3052
3051
|
* <ul>
|
|
@@ -3077,6 +3076,7 @@ export interface PutAnomalyDetectorInput {
|
|
|
3077
3076
|
* </ul>
|
|
3078
3077
|
* <p>Instead, specify the metric math anomaly detector attributes
|
|
3079
3078
|
* as part of the property <code>MetricMathAnomalyDetector</code>.</p>
|
|
3079
|
+
* @public
|
|
3080
3080
|
*/
|
|
3081
3081
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
|
|
3082
3082
|
}
|
|
@@ -3086,8 +3086,8 @@ export interface PutAnomalyDetectorInput {
|
|
|
3086
3086
|
export interface PutAnomalyDetectorOutput {
|
|
3087
3087
|
}
|
|
3088
3088
|
/**
|
|
3089
|
-
* @public
|
|
3090
3089
|
* <p>The quota for alarms for this customer has already been reached.</p>
|
|
3090
|
+
* @public
|
|
3091
3091
|
*/
|
|
3092
3092
|
export declare class LimitExceededFault extends __BaseException {
|
|
3093
3093
|
readonly name: "LimitExceededFault";
|
|
@@ -3102,13 +3102,12 @@ export declare class LimitExceededFault extends __BaseException {
|
|
|
3102
3102
|
*/
|
|
3103
3103
|
export interface PutCompositeAlarmInput {
|
|
3104
3104
|
/**
|
|
3105
|
-
* @public
|
|
3106
3105
|
* <p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is
|
|
3107
3106
|
* <code>TRUE</code>.</p>
|
|
3107
|
+
* @public
|
|
3108
3108
|
*/
|
|
3109
3109
|
ActionsEnabled?: boolean;
|
|
3110
3110
|
/**
|
|
3111
|
-
* @public
|
|
3112
3111
|
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
|
|
3113
3112
|
* Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
3114
3113
|
* <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
@@ -3116,20 +3115,20 @@ export interface PutCompositeAlarmInput {
|
|
|
3116
3115
|
* | <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
|
|
3117
3116
|
* </code>
|
|
3118
3117
|
* </p>
|
|
3118
|
+
* @public
|
|
3119
3119
|
*/
|
|
3120
3120
|
AlarmActions?: string[];
|
|
3121
3121
|
/**
|
|
3122
|
-
* @public
|
|
3123
3122
|
* <p>The description for the composite alarm.</p>
|
|
3123
|
+
* @public
|
|
3124
3124
|
*/
|
|
3125
3125
|
AlarmDescription?: string;
|
|
3126
3126
|
/**
|
|
3127
|
-
* @public
|
|
3128
3127
|
* <p>The name for the composite alarm. This name must be unique within the Region.</p>
|
|
3128
|
+
* @public
|
|
3129
3129
|
*/
|
|
3130
3130
|
AlarmName: string | undefined;
|
|
3131
3131
|
/**
|
|
3132
|
-
* @public
|
|
3133
3132
|
* <p>An expression that specifies which other alarms are to be evaluated to determine this
|
|
3134
3133
|
* composite alarm's state. For each alarm that you reference, you
|
|
3135
3134
|
* designate a function that
|
|
@@ -3193,36 +3192,36 @@ export interface PutCompositeAlarmInput {
|
|
|
3193
3192
|
* "children" alarms. The <code>AlarmRule</code> expression can have as many as 500 elements. Elements
|
|
3194
3193
|
* are child alarms, TRUE or FALSE statements, and
|
|
3195
3194
|
* parentheses.</p>
|
|
3195
|
+
* @public
|
|
3196
3196
|
*/
|
|
3197
3197
|
AlarmRule: string | undefined;
|
|
3198
3198
|
/**
|
|
3199
|
-
* @public
|
|
3200
3199
|
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
|
|
3201
3200
|
* Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
3202
3201
|
* <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
3203
3202
|
* </code>
|
|
3204
3203
|
* </p>
|
|
3204
|
+
* @public
|
|
3205
3205
|
*/
|
|
3206
3206
|
InsufficientDataActions?: string[];
|
|
3207
3207
|
/**
|
|
3208
|
-
* @public
|
|
3209
3208
|
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state
|
|
3210
3209
|
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
3211
3210
|
* <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
3212
3211
|
* </code>
|
|
3213
3212
|
* </p>
|
|
3213
|
+
* @public
|
|
3214
3214
|
*/
|
|
3215
3215
|
OKActions?: string[];
|
|
3216
3216
|
/**
|
|
3217
|
-
* @public
|
|
3218
3217
|
* <p>A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.</p>
|
|
3219
3218
|
* <p>Tags can help you organize and categorize your
|
|
3220
3219
|
* resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
|
|
3221
3220
|
* certain tag values.</p>
|
|
3221
|
+
* @public
|
|
3222
3222
|
*/
|
|
3223
3223
|
Tags?: Tag[];
|
|
3224
3224
|
/**
|
|
3225
|
-
* @public
|
|
3226
3225
|
* <p>
|
|
3227
3226
|
* Actions will be suppressed
|
|
3228
3227
|
* if the suppressor alarm is
|
|
@@ -3230,10 +3229,10 @@ export interface PutCompositeAlarmInput {
|
|
|
3230
3229
|
* <code>ActionsSuppressor</code> can be an AlarmName or an Amazon Resource Name (ARN)
|
|
3231
3230
|
* from an existing alarm.
|
|
3232
3231
|
* </p>
|
|
3232
|
+
* @public
|
|
3233
3233
|
*/
|
|
3234
3234
|
ActionsSuppressor?: string;
|
|
3235
3235
|
/**
|
|
3236
|
-
* @public
|
|
3237
3236
|
* <p>
|
|
3238
3237
|
* The maximum time
|
|
3239
3238
|
* in seconds
|
|
@@ -3251,10 +3250,10 @@ export interface PutCompositeAlarmInput {
|
|
|
3251
3250
|
* when <code>ActionsSuppressor</code> is specified.
|
|
3252
3251
|
* </p>
|
|
3253
3252
|
* </important>
|
|
3253
|
+
* @public
|
|
3254
3254
|
*/
|
|
3255
3255
|
ActionsSuppressorWaitPeriod?: number;
|
|
3256
3256
|
/**
|
|
3257
|
-
* @public
|
|
3258
3257
|
* <p>
|
|
3259
3258
|
* The maximum time
|
|
3260
3259
|
* in seconds
|
|
@@ -3271,6 +3270,7 @@ export interface PutCompositeAlarmInput {
|
|
|
3271
3270
|
* when <code>ActionsSuppressor</code> is specified.
|
|
3272
3271
|
* </p>
|
|
3273
3272
|
* </important>
|
|
3273
|
+
* @public
|
|
3274
3274
|
*/
|
|
3275
3275
|
ActionsSuppressorExtensionPeriod?: number;
|
|
3276
3276
|
}
|
|
@@ -3279,18 +3279,18 @@ export interface PutCompositeAlarmInput {
|
|
|
3279
3279
|
*/
|
|
3280
3280
|
export interface PutDashboardInput {
|
|
3281
3281
|
/**
|
|
3282
|
-
* @public
|
|
3283
3282
|
* <p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing
|
|
3284
3283
|
* its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are
|
|
3285
3284
|
* A-Z, a-z, 0-9, "-", and "_". This parameter is required.</p>
|
|
3285
|
+
* @public
|
|
3286
3286
|
*/
|
|
3287
3287
|
DashboardName: string | undefined;
|
|
3288
3288
|
/**
|
|
3289
|
-
* @public
|
|
3290
3289
|
* <p>The detailed information about the dashboard in JSON format, including the widgets to include and their location
|
|
3291
3290
|
* on the dashboard. This parameter is required.</p>
|
|
3292
3291
|
* <p>For more information about the syntax,
|
|
3293
3292
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
|
|
3293
|
+
* @public
|
|
3294
3294
|
*/
|
|
3295
3295
|
DashboardBody: string | undefined;
|
|
3296
3296
|
}
|
|
@@ -3299,12 +3299,12 @@ export interface PutDashboardInput {
|
|
|
3299
3299
|
*/
|
|
3300
3300
|
export interface PutDashboardOutput {
|
|
3301
3301
|
/**
|
|
3302
|
-
* @public
|
|
3303
3302
|
* <p>If the input for <code>PutDashboard</code> was correct and the dashboard was successfully created or modified, this result is empty.</p>
|
|
3304
3303
|
* <p>If this result includes only warning messages, then the input was valid enough for the dashboard to be
|
|
3305
3304
|
* created or modified, but some elements of the dashboard
|
|
3306
3305
|
* might not render.</p>
|
|
3307
3306
|
* <p>If this result includes error messages, the input was not valid and the operation failed.</p>
|
|
3307
|
+
* @public
|
|
3308
3308
|
*/
|
|
3309
3309
|
DashboardValidationMessages?: DashboardValidationMessage[];
|
|
3310
3310
|
}
|
|
@@ -3313,24 +3313,23 @@ export interface PutDashboardOutput {
|
|
|
3313
3313
|
*/
|
|
3314
3314
|
export interface PutInsightRuleInput {
|
|
3315
3315
|
/**
|
|
3316
|
-
* @public
|
|
3317
3316
|
* <p>A unique name for the rule.</p>
|
|
3317
|
+
* @public
|
|
3318
3318
|
*/
|
|
3319
3319
|
RuleName: string | undefined;
|
|
3320
3320
|
/**
|
|
3321
|
-
* @public
|
|
3322
3321
|
* <p>The state of the rule. Valid values are ENABLED and DISABLED.</p>
|
|
3322
|
+
* @public
|
|
3323
3323
|
*/
|
|
3324
3324
|
RuleState?: string;
|
|
3325
3325
|
/**
|
|
3326
|
-
* @public
|
|
3327
3326
|
* <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
|
|
3328
3327
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
|
|
3329
3328
|
* Rule Syntax</a>.</p>
|
|
3329
|
+
* @public
|
|
3330
3330
|
*/
|
|
3331
3331
|
RuleDefinition: string | undefined;
|
|
3332
3332
|
/**
|
|
3333
|
-
* @public
|
|
3334
3333
|
* <p>A list of key-value pairs to associate with the Contributor Insights rule.
|
|
3335
3334
|
* You can associate as many as 50 tags with a rule.</p>
|
|
3336
3335
|
* <p>Tags can help you organize and categorize your
|
|
@@ -3342,6 +3341,7 @@ export interface PutInsightRuleInput {
|
|
|
3342
3341
|
* <p>If you are using this operation to update an existing Contributor Insights rule, any tags
|
|
3343
3342
|
* you specify in this parameter are ignored. To change the tags of an existing rule, use
|
|
3344
3343
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
3344
|
+
* @public
|
|
3345
3345
|
*/
|
|
3346
3346
|
Tags?: Tag[];
|
|
3347
3347
|
}
|
|
@@ -3351,7 +3351,6 @@ export interface PutInsightRuleInput {
|
|
|
3351
3351
|
export interface PutInsightRuleOutput {
|
|
3352
3352
|
}
|
|
3353
3353
|
/**
|
|
3354
|
-
* @public
|
|
3355
3354
|
* <p>
|
|
3356
3355
|
* Contains the information
|
|
3357
3356
|
* that's required
|
|
@@ -3359,29 +3358,29 @@ export interface PutInsightRuleOutput {
|
|
|
3359
3358
|
* for an Amazon Web Services resource.
|
|
3360
3359
|
*
|
|
3361
3360
|
* </p>
|
|
3361
|
+
* @public
|
|
3362
3362
|
*/
|
|
3363
3363
|
export interface ManagedRule {
|
|
3364
3364
|
/**
|
|
3365
|
-
* @public
|
|
3366
3365
|
* <p>
|
|
3367
3366
|
* The template name
|
|
3368
3367
|
* for the managed Contributor Insights rule,
|
|
3369
3368
|
* as returned
|
|
3370
3369
|
* by <code>ListManagedInsightRules</code>.
|
|
3371
3370
|
* </p>
|
|
3371
|
+
* @public
|
|
3372
3372
|
*/
|
|
3373
3373
|
TemplateName: string | undefined;
|
|
3374
3374
|
/**
|
|
3375
|
-
* @public
|
|
3376
3375
|
* <p>
|
|
3377
3376
|
* The ARN
|
|
3378
3377
|
* of an Amazon Web Services resource
|
|
3379
3378
|
* that has managed Contributor Insights rules.
|
|
3380
3379
|
* </p>
|
|
3380
|
+
* @public
|
|
3381
3381
|
*/
|
|
3382
3382
|
ResourceARN: string | undefined;
|
|
3383
3383
|
/**
|
|
3384
|
-
* @public
|
|
3385
3384
|
* <p>
|
|
3386
3385
|
* A list
|
|
3387
3386
|
* of key-value pairs
|
|
@@ -3409,6 +3408,7 @@ export interface ManagedRule {
|
|
|
3409
3408
|
* of an existing rule,
|
|
3410
3409
|
* use <code>TagResource</code>.
|
|
3411
3410
|
* </p>
|
|
3411
|
+
* @public
|
|
3412
3412
|
*/
|
|
3413
3413
|
Tags?: Tag[];
|
|
3414
3414
|
}
|
|
@@ -3417,12 +3417,12 @@ export interface ManagedRule {
|
|
|
3417
3417
|
*/
|
|
3418
3418
|
export interface PutManagedInsightRulesInput {
|
|
3419
3419
|
/**
|
|
3420
|
-
* @public
|
|
3421
3420
|
* <p>
|
|
3422
3421
|
* A list
|
|
3423
3422
|
* of <code>ManagedRules</code>
|
|
3424
3423
|
* to enable.
|
|
3425
3424
|
* </p>
|
|
3425
|
+
* @public
|
|
3426
3426
|
*/
|
|
3427
3427
|
ManagedRules: ManagedRule[] | undefined;
|
|
3428
3428
|
}
|
|
@@ -3431,12 +3431,12 @@ export interface PutManagedInsightRulesInput {
|
|
|
3431
3431
|
*/
|
|
3432
3432
|
export interface PutManagedInsightRulesOutput {
|
|
3433
3433
|
/**
|
|
3434
|
-
* @public
|
|
3435
3434
|
* <p>
|
|
3436
3435
|
* An array
|
|
3437
3436
|
* that lists the rules
|
|
3438
3437
|
* that could not be enabled.
|
|
3439
3438
|
* </p>
|
|
3439
|
+
* @public
|
|
3440
3440
|
*/
|
|
3441
3441
|
Failures?: PartialFailure[];
|
|
3442
3442
|
}
|
|
@@ -3445,25 +3445,24 @@ export interface PutManagedInsightRulesOutput {
|
|
|
3445
3445
|
*/
|
|
3446
3446
|
export interface PutMetricAlarmInput {
|
|
3447
3447
|
/**
|
|
3448
|
-
* @public
|
|
3449
3448
|
* <p>The name for the alarm. This name must be unique within the Region.</p>
|
|
3450
3449
|
* <p>The name must contain only UTF-8
|
|
3451
3450
|
* characters, and can't contain ASCII control characters</p>
|
|
3451
|
+
* @public
|
|
3452
3452
|
*/
|
|
3453
3453
|
AlarmName: string | undefined;
|
|
3454
3454
|
/**
|
|
3455
|
-
* @public
|
|
3456
3455
|
* <p>The description for the alarm.</p>
|
|
3456
|
+
* @public
|
|
3457
3457
|
*/
|
|
3458
3458
|
AlarmDescription?: string;
|
|
3459
3459
|
/**
|
|
3460
|
-
* @public
|
|
3461
3460
|
* <p>Indicates whether actions should be executed during any changes to the alarm state. The default is
|
|
3462
3461
|
* <code>TRUE</code>.</p>
|
|
3462
|
+
* @public
|
|
3463
3463
|
*/
|
|
3464
3464
|
ActionsEnabled?: boolean;
|
|
3465
3465
|
/**
|
|
3466
|
-
* @public
|
|
3467
3466
|
* <p>The actions to execute when this alarm transitions to an <code>OK</code> state
|
|
3468
3467
|
* from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
|
|
3469
3468
|
* <p>
|
|
@@ -3550,10 +3549,10 @@ export interface PutMetricAlarmInput {
|
|
|
3550
3549
|
* </p>
|
|
3551
3550
|
* </li>
|
|
3552
3551
|
* </ul>
|
|
3552
|
+
* @public
|
|
3553
3553
|
*/
|
|
3554
3554
|
OKActions?: string[];
|
|
3555
3555
|
/**
|
|
3556
|
-
* @public
|
|
3557
3556
|
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
|
|
3558
3557
|
* Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
|
|
3559
3558
|
* <p>
|
|
@@ -3640,10 +3639,10 @@ export interface PutMetricAlarmInput {
|
|
|
3640
3639
|
* </p>
|
|
3641
3640
|
* </li>
|
|
3642
3641
|
* </ul>
|
|
3642
|
+
* @public
|
|
3643
3643
|
*/
|
|
3644
3644
|
AlarmActions?: string[];
|
|
3645
3645
|
/**
|
|
3646
|
-
* @public
|
|
3647
3646
|
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
|
|
3648
3647
|
* Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
|
|
3649
3648
|
* <p>
|
|
@@ -3730,33 +3729,33 @@ export interface PutMetricAlarmInput {
|
|
|
3730
3729
|
* </p>
|
|
3731
3730
|
* </li>
|
|
3732
3731
|
* </ul>
|
|
3732
|
+
* @public
|
|
3733
3733
|
*/
|
|
3734
3734
|
InsufficientDataActions?: string[];
|
|
3735
3735
|
/**
|
|
3736
|
-
* @public
|
|
3737
3736
|
* <p>The name for the metric associated with the alarm. For each <code>PutMetricAlarm</code>
|
|
3738
3737
|
* operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
|
|
3739
3738
|
* <p>If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
|
|
3740
3739
|
* <code>Namespace</code>, <code>Dimensions</code>, <code>Period</code>,
|
|
3741
3740
|
* <code>Unit</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters. Instead, you specify
|
|
3742
3741
|
* all this information in the <code>Metrics</code> array.</p>
|
|
3742
|
+
* @public
|
|
3743
3743
|
*/
|
|
3744
3744
|
MetricName?: string;
|
|
3745
3745
|
/**
|
|
3746
|
-
* @public
|
|
3747
3746
|
* <p>The namespace for the metric associated specified in <code>MetricName</code>.</p>
|
|
3747
|
+
* @public
|
|
3748
3748
|
*/
|
|
3749
3749
|
Namespace?: string;
|
|
3750
3750
|
/**
|
|
3751
|
-
* @public
|
|
3752
3751
|
* <p>The statistic for the metric specified in <code>MetricName</code>, other than percentile.
|
|
3753
3752
|
* For percentile statistics, use <code>ExtendedStatistic</code>. When you call <code>PutMetricAlarm</code> and specify
|
|
3754
3753
|
* a <code>MetricName</code>, you must
|
|
3755
3754
|
* specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
|
|
3755
|
+
* @public
|
|
3756
3756
|
*/
|
|
3757
3757
|
Statistic?: Statistic;
|
|
3758
3758
|
/**
|
|
3759
|
-
* @public
|
|
3760
3759
|
* <p>The extended statistic for the metric specified in <code>MetricName</code>. When you
|
|
3761
3760
|
* call <code>PutMetricAlarm</code> and specify
|
|
3762
3761
|
* a <code>MetricName</code>, you must
|
|
@@ -3821,15 +3820,15 @@ export interface PutMetricAlarmInput {
|
|
|
3821
3820
|
* </ul>
|
|
3822
3821
|
* <p>For more information about these extended statistics, see
|
|
3823
3822
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
|
|
3823
|
+
* @public
|
|
3824
3824
|
*/
|
|
3825
3825
|
ExtendedStatistic?: string;
|
|
3826
3826
|
/**
|
|
3827
|
-
* @public
|
|
3828
3827
|
* <p>The dimensions for the metric specified in <code>MetricName</code>.</p>
|
|
3828
|
+
* @public
|
|
3829
3829
|
*/
|
|
3830
3830
|
Dimensions?: Dimension[];
|
|
3831
3831
|
/**
|
|
3832
|
-
* @public
|
|
3833
3832
|
* <p>The length, in seconds, used each time the metric specified in <code>MetricName</code> is
|
|
3834
3833
|
* evaluated. Valid values are 10, 30, and any multiple of 60.</p>
|
|
3835
3834
|
* <p>
|
|
@@ -3844,10 +3843,10 @@ export interface PutMetricAlarmInput {
|
|
|
3844
3843
|
* which has a higher charge than other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
|
|
3845
3844
|
* <p>An alarm's total current evaluation period can
|
|
3846
3845
|
* be no longer than one day, so <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than 86,400 seconds.</p>
|
|
3846
|
+
* @public
|
|
3847
3847
|
*/
|
|
3848
3848
|
Period?: number;
|
|
3849
3849
|
/**
|
|
3850
|
-
* @public
|
|
3851
3850
|
* <p>The unit of measure for the statistic. For example, the units for the Amazon EC2
|
|
3852
3851
|
* NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
|
|
3853
3852
|
* receives on all network interfaces. You can also specify a unit when you create a custom
|
|
@@ -3866,44 +3865,44 @@ export interface PutMetricAlarmInput {
|
|
|
3866
3865
|
* <p>We recommend omitting <code>Unit</code> so that you don't inadvertently
|
|
3867
3866
|
* specify an incorrect unit that is not published for this metric. Doing so
|
|
3868
3867
|
* causes the alarm to be stuck in the <code>INSUFFICIENT DATA</code> state.</p>
|
|
3868
|
+
* @public
|
|
3869
3869
|
*/
|
|
3870
3870
|
Unit?: StandardUnit;
|
|
3871
3871
|
/**
|
|
3872
|
-
* @public
|
|
3873
3872
|
* <p>The number of periods over which data is compared to the specified threshold. If you are
|
|
3874
3873
|
* setting an alarm that requires that a number of consecutive data points be breaching to
|
|
3875
3874
|
* trigger the alarm, this value specifies that number. If you are setting an "M out of N"
|
|
3876
3875
|
* alarm, this value is the N.</p>
|
|
3877
3876
|
* <p>An alarm's total current evaluation period can
|
|
3878
3877
|
* be no longer than one day, so this number multiplied by <code>Period</code> cannot be more than 86,400 seconds.</p>
|
|
3878
|
+
* @public
|
|
3879
3879
|
*/
|
|
3880
3880
|
EvaluationPeriods: number | undefined;
|
|
3881
3881
|
/**
|
|
3882
|
-
* @public
|
|
3883
3882
|
* <p>The number of data points that must be breaching to trigger the alarm. This is used only if you are setting
|
|
3884
3883
|
* an "M out of N" alarm. In that case, this value is the M. For more information, see
|
|
3885
3884
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation">Evaluating an Alarm</a> in the
|
|
3886
3885
|
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
3886
|
+
* @public
|
|
3887
3887
|
*/
|
|
3888
3888
|
DatapointsToAlarm?: number;
|
|
3889
3889
|
/**
|
|
3890
|
-
* @public
|
|
3891
3890
|
* <p>The value against which the specified statistic is compared.</p>
|
|
3892
3891
|
* <p>This parameter is required for alarms based on static thresholds, but should
|
|
3893
3892
|
* not be used for alarms based on anomaly detection models.</p>
|
|
3893
|
+
* @public
|
|
3894
3894
|
*/
|
|
3895
3895
|
Threshold?: number;
|
|
3896
3896
|
/**
|
|
3897
|
-
* @public
|
|
3898
3897
|
* <p> The arithmetic operation to use when comparing the specified statistic and
|
|
3899
3898
|
* threshold. The specified statistic value is used as the first operand.</p>
|
|
3900
3899
|
* <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
|
|
3901
3900
|
* <code>LessThanLowerThreshold</code>, and <code>GreaterThanUpperThreshold</code>
|
|
3902
3901
|
* are used only for alarms based on anomaly detection models.</p>
|
|
3902
|
+
* @public
|
|
3903
3903
|
*/
|
|
3904
3904
|
ComparisonOperator: ComparisonOperator | undefined;
|
|
3905
3905
|
/**
|
|
3906
|
-
* @public
|
|
3907
3906
|
* <p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used.
|
|
3908
3907
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring How CloudWatch
|
|
3909
3908
|
* Alarms Treats Missing Data</a>.</p>
|
|
@@ -3914,19 +3913,19 @@ export interface PutMetricAlarmInput {
|
|
|
3914
3913
|
* missing data even if you choose a different option for <code>TreatMissingData</code>. When an
|
|
3915
3914
|
* <code>AWS/DynamoDB</code> metric has missing data, alarms that evaluate that metric remain in their current state.</p>
|
|
3916
3915
|
* </note>
|
|
3916
|
+
* @public
|
|
3917
3917
|
*/
|
|
3918
3918
|
TreatMissingData?: string;
|
|
3919
3919
|
/**
|
|
3920
|
-
* @public
|
|
3921
3920
|
* <p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be
|
|
3922
3921
|
* statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state
|
|
3923
3922
|
* no matter how many data points are 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>
|
|
3924
3923
|
* <p>Valid Values: <code>evaluate | ignore</code>
|
|
3925
3924
|
* </p>
|
|
3925
|
+
* @public
|
|
3926
3926
|
*/
|
|
3927
3927
|
EvaluateLowSampleCountPercentile?: string;
|
|
3928
3928
|
/**
|
|
3929
|
-
* @public
|
|
3930
3929
|
* <p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a
|
|
3931
3930
|
* metric math expression. For each <code>PutMetricAlarm</code>
|
|
3932
3931
|
* operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
|
|
@@ -3938,10 +3937,10 @@ export interface PutMetricAlarmInput {
|
|
|
3938
3937
|
* <code>Unit</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation.
|
|
3939
3938
|
* Instead, you retrieve
|
|
3940
3939
|
* the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>
|
|
3940
|
+
* @public
|
|
3941
3941
|
*/
|
|
3942
3942
|
Metrics?: MetricDataQuery[];
|
|
3943
3943
|
/**
|
|
3944
|
-
* @public
|
|
3945
3944
|
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
|
|
3946
3945
|
* To be able to associate tags with the alarm when you create the alarm, you must
|
|
3947
3946
|
* have the <code>cloudwatch:TagResource</code> permission.</p>
|
|
@@ -3952,10 +3951,10 @@ export interface PutMetricAlarmInput {
|
|
|
3952
3951
|
* you specify in this parameter are ignored. To change the tags of an existing alarm, use
|
|
3953
3952
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>
|
|
3954
3953
|
* or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
3954
|
+
* @public
|
|
3955
3955
|
*/
|
|
3956
3956
|
Tags?: Tag[];
|
|
3957
3957
|
/**
|
|
3958
|
-
* @public
|
|
3959
3958
|
* <p>If this is an alarm based on an anomaly detection model, make this value match
|
|
3960
3959
|
* the ID of
|
|
3961
3960
|
* the <code>ANOMALY_DETECTION_BAND</code> function.</p>
|
|
@@ -3963,71 +3962,71 @@ export interface PutMetricAlarmInput {
|
|
|
3963
3962
|
* <b>Anomaly Detection
|
|
3964
3963
|
* Model Alarm</b> example on this page.</p>
|
|
3965
3964
|
* <p>If your alarm uses this parameter, it cannot have Auto Scaling actions.</p>
|
|
3965
|
+
* @public
|
|
3966
3966
|
*/
|
|
3967
3967
|
ThresholdMetricId?: string;
|
|
3968
3968
|
}
|
|
3969
3969
|
/**
|
|
3970
|
-
* @public
|
|
3971
3970
|
* <p>Represents a set of statistics that describes a specific metric. </p>
|
|
3971
|
+
* @public
|
|
3972
3972
|
*/
|
|
3973
3973
|
export interface StatisticSet {
|
|
3974
3974
|
/**
|
|
3975
|
-
* @public
|
|
3976
3975
|
* <p>The number of samples used for the statistic set.</p>
|
|
3976
|
+
* @public
|
|
3977
3977
|
*/
|
|
3978
3978
|
SampleCount: number | undefined;
|
|
3979
3979
|
/**
|
|
3980
|
-
* @public
|
|
3981
3980
|
* <p>The sum of values for the sample set.</p>
|
|
3981
|
+
* @public
|
|
3982
3982
|
*/
|
|
3983
3983
|
Sum: number | undefined;
|
|
3984
3984
|
/**
|
|
3985
|
-
* @public
|
|
3986
3985
|
* <p>The minimum value of the sample set.</p>
|
|
3986
|
+
* @public
|
|
3987
3987
|
*/
|
|
3988
3988
|
Minimum: number | undefined;
|
|
3989
3989
|
/**
|
|
3990
|
-
* @public
|
|
3991
3990
|
* <p>The maximum value of the sample set.</p>
|
|
3991
|
+
* @public
|
|
3992
3992
|
*/
|
|
3993
3993
|
Maximum: number | undefined;
|
|
3994
3994
|
}
|
|
3995
3995
|
/**
|
|
3996
|
-
* @public
|
|
3997
3996
|
* <p>Encapsulates the information sent to either create a metric or add new values
|
|
3998
3997
|
* to be aggregated into an existing metric.</p>
|
|
3998
|
+
* @public
|
|
3999
3999
|
*/
|
|
4000
4000
|
export interface MetricDatum {
|
|
4001
4001
|
/**
|
|
4002
|
-
* @public
|
|
4003
4002
|
* <p>The name of the metric.</p>
|
|
4003
|
+
* @public
|
|
4004
4004
|
*/
|
|
4005
4005
|
MetricName: string | undefined;
|
|
4006
4006
|
/**
|
|
4007
|
-
* @public
|
|
4008
4007
|
* <p>The dimensions associated with the metric. </p>
|
|
4008
|
+
* @public
|
|
4009
4009
|
*/
|
|
4010
4010
|
Dimensions?: Dimension[];
|
|
4011
4011
|
/**
|
|
4012
|
-
* @public
|
|
4013
4012
|
* <p>The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
|
|
4013
|
+
* @public
|
|
4014
4014
|
*/
|
|
4015
4015
|
Timestamp?: Date;
|
|
4016
4016
|
/**
|
|
4017
|
-
* @public
|
|
4018
4017
|
* <p>The value for the metric.</p>
|
|
4019
4018
|
* <p>Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or
|
|
4020
4019
|
* too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)
|
|
4021
4020
|
* are not supported.</p>
|
|
4021
|
+
* @public
|
|
4022
4022
|
*/
|
|
4023
4023
|
Value?: number;
|
|
4024
4024
|
/**
|
|
4025
|
-
* @public
|
|
4026
4025
|
* <p>The statistical values for the metric.</p>
|
|
4026
|
+
* @public
|
|
4027
4027
|
*/
|
|
4028
4028
|
StatisticValues?: StatisticSet;
|
|
4029
4029
|
/**
|
|
4030
|
-
* @public
|
|
4031
4030
|
* <p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once
|
|
4032
4031
|
* in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period.
|
|
4033
4032
|
* You can include up to 150 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p>
|
|
@@ -4035,25 +4034,25 @@ export interface MetricDatum {
|
|
|
4035
4034
|
* <code>Double</code>, CloudWatch rejects values that are either too small
|
|
4036
4035
|
* or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
|
|
4037
4036
|
* -Infinity) are not supported.</p>
|
|
4037
|
+
* @public
|
|
4038
4038
|
*/
|
|
4039
4039
|
Values?: number[];
|
|
4040
4040
|
/**
|
|
4041
|
-
* @public
|
|
4042
4041
|
* <p>Array of numbers that is used along with the <code>Values</code> array. Each number in the <code>Count</code> array
|
|
4043
4042
|
* is the number of times the corresponding value in the <code>Values</code> array occurred during the period. </p>
|
|
4044
4043
|
* <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for each count. If you
|
|
4045
4044
|
* include a <code>Counts</code> array, it must include the same amount of values as the <code>Values</code> array.</p>
|
|
4045
|
+
* @public
|
|
4046
4046
|
*/
|
|
4047
4047
|
Counts?: number[];
|
|
4048
4048
|
/**
|
|
4049
|
-
* @public
|
|
4050
4049
|
* <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
|
|
4051
4050
|
* <p>In
|
|
4052
4051
|
* a <code>Get</code> operation, this displays the unit that is used for the metric.</p>
|
|
4052
|
+
* @public
|
|
4053
4053
|
*/
|
|
4054
4054
|
Unit?: StandardUnit;
|
|
4055
4055
|
/**
|
|
4056
|
-
* @public
|
|
4057
4056
|
* <p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with
|
|
4058
4057
|
* sub-minute resolution down to one second.
|
|
4059
4058
|
* Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available
|
|
@@ -4062,6 +4061,7 @@ export interface MetricDatum {
|
|
|
4062
4061
|
* <i>Amazon CloudWatch User Guide</i>.
|
|
4063
4062
|
* </p>
|
|
4064
4063
|
* <p>This field is optional, if you do not specify it the default of 60 is used.</p>
|
|
4064
|
+
* @public
|
|
4065
4065
|
*/
|
|
4066
4066
|
StorageResolution?: number;
|
|
4067
4067
|
}
|
|
@@ -4070,17 +4070,17 @@ export interface MetricDatum {
|
|
|
4070
4070
|
*/
|
|
4071
4071
|
export interface PutMetricDataInput {
|
|
4072
4072
|
/**
|
|
4073
|
-
* @public
|
|
4074
4073
|
* <p>The namespace for the metric data. You can use ASCII characters for the namespace, except for
|
|
4075
4074
|
* control characters which are not supported.</p>
|
|
4076
4075
|
* <p>To avoid conflicts
|
|
4077
4076
|
* with Amazon Web Services service namespaces, you should not specify a namespace that begins with <code>AWS/</code>
|
|
4078
4077
|
* </p>
|
|
4078
|
+
* @public
|
|
4079
4079
|
*/
|
|
4080
4080
|
Namespace: string | undefined;
|
|
4081
4081
|
/**
|
|
4082
|
-
* @public
|
|
4083
4082
|
* <p>The data for the metric. The array can include no more than 1000 metrics per call.</p>
|
|
4083
|
+
* @public
|
|
4084
4084
|
*/
|
|
4085
4085
|
MetricData: MetricDatum[] | undefined;
|
|
4086
4086
|
}
|
|
@@ -4089,38 +4089,37 @@ export interface PutMetricDataInput {
|
|
|
4089
4089
|
*/
|
|
4090
4090
|
export interface PutMetricStreamInput {
|
|
4091
4091
|
/**
|
|
4092
|
-
* @public
|
|
4093
4092
|
* <p>If you are creating a new metric stream, this is the name for the new stream. The name
|
|
4094
4093
|
* must be different than the names of other metric streams in this account and Region.</p>
|
|
4095
4094
|
* <p>If you are updating a metric stream, specify the name of that stream here.</p>
|
|
4096
4095
|
* <p>Valid characters are A-Z, a-z, 0-9, "-" and "_".</p>
|
|
4096
|
+
* @public
|
|
4097
4097
|
*/
|
|
4098
4098
|
Name: string | undefined;
|
|
4099
4099
|
/**
|
|
4100
|
-
* @public
|
|
4101
4100
|
* <p>If you specify this parameter, the stream sends only the
|
|
4102
4101
|
* metrics from the metric namespaces that you specify here.</p>
|
|
4103
4102
|
* <p>You cannot include <code>IncludeFilters</code> and <code>ExcludeFilters</code>
|
|
4104
4103
|
* in the same operation.</p>
|
|
4104
|
+
* @public
|
|
4105
4105
|
*/
|
|
4106
4106
|
IncludeFilters?: MetricStreamFilter[];
|
|
4107
4107
|
/**
|
|
4108
|
-
* @public
|
|
4109
4108
|
* <p>If you specify this parameter, the stream sends metrics from all
|
|
4110
4109
|
* metric namespaces except for the namespaces that you specify here.</p>
|
|
4111
4110
|
* <p>You cannot include <code>ExcludeFilters</code> and <code>IncludeFilters</code> in
|
|
4112
4111
|
* the same operation.</p>
|
|
4112
|
+
* @public
|
|
4113
4113
|
*/
|
|
4114
4114
|
ExcludeFilters?: MetricStreamFilter[];
|
|
4115
4115
|
/**
|
|
4116
|
-
* @public
|
|
4117
4116
|
* <p>The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.
|
|
4118
4117
|
* This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the
|
|
4119
4118
|
* same account as the metric stream.</p>
|
|
4119
|
+
* @public
|
|
4120
4120
|
*/
|
|
4121
4121
|
FirehoseArn: string | undefined;
|
|
4122
4122
|
/**
|
|
4123
|
-
* @public
|
|
4124
4123
|
* <p>The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data
|
|
4125
4124
|
* Firehose resources. This IAM role must already exist and must be in the same account as
|
|
4126
4125
|
* the metric stream. This IAM role must include the following permissions:</p>
|
|
@@ -4132,19 +4131,19 @@ export interface PutMetricStreamInput {
|
|
|
4132
4131
|
* <p>firehose:PutRecordBatch</p>
|
|
4133
4132
|
* </li>
|
|
4134
4133
|
* </ul>
|
|
4134
|
+
* @public
|
|
4135
4135
|
*/
|
|
4136
4136
|
RoleArn: string | undefined;
|
|
4137
4137
|
/**
|
|
4138
|
-
* @public
|
|
4139
4138
|
* <p>The output format for the stream. Valid values are <code>json</code>, <code>opentelemetry1.0</code>,
|
|
4140
4139
|
* and <code>opentelemetry0.7</code>. For more information about metric stream
|
|
4141
4140
|
* output formats, see
|
|
4142
4141
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">
|
|
4143
4142
|
* Metric streams output formats</a>.</p>
|
|
4143
|
+
* @public
|
|
4144
4144
|
*/
|
|
4145
4145
|
OutputFormat: MetricStreamOutputFormat | undefined;
|
|
4146
4146
|
/**
|
|
4147
|
-
* @public
|
|
4148
4147
|
* <p>A list of key-value pairs to associate with the metric stream. You can associate as
|
|
4149
4148
|
* many as 50 tags with a metric stream.</p>
|
|
4150
4149
|
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
|
|
@@ -4154,10 +4153,10 @@ export interface PutMetricStreamInput {
|
|
|
4154
4153
|
* you specify in this parameter are ignored. To change the tags of an existing metric stream, use
|
|
4155
4154
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>
|
|
4156
4155
|
* or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4156
|
+
* @public
|
|
4157
4157
|
*/
|
|
4158
4158
|
Tags?: Tag[];
|
|
4159
4159
|
/**
|
|
4160
|
-
* @public
|
|
4161
4160
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
|
|
4162
4161
|
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use this parameter to have
|
|
4163
4162
|
* the metric stream also send additional statistics in the stream. This
|
|
@@ -4170,12 +4169,13 @@ export interface PutMetricStreamInput {
|
|
|
4170
4169
|
* CloudWatch statistics definitions</a>. If the <code>OutputFormat</code>
|
|
4171
4170
|
* is <code>opentelemetry1.0</code> or <code>opentelemetry0.7</code>, you can stream percentile statistics such as p95,
|
|
4172
4171
|
* p99.9, and so on.</p>
|
|
4172
|
+
* @public
|
|
4173
4173
|
*/
|
|
4174
4174
|
StatisticsConfigurations?: MetricStreamStatisticsConfiguration[];
|
|
4175
4175
|
/**
|
|
4176
|
-
* @public
|
|
4177
4176
|
* <p>If you are creating a metric stream in a monitoring account,
|
|
4178
4177
|
* specify <code>true</code> to include metrics from source accounts in the metric stream.</p>
|
|
4178
|
+
* @public
|
|
4179
4179
|
*/
|
|
4180
4180
|
IncludeLinkedAccountsMetrics?: boolean;
|
|
4181
4181
|
}
|
|
@@ -4184,14 +4184,14 @@ export interface PutMetricStreamInput {
|
|
|
4184
4184
|
*/
|
|
4185
4185
|
export interface PutMetricStreamOutput {
|
|
4186
4186
|
/**
|
|
4187
|
-
* @public
|
|
4188
4187
|
* <p>The ARN of the metric stream.</p>
|
|
4188
|
+
* @public
|
|
4189
4189
|
*/
|
|
4190
4190
|
Arn?: string;
|
|
4191
4191
|
}
|
|
4192
4192
|
/**
|
|
4193
|
-
* @public
|
|
4194
4193
|
* <p>Data was not syntactically valid JSON.</p>
|
|
4194
|
+
* @public
|
|
4195
4195
|
*/
|
|
4196
4196
|
export declare class InvalidFormatFault extends __BaseException {
|
|
4197
4197
|
readonly name: "InvalidFormatFault";
|
|
@@ -4206,25 +4206,25 @@ export declare class InvalidFormatFault extends __BaseException {
|
|
|
4206
4206
|
*/
|
|
4207
4207
|
export interface SetAlarmStateInput {
|
|
4208
4208
|
/**
|
|
4209
|
-
* @public
|
|
4210
4209
|
* <p>The name of the alarm.</p>
|
|
4210
|
+
* @public
|
|
4211
4211
|
*/
|
|
4212
4212
|
AlarmName: string | undefined;
|
|
4213
4213
|
/**
|
|
4214
|
-
* @public
|
|
4215
4214
|
* <p>The value of the state.</p>
|
|
4215
|
+
* @public
|
|
4216
4216
|
*/
|
|
4217
4217
|
StateValue: StateValue | undefined;
|
|
4218
4218
|
/**
|
|
4219
|
-
* @public
|
|
4220
4219
|
* <p>The reason that this alarm is set to this specific state, in text format.</p>
|
|
4220
|
+
* @public
|
|
4221
4221
|
*/
|
|
4222
4222
|
StateReason: string | undefined;
|
|
4223
4223
|
/**
|
|
4224
|
-
* @public
|
|
4225
4224
|
* <p>The reason that this alarm is set to this specific state, in JSON format.</p>
|
|
4226
4225
|
* <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling
|
|
4227
4226
|
* alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.</p>
|
|
4227
|
+
* @public
|
|
4228
4228
|
*/
|
|
4229
4229
|
StateReasonData?: string;
|
|
4230
4230
|
}
|
|
@@ -4233,11 +4233,11 @@ export interface SetAlarmStateInput {
|
|
|
4233
4233
|
*/
|
|
4234
4234
|
export interface StartMetricStreamsInput {
|
|
4235
4235
|
/**
|
|
4236
|
-
* @public
|
|
4237
4236
|
* <p>The array of the names of metric streams to start streaming.</p>
|
|
4238
4237
|
* <p>This is an "all or nothing" operation. If you do not have
|
|
4239
4238
|
* permission to access all of the metric streams that you list here, then none of the streams that you list
|
|
4240
4239
|
* in the operation will start streaming.</p>
|
|
4240
|
+
* @public
|
|
4241
4241
|
*/
|
|
4242
4242
|
Names: string[] | undefined;
|
|
4243
4243
|
}
|
|
@@ -4251,11 +4251,11 @@ export interface StartMetricStreamsOutput {
|
|
|
4251
4251
|
*/
|
|
4252
4252
|
export interface StopMetricStreamsInput {
|
|
4253
4253
|
/**
|
|
4254
|
-
* @public
|
|
4255
4254
|
* <p>The array of the names of metric streams to stop streaming.</p>
|
|
4256
4255
|
* <p>This is an "all or nothing" operation. If you do not have
|
|
4257
4256
|
* permission to access all of the metric streams that you list here, then none of the streams that you list
|
|
4258
4257
|
* in the operation will stop streaming.</p>
|
|
4258
|
+
* @public
|
|
4259
4259
|
*/
|
|
4260
4260
|
Names: string[] | undefined;
|
|
4261
4261
|
}
|
|
@@ -4269,7 +4269,6 @@ export interface StopMetricStreamsOutput {
|
|
|
4269
4269
|
*/
|
|
4270
4270
|
export interface TagResourceInput {
|
|
4271
4271
|
/**
|
|
4272
|
-
* @public
|
|
4273
4272
|
* <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
|
|
4274
4273
|
* <p>The ARN format of an alarm is
|
|
4275
4274
|
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
@@ -4282,11 +4281,12 @@ export interface TagResourceInput {
|
|
|
4282
4281
|
* <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
|
|
4283
4282
|
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
4284
4283
|
* Reference</i>.</p>
|
|
4284
|
+
* @public
|
|
4285
4285
|
*/
|
|
4286
4286
|
ResourceARN: string | undefined;
|
|
4287
4287
|
/**
|
|
4288
|
-
* @public
|
|
4289
4288
|
* <p>The list of key-value pairs to associate with the alarm.</p>
|
|
4289
|
+
* @public
|
|
4290
4290
|
*/
|
|
4291
4291
|
Tags: Tag[] | undefined;
|
|
4292
4292
|
}
|
|
@@ -4300,7 +4300,6 @@ export interface TagResourceOutput {
|
|
|
4300
4300
|
*/
|
|
4301
4301
|
export interface UntagResourceInput {
|
|
4302
4302
|
/**
|
|
4303
|
-
* @public
|
|
4304
4303
|
* <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
|
|
4305
4304
|
* <p>The ARN format of an alarm is
|
|
4306
4305
|
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
@@ -4313,11 +4312,12 @@ export interface UntagResourceInput {
|
|
|
4313
4312
|
* <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
|
|
4314
4313
|
* Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
|
|
4315
4314
|
* Reference</i>.</p>
|
|
4315
|
+
* @public
|
|
4316
4316
|
*/
|
|
4317
4317
|
ResourceARN: string | undefined;
|
|
4318
4318
|
/**
|
|
4319
|
-
* @public
|
|
4320
4319
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
4320
|
+
* @public
|
|
4321
4321
|
*/
|
|
4322
4322
|
TagKeys: string[] | undefined;
|
|
4323
4323
|
}
|