@aws-sdk/client-cloudwatch 3.1075.0 → 3.1077.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -13
- package/dist-cjs/index.js +2210 -24
- package/dist-es/CloudWatch.js +4 -0
- package/dist-es/commands/PutLogAlarmCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +1 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/runtimeConfig.browser.js +0 -2
- package/dist-es/runtimeConfig.js +1 -2
- package/dist-es/runtimeConfig.native.js +0 -2
- package/dist-es/runtimeConfig.shared.js +2 -0
- package/dist-es/schemas/schemas_0.js +77 -7
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForLogAlarmExists.js +32 -0
- package/dist-types/CloudWatch.d.ts +64 -13
- package/dist-types/CloudWatchClient.d.ts +54 -15
- package/dist-types/commands/DeleteAlarmMuteRuleCommand.d.ts +7 -3
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +8 -5
- package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAlarmContributorsCommand.d.ts +3 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +54 -3
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +6 -0
- package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +1 -1
- package/dist-types/commands/GetAlarmMuteRuleCommand.d.ts +11 -5
- package/dist-types/commands/GetMetricDataCommand.d.ts +3 -3
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +1 -1
- package/dist-types/commands/GetOTelEnrichmentCommand.d.ts +2 -3
- package/dist-types/commands/ListAlarmMuteRulesCommand.d.ts +7 -3
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/PutAlarmMuteRuleCommand.d.ts +24 -6
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +1 -1
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +6 -6
- package/dist-types/commands/PutLogAlarmCommand.d.ts +131 -0
- package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +4 -4
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +16 -10
- package/dist-types/commands/PutMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/PutMetricStreamCommand.d.ts +6 -6
- package/dist-types/commands/StartOTelEnrichmentCommand.d.ts +7 -8
- package/dist-types/commands/StopOTelEnrichmentCommand.d.ts +3 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +51 -13
- package/dist-types/models/enums.d.ts +1 -0
- package/dist-types/models/errors.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +849 -294
- 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 +1 -0
- package/dist-types/schemas/schemas_0.d.ts +9 -0
- package/dist-types/ts3.4/CloudWatch.d.ts +26 -0
- package/dist-types/ts3.4/CloudWatchClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/PutLogAlarmCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +1 -0
- package/dist-types/ts3.4/models/errors.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +92 -4
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +9 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForLogAlarmExists.d.ts +17 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForLogAlarmExists.d.ts +15 -0
- package/package.json +10 -12
- package/dist-cjs/auth/httpAuthSchemeProvider.js +0 -40
- package/dist-cjs/endpoint/bdd.js +0 -49
- package/dist-cjs/endpoint/endpointResolver.js +0 -14
- package/dist-cjs/models/CloudWatchServiceException.js +0 -8
- package/dist-cjs/models/errors.js +0 -227
- package/dist-cjs/runtimeConfig.browser.js +0 -35
- package/dist-cjs/runtimeConfig.js +0 -48
- package/dist-cjs/runtimeConfig.native.js +0 -12
- package/dist-cjs/runtimeConfig.shared.js +0 -40
- package/dist-cjs/schemas/schemas_0.js +0 -1600
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { ActionsSuppressedBy, AlarmMuteRuleStatus, AlarmType, AnomalyDetectorStateValue, AnomalyDetectorType, ComparisonOperator, EvaluationState, HistoryItemType, MetricStreamOutputFormat, OTelEnrichmentStatus, RecentlyActive, ScanBy, StandardUnit, StateValue, Statistic, StatusCode } from "./enums";
|
|
2
2
|
/**
|
|
3
|
-
* <p>Represents an individual contributor to a multi-timeseries alarm, containing
|
|
3
|
+
* <p>Represents an individual contributor to a multi-timeseries alarm, containing
|
|
4
|
+
* information about a specific time series and its contribution to the alarm's
|
|
5
|
+
* state.</p>
|
|
4
6
|
* @public
|
|
5
7
|
*/
|
|
6
8
|
export interface AlarmContributor {
|
|
@@ -10,12 +12,14 @@ export interface AlarmContributor {
|
|
|
10
12
|
*/
|
|
11
13
|
ContributorId: string | undefined;
|
|
12
14
|
/**
|
|
13
|
-
* <p>A map of attributes that describe the contributor, such as metric dimensions and other
|
|
15
|
+
* <p>A map of attributes that describe the contributor, such as metric dimensions and other
|
|
16
|
+
* identifying characteristics.</p>
|
|
14
17
|
* @public
|
|
15
18
|
*/
|
|
16
19
|
ContributorAttributes: Record<string, string> | undefined;
|
|
17
20
|
/**
|
|
18
|
-
* <p>An explanation for the contributor's current state, providing context about why it is
|
|
21
|
+
* <p>An explanation for the contributor's current state, providing context about why it is
|
|
22
|
+
* in its current condition.</p>
|
|
19
23
|
* @public
|
|
20
24
|
*/
|
|
21
25
|
StateReason: string | undefined;
|
|
@@ -36,7 +40,8 @@ export interface AlarmHistoryItem {
|
|
|
36
40
|
*/
|
|
37
41
|
AlarmName?: string | undefined;
|
|
38
42
|
/**
|
|
39
|
-
* <p>The unique identifier of the alarm contributor associated with this history item, if
|
|
43
|
+
* <p>The unique identifier of the alarm contributor associated with this history item, if
|
|
44
|
+
* applicable.</p>
|
|
40
45
|
* @public
|
|
41
46
|
*/
|
|
42
47
|
AlarmContributorId?: string | undefined;
|
|
@@ -66,13 +71,16 @@ export interface AlarmHistoryItem {
|
|
|
66
71
|
*/
|
|
67
72
|
HistoryData?: string | undefined;
|
|
68
73
|
/**
|
|
69
|
-
* <p>A map of attributes that describe the alarm contributor associated with this history
|
|
74
|
+
* <p>A map of attributes that describe the alarm contributor associated with this history
|
|
75
|
+
* item, providing context about the contributor's characteristics at the time of the
|
|
76
|
+
* event.</p>
|
|
70
77
|
* @public
|
|
71
78
|
*/
|
|
72
79
|
AlarmContributorAttributes?: Record<string, string> | undefined;
|
|
73
80
|
}
|
|
74
81
|
/**
|
|
75
|
-
* <p>Summary information about an alarm mute rule, including its name, status, and
|
|
82
|
+
* <p>Summary information about an alarm mute rule, including its name, status, and
|
|
83
|
+
* configuration details.</p>
|
|
76
84
|
* @public
|
|
77
85
|
*/
|
|
78
86
|
export interface AlarmMuteRuleSummary {
|
|
@@ -82,17 +90,20 @@ export interface AlarmMuteRuleSummary {
|
|
|
82
90
|
*/
|
|
83
91
|
AlarmMuteRuleArn?: string | undefined;
|
|
84
92
|
/**
|
|
85
|
-
* <p>The date and time when the mute rule expires and is no longer evaluated. This field
|
|
93
|
+
* <p>The date and time when the mute rule expires and is no longer evaluated. This field
|
|
94
|
+
* is only present if an expiration date was configured.</p>
|
|
86
95
|
* @public
|
|
87
96
|
*/
|
|
88
97
|
ExpireDate?: Date | undefined;
|
|
89
98
|
/**
|
|
90
|
-
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
99
|
+
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
100
|
+
* <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
|
|
91
101
|
* @public
|
|
92
102
|
*/
|
|
93
103
|
Status?: AlarmMuteRuleStatus | undefined;
|
|
94
104
|
/**
|
|
95
|
-
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
105
|
+
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
106
|
+
* <code>ONE_TIME</code> or <code>RECURRING</code>.</p>
|
|
96
107
|
* @public
|
|
97
108
|
*/
|
|
98
109
|
MuteType?: string | undefined;
|
|
@@ -136,7 +147,7 @@ export interface AlarmPromQLCriteria {
|
|
|
136
147
|
export interface Range {
|
|
137
148
|
/**
|
|
138
149
|
* <p>The start time of the range to exclude. The format is
|
|
139
|
-
*
|
|
150
|
+
* <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
140
151
|
* <code>2019-07-01T23:59:59</code>.</p>
|
|
141
152
|
* @public
|
|
142
153
|
*/
|
|
@@ -186,7 +197,7 @@ export interface Dimension {
|
|
|
186
197
|
/**
|
|
187
198
|
* <p>The name of the dimension. Dimension names must contain only ASCII characters, must
|
|
188
199
|
* include at least one non-whitespace character, and cannot start with a colon
|
|
189
|
-
*
|
|
200
|
+
* (<code>:</code>). ASCII control characters are not supported as part of dimension
|
|
190
201
|
* names.</p>
|
|
191
202
|
* @public
|
|
192
203
|
*/
|
|
@@ -252,7 +263,7 @@ export interface MetricStat {
|
|
|
252
263
|
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
253
264
|
* minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution
|
|
254
265
|
* metrics are those metrics stored by a <code>PutMetricData</code> call that includes a
|
|
255
|
-
*
|
|
266
|
+
* <code>StorageResolution</code> of 1 second.</p>
|
|
256
267
|
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
257
268
|
* 3 hours ago, you must specify the period as follows or no data points in that time range
|
|
258
269
|
* is returned:</p>
|
|
@@ -294,29 +305,29 @@ export interface MetricStat {
|
|
|
294
305
|
}
|
|
295
306
|
/**
|
|
296
307
|
* <p>This structure is used in both <code>GetMetricData</code> and
|
|
297
|
-
*
|
|
308
|
+
* <code>PutMetricAlarm</code>. The supported use of this structure is different for
|
|
298
309
|
* those two operations.</p>
|
|
299
310
|
* <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and
|
|
300
311
|
* whether this call is just retrieving a batch set of data for one metric, or is
|
|
301
312
|
* performing a Metrics Insights query or a math expression. A single
|
|
302
|
-
*
|
|
313
|
+
* <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>
|
|
303
314
|
* structures.</p>
|
|
304
315
|
* <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a
|
|
305
316
|
* metric math expression. Each <code>MetricDataQuery</code> in the array specifies either
|
|
306
317
|
* a metric to retrieve, or a math expression to be performed on retrieved metrics. A
|
|
307
318
|
* single <code>PutMetricAlarm</code> call can include up to 20
|
|
308
|
-
*
|
|
319
|
+
* <code>MetricDataQuery</code> structures in the array. The 20 structures can include
|
|
309
320
|
* as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a
|
|
310
321
|
* metric, and as many as 10 structures that contain the <code>Expression</code> parameter
|
|
311
322
|
* to perform a math expression. Of those <code>Expression</code> structures, one must have
|
|
312
|
-
*
|
|
323
|
+
* <code>true</code> as the value for <code>ReturnData</code>. The result of this
|
|
313
324
|
* expression is the value the alarm watches.</p>
|
|
314
325
|
* <p>Any expression used in a <code>PutMetricAlarm</code> operation must return a single
|
|
315
326
|
* time series. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
|
|
316
|
-
*
|
|
327
|
+
* Guide</i>.</p>
|
|
317
328
|
* <p>Some of the parameters of this structure also have different uses whether you are
|
|
318
329
|
* using this structure in a <code>GetMetricData</code> operation or a
|
|
319
|
-
*
|
|
330
|
+
* <code>PutMetricAlarm</code> operation. These differences are explained in the
|
|
320
331
|
* following parameter list.</p>
|
|
321
332
|
* @public
|
|
322
333
|
*/
|
|
@@ -335,7 +346,7 @@ export interface MetricDataQuery {
|
|
|
335
346
|
* parameter only if this object is retrieving a metric and not performing a math
|
|
336
347
|
* expression on returned data.</p>
|
|
337
348
|
* <p>Within one MetricDataQuery object, you must specify either <code>Expression</code> or
|
|
338
|
-
*
|
|
349
|
+
* <code>MetricStat</code> but not both.</p>
|
|
339
350
|
* @public
|
|
340
351
|
*/
|
|
341
352
|
MetricStat?: MetricStat | undefined;
|
|
@@ -343,14 +354,14 @@ export interface MetricDataQuery {
|
|
|
343
354
|
* <p>This field can contain either a Metrics Insights query, or a metric math expression to
|
|
344
355
|
* be performed on the returned data. For more information about Metrics Insights queries,
|
|
345
356
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage">Metrics Insights query components and syntax</a> in the <i>Amazon
|
|
346
|
-
*
|
|
357
|
+
* CloudWatch User Guide</i>.</p>
|
|
347
358
|
* <p>A math expression can use the <code>Id</code> of the other metrics or queries to refer
|
|
348
359
|
* to those metrics, and can also use the <code>Id</code> of other expressions to use the
|
|
349
360
|
* result of those expressions. For more information about metric math expressions, see
|
|
350
|
-
*
|
|
351
|
-
*
|
|
361
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
|
|
362
|
+
* Guide</i>.</p>
|
|
352
363
|
* <p>Within each MetricDataQuery object, you must specify either <code>Expression</code> or
|
|
353
|
-
*
|
|
364
|
+
* <code>MetricStat</code> but not both.</p>
|
|
354
365
|
* @public
|
|
355
366
|
*/
|
|
356
367
|
Expression?: string | undefined;
|
|
@@ -369,11 +380,11 @@ export interface MetricDataQuery {
|
|
|
369
380
|
* <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
|
|
370
381
|
* timestamps and raw data values of this metric. If you are performing this call just to
|
|
371
382
|
* do math expressions and do not also need the raw data returned, you can specify
|
|
372
|
-
*
|
|
383
|
+
* <code>false</code>. If you omit this, the default of <code>true</code> is
|
|
373
384
|
* used.</p>
|
|
374
385
|
* <p>When used in <code>PutMetricAlarm</code>, specify <code>true</code> for the one
|
|
375
386
|
* expression result to use as the alarm. For all other metrics and expressions in the same
|
|
376
|
-
*
|
|
387
|
+
* <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as
|
|
377
388
|
* False.</p>
|
|
378
389
|
* @public
|
|
379
390
|
*/
|
|
@@ -408,10 +419,10 @@ export interface MetricMathAnomalyDetector {
|
|
|
408
419
|
/**
|
|
409
420
|
* <p>An array of metric data query structures that enables you to create an anomaly
|
|
410
421
|
* detector based on the result of a metric math expression. Each item in
|
|
411
|
-
*
|
|
422
|
+
* <code>MetricDataQueries</code> gets a metric or performs a math expression. One item
|
|
412
423
|
* in <code>MetricDataQueries</code> is the expression that provides the time series that
|
|
413
424
|
* the anomaly detector uses as input. Designate the expression by setting
|
|
414
|
-
*
|
|
425
|
+
* <code>ReturnData</code> to <code>true</code> for this object in the array. For all
|
|
415
426
|
* other expressions and metrics, set <code>ReturnData</code> to <code>false</code>. The
|
|
416
427
|
* designated expression must return a single time series.</p>
|
|
417
428
|
* @public
|
|
@@ -665,14 +676,14 @@ export interface CompositeAlarm {
|
|
|
665
676
|
/**
|
|
666
677
|
* <p> When the value is <code>ALARM</code>, it means that the actions are suppressed
|
|
667
678
|
* because the suppressor alarm is in <code>ALARM</code> When the value is
|
|
668
|
-
*
|
|
679
|
+
* <code>WaitPeriod</code>, it means that the actions are suppressed because the
|
|
669
680
|
* composite alarm is waiting for the suppressor alarm to go into into the
|
|
670
|
-
*
|
|
671
|
-
*
|
|
681
|
+
* <code>ALARM</code> state. The maximum waiting time is as specified in
|
|
682
|
+
* <code>ActionsSuppressorWaitPeriod</code>. After this time, the composite alarm
|
|
672
683
|
* performs its actions. When the value is <code>ExtensionPeriod</code>, it means that the
|
|
673
684
|
* actions are suppressed because the composite alarm is waiting after the suppressor alarm
|
|
674
685
|
* went out of the <code>ALARM</code> state. The maximum waiting time is as specified in
|
|
675
|
-
*
|
|
686
|
+
* <code>ActionsSuppressorExtensionPeriod</code>. After this time, the composite alarm
|
|
676
687
|
* performs its actions. </p>
|
|
677
688
|
* @public
|
|
678
689
|
*/
|
|
@@ -884,12 +895,12 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
884
895
|
* </li>
|
|
885
896
|
* <li>
|
|
886
897
|
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
887
|
-
*
|
|
898
|
+
* <code>DeleteAnomalyDetectorInput</code>
|
|
888
899
|
* </p>
|
|
889
900
|
* </li>
|
|
890
901
|
* </ul>
|
|
891
902
|
* <p>Instead, specify the single metric anomaly detector attributes as part of the
|
|
892
|
-
*
|
|
903
|
+
* <code>SingleMetricAnomalyDetector</code> property.</p>
|
|
893
904
|
* @public
|
|
894
905
|
*/
|
|
895
906
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
|
|
@@ -919,12 +930,12 @@ export interface DeleteAnomalyDetectorInput {
|
|
|
919
930
|
* </li>
|
|
920
931
|
* <li>
|
|
921
932
|
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
922
|
-
*
|
|
933
|
+
* <code>DeleteAnomalyDetectorInput</code>
|
|
923
934
|
* </p>
|
|
924
935
|
* </li>
|
|
925
936
|
* </ul>
|
|
926
937
|
* <p>Instead, specify the metric math anomaly detector attributes as part of the
|
|
927
|
-
*
|
|
938
|
+
* <code>MetricMathAnomalyDetector</code> property.</p>
|
|
928
939
|
* @public
|
|
929
940
|
*/
|
|
930
941
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
|
|
@@ -996,7 +1007,8 @@ export interface DescribeAlarmContributorsInput {
|
|
|
996
1007
|
*/
|
|
997
1008
|
AlarmName: string | undefined;
|
|
998
1009
|
/**
|
|
999
|
-
* <p>The token returned by a previous call to indicate that there is more data
|
|
1010
|
+
* <p>The token returned by a previous call to indicate that there is more data
|
|
1011
|
+
* available.</p>
|
|
1000
1012
|
* @public
|
|
1001
1013
|
*/
|
|
1002
1014
|
NextToken?: string | undefined;
|
|
@@ -1006,7 +1018,8 @@ export interface DescribeAlarmContributorsInput {
|
|
|
1006
1018
|
*/
|
|
1007
1019
|
export interface DescribeAlarmContributorsOutput {
|
|
1008
1020
|
/**
|
|
1009
|
-
* <p>A list of alarm contributors that provide details about the individual time series
|
|
1021
|
+
* <p>A list of alarm contributors that provide details about the individual time series
|
|
1022
|
+
* contributing to the alarm's state.</p>
|
|
1010
1023
|
* @public
|
|
1011
1024
|
*/
|
|
1012
1025
|
AlarmContributors: AlarmContributor[] | undefined;
|
|
@@ -1026,13 +1039,15 @@ export interface DescribeAlarmHistoryInput {
|
|
|
1026
1039
|
*/
|
|
1027
1040
|
AlarmName?: string | undefined;
|
|
1028
1041
|
/**
|
|
1029
|
-
* <p>The unique identifier of a specific alarm contributor to filter the alarm history
|
|
1042
|
+
* <p>The unique identifier of a specific alarm contributor to filter the alarm history
|
|
1043
|
+
* results.</p>
|
|
1030
1044
|
* @public
|
|
1031
1045
|
*/
|
|
1032
1046
|
AlarmContributorId?: string | undefined;
|
|
1033
1047
|
/**
|
|
1034
|
-
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1035
|
-
* or
|
|
1048
|
+
* <p>Use this parameter to specify whether you want the operation to return metric alarms,
|
|
1049
|
+
* composite alarms, or log alarms. If you omit this parameter, only metric alarms are
|
|
1050
|
+
* returned.</p>
|
|
1036
1051
|
* @public
|
|
1037
1052
|
*/
|
|
1038
1053
|
AlarmTypes?: AlarmType[] | undefined;
|
|
@@ -1064,7 +1079,7 @@ export interface DescribeAlarmHistoryInput {
|
|
|
1064
1079
|
NextToken?: string | undefined;
|
|
1065
1080
|
/**
|
|
1066
1081
|
* <p>Specified whether to return the newest or oldest alarm history first. Specify
|
|
1067
|
-
*
|
|
1082
|
+
* <code>TimestampDescending</code> to have the newest event history returned first,
|
|
1068
1083
|
* and specify <code>TimestampAscending</code> to have the oldest history returned
|
|
1069
1084
|
* first.</p>
|
|
1070
1085
|
* @public
|
|
@@ -1104,14 +1119,16 @@ export interface DescribeAlarmsInput {
|
|
|
1104
1119
|
*/
|
|
1105
1120
|
AlarmNamePrefix?: string | undefined;
|
|
1106
1121
|
/**
|
|
1107
|
-
* <p>Use this parameter to specify whether you want the operation to return metric alarms
|
|
1108
|
-
* or
|
|
1109
|
-
* if composite alarms exist in the account.</p>
|
|
1122
|
+
* <p>Use this parameter to specify whether you want the operation to return metric alarms,
|
|
1123
|
+
* composite alarms, or log alarms. If you omit this parameter, only metric alarms are
|
|
1124
|
+
* returned, even if composite alarms or log alarms exist in the account.</p>
|
|
1110
1125
|
* <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the
|
|
1111
|
-
* operation returns only a list of metric alarms. It does not return any composite alarms
|
|
1112
|
-
* even if
|
|
1126
|
+
* operation returns only a list of metric alarms. It does not return any composite alarms
|
|
1127
|
+
* or log alarms, even if they exist in the account.</p>
|
|
1113
1128
|
* <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of
|
|
1114
|
-
* composite alarms, and does not return any metric alarms.</p>
|
|
1129
|
+
* composite alarms, and does not return any metric alarms or log alarms.</p>
|
|
1130
|
+
* <p>If you specify <code>LogAlarms</code>, the operation returns only a list of log
|
|
1131
|
+
* alarms, and does not return any metric alarms or composite alarms.</p>
|
|
1115
1132
|
* @public
|
|
1116
1133
|
*/
|
|
1117
1134
|
AlarmTypes?: AlarmType[] | undefined;
|
|
@@ -1147,8 +1164,8 @@ export interface DescribeAlarmsInput {
|
|
|
1147
1164
|
* <note>
|
|
1148
1165
|
* <p>Only the Alarm Name and ARN are returned by this operation when you use this
|
|
1149
1166
|
* parameter. To get complete information about these alarms, perform another
|
|
1150
|
-
*
|
|
1151
|
-
*
|
|
1167
|
+
* <code>DescribeAlarms</code> operation and specify the parent alarm names in the
|
|
1168
|
+
* <code>AlarmNames</code> parameter.</p>
|
|
1152
1169
|
* </note>
|
|
1153
1170
|
* @public
|
|
1154
1171
|
*/
|
|
@@ -1179,8 +1196,205 @@ export interface DescribeAlarmsInput {
|
|
|
1179
1196
|
NextToken?: string | undefined;
|
|
1180
1197
|
}
|
|
1181
1198
|
/**
|
|
1182
|
-
* <p>
|
|
1183
|
-
*
|
|
1199
|
+
* <p>Contains the schedule expression and time-range offsets that define when a scheduled query runs and what time range each execution covers.</p>
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
export interface ScheduleConfiguration {
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>The schedule expression that defines how often the underlying CloudWatch Logs scheduled query runs. Specify a <code>rate()</code> expression, for example <code>rate(5 minutes)</code>.</p>
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
ScheduleExpression: string | undefined;
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>The offset, in seconds, before the scheduled execution time at which the query time range begins. For example, an offset of 360 (6 minutes) on a query running at 12:05:00 starts the query time range at 11:59:00.</p>
|
|
1210
|
+
* @public
|
|
1211
|
+
*/
|
|
1212
|
+
StartTimeOffset?: number | undefined;
|
|
1213
|
+
/**
|
|
1214
|
+
* <p>The offset, in seconds, before the scheduled execution time at which the query time range ends. Must be non-negative and less than <code>StartTimeOffset</code>. The default is 0.</p>
|
|
1215
|
+
* @public
|
|
1216
|
+
*/
|
|
1217
|
+
EndTimeOffset?: number | undefined;
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* <p>A key-value pair associated with a CloudWatch resource.</p>
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1223
|
+
export interface Tag {
|
|
1224
|
+
/**
|
|
1225
|
+
* <p>A string that you can use to assign a value. The combination of tag keys and values
|
|
1226
|
+
* can help you organize and categorize your resources.</p>
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
Key: string | undefined;
|
|
1230
|
+
/**
|
|
1231
|
+
* <p>The value for the specified tag key.</p>
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
Value: string | undefined;
|
|
1235
|
+
}
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The configuration of the CloudWatch Logs scheduled query that backs a log alarm.</p>
|
|
1238
|
+
* @public
|
|
1239
|
+
*/
|
|
1240
|
+
export interface ScheduledQueryConfiguration {
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>The CloudWatch Logs query to execute on each scheduled run. Length constraints: maximum of 10,000 characters.</p>
|
|
1243
|
+
* @public
|
|
1244
|
+
*/
|
|
1245
|
+
QueryString: string | undefined;
|
|
1246
|
+
/**
|
|
1247
|
+
* <p>The log groups to query. Each entry can be a log group name or ARN. Use the ARN form when querying log groups in a different account (for example, when running cross-account queries from a monitoring account). The list must contain between 1 and 50 entries.</p>
|
|
1248
|
+
* @public
|
|
1249
|
+
*/
|
|
1250
|
+
LogGroupIdentifiers?: string[] | undefined;
|
|
1251
|
+
/**
|
|
1252
|
+
* <p>The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled query that the alarm uses. This field is populated in <code>DescribeAlarms</code> responses.</p>
|
|
1253
|
+
* @public
|
|
1254
|
+
*/
|
|
1255
|
+
QueryARN?: string | undefined;
|
|
1256
|
+
/**
|
|
1257
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes when executing the scheduled query against the configured log groups.</p>
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
ScheduledQueryRoleARN: string | undefined;
|
|
1261
|
+
/**
|
|
1262
|
+
* <p>The schedule and time-range offset configuration for the underlying scheduled query.</p>
|
|
1263
|
+
* @public
|
|
1264
|
+
*/
|
|
1265
|
+
ScheduleConfiguration: ScheduleConfiguration | undefined;
|
|
1266
|
+
/**
|
|
1267
|
+
* <p>The expression that defines how to aggregate query results into one or more scalar values for alarm evaluation. For example, <code>count(*)</code> or <code>avg(latency) by host | sort desc</code>. Length constraints: minimum 1 character, maximum 2048 characters.</p>
|
|
1268
|
+
* @public
|
|
1269
|
+
*/
|
|
1270
|
+
AggregationExpression: string | undefined;
|
|
1271
|
+
/**
|
|
1272
|
+
* <p>A list of key-value pairs to associate with the underlying scheduled query resource.</p>
|
|
1273
|
+
* @public
|
|
1274
|
+
*/
|
|
1275
|
+
Tags?: Tag[] | undefined;
|
|
1276
|
+
}
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>The details about a log alarm.</p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
export interface LogAlarm {
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>The name of the alarm.</p>
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
AlarmName?: string | undefined;
|
|
1287
|
+
/**
|
|
1288
|
+
* <p>The Amazon Resource Name (ARN) of the alarm.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
AlarmArn?: string | undefined;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The description of the alarm.</p>
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
AlarmDescription?: string | undefined;
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>The time stamp of the last update to the alarm configuration.</p>
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
AlarmConfigurationUpdatedTimestamp?: Date | undefined;
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
|
|
1304
|
+
* @public
|
|
1305
|
+
*/
|
|
1306
|
+
ActionsEnabled?: boolean | undefined;
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1309
|
+
* @public
|
|
1310
|
+
*/
|
|
1311
|
+
OKActions?: string[] | undefined;
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
AlarmActions?: string[] | undefined;
|
|
1317
|
+
/**
|
|
1318
|
+
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
InsufficientDataActions?: string[] | undefined;
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The state value for the alarm.</p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
StateValue?: StateValue | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>An explanation for the alarm state, in text format.</p>
|
|
1329
|
+
* @public
|
|
1330
|
+
*/
|
|
1331
|
+
StateReason?: string | undefined;
|
|
1332
|
+
/**
|
|
1333
|
+
* <p>An explanation for the alarm state, in JSON format.</p>
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1336
|
+
StateReasonData?: string | undefined;
|
|
1337
|
+
/**
|
|
1338
|
+
* <p>The time stamp of the last update to the value of either the <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
|
|
1339
|
+
* @public
|
|
1340
|
+
*/
|
|
1341
|
+
StateUpdatedTimestamp?: Date | undefined;
|
|
1342
|
+
/**
|
|
1343
|
+
* <p>The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.</p>
|
|
1344
|
+
* @public
|
|
1345
|
+
*/
|
|
1346
|
+
ScheduledQueryConfiguration?: ScheduledQueryConfiguration | undefined;
|
|
1347
|
+
/**
|
|
1348
|
+
* <p>The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).</p>
|
|
1349
|
+
* @public
|
|
1350
|
+
*/
|
|
1351
|
+
QueryResultsToEvaluate?: number | undefined;
|
|
1352
|
+
/**
|
|
1353
|
+
* <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation).</p>
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
QueryResultsToAlarm?: number | undefined;
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>The value to compare with the aggregated query result.</p>
|
|
1359
|
+
* @public
|
|
1360
|
+
*/
|
|
1361
|
+
Threshold?: number | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.</p>
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
ComparisonOperator?: ComparisonOperator | undefined;
|
|
1367
|
+
/**
|
|
1368
|
+
* <p>How this alarm handles missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>.</p>
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
TreatMissingData?: string | undefined;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>The date and time that the alarm's <code>StateValue</code> most recently changed.</p>
|
|
1374
|
+
* @public
|
|
1375
|
+
*/
|
|
1376
|
+
StateTransitionedTimestamp?: Date | undefined;
|
|
1377
|
+
/**
|
|
1378
|
+
* <p>If the value of this field is <code>EVALUATION_ERROR</code>, it indicates configuration errors in the alarm setup that require review and correction. Refer to the <code>StateReason</code> field of the alarm for more details.</p>
|
|
1379
|
+
* <p>If the value of this field is <code>EVALUATION_FAILURE</code>, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.</p>
|
|
1380
|
+
* <p>If the value of this field is <code>PARTIAL_DATA</code>, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.</p>
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
EvaluationState?: EvaluationState | undefined;
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.</p>
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
ActionLogLineCount?: number | undefined;
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when <code>ActionLogLineCount</code> is greater than 0.</p>
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
ActionLogLineRoleArn?: string | undefined;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>The evaluation criteria for an alarm. This is a union type that currently supports
|
|
1397
|
+
* <code>PromQLCriteria</code>.</p>
|
|
1184
1398
|
* @public
|
|
1185
1399
|
*/
|
|
1186
1400
|
export type EvaluationCriteria = EvaluationCriteria.PromQLCriteriaMember | EvaluationCriteria.$UnknownMember;
|
|
@@ -1212,6 +1426,98 @@ export declare namespace EvaluationCriteria {
|
|
|
1212
1426
|
_: (name: string, value: any) => T;
|
|
1213
1427
|
}
|
|
1214
1428
|
}
|
|
1429
|
+
/**
|
|
1430
|
+
* <p>An evaluation window that advances each time the alarm is evaluated, forming a rolling
|
|
1431
|
+
* time window. This is the default evaluation window. A sliding window has no additional
|
|
1432
|
+
* configuration options.</p>
|
|
1433
|
+
* <p>Choose a sliding window when you need the fastest detection and the calendar
|
|
1434
|
+
* boundaries of the data don't matter, such as for continuous performance, latency, or
|
|
1435
|
+
* resource-exhaustion monitoring.</p>
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
export interface SlidingWindow {
|
|
1439
|
+
}
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>An evaluation window that aligns the evaluated range to fixed clock boundaries that
|
|
1442
|
+
* match the alarm's period, such as the top of the hour, midnight, or the start of the
|
|
1443
|
+
* calendar week, optionally in a specific time zone.</p>
|
|
1444
|
+
* <p>When you use a wall clock window, the alarm's period must be 1 minute (60 seconds),
|
|
1445
|
+
* 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day (86,400 seconds), or 1 week
|
|
1446
|
+
* (604,800 seconds). Other period values aren't supported with a wall clock window.</p>
|
|
1447
|
+
* <p>Choose a wall clock window when your monitoring is tied to a business or calendar
|
|
1448
|
+
* period, such as daily reports, batch jobs, or backups, or when you want alarm
|
|
1449
|
+
* evaluations to match the periods shown on a metric dashboard.</p>
|
|
1450
|
+
* @public
|
|
1451
|
+
*/
|
|
1452
|
+
export interface WallClockWindow {
|
|
1453
|
+
/**
|
|
1454
|
+
* <p>The time zone to use when the alarm aligns the evaluation window to clock boundaries.
|
|
1455
|
+
* You can specify an IANA time zone name (for example, <code>America/New_York</code>), a
|
|
1456
|
+
* fixed UTC offset (for example, <code>+05:30</code>), or an offset-prefixed identifier
|
|
1457
|
+
* (for example, <code>UTC+05:30</code>). The offset must be aligned to a multiple of
|
|
1458
|
+
* 5 minutes. If you don't specify a time zone, CloudWatch uses
|
|
1459
|
+
* <code>UTC</code>.</p>
|
|
1460
|
+
* <p>The time zone affects window alignment for all periods, including periods of one
|
|
1461
|
+
* hour or shorter.</p>
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
Timezone?: string | undefined;
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* <p>The evaluation window that an alarm uses to select the range of metric data that it
|
|
1468
|
+
* evaluates each time it runs. This is a union type. Set exactly one of its members,
|
|
1469
|
+
* <code>SlidingWindow</code> or <code>WallClockWindow</code>. If you don't set
|
|
1470
|
+
* <code>EvaluationWindow</code>, the alarm uses a <code>SlidingWindow</code> by
|
|
1471
|
+
* default.</p>
|
|
1472
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html">Alarm
|
|
1473
|
+
* evaluation windows</a> in the <i>CloudWatch User
|
|
1474
|
+
* Guide</i>.</p>
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1477
|
+
export type EvaluationWindow = EvaluationWindow.SlidingWindowMember | EvaluationWindow.WallClockWindowMember | EvaluationWindow.$UnknownMember;
|
|
1478
|
+
/**
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
export declare namespace EvaluationWindow {
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>A wall clock window, which aligns the evaluated range to fixed clock boundaries that
|
|
1484
|
+
* match the alarm's period, such as the top of the hour, midnight, or the start of the
|
|
1485
|
+
* calendar week.</p>
|
|
1486
|
+
* @public
|
|
1487
|
+
*/
|
|
1488
|
+
interface WallClockWindowMember {
|
|
1489
|
+
WallClockWindow: WallClockWindow;
|
|
1490
|
+
SlidingWindow?: never;
|
|
1491
|
+
$unknown?: never;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* <p>A sliding window, which advances each time the alarm is evaluated, forming a rolling
|
|
1495
|
+
* time window. This is the default evaluation window.</p>
|
|
1496
|
+
* @public
|
|
1497
|
+
*/
|
|
1498
|
+
interface SlidingWindowMember {
|
|
1499
|
+
WallClockWindow?: never;
|
|
1500
|
+
SlidingWindow: SlidingWindow;
|
|
1501
|
+
$unknown?: never;
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
interface $UnknownMember {
|
|
1507
|
+
WallClockWindow?: never;
|
|
1508
|
+
SlidingWindow?: never;
|
|
1509
|
+
$unknown: [string, any];
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* @deprecated unused in schema-serde mode.
|
|
1513
|
+
*
|
|
1514
|
+
*/
|
|
1515
|
+
interface Visitor<T> {
|
|
1516
|
+
WallClockWindow: (value: WallClockWindow) => T;
|
|
1517
|
+
SlidingWindow: (value: SlidingWindow) => T;
|
|
1518
|
+
_: (name: string, value: any) => T;
|
|
1519
|
+
}
|
|
1520
|
+
}
|
|
1215
1521
|
/**
|
|
1216
1522
|
* <p>The details about a metric alarm.</p>
|
|
1217
1523
|
* @public
|
|
@@ -1259,7 +1565,7 @@ export interface MetricAlarm {
|
|
|
1259
1565
|
AlarmActions?: string[] | undefined;
|
|
1260
1566
|
/**
|
|
1261
1567
|
* <p>The actions to execute when this alarm transitions to the
|
|
1262
|
-
*
|
|
1568
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
1263
1569
|
* as an Amazon Resource Name (ARN).</p>
|
|
1264
1570
|
* @public
|
|
1265
1571
|
*/
|
|
@@ -1281,7 +1587,7 @@ export interface MetricAlarm {
|
|
|
1281
1587
|
StateReasonData?: string | undefined;
|
|
1282
1588
|
/**
|
|
1283
1589
|
* <p>The time stamp of the last update to the value of either the
|
|
1284
|
-
*
|
|
1590
|
+
* <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
|
|
1285
1591
|
* @public
|
|
1286
1592
|
*/
|
|
1287
1593
|
StateUpdatedTimestamp?: Date | undefined;
|
|
@@ -1347,8 +1653,8 @@ export interface MetricAlarm {
|
|
|
1347
1653
|
ComparisonOperator?: ComparisonOperator | undefined;
|
|
1348
1654
|
/**
|
|
1349
1655
|
* <p>Sets how this alarm is to handle missing data points. The valid values are
|
|
1350
|
-
*
|
|
1351
|
-
*
|
|
1656
|
+
* <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and
|
|
1657
|
+
* <code>missing</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring how CloudWatch alarms treat missing data</a>.</p>
|
|
1352
1658
|
* <p>If this parameter is omitted, the default behavior of <code>missing</code> is
|
|
1353
1659
|
* used.</p>
|
|
1354
1660
|
* <note>
|
|
@@ -1375,16 +1681,21 @@ export interface MetricAlarm {
|
|
|
1375
1681
|
Metrics?: MetricDataQuery[] | undefined;
|
|
1376
1682
|
/**
|
|
1377
1683
|
* <p>In an alarm based on an anomaly detection model, this is the ID of the
|
|
1378
|
-
*
|
|
1684
|
+
* <code>ANOMALY_DETECTION_BAND</code> function used as the threshold for the
|
|
1379
1685
|
* alarm.</p>
|
|
1380
1686
|
* @public
|
|
1381
1687
|
*/
|
|
1382
1688
|
ThresholdMetricId?: string | undefined;
|
|
1383
1689
|
/**
|
|
1384
|
-
* <p>If the value of this field is <code>PARTIAL_DATA</code>, it indicates that not all the
|
|
1690
|
+
* <p>If the value of this field is <code>PARTIAL_DATA</code>, it indicates that not all the
|
|
1691
|
+
* available data was able to be retrieved due to quota limitations. For more information,
|
|
1692
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create
|
|
1385
1693
|
* alarms on Metrics Insights queries</a>.</p>
|
|
1386
|
-
* <p>If the value of this field is <code>EVALUATION_ERROR</code>, it indicates
|
|
1387
|
-
*
|
|
1694
|
+
* <p>If the value of this field is <code>EVALUATION_ERROR</code>, it indicates
|
|
1695
|
+
* configuration errors in alarm setup that require review and correction. Refer to
|
|
1696
|
+
* StateReason field of the alarm for more details.</p>
|
|
1697
|
+
* <p>If the value of this field is <code>EVALUATION_FAILURE</code>, it indicates temporary
|
|
1698
|
+
* CloudWatch issues. We recommend manual monitoring until the issue is resolved </p>
|
|
1388
1699
|
* @public
|
|
1389
1700
|
*/
|
|
1390
1701
|
EvaluationState?: EvaluationState | undefined;
|
|
@@ -1394,6 +1705,15 @@ export interface MetricAlarm {
|
|
|
1394
1705
|
* @public
|
|
1395
1706
|
*/
|
|
1396
1707
|
StateTransitionedTimestamp?: Date | undefined;
|
|
1708
|
+
/**
|
|
1709
|
+
* <p>The evaluation window that the alarm uses to select the range of metric data that it
|
|
1710
|
+
* evaluates. This is either a sliding window or a wall clock window. For more information,
|
|
1711
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html">Alarm
|
|
1712
|
+
* evaluation windows</a> in the <i>CloudWatch User
|
|
1713
|
+
* Guide</i>.</p>
|
|
1714
|
+
* @public
|
|
1715
|
+
*/
|
|
1716
|
+
EvaluationWindow?: EvaluationWindow | undefined;
|
|
1397
1717
|
/**
|
|
1398
1718
|
* <p>The evaluation criteria for the alarm.</p>
|
|
1399
1719
|
* @public
|
|
@@ -1419,6 +1739,11 @@ export interface DescribeAlarmsOutput {
|
|
|
1419
1739
|
* @public
|
|
1420
1740
|
*/
|
|
1421
1741
|
MetricAlarms?: MetricAlarm[] | undefined;
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>The information about any log alarms returned by the operation.</p>
|
|
1744
|
+
* @public
|
|
1745
|
+
*/
|
|
1746
|
+
LogAlarms?: LogAlarm[] | undefined;
|
|
1422
1747
|
/**
|
|
1423
1748
|
* <p>The token that marks the start of the next batch of returned results.</p>
|
|
1424
1749
|
* @public
|
|
@@ -1492,7 +1817,7 @@ export interface DescribeAnomalyDetectorsInput {
|
|
|
1492
1817
|
* <p>The maximum number of results to return in one operation. The maximum value that you
|
|
1493
1818
|
* can specify is 100.</p>
|
|
1494
1819
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1495
|
-
*
|
|
1820
|
+
* <code>NextToken</code> value. </p>
|
|
1496
1821
|
* @public
|
|
1497
1822
|
*/
|
|
1498
1823
|
MaxResults?: number | undefined;
|
|
@@ -1518,8 +1843,8 @@ export interface DescribeAnomalyDetectorsInput {
|
|
|
1518
1843
|
Dimensions?: Dimension[] | undefined;
|
|
1519
1844
|
/**
|
|
1520
1845
|
* <p>The anomaly detector types to request when using
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1846
|
+
* <code>DescribeAnomalyDetectorsInput</code>. If empty, defaults to
|
|
1847
|
+
* <code>SINGLE_METRIC</code>.</p>
|
|
1523
1848
|
* @public
|
|
1524
1849
|
*/
|
|
1525
1850
|
AnomalyDetectorTypes?: AnomalyDetectorType[] | undefined;
|
|
@@ -1560,7 +1885,7 @@ export interface DescribeInsightRulesInput {
|
|
|
1560
1885
|
/**
|
|
1561
1886
|
* <p>This structure contains the definition for a Contributor Insights rule. For more
|
|
1562
1887
|
* information about this rule, see<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html"> Using Constributor Insights to analyze high-cardinality data</a> in the
|
|
1563
|
-
*
|
|
1888
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1564
1889
|
* @public
|
|
1565
1890
|
*/
|
|
1566
1891
|
export interface InsightRule {
|
|
@@ -1576,7 +1901,7 @@ export interface InsightRule {
|
|
|
1576
1901
|
State: string | undefined;
|
|
1577
1902
|
/**
|
|
1578
1903
|
* <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule",
|
|
1579
|
-
*
|
|
1904
|
+
* "Version": 1\}</code>. For managed rules, this is <code>\{"Name": "ServiceLogRule",
|
|
1580
1905
|
* "Version": 1\}</code>
|
|
1581
1906
|
* </p>
|
|
1582
1907
|
* @public
|
|
@@ -1595,8 +1920,10 @@ export interface InsightRule {
|
|
|
1595
1920
|
*/
|
|
1596
1921
|
ManagedRule?: boolean | undefined;
|
|
1597
1922
|
/**
|
|
1598
|
-
* <p>Displays whether the rule is evaluated on the transformed versions of logs, for log
|
|
1599
|
-
* that have <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
1923
|
+
* <p>Displays whether the rule is evaluated on the transformed versions of logs, for log
|
|
1924
|
+
* groups that have <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
1925
|
+
* transformation</a> enabled. If this is <code>false</code>, log events are
|
|
1926
|
+
* evaluated before they are transformed.</p>
|
|
1600
1927
|
* @public
|
|
1601
1928
|
*/
|
|
1602
1929
|
ApplyOnTransformedLogs?: boolean | undefined;
|
|
@@ -1718,7 +2045,7 @@ export interface EnableInsightRulesOutput {
|
|
|
1718
2045
|
/**
|
|
1719
2046
|
* <p>An entity associated with metrics, to allow for finding related telemetry. An entity
|
|
1720
2047
|
* is typically a resource or service within your system. For example, metrics from an
|
|
1721
|
-
*
|
|
2048
|
+
* Amazon EC2 instance could be associated with that instance as the entity.
|
|
1722
2049
|
* Similarly, metrics from a service that you own could be associated with that service as
|
|
1723
2050
|
* the entity.</p>
|
|
1724
2051
|
* @public
|
|
@@ -1730,12 +2057,11 @@ export interface Entity {
|
|
|
1730
2057
|
* the same entity. For an entity to be valid, the <code>KeyAttributes</code> must exist
|
|
1731
2058
|
* and be formatted correctly.</p>
|
|
1732
2059
|
* <p>There are five allowed attributes (key names): <code>Type</code>,
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
2060
|
+
* <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and
|
|
2061
|
+
* <code>Environment</code>.</p>
|
|
1735
2062
|
* <p>For details about how to use the key attributes to specify an entity, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1738
|
-
* Guide</i>.</p>
|
|
2063
|
+
* to add related information to telemetry</a> in the <i>CloudWatch
|
|
2064
|
+
* User Guide</i>.</p>
|
|
1739
2065
|
* @public
|
|
1740
2066
|
*/
|
|
1741
2067
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -1743,8 +2069,8 @@ export interface Entity {
|
|
|
1743
2069
|
* <p>Additional attributes of the entity that are not used to specify the identity of the
|
|
1744
2070
|
* entity. A list of key-value pairs.</p>
|
|
1745
2071
|
* <p>For details about how to use the attributes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How
|
|
1746
|
-
*
|
|
1747
|
-
*
|
|
2072
|
+
* to add related information to telemetry</a> in the <i>CloudWatch
|
|
2073
|
+
* User Guide</i>.</p>
|
|
1748
2074
|
* @public
|
|
1749
2075
|
*/
|
|
1750
2076
|
Attributes?: Record<string, string> | undefined;
|
|
@@ -1814,7 +2140,7 @@ export interface MetricDatum {
|
|
|
1814
2140
|
/**
|
|
1815
2141
|
* <p>Array of numbers representing the values for the metric during the period. Each unique
|
|
1816
2142
|
* value is listed just once in this array, and the corresponding number in the
|
|
1817
|
-
*
|
|
2143
|
+
* <code>Counts</code> array specifies the number of times that value occurred during
|
|
1818
2144
|
* the period. You can include up to 150 unique values in each <code>PutMetricData</code>
|
|
1819
2145
|
* action that specifies a <code>Values</code> array.</p>
|
|
1820
2146
|
* <p>Although the <code>Values</code> array accepts numbers of type <code>Double</code>,
|
|
@@ -1827,7 +2153,7 @@ export interface MetricDatum {
|
|
|
1827
2153
|
/**
|
|
1828
2154
|
* <p>Array of numbers that is used along with the <code>Values</code> array. Each number in
|
|
1829
2155
|
* the <code>Count</code> array is the number of times the corresponding value in the
|
|
1830
|
-
*
|
|
2156
|
+
* <code>Values</code> array occurred during the period. </p>
|
|
1831
2157
|
* <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for
|
|
1832
2158
|
* each count. If you include a <code>Counts</code> array, it must include the same amount
|
|
1833
2159
|
* of values as the <code>Values</code> array.</p>
|
|
@@ -1849,7 +2175,7 @@ export interface MetricDatum {
|
|
|
1849
2175
|
* metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is
|
|
1850
2176
|
* available only for custom metrics. For more information about high-resolution metrics,
|
|
1851
2177
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics">High-Resolution Metrics</a> in the <i>Amazon CloudWatch User
|
|
1852
|
-
*
|
|
2178
|
+
* Guide</i>. </p>
|
|
1853
2179
|
* <p>This field is optional, if you do not specify it the default of 60 is
|
|
1854
2180
|
* used.</p>
|
|
1855
2181
|
* @public
|
|
@@ -1857,8 +2183,8 @@ export interface MetricDatum {
|
|
|
1857
2183
|
StorageResolution?: number | undefined;
|
|
1858
2184
|
}
|
|
1859
2185
|
/**
|
|
1860
|
-
* <p>A set of metrics that are associated with an entity, such as a specific service
|
|
1861
|
-
*
|
|
2186
|
+
* <p>A set of metrics that are associated with an entity, such as a specific service or
|
|
2187
|
+
* resource. Contains the entity and the list of metric data associated with it.</p>
|
|
1862
2188
|
* @public
|
|
1863
2189
|
*/
|
|
1864
2190
|
export interface EntityMetricData {
|
|
@@ -1885,30 +2211,39 @@ export interface GetAlarmMuteRuleInput {
|
|
|
1885
2211
|
}
|
|
1886
2212
|
/**
|
|
1887
2213
|
* <p>Specifies which alarms an alarm mute rule applies to.</p>
|
|
1888
|
-
* <p>You can target up to 100 specific alarms by name. When a mute rule is active, the
|
|
2214
|
+
* <p>You can target up to 100 specific alarms by name. When a mute rule is active, the
|
|
2215
|
+
* targeted alarms continue to evaluate metrics and transition between states, but their
|
|
2216
|
+
* configured actions are muted.</p>
|
|
1889
2217
|
* @public
|
|
1890
2218
|
*/
|
|
1891
2219
|
export interface MuteTargets {
|
|
1892
2220
|
/**
|
|
1893
|
-
* <p>The list of alarm names that this mute rule targets. You can specify up to 100 alarm
|
|
1894
|
-
*
|
|
2221
|
+
* <p>The list of alarm names that this mute rule targets. You can specify up to 100 alarm
|
|
2222
|
+
* names.</p>
|
|
2223
|
+
* <p>Each alarm name must be between 1 and 255 characters in length. The alarm names must
|
|
2224
|
+
* match existing alarms in your Amazon Web Services account and region.</p>
|
|
1895
2225
|
* @public
|
|
1896
2226
|
*/
|
|
1897
2227
|
AlarmNames: string[] | undefined;
|
|
1898
2228
|
}
|
|
1899
2229
|
/**
|
|
1900
2230
|
* <p>Specifies when and how long an alarm mute rule is active.</p>
|
|
1901
|
-
* <p>The schedule uses either a cron expression for recurring mute windows or an at
|
|
2231
|
+
* <p>The schedule uses either a cron expression for recurring mute windows or an at
|
|
2232
|
+
* expression for one-time mute windows. When the schedule activates, the mute rule mutes
|
|
2233
|
+
* alarm actions for the specified duration.</p>
|
|
1902
2234
|
* @public
|
|
1903
2235
|
*/
|
|
1904
2236
|
export interface Schedule {
|
|
1905
2237
|
/**
|
|
1906
|
-
* <p>The schedule expression that defines when the mute rule activates. The expression must
|
|
2238
|
+
* <p>The schedule expression that defines when the mute rule activates. The expression must
|
|
2239
|
+
* be between 1 and 256 characters in length.</p>
|
|
1907
2240
|
* <p>You can use one of two expression formats:</p>
|
|
1908
2241
|
* <ul>
|
|
1909
2242
|
* <li>
|
|
1910
2243
|
* <p>
|
|
1911
|
-
* <b>Cron expressions</b> - For recurring mute
|
|
2244
|
+
* <b>Cron expressions</b> - For recurring mute
|
|
2245
|
+
* windows. Format: <code>cron(Minutes Hours Day-of-month Month
|
|
2246
|
+
* Day-of-week)</code>
|
|
1912
2247
|
* </p>
|
|
1913
2248
|
* <p>Examples:</p>
|
|
1914
2249
|
* <ul>
|
|
@@ -1918,36 +2253,45 @@ export interface Schedule {
|
|
|
1918
2253
|
* </li>
|
|
1919
2254
|
* <li>
|
|
1920
2255
|
* <p>
|
|
1921
|
-
* <code>cron(0 2 * * SUN)</code> - Activates every Sunday at 2:00 AM for
|
|
2256
|
+
* <code>cron(0 2 * * SUN)</code> - Activates every Sunday at 2:00 AM for
|
|
2257
|
+
* weekly system maintenance</p>
|
|
1922
2258
|
* </li>
|
|
1923
2259
|
* <li>
|
|
1924
2260
|
* <p>
|
|
1925
|
-
* <code>cron(0 1 1 * *)</code> - Activates on the first day of each
|
|
2261
|
+
* <code>cron(0 1 1 * *)</code> - Activates on the first day of each
|
|
2262
|
+
* month at 1:00 AM for monthly database maintenance</p>
|
|
1926
2263
|
* </li>
|
|
1927
2264
|
* <li>
|
|
1928
2265
|
* <p>
|
|
1929
|
-
* <code>cron(0 18 * * FRI)</code> - Activates every Friday at 6:00
|
|
2266
|
+
* <code>cron(0 18 * * FRI)</code> - Activates every Friday at 6:00
|
|
2267
|
+
* PM</p>
|
|
1930
2268
|
* </li>
|
|
1931
2269
|
* <li>
|
|
1932
2270
|
* <p>
|
|
1933
|
-
* <code>cron(0 23 * * *)</code> - Activates every day at 11:00 PM during
|
|
2271
|
+
* <code>cron(0 23 * * *)</code> - Activates every day at 11:00 PM during
|
|
2272
|
+
* nightly backup operations</p>
|
|
1934
2273
|
* </li>
|
|
1935
2274
|
* </ul>
|
|
1936
|
-
* <p>The characters <code>*</code>, <code>-</code>, and <code>,</code> are
|
|
2275
|
+
* <p>The characters <code>*</code>, <code>-</code>, and <code>,</code> are
|
|
2276
|
+
* supported in all fields. English names can be used for the month (JAN-DEC) and
|
|
2277
|
+
* day of week (SUN-SAT) fields.</p>
|
|
1937
2278
|
* </li>
|
|
1938
2279
|
* <li>
|
|
1939
2280
|
* <p>
|
|
1940
|
-
* <b>At expressions</b> - For one-time mute windows.
|
|
2281
|
+
* <b>At expressions</b> - For one-time mute windows.
|
|
2282
|
+
* Format: <code>at(yyyy-MM-ddThh:mm)</code>
|
|
1941
2283
|
* </p>
|
|
1942
2284
|
* <p>Examples:</p>
|
|
1943
2285
|
* <ul>
|
|
1944
2286
|
* <li>
|
|
1945
2287
|
* <p>
|
|
1946
|
-
* <code>at(2024-05-10T14:00)</code> - Activates once on May 10, 2024 at
|
|
2288
|
+
* <code>at(2024-05-10T14:00)</code> - Activates once on May 10, 2024 at
|
|
2289
|
+
* 2:00 PM during an active incident response session</p>
|
|
1947
2290
|
* </li>
|
|
1948
2291
|
* <li>
|
|
1949
2292
|
* <p>
|
|
1950
|
-
* <code>at(2024-12-23T00:00)</code> - Activates once on December 23,
|
|
2293
|
+
* <code>at(2024-12-23T00:00)</code> - Activates once on December 23,
|
|
2294
|
+
* 2024 at midnight during annual company shutdown</p>
|
|
1951
2295
|
* </li>
|
|
1952
2296
|
* </ul>
|
|
1953
2297
|
* </li>
|
|
@@ -1956,8 +2300,10 @@ export interface Schedule {
|
|
|
1956
2300
|
*/
|
|
1957
2301
|
Expression: string | undefined;
|
|
1958
2302
|
/**
|
|
1959
|
-
* <p>The length of time that alarms remain muted when the schedule activates. The duration
|
|
1960
|
-
*
|
|
2303
|
+
* <p>The length of time that alarms remain muted when the schedule activates. The duration
|
|
2304
|
+
* must be between 1 and 50 characters in length.</p>
|
|
2305
|
+
* <p>Specify the duration using ISO 8601 duration format with a minimum of 1 minute
|
|
2306
|
+
* (<code>PT1M</code>) and maximum of 15 days (<code>P15D</code>).</p>
|
|
1961
2307
|
* <p>Examples:</p>
|
|
1962
2308
|
* <ul>
|
|
1963
2309
|
* <li>
|
|
@@ -1966,7 +2312,8 @@ export interface Schedule {
|
|
|
1966
2312
|
* </li>
|
|
1967
2313
|
* <li>
|
|
1968
2314
|
* <p>
|
|
1969
|
-
* <code>P2DT12H</code> - 2 days and 12 hours for weekend muting from Friday 6:00
|
|
2315
|
+
* <code>P2DT12H</code> - 2 days and 12 hours for weekend muting from Friday 6:00
|
|
2316
|
+
* PM to Monday 6:00 AM</p>
|
|
1970
2317
|
* </li>
|
|
1971
2318
|
* <li>
|
|
1972
2319
|
* <p>
|
|
@@ -1981,14 +2328,20 @@ export interface Schedule {
|
|
|
1981
2328
|
* <code>P7D</code> - 7 days for annual company shutdown</p>
|
|
1982
2329
|
* </li>
|
|
1983
2330
|
* </ul>
|
|
1984
|
-
* <p>The duration begins when the schedule expression time is reached. For recurring
|
|
2331
|
+
* <p>The duration begins when the schedule expression time is reached. For recurring
|
|
2332
|
+
* schedules, the duration applies to each occurrence.</p>
|
|
1985
2333
|
* @public
|
|
1986
2334
|
*/
|
|
1987
2335
|
Duration: string | undefined;
|
|
1988
2336
|
/**
|
|
1989
|
-
* <p>The time zone to use when evaluating the schedule expression. The time zone must be
|
|
1990
|
-
*
|
|
1991
|
-
* <p>
|
|
2337
|
+
* <p>The time zone to use when evaluating the schedule expression. The time zone must be
|
|
2338
|
+
* between 1 and 50 characters in length.</p>
|
|
2339
|
+
* <p>Specify the time zone using standard timezone identifiers (for example,
|
|
2340
|
+
* <code>America/New_York</code>, <code>Europe/London</code>, or
|
|
2341
|
+
* <code>Asia/Tokyo</code>).</p>
|
|
2342
|
+
* <p>If you don't specify a time zone, UTC is used by default. The time zone affects how
|
|
2343
|
+
* cron and at expressions are interpreted, as well as start and expire dates you
|
|
2344
|
+
* specify</p>
|
|
1992
2345
|
* <p>Examples:</p>
|
|
1993
2346
|
* <ul>
|
|
1994
2347
|
* <li>
|
|
@@ -2018,12 +2371,15 @@ export interface Schedule {
|
|
|
2018
2371
|
}
|
|
2019
2372
|
/**
|
|
2020
2373
|
* <p>Defines the schedule configuration for an alarm mute rule.</p>
|
|
2021
|
-
* <p>The rule contains a schedule that specifies when and how long alarms should be muted.
|
|
2374
|
+
* <p>The rule contains a schedule that specifies when and how long alarms should be muted.
|
|
2375
|
+
* The schedule can be a recurring pattern using cron expressions or a one-time mute window
|
|
2376
|
+
* using at expressions.</p>
|
|
2022
2377
|
* @public
|
|
2023
2378
|
*/
|
|
2024
2379
|
export interface Rule {
|
|
2025
2380
|
/**
|
|
2026
|
-
* <p>The schedule configuration that defines when the mute rule activates and how long it
|
|
2381
|
+
* <p>The schedule configuration that defines when the mute rule activates and how long it
|
|
2382
|
+
* remains active.</p>
|
|
2027
2383
|
* @public
|
|
2028
2384
|
*/
|
|
2029
2385
|
Schedule: Schedule | undefined;
|
|
@@ -2058,7 +2414,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2058
2414
|
*/
|
|
2059
2415
|
MuteTargets?: MuteTargets | undefined;
|
|
2060
2416
|
/**
|
|
2061
|
-
* <p>The date and time when the mute rule becomes active. If not set, the rule is active
|
|
2417
|
+
* <p>The date and time when the mute rule becomes active. If not set, the rule is active
|
|
2418
|
+
* immediately.</p>
|
|
2062
2419
|
* @public
|
|
2063
2420
|
*/
|
|
2064
2421
|
StartDate?: Date | undefined;
|
|
@@ -2068,7 +2425,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2068
2425
|
*/
|
|
2069
2426
|
ExpireDate?: Date | undefined;
|
|
2070
2427
|
/**
|
|
2071
|
-
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
2428
|
+
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
2429
|
+
* <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
|
|
2072
2430
|
* @public
|
|
2073
2431
|
*/
|
|
2074
2432
|
Status?: AlarmMuteRuleStatus | undefined;
|
|
@@ -2078,7 +2436,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2078
2436
|
*/
|
|
2079
2437
|
LastUpdatedTimestamp?: Date | undefined;
|
|
2080
2438
|
/**
|
|
2081
|
-
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
2439
|
+
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
2440
|
+
* <code>ONE_TIME</code> or <code>RECURRING</code>.</p>
|
|
2082
2441
|
* @public
|
|
2083
2442
|
*/
|
|
2084
2443
|
MuteType?: string | undefined;
|
|
@@ -2105,7 +2464,7 @@ export interface GetDashboardOutput {
|
|
|
2105
2464
|
/**
|
|
2106
2465
|
* <p>The detailed information about the dashboard, including what widgets are included
|
|
2107
2466
|
* and their location on the dashboard. For more information about the
|
|
2108
|
-
*
|
|
2467
|
+
* <code>DashboardBody</code> syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>. </p>
|
|
2109
2468
|
* @public
|
|
2110
2469
|
*/
|
|
2111
2470
|
DashboardBody?: string | undefined;
|
|
@@ -2166,20 +2525,20 @@ export interface GetInsightRuleReportInput {
|
|
|
2166
2525
|
/**
|
|
2167
2526
|
* <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
2168
2527
|
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2169
|
-
*
|
|
2528
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2170
2529
|
* @public
|
|
2171
2530
|
*/
|
|
2172
2531
|
StartTime: Date | undefined;
|
|
2173
2532
|
/**
|
|
2174
2533
|
* <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
2175
2534
|
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2176
|
-
*
|
|
2535
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2177
2536
|
* @public
|
|
2178
2537
|
*/
|
|
2179
2538
|
EndTime: Date | undefined;
|
|
2180
2539
|
/**
|
|
2181
2540
|
* <p>The period, in seconds, to use for the statistics in the
|
|
2182
|
-
*
|
|
2541
|
+
* <code>InsightRuleMetricDatapoint</code> results.</p>
|
|
2183
2542
|
* @public
|
|
2184
2543
|
*/
|
|
2185
2544
|
Period: number | undefined;
|
|
@@ -2239,7 +2598,7 @@ export interface GetInsightRuleReportInput {
|
|
|
2239
2598
|
Metrics?: string[] | undefined;
|
|
2240
2599
|
/**
|
|
2241
2600
|
* <p>Determines what statistic to use to rank the contributors. Valid values are
|
|
2242
|
-
*
|
|
2601
|
+
* <code>Sum</code> and <code>Maximum</code>.</p>
|
|
2243
2602
|
* @public
|
|
2244
2603
|
*/
|
|
2245
2604
|
OrderBy?: string | undefined;
|
|
@@ -2404,14 +2763,14 @@ export interface GetInsightRuleReportOutput {
|
|
|
2404
2763
|
* display the correct time for your time zone. </p>
|
|
2405
2764
|
* <p>The <code>Timezone</code> value affects a label only if you have a time-based dynamic
|
|
2406
2765
|
* expression in the label. For more information about dynamic expressions in labels, see
|
|
2407
|
-
*
|
|
2408
|
-
*
|
|
2766
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic
|
|
2767
|
+
* Labels</a>.</p>
|
|
2409
2768
|
* @public
|
|
2410
2769
|
*/
|
|
2411
2770
|
export interface LabelOptions {
|
|
2412
2771
|
/**
|
|
2413
2772
|
* <p>The time zone to use for metric data return in this operation. The format is
|
|
2414
|
-
*
|
|
2773
|
+
* <code>+</code> or <code>-</code> followed by four digits. The first two digits
|
|
2415
2774
|
* indicate the number of hours ahead or behind of UTC, and the final two digits are the
|
|
2416
2775
|
* number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
|
|
2417
2776
|
* minutes ahead of UTC. The default is +0000. </p>
|
|
@@ -2450,8 +2809,8 @@ export interface GetMetricDataInput {
|
|
|
2450
2809
|
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2451
2810
|
* </li>
|
|
2452
2811
|
* </ul>
|
|
2453
|
-
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
2454
|
-
* rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
2812
|
+
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
2813
|
+
* is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
2455
2814
|
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2456
2815
|
* previous 10-second period, the start time of your request is rounded down and you
|
|
2457
2816
|
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
@@ -2511,9 +2870,9 @@ export interface GetMetricDataInput {
|
|
|
2511
2870
|
* <p>A message returned by the <code>GetMetricData</code>API, including a code and a
|
|
2512
2871
|
* description.</p>
|
|
2513
2872
|
* <p>If a cross-Region <code>GetMetricData</code> operation fails with a code of
|
|
2514
|
-
*
|
|
2873
|
+
* <code>Forbidden</code> and a value of <code>Authentication too complex to retrieve
|
|
2515
2874
|
* cross region data</code>, you can correct the problem by running the
|
|
2516
|
-
*
|
|
2875
|
+
* <code>GetMetricData</code> operation in the same Region where the metric data
|
|
2517
2876
|
* is.</p>
|
|
2518
2877
|
* @public
|
|
2519
2878
|
*/
|
|
@@ -2565,8 +2924,8 @@ export interface MetricDataResult {
|
|
|
2565
2924
|
* in the requested time range were returned. <code>PartialData</code> means that an
|
|
2566
2925
|
* incomplete set of data points were returned. You can use the <code>NextToken</code>
|
|
2567
2926
|
* value that was returned and repeat your request to get more data points.
|
|
2568
|
-
*
|
|
2569
|
-
*
|
|
2927
|
+
* <code>NextToken</code> is not returned if you are performing a math expression.
|
|
2928
|
+
* <code>InternalError</code> indicates that an error occurred. Retry your request
|
|
2570
2929
|
* using <code>NextToken</code>, if present.</p>
|
|
2571
2930
|
* @public
|
|
2572
2931
|
*/
|
|
@@ -2624,7 +2983,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2624
2983
|
* separate metric. If a specific combination of dimensions was not published, you can't
|
|
2625
2984
|
* retrieve statistics for it. You must specify the same dimensions that were used when the
|
|
2626
2985
|
* metrics were created. For an example, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations">Dimension Combinations</a> in the <i>Amazon CloudWatch User
|
|
2627
|
-
*
|
|
2986
|
+
* Guide</i>. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the <i>Amazon CloudWatch User
|
|
2628
2987
|
* Guide</i>.</p>
|
|
2629
2988
|
* @public
|
|
2630
2989
|
*/
|
|
@@ -2650,8 +3009,8 @@ export interface GetMetricStatisticsInput {
|
|
|
2650
3009
|
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2651
3010
|
* </li>
|
|
2652
3011
|
* </ul>
|
|
2653
|
-
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
2654
|
-
* rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
3012
|
+
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
3013
|
+
* is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
2655
3014
|
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2656
3015
|
* previous 10-second period, the start time of your request is rounded down and you
|
|
2657
3016
|
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
@@ -2674,7 +3033,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2674
3033
|
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
2675
3034
|
* minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution
|
|
2676
3035
|
* metrics are those metrics stored by a <code>PutMetricData</code> call that includes a
|
|
2677
|
-
*
|
|
3036
|
+
* <code>StorageResolution</code> of 1 second.</p>
|
|
2678
3037
|
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
2679
3038
|
* 3 hours ago, you must specify the period as follows or no data points in that time range
|
|
2680
3039
|
* is returned:</p>
|
|
@@ -2697,7 +3056,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2697
3056
|
Period: number | undefined;
|
|
2698
3057
|
/**
|
|
2699
3058
|
* <p>The metric statistics, other than percentile. For percentile statistics, use
|
|
2700
|
-
*
|
|
3059
|
+
* <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you
|
|
2701
3060
|
* must specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not
|
|
2702
3061
|
* both.</p>
|
|
2703
3062
|
* @public
|
|
@@ -2705,8 +3064,8 @@ export interface GetMetricStatisticsInput {
|
|
|
2705
3064
|
Statistics?: Statistic[] | undefined;
|
|
2706
3065
|
/**
|
|
2707
3066
|
* <p>The percentile statistics. Specify values between p0.0 and p100. When calling
|
|
2708
|
-
*
|
|
2709
|
-
*
|
|
3067
|
+
* <code>GetMetricStatistics</code>, you must specify either <code>Statistics</code> or
|
|
3068
|
+
* <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
|
|
2710
3069
|
* available for metrics when any of the metric values are negative numbers.</p>
|
|
2711
3070
|
* @public
|
|
2712
3071
|
*/
|
|
@@ -2794,11 +3153,11 @@ export interface MetricStreamStatisticsMetric {
|
|
|
2794
3153
|
}
|
|
2795
3154
|
/**
|
|
2796
3155
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
2797
|
-
*
|
|
3156
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
2798
3157
|
* streamed. This structure contains information for one metric that includes additional
|
|
2799
3158
|
* statistics in the stream. For more information about statistics, see CloudWatch,
|
|
2800
3159
|
* listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2801
|
-
*
|
|
3160
|
+
* CloudWatch statistics definitions</a>.</p>
|
|
2802
3161
|
* @public
|
|
2803
3162
|
*/
|
|
2804
3163
|
export interface MetricStreamStatisticsConfiguration {
|
|
@@ -2816,14 +3175,14 @@ export interface MetricStreamStatisticsConfiguration {
|
|
|
2816
3175
|
* the <code>IncludeMetrics</code> array in this structure. This list can include as many
|
|
2817
3176
|
* as 20 statistics.</p>
|
|
2818
3177
|
* <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry1.0</code> or
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
3178
|
+
* <code>opentelemetry0.7</code>, the only valid values are
|
|
3179
|
+
* <code>p<i>??</i>
|
|
2821
3180
|
* </code> percentile statistics such as
|
|
2822
|
-
*
|
|
3181
|
+
* <code>p90</code>, <code>p99</code> and so on.</p>
|
|
2823
3182
|
* <p>If the <code>OutputFormat</code> for the stream is <code>json</code>, the valid values
|
|
2824
3183
|
* include the abbreviations for all of the statistics listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2825
3184
|
* CloudWatch statistics definitions</a>. For example, this includes
|
|
2826
|
-
*
|
|
3185
|
+
* <code>tm98, </code>
|
|
2827
3186
|
* <code>wm90</code>, <code>PR(:300)</code>, and so on.</p>
|
|
2828
3187
|
* @public
|
|
2829
3188
|
*/
|
|
@@ -2869,7 +3228,7 @@ export interface GetMetricStreamOutput {
|
|
|
2869
3228
|
RoleArn?: string | undefined;
|
|
2870
3229
|
/**
|
|
2871
3230
|
* <p>The state of the metric stream. The possible values are <code>running</code> and
|
|
2872
|
-
*
|
|
3231
|
+
* <code>stopped</code>.</p>
|
|
2873
3232
|
* @public
|
|
2874
3233
|
*/
|
|
2875
3234
|
State?: string | undefined;
|
|
@@ -2885,7 +3244,7 @@ export interface GetMetricStreamOutput {
|
|
|
2885
3244
|
LastUpdateDate?: Date | undefined;
|
|
2886
3245
|
/**
|
|
2887
3246
|
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
2888
|
-
*
|
|
3247
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
2889
3248
|
* information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">Metric streams output formats</a>.</p>
|
|
2890
3249
|
* @public
|
|
2891
3250
|
*/
|
|
@@ -2914,8 +3273,8 @@ export interface GetMetricWidgetImageInput {
|
|
|
2914
3273
|
* <p>A JSON string that defines the bitmap graph to be retrieved. The string includes
|
|
2915
3274
|
* the metrics to include in the graph, statistics, annotations, title, axis limits, and so
|
|
2916
3275
|
* on. You can include only one <code>MetricWidget</code> parameter in each
|
|
2917
|
-
*
|
|
2918
|
-
* <p>For more information about the syntax of <code>MetricWidget</code> see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
3276
|
+
* <code>GetMetricWidgetImage</code> call.</p>
|
|
3277
|
+
* <p>For more information about the syntax of <code>MetricWidget</code> see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Widget-Structure.html">GetMetricWidgetImage: Metric Widget Structure and Syntax</a>.</p>
|
|
2919
3278
|
* <p>If any metric on the graph could not load all the requested data points, an orange
|
|
2920
3279
|
* triangle with an exclamation point appears next to the graph legend.</p>
|
|
2921
3280
|
* @public
|
|
@@ -2959,7 +3318,7 @@ export interface GetMetricWidgetImageInput {
|
|
|
2959
3318
|
* </p>
|
|
2960
3319
|
* <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For
|
|
2961
3320
|
* most use cases, and all actions using an Amazon Web Services SDK, you should use
|
|
2962
|
-
*
|
|
3321
|
+
* <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a
|
|
2963
3322
|
* content-type set to <code>image/png</code>, and the body of the response is a PNG
|
|
2964
3323
|
* image.</p>
|
|
2965
3324
|
* @public
|
|
@@ -2988,8 +3347,8 @@ export interface GetOTelEnrichmentInput {
|
|
|
2988
3347
|
export interface GetOTelEnrichmentOutput {
|
|
2989
3348
|
/**
|
|
2990
3349
|
* <p>The status of OTel enrichment for the account. Valid values are
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
3350
|
+
* <code>Running</code> (enrichment is enabled) and <code>Stopped</code> (enrichment is
|
|
3351
|
+
* disabled).</p>
|
|
2993
3352
|
* @public
|
|
2994
3353
|
*/
|
|
2995
3354
|
Status: OTelEnrichmentStatus | undefined;
|
|
@@ -2999,22 +3358,26 @@ export interface GetOTelEnrichmentOutput {
|
|
|
2999
3358
|
*/
|
|
3000
3359
|
export interface ListAlarmMuteRulesInput {
|
|
3001
3360
|
/**
|
|
3002
|
-
* <p>Filter results to show only mute rules that target the specified alarm
|
|
3361
|
+
* <p>Filter results to show only mute rules that target the specified alarm
|
|
3362
|
+
* name.</p>
|
|
3003
3363
|
* @public
|
|
3004
3364
|
*/
|
|
3005
3365
|
AlarmName?: string | undefined;
|
|
3006
3366
|
/**
|
|
3007
|
-
* <p>Filter results to show only mute rules with the specified statuses. Valid values
|
|
3367
|
+
* <p>Filter results to show only mute rules with the specified statuses. Valid values
|
|
3368
|
+
* are <code>SCHEDULED</code>, <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
|
|
3008
3369
|
* @public
|
|
3009
3370
|
*/
|
|
3010
3371
|
Statuses?: AlarmMuteRuleStatus[] | undefined;
|
|
3011
3372
|
/**
|
|
3012
|
-
* <p>The maximum number of mute rules to return in one call. The default is
|
|
3373
|
+
* <p>The maximum number of mute rules to return in one call. The default is
|
|
3374
|
+
* 50.</p>
|
|
3013
3375
|
* @public
|
|
3014
3376
|
*/
|
|
3015
3377
|
MaxRecords?: number | undefined;
|
|
3016
3378
|
/**
|
|
3017
|
-
* <p>The token returned from a previous call to indicate where to continue retrieving
|
|
3379
|
+
* <p>The token returned from a previous call to indicate where to continue retrieving
|
|
3380
|
+
* results.</p>
|
|
3018
3381
|
* @public
|
|
3019
3382
|
*/
|
|
3020
3383
|
NextToken?: string | undefined;
|
|
@@ -3029,7 +3392,8 @@ export interface ListAlarmMuteRulesOutput {
|
|
|
3029
3392
|
*/
|
|
3030
3393
|
AlarmMuteRuleSummaries?: AlarmMuteRuleSummary[] | undefined;
|
|
3031
3394
|
/**
|
|
3032
|
-
* <p>The token to use when requesting the next set of results. If this field is absent,
|
|
3395
|
+
* <p>The token to use when requesting the next set of results. If this field is absent,
|
|
3396
|
+
* there are no more results to retrieve.</p>
|
|
3033
3397
|
* @public
|
|
3034
3398
|
*/
|
|
3035
3399
|
NextToken?: string | undefined;
|
|
@@ -3097,7 +3461,7 @@ export interface ListManagedInsightRulesInput {
|
|
|
3097
3461
|
export interface ManagedRuleState {
|
|
3098
3462
|
/**
|
|
3099
3463
|
* <p> The name of the Contributor Insights rule that contains data for the specified
|
|
3100
|
-
*
|
|
3464
|
+
* Amazon Web Services resource. </p>
|
|
3101
3465
|
* @public
|
|
3102
3466
|
*/
|
|
3103
3467
|
RuleName: string | undefined;
|
|
@@ -3109,14 +3473,14 @@ export interface ManagedRuleState {
|
|
|
3109
3473
|
}
|
|
3110
3474
|
/**
|
|
3111
3475
|
* <p> Contains information about managed Contributor Insights rules, as returned by
|
|
3112
|
-
*
|
|
3476
|
+
* <code>ListManagedInsightRules</code>.
|
|
3113
3477
|
* </p>
|
|
3114
3478
|
* @public
|
|
3115
3479
|
*/
|
|
3116
3480
|
export interface ManagedRuleDescription {
|
|
3117
3481
|
/**
|
|
3118
3482
|
* <p> The template name for the managed rule. Used to enable managed rules using
|
|
3119
|
-
*
|
|
3483
|
+
* <code>PutManagedInsightRules</code>. </p>
|
|
3120
3484
|
* @public
|
|
3121
3485
|
*/
|
|
3122
3486
|
TemplateName?: string | undefined;
|
|
@@ -3168,8 +3532,9 @@ export interface ListMetricsInput {
|
|
|
3168
3532
|
*/
|
|
3169
3533
|
MetricName?: string | undefined;
|
|
3170
3534
|
/**
|
|
3171
|
-
* <p>The dimensions to filter against. Only the dimension with names that match exactly
|
|
3172
|
-
* returned. If you specify one dimension name and a metric has that dimension and
|
|
3535
|
+
* <p>The dimensions to filter against. Only the dimension with names that match exactly
|
|
3536
|
+
* will be returned. If you specify one dimension name and a metric has that dimension and
|
|
3537
|
+
* also other dimensions, it will be returned.</p>
|
|
3173
3538
|
* @public
|
|
3174
3539
|
*/
|
|
3175
3540
|
Dimensions?: DimensionFilter[] | undefined;
|
|
@@ -3278,13 +3643,13 @@ export interface MetricStreamEntry {
|
|
|
3278
3643
|
FirehoseArn?: string | undefined;
|
|
3279
3644
|
/**
|
|
3280
3645
|
* <p>The current state of this stream. Valid values are <code>running</code> and
|
|
3281
|
-
*
|
|
3646
|
+
* <code>stopped</code>.</p>
|
|
3282
3647
|
* @public
|
|
3283
3648
|
*/
|
|
3284
3649
|
State?: string | undefined;
|
|
3285
3650
|
/**
|
|
3286
3651
|
* <p>The output format of this metric stream. Valid values are <code>json</code>,
|
|
3287
|
-
*
|
|
3652
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>.</p>
|
|
3288
3653
|
* @public
|
|
3289
3654
|
*/
|
|
3290
3655
|
OutputFormat?: MetricStreamOutputFormat | undefined;
|
|
@@ -3312,19 +3677,19 @@ export interface ListTagsForResourceInput {
|
|
|
3312
3677
|
/**
|
|
3313
3678
|
* <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
|
|
3314
3679
|
* <p>The ARN format of an alarm is
|
|
3315
|
-
*
|
|
3680
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
3316
3681
|
* </code>
|
|
3317
3682
|
* </p>
|
|
3318
3683
|
* <p>The ARN format of a Contributor Insights rule is
|
|
3319
|
-
*
|
|
3684
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
3320
3685
|
* </code>
|
|
3321
3686
|
* </p>
|
|
3322
3687
|
* <p>The ARN format of a dashboard is
|
|
3323
|
-
*
|
|
3688
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
3324
3689
|
* </code>
|
|
3325
3690
|
* </p>
|
|
3326
3691
|
* <p>The ARN format of a metric stream is
|
|
3327
|
-
*
|
|
3692
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
3328
3693
|
* </code>
|
|
3329
3694
|
* </p>
|
|
3330
3695
|
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|
|
@@ -3333,23 +3698,6 @@ export interface ListTagsForResourceInput {
|
|
|
3333
3698
|
*/
|
|
3334
3699
|
ResourceARN: string | undefined;
|
|
3335
3700
|
}
|
|
3336
|
-
/**
|
|
3337
|
-
* <p>A key-value pair associated with a CloudWatch resource.</p>
|
|
3338
|
-
* @public
|
|
3339
|
-
*/
|
|
3340
|
-
export interface Tag {
|
|
3341
|
-
/**
|
|
3342
|
-
* <p>A string that you can use to assign a value. The combination of tag keys and values
|
|
3343
|
-
* can help you organize and categorize your resources.</p>
|
|
3344
|
-
* @public
|
|
3345
|
-
*/
|
|
3346
|
-
Key: string | undefined;
|
|
3347
|
-
/**
|
|
3348
|
-
* <p>The value for the specified tag key.</p>
|
|
3349
|
-
* @public
|
|
3350
|
-
*/
|
|
3351
|
-
Value: string | undefined;
|
|
3352
|
-
}
|
|
3353
3701
|
/**
|
|
3354
3702
|
* @public
|
|
3355
3703
|
*/
|
|
@@ -3385,17 +3733,24 @@ export interface PutAlarmMuteRuleInput {
|
|
|
3385
3733
|
*/
|
|
3386
3734
|
MuteTargets?: MuteTargets | undefined;
|
|
3387
3735
|
/**
|
|
3388
|
-
* <p>A list of key-value pairs to associate with the alarm mute rule. You can use tags
|
|
3736
|
+
* <p>A list of key-value pairs to associate with the alarm mute rule. You can use tags
|
|
3737
|
+
* to categorize and manage your mute rules.</p>
|
|
3389
3738
|
* @public
|
|
3390
3739
|
*/
|
|
3391
3740
|
Tags?: Tag[] | undefined;
|
|
3392
3741
|
/**
|
|
3393
|
-
* <p>The date and time after which the mute rule takes effect, specified as a timestamp
|
|
3742
|
+
* <p>The date and time after which the mute rule takes effect, specified as a timestamp
|
|
3743
|
+
* in ISO 8601 format (for example, <code>2026-04-15T08:00:00Z</code>). If not specified,
|
|
3744
|
+
* the mute rule takes effect immediately upon creation and the mutes are applied as per
|
|
3745
|
+
* the schedule expression.</p>
|
|
3394
3746
|
* @public
|
|
3395
3747
|
*/
|
|
3396
3748
|
StartDate?: Date | undefined;
|
|
3397
3749
|
/**
|
|
3398
|
-
* <p>The date and time when the mute rule expires and is no longer evaluated, specified
|
|
3750
|
+
* <p>The date and time when the mute rule expires and is no longer evaluated, specified
|
|
3751
|
+
* as a timestamp in ISO 8601 format (for example, <code>2026-12-31T23:59:59Z</code>).
|
|
3752
|
+
* After this time, the rule status becomes EXPIRED and will no longer mute the targeted
|
|
3753
|
+
* alarms.</p>
|
|
3399
3754
|
* @public
|
|
3400
3755
|
*/
|
|
3401
3756
|
ExpireDate?: Date | undefined;
|
|
@@ -3442,7 +3797,7 @@ export interface PutAnomalyDetectorInput {
|
|
|
3442
3797
|
Configuration?: AnomalyDetectorConfiguration | undefined;
|
|
3443
3798
|
/**
|
|
3444
3799
|
* <p>Use this object to include parameters to provide information about your metric to
|
|
3445
|
-
*
|
|
3800
|
+
* CloudWatch to help it build more accurate anomaly detection models.
|
|
3446
3801
|
* Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>
|
|
3447
3802
|
* @public
|
|
3448
3803
|
*/
|
|
@@ -3474,12 +3829,12 @@ export interface PutAnomalyDetectorInput {
|
|
|
3474
3829
|
* </li>
|
|
3475
3830
|
* <li>
|
|
3476
3831
|
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
3477
|
-
*
|
|
3832
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3478
3833
|
* </p>
|
|
3479
3834
|
* </li>
|
|
3480
3835
|
* </ul>
|
|
3481
3836
|
* <p>Instead, specify the single metric anomaly detector attributes as part of the property
|
|
3482
|
-
*
|
|
3837
|
+
* <code>SingleMetricAnomalyDetector</code>.</p>
|
|
3483
3838
|
* @public
|
|
3484
3839
|
*/
|
|
3485
3840
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
|
|
@@ -3510,12 +3865,12 @@ export interface PutAnomalyDetectorInput {
|
|
|
3510
3865
|
* </li>
|
|
3511
3866
|
* <li>
|
|
3512
3867
|
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
3513
|
-
*
|
|
3868
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3514
3869
|
* </p>
|
|
3515
3870
|
* </li>
|
|
3516
3871
|
* </ul>
|
|
3517
3872
|
* <p>Instead, specify the metric math anomaly detector attributes as part of the property
|
|
3518
|
-
*
|
|
3873
|
+
* <code>MetricMathAnomalyDetector</code>.</p>
|
|
3519
3874
|
* @public
|
|
3520
3875
|
*/
|
|
3521
3876
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
|
|
@@ -3553,19 +3908,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3553
3908
|
* <ul>
|
|
3554
3909
|
* <li>
|
|
3555
3910
|
* <p>Invoke the latest version of a Lambda function:
|
|
3556
|
-
*
|
|
3911
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3557
3912
|
* </code>
|
|
3558
3913
|
* </p>
|
|
3559
3914
|
* </li>
|
|
3560
3915
|
* <li>
|
|
3561
3916
|
* <p>Invoke a specific version of a Lambda function:
|
|
3562
|
-
*
|
|
3917
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3563
3918
|
* </code>
|
|
3564
3919
|
* </p>
|
|
3565
3920
|
* </li>
|
|
3566
3921
|
* <li>
|
|
3567
3922
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3568
|
-
*
|
|
3923
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3569
3924
|
* </code>
|
|
3570
3925
|
* </p>
|
|
3571
3926
|
* </li>
|
|
@@ -3578,7 +3933,8 @@ export interface PutCompositeAlarmInput {
|
|
|
3578
3933
|
* </code>
|
|
3579
3934
|
* </p>
|
|
3580
3935
|
* <p>
|
|
3581
|
-
* <b>Start a Amazon Q Developer operational
|
|
3936
|
+
* <b>Start a Amazon Q Developer operational
|
|
3937
|
+
* investigation</b>
|
|
3582
3938
|
* </p>
|
|
3583
3939
|
* <p>
|
|
3584
3940
|
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i>
|
|
@@ -3612,19 +3968,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3612
3968
|
* <li>
|
|
3613
3969
|
* <p>
|
|
3614
3970
|
* <code>ALARM("<i>alarm-name</i> or
|
|
3615
|
-
*
|
|
3971
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3616
3972
|
* ALARM state.</p>
|
|
3617
3973
|
* </li>
|
|
3618
3974
|
* <li>
|
|
3619
3975
|
* <p>
|
|
3620
3976
|
* <code>OK("<i>alarm-name</i> or
|
|
3621
|
-
*
|
|
3977
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in OK
|
|
3622
3978
|
* state.</p>
|
|
3623
3979
|
* </li>
|
|
3624
3980
|
* <li>
|
|
3625
3981
|
* <p>
|
|
3626
3982
|
* <code>INSUFFICIENT_DATA("<i>alarm-name</i> or
|
|
3627
|
-
*
|
|
3983
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3628
3984
|
* INSUFFICIENT_DATA state.</p>
|
|
3629
3985
|
* </li>
|
|
3630
3986
|
* <li>
|
|
@@ -3658,7 +4014,7 @@ export interface PutCompositeAlarmInput {
|
|
|
3658
4014
|
* <li>
|
|
3659
4015
|
* <p>
|
|
3660
4016
|
* <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
|
|
3661
|
-
*
|
|
4017
|
+
* OK(NetworkOutTooHigh)</code> goes into ALARM state if CPUUtilizationTooHigh
|
|
3662
4018
|
* OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
|
|
3663
4019
|
* state. This provides another example of using a composite alarm to prevent
|
|
3664
4020
|
* noise. This rule ensures that you are not notified with an alarm action on high
|
|
@@ -3666,14 +4022,14 @@ export interface PutCompositeAlarmInput {
|
|
|
3666
4022
|
* </li>
|
|
3667
4023
|
* </ul>
|
|
3668
4024
|
* <p>The <code>AlarmRule</code> can specify as many as 100 "children" alarms. The
|
|
3669
|
-
*
|
|
4025
|
+
* <code>AlarmRule</code> expression can have as many as 500 elements. Elements are
|
|
3670
4026
|
* child alarms, TRUE or FALSE statements, and parentheses.</p>
|
|
3671
4027
|
* @public
|
|
3672
4028
|
*/
|
|
3673
4029
|
AlarmRule: string | undefined;
|
|
3674
4030
|
/**
|
|
3675
4031
|
* <p>The actions to execute when this alarm transitions to the
|
|
3676
|
-
*
|
|
4032
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
3677
4033
|
* as an Amazon Resource Name (ARN).</p>
|
|
3678
4034
|
* <p>Valid Values: ]</p>
|
|
3679
4035
|
* <p>
|
|
@@ -3689,19 +4045,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3689
4045
|
* <ul>
|
|
3690
4046
|
* <li>
|
|
3691
4047
|
* <p>Invoke the latest version of a Lambda function:
|
|
3692
|
-
*
|
|
4048
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3693
4049
|
* </code>
|
|
3694
4050
|
* </p>
|
|
3695
4051
|
* </li>
|
|
3696
4052
|
* <li>
|
|
3697
4053
|
* <p>Invoke a specific version of a Lambda function:
|
|
3698
|
-
*
|
|
4054
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3699
4055
|
* </code>
|
|
3700
4056
|
* </p>
|
|
3701
4057
|
* </li>
|
|
3702
4058
|
* <li>
|
|
3703
4059
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3704
|
-
*
|
|
4060
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3705
4061
|
* </code>
|
|
3706
4062
|
* </p>
|
|
3707
4063
|
* </li>
|
|
@@ -3726,19 +4082,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3726
4082
|
* <ul>
|
|
3727
4083
|
* <li>
|
|
3728
4084
|
* <p>Invoke the latest version of a Lambda function:
|
|
3729
|
-
*
|
|
4085
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3730
4086
|
* </code>
|
|
3731
4087
|
* </p>
|
|
3732
4088
|
* </li>
|
|
3733
4089
|
* <li>
|
|
3734
4090
|
* <p>Invoke a specific version of a Lambda function:
|
|
3735
|
-
*
|
|
4091
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3736
4092
|
* </code>
|
|
3737
4093
|
* </p>
|
|
3738
4094
|
* </li>
|
|
3739
4095
|
* <li>
|
|
3740
4096
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3741
|
-
*
|
|
4097
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3742
4098
|
* </code>
|
|
3743
4099
|
* </p>
|
|
3744
4100
|
* </li>
|
|
@@ -3805,7 +4161,7 @@ export interface PutDashboardInput {
|
|
|
3805
4161
|
/**
|
|
3806
4162
|
* <p>The detailed information about the dashboard in JSON format, including the widgets
|
|
3807
4163
|
* to include and their location on the dashboard. This parameter is required.</p>
|
|
3808
|
-
* <p>For more information about the syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
4164
|
+
* <p>For more information about the syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
|
|
3809
4165
|
* @public
|
|
3810
4166
|
*/
|
|
3811
4167
|
DashboardBody: string | undefined;
|
|
@@ -3816,9 +4172,9 @@ export interface PutDashboardInput {
|
|
|
3816
4172
|
* scope user permissions by granting a user permission to access or change only dashboards
|
|
3817
4173
|
* with certain tag values.</p>
|
|
3818
4174
|
* <p>You can use this parameter only when creating a new dashboard. If you specify
|
|
3819
|
-
*
|
|
3820
|
-
* add or update tags on an existing dashboard, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.
|
|
3821
|
-
* remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4175
|
+
* <code>Tags</code> when updating an existing dashboard, the tag updates are ignored.
|
|
4176
|
+
* To add or update tags on an existing dashboard, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.
|
|
4177
|
+
* To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
3822
4178
|
* @public
|
|
3823
4179
|
*/
|
|
3824
4180
|
Tags?: Tag[] | undefined;
|
|
@@ -3855,7 +4211,7 @@ export interface PutInsightRuleInput {
|
|
|
3855
4211
|
RuleState?: string | undefined;
|
|
3856
4212
|
/**
|
|
3857
4213
|
* <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
|
|
3858
|
-
*
|
|
4214
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights Rule Syntax</a>.</p>
|
|
3859
4215
|
* @public
|
|
3860
4216
|
*/
|
|
3861
4217
|
RuleDefinition: string | undefined;
|
|
@@ -3866,8 +4222,8 @@ export interface PutInsightRuleInput {
|
|
|
3866
4222
|
* scope user permissions, by granting a user permission to access or change only the
|
|
3867
4223
|
* resources that have certain tag values.</p>
|
|
3868
4224
|
* <p>To be able to associate tags with a rule, you must have the
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
4225
|
+
* <code>cloudwatch:TagResource</code> permission in addition to the
|
|
4226
|
+
* <code>cloudwatch:PutInsightRule</code> permission.</p>
|
|
3871
4227
|
* <p>If you are using this operation to update an existing Contributor Insights rule, any
|
|
3872
4228
|
* tags you specify in this parameter are ignored. To change the tags of an existing rule,
|
|
3873
4229
|
* use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
@@ -3875,16 +4231,18 @@ export interface PutInsightRuleInput {
|
|
|
3875
4231
|
*/
|
|
3876
4232
|
Tags?: Tag[] | undefined;
|
|
3877
4233
|
/**
|
|
3878
|
-
* <p>Specify <code>true</code> to have this rule evaluate log events after they have been
|
|
3879
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
3880
|
-
*
|
|
3881
|
-
*
|
|
4234
|
+
* <p>Specify <code>true</code> to have this rule evaluate log events after they have been
|
|
4235
|
+
* transformed by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
4236
|
+
* transformation</a>. If you specify <code>true</code>, then the log events in log
|
|
4237
|
+
* groups that have transformers will be evaluated by Contributor Insights after being
|
|
4238
|
+
* transformed. Log groups that don't have transformers will still have their original log
|
|
4239
|
+
* events evaluated by Contributor Insights.</p>
|
|
3882
4240
|
* <p>The default is <code>false</code>
|
|
3883
4241
|
* </p>
|
|
3884
4242
|
* <note>
|
|
3885
|
-
* <p>If a log group has a transformer, and transformation fails for some log events,
|
|
3886
|
-
*
|
|
3887
|
-
*
|
|
4243
|
+
* <p>If a log group has a transformer, and transformation fails for some log events,
|
|
4244
|
+
* those log events won't be evaluated by Contributor Insights. For information about
|
|
4245
|
+
* investigating log transformation failures, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Transformation-Errors-Metrics.html">Transformation metrics and errors</a>.</p>
|
|
3888
4246
|
* </note>
|
|
3889
4247
|
* @public
|
|
3890
4248
|
*/
|
|
@@ -3895,6 +4253,189 @@ export interface PutInsightRuleInput {
|
|
|
3895
4253
|
*/
|
|
3896
4254
|
export interface PutInsightRuleOutput {
|
|
3897
4255
|
}
|
|
4256
|
+
/**
|
|
4257
|
+
* @public
|
|
4258
|
+
*/
|
|
4259
|
+
export interface PutLogAlarmInput {
|
|
4260
|
+
/**
|
|
4261
|
+
* <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
|
|
4262
|
+
* @public
|
|
4263
|
+
*/
|
|
4264
|
+
AlarmName: string | undefined;
|
|
4265
|
+
/**
|
|
4266
|
+
* <p>The description for the alarm.</p>
|
|
4267
|
+
* @public
|
|
4268
|
+
*/
|
|
4269
|
+
AlarmDescription?: string | undefined;
|
|
4270
|
+
/**
|
|
4271
|
+
* <p>The configuration of the underlying CloudWatch Logs scheduled query that this alarm evaluates, including the query string, log groups, schedule, and aggregation expression.</p>
|
|
4272
|
+
* @public
|
|
4273
|
+
*/
|
|
4274
|
+
ScheduledQueryConfiguration: ScheduledQueryConfiguration | undefined;
|
|
4275
|
+
/**
|
|
4276
|
+
* <p>The number of log lines from the most recent scheduled query execution to include in alarm action notifications. Valid range is 0 through 50. The default is 0, which means no log lines are included.</p>
|
|
4277
|
+
* @public
|
|
4278
|
+
*/
|
|
4279
|
+
ActionLogLineCount?: number | undefined;
|
|
4280
|
+
/**
|
|
4281
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Required when <code>ActionLogLineCount</code> is greater than 0.</p>
|
|
4282
|
+
* @public
|
|
4283
|
+
*/
|
|
4284
|
+
ActionLogLineRoleArn?: string | undefined;
|
|
4285
|
+
/**
|
|
4286
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
|
|
4287
|
+
* @public
|
|
4288
|
+
*/
|
|
4289
|
+
ActionsEnabled?: boolean | undefined;
|
|
4290
|
+
/**
|
|
4291
|
+
* <p>The actions to execute when this alarm transitions to the <code>OK</code> state
|
|
4292
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4293
|
+
* <p>Valid Values:</p>
|
|
4294
|
+
* <p>
|
|
4295
|
+
* <b>Amazon SNS actions:</b>
|
|
4296
|
+
* </p>
|
|
4297
|
+
* <p>
|
|
4298
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4299
|
+
* </code>
|
|
4300
|
+
* </p>
|
|
4301
|
+
* <p>
|
|
4302
|
+
* <b>Lambda actions:</b>
|
|
4303
|
+
* </p>
|
|
4304
|
+
* <ul>
|
|
4305
|
+
* <li>
|
|
4306
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4307
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4308
|
+
* </code>
|
|
4309
|
+
* </p>
|
|
4310
|
+
* </li>
|
|
4311
|
+
* <li>
|
|
4312
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4313
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4314
|
+
* </code>
|
|
4315
|
+
* </p>
|
|
4316
|
+
* </li>
|
|
4317
|
+
* <li>
|
|
4318
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4319
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4320
|
+
* </code>
|
|
4321
|
+
* </p>
|
|
4322
|
+
* </li>
|
|
4323
|
+
* </ul>
|
|
4324
|
+
* @public
|
|
4325
|
+
*/
|
|
4326
|
+
OKActions?: string[] | undefined;
|
|
4327
|
+
/**
|
|
4328
|
+
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
4329
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4330
|
+
* <p>Valid Values:</p>
|
|
4331
|
+
* <p>
|
|
4332
|
+
* <b>Amazon SNS actions:</b>
|
|
4333
|
+
* </p>
|
|
4334
|
+
* <p>
|
|
4335
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4336
|
+
* </code>
|
|
4337
|
+
* </p>
|
|
4338
|
+
* <p>
|
|
4339
|
+
* <b>Lambda actions:</b>
|
|
4340
|
+
* </p>
|
|
4341
|
+
* <ul>
|
|
4342
|
+
* <li>
|
|
4343
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4344
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4345
|
+
* </code>
|
|
4346
|
+
* </p>
|
|
4347
|
+
* </li>
|
|
4348
|
+
* <li>
|
|
4349
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4350
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4351
|
+
* </code>
|
|
4352
|
+
* </p>
|
|
4353
|
+
* </li>
|
|
4354
|
+
* <li>
|
|
4355
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4356
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4357
|
+
* </code>
|
|
4358
|
+
* </p>
|
|
4359
|
+
* </li>
|
|
4360
|
+
* </ul>
|
|
4361
|
+
* <p>
|
|
4362
|
+
* <b>Systems Manager actions:</b>
|
|
4363
|
+
* </p>
|
|
4364
|
+
* <p>
|
|
4365
|
+
* <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
|
|
4366
|
+
* </code>
|
|
4367
|
+
* </p>
|
|
4368
|
+
* @public
|
|
4369
|
+
*/
|
|
4370
|
+
AlarmActions?: string[] | undefined;
|
|
4371
|
+
/**
|
|
4372
|
+
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state
|
|
4373
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4374
|
+
* <p>Valid Values:</p>
|
|
4375
|
+
* <p>
|
|
4376
|
+
* <b>Amazon SNS actions:</b>
|
|
4377
|
+
* </p>
|
|
4378
|
+
* <p>
|
|
4379
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4380
|
+
* </code>
|
|
4381
|
+
* </p>
|
|
4382
|
+
* <p>
|
|
4383
|
+
* <b>Lambda actions:</b>
|
|
4384
|
+
* </p>
|
|
4385
|
+
* <ul>
|
|
4386
|
+
* <li>
|
|
4387
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4388
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4389
|
+
* </code>
|
|
4390
|
+
* </p>
|
|
4391
|
+
* </li>
|
|
4392
|
+
* <li>
|
|
4393
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4394
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4395
|
+
* </code>
|
|
4396
|
+
* </p>
|
|
4397
|
+
* </li>
|
|
4398
|
+
* <li>
|
|
4399
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4400
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4401
|
+
* </code>
|
|
4402
|
+
* </p>
|
|
4403
|
+
* </li>
|
|
4404
|
+
* </ul>
|
|
4405
|
+
* @public
|
|
4406
|
+
*/
|
|
4407
|
+
InsufficientDataActions?: string[] | undefined;
|
|
4408
|
+
/**
|
|
4409
|
+
* <p>The number of most recent scheduled query results to evaluate against the threshold (the N in M-of-N evaluation). Valid range is 1 through 100.</p>
|
|
4410
|
+
* @public
|
|
4411
|
+
*/
|
|
4412
|
+
QueryResultsToEvaluate: number | undefined;
|
|
4413
|
+
/**
|
|
4414
|
+
* <p>The number of query results, out of the most recent <code>QueryResultsToEvaluate</code> results, that must breach the threshold to trigger the alarm to transition to <code>ALARM</code> (the M in M-of-N evaluation). Must be less than or equal to <code>QueryResultsToEvaluate</code>.</p>
|
|
4415
|
+
* @public
|
|
4416
|
+
*/
|
|
4417
|
+
QueryResultsToAlarm: number | undefined;
|
|
4418
|
+
/**
|
|
4419
|
+
* <p>The value to compare with the aggregated query result.</p>
|
|
4420
|
+
* @public
|
|
4421
|
+
*/
|
|
4422
|
+
Threshold: number | undefined;
|
|
4423
|
+
/**
|
|
4424
|
+
* <p>The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand. Valid values are <code>GreaterThanThreshold</code>, <code>GreaterThanOrEqualToThreshold</code>, <code>LessThanThreshold</code>, and <code>LessThanOrEqualToThreshold</code>.</p>
|
|
4425
|
+
* @public
|
|
4426
|
+
*/
|
|
4427
|
+
ComparisonOperator: ComparisonOperator | undefined;
|
|
4428
|
+
/**
|
|
4429
|
+
* <p>Sets how this alarm is to handle missing data points. Valid values are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and <code>missing</code>. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
|
|
4430
|
+
* @public
|
|
4431
|
+
*/
|
|
4432
|
+
TreatMissingData?: string | undefined;
|
|
4433
|
+
/**
|
|
4434
|
+
* <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
|
|
4435
|
+
* @public
|
|
4436
|
+
*/
|
|
4437
|
+
Tags?: Tag[] | undefined;
|
|
4438
|
+
}
|
|
3898
4439
|
/**
|
|
3899
4440
|
* <p> Contains the information that's required to enable a managed Contributor Insights
|
|
3900
4441
|
* rule for an Amazon Web Services resource.
|
|
@@ -3905,7 +4446,7 @@ export interface PutInsightRuleOutput {
|
|
|
3905
4446
|
export interface ManagedRule {
|
|
3906
4447
|
/**
|
|
3907
4448
|
* <p> The template name for the managed Contributor Insights rule, as returned by
|
|
3908
|
-
*
|
|
4449
|
+
* <code>ListManagedInsightRules</code>. </p>
|
|
3909
4450
|
* @public
|
|
3910
4451
|
*/
|
|
3911
4452
|
TemplateName: string | undefined;
|
|
@@ -3924,7 +4465,7 @@ export interface ManagedRule {
|
|
|
3924
4465
|
* permission in addition to the <code>cloudwatch:PutInsightRule</code> permission. If you
|
|
3925
4466
|
* are using this operation to update an existing Contributor Insights rule, any tags that
|
|
3926
4467
|
* you specify in this parameter are ignored. To change the tags of an existing rule, use
|
|
3927
|
-
*
|
|
4468
|
+
* <code>TagResource</code>. </p>
|
|
3928
4469
|
* @public
|
|
3929
4470
|
*/
|
|
3930
4471
|
Tags?: Tag[] | undefined;
|
|
@@ -4037,19 +4578,19 @@ export interface PutMetricAlarmInput {
|
|
|
4037
4578
|
* <ul>
|
|
4038
4579
|
* <li>
|
|
4039
4580
|
* <p>Invoke the latest version of a Lambda function:
|
|
4040
|
-
*
|
|
4581
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4041
4582
|
* </code>
|
|
4042
4583
|
* </p>
|
|
4043
4584
|
* </li>
|
|
4044
4585
|
* <li>
|
|
4045
4586
|
* <p>Invoke a specific version of a Lambda function:
|
|
4046
|
-
*
|
|
4587
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4047
4588
|
* </code>
|
|
4048
4589
|
* </p>
|
|
4049
4590
|
* </li>
|
|
4050
4591
|
* <li>
|
|
4051
4592
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4052
|
-
*
|
|
4593
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4053
4594
|
* </code>
|
|
4054
4595
|
* </p>
|
|
4055
4596
|
* </li>
|
|
@@ -4151,19 +4692,19 @@ export interface PutMetricAlarmInput {
|
|
|
4151
4692
|
* <ul>
|
|
4152
4693
|
* <li>
|
|
4153
4694
|
* <p>Invoke the latest version of a Lambda function:
|
|
4154
|
-
*
|
|
4695
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4155
4696
|
* </code>
|
|
4156
4697
|
* </p>
|
|
4157
4698
|
* </li>
|
|
4158
4699
|
* <li>
|
|
4159
4700
|
* <p>Invoke a specific version of a Lambda function:
|
|
4160
|
-
*
|
|
4701
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4161
4702
|
* </code>
|
|
4162
4703
|
* </p>
|
|
4163
4704
|
* </li>
|
|
4164
4705
|
* <li>
|
|
4165
4706
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4166
|
-
*
|
|
4707
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4167
4708
|
* </code>
|
|
4168
4709
|
* </p>
|
|
4169
4710
|
* </li>
|
|
@@ -4197,7 +4738,8 @@ export interface PutMetricAlarmInput {
|
|
|
4197
4738
|
* </li>
|
|
4198
4739
|
* </ul>
|
|
4199
4740
|
* <p>
|
|
4200
|
-
* <b>Start a Amazon Q Developer operational
|
|
4741
|
+
* <b>Start a Amazon Q Developer operational
|
|
4742
|
+
* investigation</b>
|
|
4201
4743
|
* </p>
|
|
4202
4744
|
* <p>
|
|
4203
4745
|
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i>
|
|
@@ -4208,7 +4750,7 @@ export interface PutMetricAlarmInput {
|
|
|
4208
4750
|
AlarmActions?: string[] | undefined;
|
|
4209
4751
|
/**
|
|
4210
4752
|
* <p>The actions to execute when this alarm transitions to the
|
|
4211
|
-
*
|
|
4753
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
4212
4754
|
* as an Amazon Resource Name (ARN). Valid values:</p>
|
|
4213
4755
|
* <p>
|
|
4214
4756
|
* <b>EC2 actions:</b>
|
|
@@ -4272,19 +4814,19 @@ export interface PutMetricAlarmInput {
|
|
|
4272
4814
|
* <ul>
|
|
4273
4815
|
* <li>
|
|
4274
4816
|
* <p>Invoke the latest version of a Lambda function:
|
|
4275
|
-
*
|
|
4817
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4276
4818
|
* </code>
|
|
4277
4819
|
* </p>
|
|
4278
4820
|
* </li>
|
|
4279
4821
|
* <li>
|
|
4280
4822
|
* <p>Invoke a specific version of a Lambda function:
|
|
4281
|
-
*
|
|
4823
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4282
4824
|
* </code>
|
|
4283
4825
|
* </p>
|
|
4284
4826
|
* </li>
|
|
4285
4827
|
* <li>
|
|
4286
4828
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4287
|
-
*
|
|
4829
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4288
4830
|
* </code>
|
|
4289
4831
|
* </p>
|
|
4290
4832
|
* </li>
|
|
@@ -4322,13 +4864,13 @@ export interface PutMetricAlarmInput {
|
|
|
4322
4864
|
InsufficientDataActions?: string[] | undefined;
|
|
4323
4865
|
/**
|
|
4324
4866
|
* <p>The name for the metric associated with the alarm. For each
|
|
4325
|
-
*
|
|
4326
|
-
*
|
|
4327
|
-
*
|
|
4867
|
+
* <code>PutMetricAlarm</code> operation, you must specify either
|
|
4868
|
+
* <code>MetricName</code>, a <code>Metrics</code> array, or an
|
|
4869
|
+
* <code>EvaluationCriteria</code>.</p>
|
|
4328
4870
|
* <p>If you are creating an alarm based on a math expression, you cannot specify this
|
|
4329
4871
|
* parameter, or any of the <code>Namespace</code>, <code>Dimensions</code>,
|
|
4330
|
-
*
|
|
4331
|
-
*
|
|
4872
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
4873
|
+
* <code>ExtendedStatistic</code> parameters. Instead, you specify all this information
|
|
4332
4874
|
* in the <code>Metrics</code> array.</p>
|
|
4333
4875
|
* @public
|
|
4334
4876
|
*/
|
|
@@ -4342,7 +4884,7 @@ export interface PutMetricAlarmInput {
|
|
|
4342
4884
|
/**
|
|
4343
4885
|
* <p>The statistic for the metric specified in <code>MetricName</code>, other than
|
|
4344
4886
|
* percentile. For percentile statistics, use <code>ExtendedStatistic</code>. When you call
|
|
4345
|
-
*
|
|
4887
|
+
* <code>PutMetricAlarm</code> and specify a <code>MetricName</code>, you must specify
|
|
4346
4888
|
* either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
|
|
4347
4889
|
* @public
|
|
4348
4890
|
*/
|
|
@@ -4421,24 +4963,25 @@ export interface PutMetricAlarmInput {
|
|
|
4421
4963
|
Dimensions?: Dimension[] | undefined;
|
|
4422
4964
|
/**
|
|
4423
4965
|
* <p>The length, in seconds, used each time the metric specified in
|
|
4424
|
-
*
|
|
4425
|
-
* 60.</p>
|
|
4966
|
+
* <code>MetricName</code> is evaluated. Valid values are 10, 20, 30, and any multiple
|
|
4967
|
+
* of 60.</p>
|
|
4426
4968
|
* <p>
|
|
4427
4969
|
* <code>Period</code> is required for alarms based on static thresholds. If you are
|
|
4428
4970
|
* creating an alarm based on a metric math expression, you specify the period for each
|
|
4429
4971
|
* metric within the objects in the <code>Metrics</code> array.</p>
|
|
4430
4972
|
* <p>Be sure to specify 10, 20, or 30 only for metrics that are stored by a
|
|
4431
|
-
*
|
|
4432
|
-
* specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution,
|
|
4433
|
-
* alarm still attempts to gather data at the period rate that you specify. In this
|
|
4434
|
-
* it does not receive data for the attempts that do not correspond to a one-minute
|
|
4435
|
-
* resolution, and the alarm might often lapse into INSUFFICENT_DATA status.
|
|
4436
|
-
* or 30 also sets this alarm as a high-resolution alarm, which has a
|
|
4437
|
-
* other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
4438
|
-
*
|
|
4973
|
+
* <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you
|
|
4974
|
+
* specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution,
|
|
4975
|
+
* the alarm still attempts to gather data at the period rate that you specify. In this
|
|
4976
|
+
* case, it does not receive data for the attempts that do not correspond to a one-minute
|
|
4977
|
+
* data resolution, and the alarm might often lapse into INSUFFICENT_DATA status.
|
|
4978
|
+
* Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a
|
|
4979
|
+
* higher charge than other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
4980
|
+
* Pricing</a>.</p>
|
|
4439
4981
|
* <p>An alarm's total current evaluation period can be no longer than seven days, so
|
|
4440
|
-
*
|
|
4441
|
-
* 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the
|
|
4982
|
+
* <code>Period</code> multiplied by <code>EvaluationPeriods</code> can't be more than
|
|
4983
|
+
* 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the
|
|
4984
|
+
* total evaluation period can't be longer than one day (86,400 seconds).</p>
|
|
4442
4985
|
* @public
|
|
4443
4986
|
*/
|
|
4444
4987
|
Period?: number | undefined;
|
|
@@ -4474,7 +5017,7 @@ export interface PutMetricAlarmInput {
|
|
|
4474
5017
|
* <p>The number of data points that must be breaching to trigger the alarm. This is used
|
|
4475
5018
|
* only if you are setting an "M out of N" alarm. In that case, this value is the M. For
|
|
4476
5019
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation">Evaluating an Alarm</a> in the <i>Amazon CloudWatch User
|
|
4477
|
-
*
|
|
5020
|
+
* Guide</i>.</p>
|
|
4478
5021
|
* @public
|
|
4479
5022
|
*/
|
|
4480
5023
|
DatapointsToAlarm?: number | undefined;
|
|
@@ -4489,21 +5032,21 @@ export interface PutMetricAlarmInput {
|
|
|
4489
5032
|
* <p> The arithmetic operation to use when comparing the specified statistic and
|
|
4490
5033
|
* threshold. The specified statistic value is used as the first operand.</p>
|
|
4491
5034
|
* <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
|
|
4492
|
-
*
|
|
5035
|
+
* <code>LessThanLowerThreshold</code>, and <code>GreaterThanUpperThreshold</code> are
|
|
4493
5036
|
* used only for alarms based on anomaly detection models.</p>
|
|
4494
5037
|
* @public
|
|
4495
5038
|
*/
|
|
4496
5039
|
ComparisonOperator?: ComparisonOperator | undefined;
|
|
4497
5040
|
/**
|
|
4498
5041
|
* <p> Sets how this alarm is to handle missing data points. If
|
|
4499
|
-
*
|
|
4500
|
-
*
|
|
5042
|
+
* <code>TreatMissingData</code> is omitted, the default behavior of
|
|
5043
|
+
* <code>missing</code> is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p>
|
|
4501
5044
|
* <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>
|
|
4502
5045
|
* </p>
|
|
4503
5046
|
* <note>
|
|
4504
5047
|
* <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
5048
|
+
* <code>ignore</code> missing data even if you choose a different option for
|
|
5049
|
+
* <code>TreatMissingData</code>. When an <code>AWS/DynamoDB</code> metric has
|
|
4507
5050
|
* missing data, alarms that evaluate that metric remain in their current state.</p>
|
|
4508
5051
|
* </note>
|
|
4509
5052
|
* <note>
|
|
@@ -4534,11 +5077,11 @@ export interface PutMetricAlarmInput {
|
|
|
4534
5077
|
* You designate this expression by setting <code>ReturnData</code> to true for this object
|
|
4535
5078
|
* in the array. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html">MetricDataQuery</a>.</p>
|
|
4536
5079
|
* <p>If you use the <code>Metrics</code> parameter, you cannot include the
|
|
4537
|
-
*
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4540
|
-
*
|
|
4541
|
-
*
|
|
5080
|
+
* <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>,
|
|
5081
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
5082
|
+
* <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same
|
|
5083
|
+
* operation. Instead, you retrieve the metrics you are using in your math expression as
|
|
5084
|
+
* part of the <code>Metrics</code> array.</p>
|
|
4542
5085
|
* @public
|
|
4543
5086
|
*/
|
|
4544
5087
|
Metrics?: MetricDataQuery[] | undefined;
|
|
@@ -4553,7 +5096,7 @@ export interface PutMetricAlarmInput {
|
|
|
4553
5096
|
* this parameter are ignored. To change the tags of an existing alarm, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
4554
5097
|
* <p>To use this field to set tags for an alarm when you create it, you must be signed on
|
|
4555
5098
|
* with both the <code>cloudwatch:PutMetricAlarm</code> and
|
|
4556
|
-
*
|
|
5099
|
+
* <code>cloudwatch:TagResource</code> permissions.</p>
|
|
4557
5100
|
* @public
|
|
4558
5101
|
*/
|
|
4559
5102
|
Tags?: Tag[] | undefined;
|
|
@@ -4561,25 +5104,40 @@ export interface PutMetricAlarmInput {
|
|
|
4561
5104
|
* <p>If this is an alarm based on an anomaly detection model, make this value match the ID
|
|
4562
5105
|
* of the <code>ANOMALY_DETECTION_BAND</code> function.</p>
|
|
4563
5106
|
* <p>For an example of how to use this parameter, see the <b>Anomaly
|
|
4564
|
-
*
|
|
5107
|
+
* Detection Model Alarm</b> example on this page.</p>
|
|
4565
5108
|
* <p>If your alarm uses this parameter, it cannot have Auto Scaling actions.</p>
|
|
4566
5109
|
* @public
|
|
4567
5110
|
*/
|
|
4568
5111
|
ThresholdMetricId?: string | undefined;
|
|
5112
|
+
/**
|
|
5113
|
+
* <p>The evaluation window that the alarm uses to select the range of metric data that it
|
|
5114
|
+
* evaluates. Specify either a sliding window or a wall clock window. If you omit this
|
|
5115
|
+
* parameter, the alarm uses a sliding window.</p>
|
|
5116
|
+
* <p>A sliding window advances each time the alarm is evaluated, forming a rolling time
|
|
5117
|
+
* window. A wall clock window aligns the evaluated range to fixed clock boundaries, such
|
|
5118
|
+
* as the top of the hour or the start of the day.</p>
|
|
5119
|
+
* <p>You can use <code>EvaluationWindow</code> with any type of metric alarm except alarms
|
|
5120
|
+
* that are based on a PromQL query.</p>
|
|
5121
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html">Alarm
|
|
5122
|
+
* evaluation windows</a> in the <i>CloudWatch User
|
|
5123
|
+
* Guide</i>.</p>
|
|
5124
|
+
* @public
|
|
5125
|
+
*/
|
|
5126
|
+
EvaluationWindow?: EvaluationWindow | undefined;
|
|
4569
5127
|
/**
|
|
4570
5128
|
* <p>The evaluation criteria for the alarm. For each <code>PutMetricAlarm</code>
|
|
4571
5129
|
* operation, you must specify either <code>MetricName</code>, a <code>Metrics</code>
|
|
4572
5130
|
* array, or an <code>EvaluationCriteria</code>.</p>
|
|
4573
5131
|
* <p>If you use the <code>EvaluationCriteria</code> parameter, you cannot include the
|
|
4574
|
-
*
|
|
4575
|
-
*
|
|
4576
|
-
*
|
|
4577
|
-
*
|
|
4578
|
-
*
|
|
4579
|
-
*
|
|
4580
|
-
* are defined within this structure.</p>
|
|
5132
|
+
* <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>,
|
|
5133
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>,
|
|
5134
|
+
* <code>ExtendedStatistic</code>, <code>Metrics</code>, <code>Threshold</code>,
|
|
5135
|
+
* <code>ComparisonOperator</code>, <code>ThresholdMetricId</code>,
|
|
5136
|
+
* <code>EvaluationPeriods</code>, or <code>DatapointsToAlarm</code> parameters of
|
|
5137
|
+
* <code>PutMetricAlarm</code> in the same operation. Instead, all evaluation
|
|
5138
|
+
* parameters are defined within this structure.</p>
|
|
4581
5139
|
* <p>For an example of how to use this parameter, see the <b>PromQL
|
|
4582
|
-
*
|
|
5140
|
+
* alarm</b> example on this page.</p>
|
|
4583
5141
|
* @public
|
|
4584
5142
|
*/
|
|
4585
5143
|
EvaluationCriteria?: EvaluationCriteria | undefined;
|
|
@@ -4588,7 +5146,7 @@ export interface PutMetricAlarmInput {
|
|
|
4588
5146
|
* 20, 30, and any multiple of 60.</p>
|
|
4589
5147
|
* <p>This parameter is required for alarms that use <code>EvaluationCriteria</code>, and
|
|
4590
5148
|
* cannot be specified for alarms configured with <code>MetricName</code> or
|
|
4591
|
-
*
|
|
5149
|
+
* <code>Metrics</code>.</p>
|
|
4592
5150
|
* @public
|
|
4593
5151
|
*/
|
|
4594
5152
|
EvaluationInterval?: number | undefined;
|
|
@@ -4615,9 +5173,9 @@ export interface PutMetricDataInput {
|
|
|
4615
5173
|
*/
|
|
4616
5174
|
MetricData?: MetricDatum[] | undefined;
|
|
4617
5175
|
/**
|
|
4618
|
-
* <p>Data for metrics that contain associated entity information. You can include up to
|
|
4619
|
-
*
|
|
4620
|
-
*
|
|
5176
|
+
* <p>Data for metrics that contain associated entity information. You can include up to two
|
|
5177
|
+
* <code>EntityMetricData</code> objects, each of which can contain a single
|
|
5178
|
+
* <code>Entity</code> and associated metrics.</p>
|
|
4621
5179
|
* <p>The limit of metrics allowed, 1000, is the sum of both <code>EntityMetricData</code>
|
|
4622
5180
|
* and <code>MetricData</code> metrics.</p>
|
|
4623
5181
|
* @public
|
|
@@ -4633,14 +5191,13 @@ export interface PutMetricDataInput {
|
|
|
4633
5191
|
* </li>
|
|
4634
5192
|
* <li>
|
|
4635
5193
|
* <p>When set to <code>false</code>: Validation errors in the entity will not
|
|
4636
|
-
* associate the metric with the entity, but the metric data will still be
|
|
4637
|
-
*
|
|
4638
|
-
*
|
|
4639
|
-
* <p>In the case of an invalid entity, the operation will return a
|
|
4640
|
-
*
|
|
4641
|
-
*
|
|
4642
|
-
*
|
|
4643
|
-
* values:</p>
|
|
5194
|
+
* associate the metric with the entity, but the metric data will still be accepted
|
|
5195
|
+
* and ingested. Validation errors in the metric data will fail the entire request,
|
|
5196
|
+
* and no data will be ingested.</p>
|
|
5197
|
+
* <p>In the case of an invalid entity, the operation will return a <code>200</code>
|
|
5198
|
+
* status, but an additional response header will contain information about the
|
|
5199
|
+
* validation errors. The new header, <code>X-Amzn-Failure-Message</code> is an
|
|
5200
|
+
* enumeration of the following values:</p>
|
|
4644
5201
|
* <ul>
|
|
4645
5202
|
* <li>
|
|
4646
5203
|
* <p>
|
|
@@ -4649,7 +5206,7 @@ export interface PutMetricDataInput {
|
|
|
4649
5206
|
* <li>
|
|
4650
5207
|
* <p>
|
|
4651
5208
|
* <code>InvalidKeyAttributes</code> - The provided
|
|
4652
|
-
*
|
|
5209
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4653
5210
|
* </li>
|
|
4654
5211
|
* <li>
|
|
4655
5212
|
* <p>
|
|
@@ -4659,24 +5216,22 @@ export interface PutMetricDataInput {
|
|
|
4659
5216
|
* <li>
|
|
4660
5217
|
* <p>
|
|
4661
5218
|
* <code>InvalidTypeValue</code> - The provided <code>Type</code> in the
|
|
4662
|
-
*
|
|
5219
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4663
5220
|
* </li>
|
|
4664
5221
|
* <li>
|
|
4665
5222
|
* <p>
|
|
4666
5223
|
* <code>EntitySizeTooLarge</code> - The number of
|
|
4667
|
-
*
|
|
5224
|
+
* <code>EntityMetricData</code> objects allowed is 2.</p>
|
|
4668
5225
|
* </li>
|
|
4669
5226
|
* <li>
|
|
4670
5227
|
* <p>
|
|
4671
|
-
* <code>MissingRequiredFields</code> - There are missing required
|
|
4672
|
-
*
|
|
5228
|
+
* <code>MissingRequiredFields</code> - There are missing required fields
|
|
5229
|
+
* in the <code>KeyAttributes</code> for the provided
|
|
4673
5230
|
* <code>Type</code>.</p>
|
|
4674
5231
|
* </li>
|
|
4675
5232
|
* </ul>
|
|
4676
|
-
* <p>For details of the requirements for specifying an entity, see
|
|
4677
|
-
*
|
|
4678
|
-
* to add related information to telemetry</a> in the
|
|
4679
|
-
* <i>CloudWatch User Guide</i>.</p>
|
|
5233
|
+
* <p>For details of the requirements for specifying an entity, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/adding-your-own-related-telemetry.html">How to add related information to telemetry</a> in the
|
|
5234
|
+
* <i>CloudWatch User Guide</i>.</p>
|
|
4680
5235
|
* </li>
|
|
4681
5236
|
* </ul>
|
|
4682
5237
|
* <p>This parameter is <i>required</i> when <code>EntityMetricData</code> is
|
|
@@ -4738,7 +5293,7 @@ export interface PutMetricStreamInput {
|
|
|
4738
5293
|
RoleArn: string | undefined;
|
|
4739
5294
|
/**
|
|
4740
5295
|
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
4741
|
-
*
|
|
5296
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
4742
5297
|
* information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">
|
|
4743
5298
|
* Metric streams output formats</a>.</p>
|
|
4744
5299
|
* @public
|
|
@@ -4758,13 +5313,13 @@ export interface PutMetricStreamInput {
|
|
|
4758
5313
|
Tags?: Tag[] | undefined;
|
|
4759
5314
|
/**
|
|
4760
5315
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
4761
|
-
*
|
|
5316
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
4762
5317
|
* streamed. You can use this parameter to have the metric stream also send additional
|
|
4763
5318
|
* statistics in the stream. This array can have up to 100 members.</p>
|
|
4764
5319
|
* <p>For each entry in this array, you specify one or more metrics and the list of
|
|
4765
5320
|
* additional statistics to stream for those metrics. The additional statistics that you
|
|
4766
5321
|
* can stream depend on the stream's <code>OutputFormat</code>. If the
|
|
4767
|
-
*
|
|
5322
|
+
* <code>OutputFormat</code> is <code>json</code>, you can stream any additional
|
|
4768
5323
|
* statistic that is supported by CloudWatch, listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
4769
5324
|
* CloudWatch statistics definitions</a>. If the <code>OutputFormat</code>
|
|
4770
5325
|
* is <code>opentelemetry1.0</code> or <code>opentelemetry0.7</code>, you can stream
|
|
@@ -4880,19 +5435,19 @@ export interface TagResourceInput {
|
|
|
4880
5435
|
/**
|
|
4881
5436
|
* <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
|
|
4882
5437
|
* <p>The ARN format of an alarm is
|
|
4883
|
-
*
|
|
5438
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4884
5439
|
* </code>
|
|
4885
5440
|
* </p>
|
|
4886
5441
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4887
|
-
*
|
|
5442
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4888
5443
|
* </code>
|
|
4889
5444
|
* </p>
|
|
4890
5445
|
* <p>The ARN format of a dashboard is
|
|
4891
|
-
*
|
|
5446
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
4892
5447
|
* </code>
|
|
4893
5448
|
* </p>
|
|
4894
5449
|
* <p>The ARN format of a metric stream is
|
|
4895
|
-
*
|
|
5450
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
4896
5451
|
* </code>
|
|
4897
5452
|
* </p>
|
|
4898
5453
|
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|
|
@@ -4918,19 +5473,19 @@ export interface UntagResourceInput {
|
|
|
4918
5473
|
/**
|
|
4919
5474
|
* <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
|
|
4920
5475
|
* <p>The ARN format of an alarm is
|
|
4921
|
-
*
|
|
5476
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4922
5477
|
* </code>
|
|
4923
5478
|
* </p>
|
|
4924
5479
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4925
|
-
*
|
|
5480
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4926
5481
|
* </code>
|
|
4927
5482
|
* </p>
|
|
4928
5483
|
* <p>The ARN format of a dashboard is
|
|
4929
|
-
*
|
|
5484
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
4930
5485
|
* </code>
|
|
4931
5486
|
* </p>
|
|
4932
5487
|
* <p>The ARN format of a metric stream is
|
|
4933
|
-
*
|
|
5488
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
4934
5489
|
* </code>
|
|
4935
5490
|
* </p>
|
|
4936
5491
|
* <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web
|