@aws-sdk/client-cloudwatch 3.1074.0 → 3.1076.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 +2188 -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/schemas/schemas_0.js +55 -3
- 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 +48 -3
- 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 +10 -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 +733 -294
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +6 -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 +60 -4
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +6 -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 -10
- 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;
|
|
@@ -1259,7 +1473,7 @@ export interface MetricAlarm {
|
|
|
1259
1473
|
AlarmActions?: string[] | undefined;
|
|
1260
1474
|
/**
|
|
1261
1475
|
* <p>The actions to execute when this alarm transitions to the
|
|
1262
|
-
*
|
|
1476
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
1263
1477
|
* as an Amazon Resource Name (ARN).</p>
|
|
1264
1478
|
* @public
|
|
1265
1479
|
*/
|
|
@@ -1281,7 +1495,7 @@ export interface MetricAlarm {
|
|
|
1281
1495
|
StateReasonData?: string | undefined;
|
|
1282
1496
|
/**
|
|
1283
1497
|
* <p>The time stamp of the last update to the value of either the
|
|
1284
|
-
*
|
|
1498
|
+
* <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
|
|
1285
1499
|
* @public
|
|
1286
1500
|
*/
|
|
1287
1501
|
StateUpdatedTimestamp?: Date | undefined;
|
|
@@ -1347,8 +1561,8 @@ export interface MetricAlarm {
|
|
|
1347
1561
|
ComparisonOperator?: ComparisonOperator | undefined;
|
|
1348
1562
|
/**
|
|
1349
1563
|
* <p>Sets how this alarm is to handle missing data points. The valid values are
|
|
1350
|
-
*
|
|
1351
|
-
*
|
|
1564
|
+
* <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and
|
|
1565
|
+
* <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
1566
|
* <p>If this parameter is omitted, the default behavior of <code>missing</code> is
|
|
1353
1567
|
* used.</p>
|
|
1354
1568
|
* <note>
|
|
@@ -1375,16 +1589,21 @@ export interface MetricAlarm {
|
|
|
1375
1589
|
Metrics?: MetricDataQuery[] | undefined;
|
|
1376
1590
|
/**
|
|
1377
1591
|
* <p>In an alarm based on an anomaly detection model, this is the ID of the
|
|
1378
|
-
*
|
|
1592
|
+
* <code>ANOMALY_DETECTION_BAND</code> function used as the threshold for the
|
|
1379
1593
|
* alarm.</p>
|
|
1380
1594
|
* @public
|
|
1381
1595
|
*/
|
|
1382
1596
|
ThresholdMetricId?: string | undefined;
|
|
1383
1597
|
/**
|
|
1384
|
-
* <p>If the value of this field is <code>PARTIAL_DATA</code>, it indicates that not all the
|
|
1598
|
+
* <p>If the value of this field is <code>PARTIAL_DATA</code>, it indicates that not all the
|
|
1599
|
+
* available data was able to be retrieved due to quota limitations. For more information,
|
|
1600
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create
|
|
1385
1601
|
* alarms on Metrics Insights queries</a>.</p>
|
|
1386
|
-
* <p>If the value of this field is <code>EVALUATION_ERROR</code>, it indicates
|
|
1387
|
-
*
|
|
1602
|
+
* <p>If the value of this field is <code>EVALUATION_ERROR</code>, it indicates
|
|
1603
|
+
* configuration errors in alarm setup that require review and correction. Refer to
|
|
1604
|
+
* StateReason field of the alarm for more details.</p>
|
|
1605
|
+
* <p>If the value of this field is <code>EVALUATION_FAILURE</code>, it indicates temporary
|
|
1606
|
+
* CloudWatch issues. We recommend manual monitoring until the issue is resolved </p>
|
|
1388
1607
|
* @public
|
|
1389
1608
|
*/
|
|
1390
1609
|
EvaluationState?: EvaluationState | undefined;
|
|
@@ -1419,6 +1638,11 @@ export interface DescribeAlarmsOutput {
|
|
|
1419
1638
|
* @public
|
|
1420
1639
|
*/
|
|
1421
1640
|
MetricAlarms?: MetricAlarm[] | undefined;
|
|
1641
|
+
/**
|
|
1642
|
+
* <p>The information about any log alarms returned by the operation.</p>
|
|
1643
|
+
* @public
|
|
1644
|
+
*/
|
|
1645
|
+
LogAlarms?: LogAlarm[] | undefined;
|
|
1422
1646
|
/**
|
|
1423
1647
|
* <p>The token that marks the start of the next batch of returned results.</p>
|
|
1424
1648
|
* @public
|
|
@@ -1492,7 +1716,7 @@ export interface DescribeAnomalyDetectorsInput {
|
|
|
1492
1716
|
* <p>The maximum number of results to return in one operation. The maximum value that you
|
|
1493
1717
|
* can specify is 100.</p>
|
|
1494
1718
|
* <p>To retrieve the remaining results, make another call with the returned
|
|
1495
|
-
*
|
|
1719
|
+
* <code>NextToken</code> value. </p>
|
|
1496
1720
|
* @public
|
|
1497
1721
|
*/
|
|
1498
1722
|
MaxResults?: number | undefined;
|
|
@@ -1518,8 +1742,8 @@ export interface DescribeAnomalyDetectorsInput {
|
|
|
1518
1742
|
Dimensions?: Dimension[] | undefined;
|
|
1519
1743
|
/**
|
|
1520
1744
|
* <p>The anomaly detector types to request when using
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1745
|
+
* <code>DescribeAnomalyDetectorsInput</code>. If empty, defaults to
|
|
1746
|
+
* <code>SINGLE_METRIC</code>.</p>
|
|
1523
1747
|
* @public
|
|
1524
1748
|
*/
|
|
1525
1749
|
AnomalyDetectorTypes?: AnomalyDetectorType[] | undefined;
|
|
@@ -1560,7 +1784,7 @@ export interface DescribeInsightRulesInput {
|
|
|
1560
1784
|
/**
|
|
1561
1785
|
* <p>This structure contains the definition for a Contributor Insights rule. For more
|
|
1562
1786
|
* 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
|
-
*
|
|
1787
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
1564
1788
|
* @public
|
|
1565
1789
|
*/
|
|
1566
1790
|
export interface InsightRule {
|
|
@@ -1576,7 +1800,7 @@ export interface InsightRule {
|
|
|
1576
1800
|
State: string | undefined;
|
|
1577
1801
|
/**
|
|
1578
1802
|
* <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule",
|
|
1579
|
-
*
|
|
1803
|
+
* "Version": 1\}</code>. For managed rules, this is <code>\{"Name": "ServiceLogRule",
|
|
1580
1804
|
* "Version": 1\}</code>
|
|
1581
1805
|
* </p>
|
|
1582
1806
|
* @public
|
|
@@ -1595,8 +1819,10 @@ export interface InsightRule {
|
|
|
1595
1819
|
*/
|
|
1596
1820
|
ManagedRule?: boolean | undefined;
|
|
1597
1821
|
/**
|
|
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
|
|
1822
|
+
* <p>Displays whether the rule is evaluated on the transformed versions of logs, for log
|
|
1823
|
+
* groups that have <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
1824
|
+
* transformation</a> enabled. If this is <code>false</code>, log events are
|
|
1825
|
+
* evaluated before they are transformed.</p>
|
|
1600
1826
|
* @public
|
|
1601
1827
|
*/
|
|
1602
1828
|
ApplyOnTransformedLogs?: boolean | undefined;
|
|
@@ -1718,7 +1944,7 @@ export interface EnableInsightRulesOutput {
|
|
|
1718
1944
|
/**
|
|
1719
1945
|
* <p>An entity associated with metrics, to allow for finding related telemetry. An entity
|
|
1720
1946
|
* is typically a resource or service within your system. For example, metrics from an
|
|
1721
|
-
*
|
|
1947
|
+
* Amazon EC2 instance could be associated with that instance as the entity.
|
|
1722
1948
|
* Similarly, metrics from a service that you own could be associated with that service as
|
|
1723
1949
|
* the entity.</p>
|
|
1724
1950
|
* @public
|
|
@@ -1730,12 +1956,11 @@ export interface Entity {
|
|
|
1730
1956
|
* the same entity. For an entity to be valid, the <code>KeyAttributes</code> must exist
|
|
1731
1957
|
* and be formatted correctly.</p>
|
|
1732
1958
|
* <p>There are five allowed attributes (key names): <code>Type</code>,
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1959
|
+
* <code>ResourceType</code>, <code>Identifier</code>, <code>Name</code>, and
|
|
1960
|
+
* <code>Environment</code>.</p>
|
|
1735
1961
|
* <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>
|
|
1962
|
+
* to add related information to telemetry</a> in the <i>CloudWatch
|
|
1963
|
+
* User Guide</i>.</p>
|
|
1739
1964
|
* @public
|
|
1740
1965
|
*/
|
|
1741
1966
|
KeyAttributes?: Record<string, string> | undefined;
|
|
@@ -1743,8 +1968,8 @@ export interface Entity {
|
|
|
1743
1968
|
* <p>Additional attributes of the entity that are not used to specify the identity of the
|
|
1744
1969
|
* entity. A list of key-value pairs.</p>
|
|
1745
1970
|
* <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
|
-
*
|
|
1971
|
+
* to add related information to telemetry</a> in the <i>CloudWatch
|
|
1972
|
+
* User Guide</i>.</p>
|
|
1748
1973
|
* @public
|
|
1749
1974
|
*/
|
|
1750
1975
|
Attributes?: Record<string, string> | undefined;
|
|
@@ -1814,7 +2039,7 @@ export interface MetricDatum {
|
|
|
1814
2039
|
/**
|
|
1815
2040
|
* <p>Array of numbers representing the values for the metric during the period. Each unique
|
|
1816
2041
|
* value is listed just once in this array, and the corresponding number in the
|
|
1817
|
-
*
|
|
2042
|
+
* <code>Counts</code> array specifies the number of times that value occurred during
|
|
1818
2043
|
* the period. You can include up to 150 unique values in each <code>PutMetricData</code>
|
|
1819
2044
|
* action that specifies a <code>Values</code> array.</p>
|
|
1820
2045
|
* <p>Although the <code>Values</code> array accepts numbers of type <code>Double</code>,
|
|
@@ -1827,7 +2052,7 @@ export interface MetricDatum {
|
|
|
1827
2052
|
/**
|
|
1828
2053
|
* <p>Array of numbers that is used along with the <code>Values</code> array. Each number in
|
|
1829
2054
|
* the <code>Count</code> array is the number of times the corresponding value in the
|
|
1830
|
-
*
|
|
2055
|
+
* <code>Values</code> array occurred during the period. </p>
|
|
1831
2056
|
* <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for
|
|
1832
2057
|
* each count. If you include a <code>Counts</code> array, it must include the same amount
|
|
1833
2058
|
* of values as the <code>Values</code> array.</p>
|
|
@@ -1849,7 +2074,7 @@ export interface MetricDatum {
|
|
|
1849
2074
|
* metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is
|
|
1850
2075
|
* available only for custom metrics. For more information about high-resolution metrics,
|
|
1851
2076
|
* 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
|
-
*
|
|
2077
|
+
* Guide</i>. </p>
|
|
1853
2078
|
* <p>This field is optional, if you do not specify it the default of 60 is
|
|
1854
2079
|
* used.</p>
|
|
1855
2080
|
* @public
|
|
@@ -1857,8 +2082,8 @@ export interface MetricDatum {
|
|
|
1857
2082
|
StorageResolution?: number | undefined;
|
|
1858
2083
|
}
|
|
1859
2084
|
/**
|
|
1860
|
-
* <p>A set of metrics that are associated with an entity, such as a specific service
|
|
1861
|
-
*
|
|
2085
|
+
* <p>A set of metrics that are associated with an entity, such as a specific service or
|
|
2086
|
+
* resource. Contains the entity and the list of metric data associated with it.</p>
|
|
1862
2087
|
* @public
|
|
1863
2088
|
*/
|
|
1864
2089
|
export interface EntityMetricData {
|
|
@@ -1885,30 +2110,39 @@ export interface GetAlarmMuteRuleInput {
|
|
|
1885
2110
|
}
|
|
1886
2111
|
/**
|
|
1887
2112
|
* <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
|
|
2113
|
+
* <p>You can target up to 100 specific alarms by name. When a mute rule is active, the
|
|
2114
|
+
* targeted alarms continue to evaluate metrics and transition between states, but their
|
|
2115
|
+
* configured actions are muted.</p>
|
|
1889
2116
|
* @public
|
|
1890
2117
|
*/
|
|
1891
2118
|
export interface MuteTargets {
|
|
1892
2119
|
/**
|
|
1893
|
-
* <p>The list of alarm names that this mute rule targets. You can specify up to 100 alarm
|
|
1894
|
-
*
|
|
2120
|
+
* <p>The list of alarm names that this mute rule targets. You can specify up to 100 alarm
|
|
2121
|
+
* names.</p>
|
|
2122
|
+
* <p>Each alarm name must be between 1 and 255 characters in length. The alarm names must
|
|
2123
|
+
* match existing alarms in your Amazon Web Services account and region.</p>
|
|
1895
2124
|
* @public
|
|
1896
2125
|
*/
|
|
1897
2126
|
AlarmNames: string[] | undefined;
|
|
1898
2127
|
}
|
|
1899
2128
|
/**
|
|
1900
2129
|
* <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
|
|
2130
|
+
* <p>The schedule uses either a cron expression for recurring mute windows or an at
|
|
2131
|
+
* expression for one-time mute windows. When the schedule activates, the mute rule mutes
|
|
2132
|
+
* alarm actions for the specified duration.</p>
|
|
1902
2133
|
* @public
|
|
1903
2134
|
*/
|
|
1904
2135
|
export interface Schedule {
|
|
1905
2136
|
/**
|
|
1906
|
-
* <p>The schedule expression that defines when the mute rule activates. The expression must
|
|
2137
|
+
* <p>The schedule expression that defines when the mute rule activates. The expression must
|
|
2138
|
+
* be between 1 and 256 characters in length.</p>
|
|
1907
2139
|
* <p>You can use one of two expression formats:</p>
|
|
1908
2140
|
* <ul>
|
|
1909
2141
|
* <li>
|
|
1910
2142
|
* <p>
|
|
1911
|
-
* <b>Cron expressions</b> - For recurring mute
|
|
2143
|
+
* <b>Cron expressions</b> - For recurring mute
|
|
2144
|
+
* windows. Format: <code>cron(Minutes Hours Day-of-month Month
|
|
2145
|
+
* Day-of-week)</code>
|
|
1912
2146
|
* </p>
|
|
1913
2147
|
* <p>Examples:</p>
|
|
1914
2148
|
* <ul>
|
|
@@ -1918,36 +2152,45 @@ export interface Schedule {
|
|
|
1918
2152
|
* </li>
|
|
1919
2153
|
* <li>
|
|
1920
2154
|
* <p>
|
|
1921
|
-
* <code>cron(0 2 * * SUN)</code> - Activates every Sunday at 2:00 AM for
|
|
2155
|
+
* <code>cron(0 2 * * SUN)</code> - Activates every Sunday at 2:00 AM for
|
|
2156
|
+
* weekly system maintenance</p>
|
|
1922
2157
|
* </li>
|
|
1923
2158
|
* <li>
|
|
1924
2159
|
* <p>
|
|
1925
|
-
* <code>cron(0 1 1 * *)</code> - Activates on the first day of each
|
|
2160
|
+
* <code>cron(0 1 1 * *)</code> - Activates on the first day of each
|
|
2161
|
+
* month at 1:00 AM for monthly database maintenance</p>
|
|
1926
2162
|
* </li>
|
|
1927
2163
|
* <li>
|
|
1928
2164
|
* <p>
|
|
1929
|
-
* <code>cron(0 18 * * FRI)</code> - Activates every Friday at 6:00
|
|
2165
|
+
* <code>cron(0 18 * * FRI)</code> - Activates every Friday at 6:00
|
|
2166
|
+
* PM</p>
|
|
1930
2167
|
* </li>
|
|
1931
2168
|
* <li>
|
|
1932
2169
|
* <p>
|
|
1933
|
-
* <code>cron(0 23 * * *)</code> - Activates every day at 11:00 PM during
|
|
2170
|
+
* <code>cron(0 23 * * *)</code> - Activates every day at 11:00 PM during
|
|
2171
|
+
* nightly backup operations</p>
|
|
1934
2172
|
* </li>
|
|
1935
2173
|
* </ul>
|
|
1936
|
-
* <p>The characters <code>*</code>, <code>-</code>, and <code>,</code> are
|
|
2174
|
+
* <p>The characters <code>*</code>, <code>-</code>, and <code>,</code> are
|
|
2175
|
+
* supported in all fields. English names can be used for the month (JAN-DEC) and
|
|
2176
|
+
* day of week (SUN-SAT) fields.</p>
|
|
1937
2177
|
* </li>
|
|
1938
2178
|
* <li>
|
|
1939
2179
|
* <p>
|
|
1940
|
-
* <b>At expressions</b> - For one-time mute windows.
|
|
2180
|
+
* <b>At expressions</b> - For one-time mute windows.
|
|
2181
|
+
* Format: <code>at(yyyy-MM-ddThh:mm)</code>
|
|
1941
2182
|
* </p>
|
|
1942
2183
|
* <p>Examples:</p>
|
|
1943
2184
|
* <ul>
|
|
1944
2185
|
* <li>
|
|
1945
2186
|
* <p>
|
|
1946
|
-
* <code>at(2024-05-10T14:00)</code> - Activates once on May 10, 2024 at
|
|
2187
|
+
* <code>at(2024-05-10T14:00)</code> - Activates once on May 10, 2024 at
|
|
2188
|
+
* 2:00 PM during an active incident response session</p>
|
|
1947
2189
|
* </li>
|
|
1948
2190
|
* <li>
|
|
1949
2191
|
* <p>
|
|
1950
|
-
* <code>at(2024-12-23T00:00)</code> - Activates once on December 23,
|
|
2192
|
+
* <code>at(2024-12-23T00:00)</code> - Activates once on December 23,
|
|
2193
|
+
* 2024 at midnight during annual company shutdown</p>
|
|
1951
2194
|
* </li>
|
|
1952
2195
|
* </ul>
|
|
1953
2196
|
* </li>
|
|
@@ -1956,8 +2199,10 @@ export interface Schedule {
|
|
|
1956
2199
|
*/
|
|
1957
2200
|
Expression: string | undefined;
|
|
1958
2201
|
/**
|
|
1959
|
-
* <p>The length of time that alarms remain muted when the schedule activates. The duration
|
|
1960
|
-
*
|
|
2202
|
+
* <p>The length of time that alarms remain muted when the schedule activates. The duration
|
|
2203
|
+
* must be between 1 and 50 characters in length.</p>
|
|
2204
|
+
* <p>Specify the duration using ISO 8601 duration format with a minimum of 1 minute
|
|
2205
|
+
* (<code>PT1M</code>) and maximum of 15 days (<code>P15D</code>).</p>
|
|
1961
2206
|
* <p>Examples:</p>
|
|
1962
2207
|
* <ul>
|
|
1963
2208
|
* <li>
|
|
@@ -1966,7 +2211,8 @@ export interface Schedule {
|
|
|
1966
2211
|
* </li>
|
|
1967
2212
|
* <li>
|
|
1968
2213
|
* <p>
|
|
1969
|
-
* <code>P2DT12H</code> - 2 days and 12 hours for weekend muting from Friday 6:00
|
|
2214
|
+
* <code>P2DT12H</code> - 2 days and 12 hours for weekend muting from Friday 6:00
|
|
2215
|
+
* PM to Monday 6:00 AM</p>
|
|
1970
2216
|
* </li>
|
|
1971
2217
|
* <li>
|
|
1972
2218
|
* <p>
|
|
@@ -1981,14 +2227,20 @@ export interface Schedule {
|
|
|
1981
2227
|
* <code>P7D</code> - 7 days for annual company shutdown</p>
|
|
1982
2228
|
* </li>
|
|
1983
2229
|
* </ul>
|
|
1984
|
-
* <p>The duration begins when the schedule expression time is reached. For recurring
|
|
2230
|
+
* <p>The duration begins when the schedule expression time is reached. For recurring
|
|
2231
|
+
* schedules, the duration applies to each occurrence.</p>
|
|
1985
2232
|
* @public
|
|
1986
2233
|
*/
|
|
1987
2234
|
Duration: string | undefined;
|
|
1988
2235
|
/**
|
|
1989
|
-
* <p>The time zone to use when evaluating the schedule expression. The time zone must be
|
|
1990
|
-
*
|
|
1991
|
-
* <p>
|
|
2236
|
+
* <p>The time zone to use when evaluating the schedule expression. The time zone must be
|
|
2237
|
+
* between 1 and 50 characters in length.</p>
|
|
2238
|
+
* <p>Specify the time zone using standard timezone identifiers (for example,
|
|
2239
|
+
* <code>America/New_York</code>, <code>Europe/London</code>, or
|
|
2240
|
+
* <code>Asia/Tokyo</code>).</p>
|
|
2241
|
+
* <p>If you don't specify a time zone, UTC is used by default. The time zone affects how
|
|
2242
|
+
* cron and at expressions are interpreted, as well as start and expire dates you
|
|
2243
|
+
* specify</p>
|
|
1992
2244
|
* <p>Examples:</p>
|
|
1993
2245
|
* <ul>
|
|
1994
2246
|
* <li>
|
|
@@ -2018,12 +2270,15 @@ export interface Schedule {
|
|
|
2018
2270
|
}
|
|
2019
2271
|
/**
|
|
2020
2272
|
* <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.
|
|
2273
|
+
* <p>The rule contains a schedule that specifies when and how long alarms should be muted.
|
|
2274
|
+
* The schedule can be a recurring pattern using cron expressions or a one-time mute window
|
|
2275
|
+
* using at expressions.</p>
|
|
2022
2276
|
* @public
|
|
2023
2277
|
*/
|
|
2024
2278
|
export interface Rule {
|
|
2025
2279
|
/**
|
|
2026
|
-
* <p>The schedule configuration that defines when the mute rule activates and how long it
|
|
2280
|
+
* <p>The schedule configuration that defines when the mute rule activates and how long it
|
|
2281
|
+
* remains active.</p>
|
|
2027
2282
|
* @public
|
|
2028
2283
|
*/
|
|
2029
2284
|
Schedule: Schedule | undefined;
|
|
@@ -2058,7 +2313,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2058
2313
|
*/
|
|
2059
2314
|
MuteTargets?: MuteTargets | undefined;
|
|
2060
2315
|
/**
|
|
2061
|
-
* <p>The date and time when the mute rule becomes active. If not set, the rule is active
|
|
2316
|
+
* <p>The date and time when the mute rule becomes active. If not set, the rule is active
|
|
2317
|
+
* immediately.</p>
|
|
2062
2318
|
* @public
|
|
2063
2319
|
*/
|
|
2064
2320
|
StartDate?: Date | undefined;
|
|
@@ -2068,7 +2324,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2068
2324
|
*/
|
|
2069
2325
|
ExpireDate?: Date | undefined;
|
|
2070
2326
|
/**
|
|
2071
|
-
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
2327
|
+
* <p>The current status of the alarm mute rule. Valid values are <code>SCHEDULED</code>,
|
|
2328
|
+
* <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
|
|
2072
2329
|
* @public
|
|
2073
2330
|
*/
|
|
2074
2331
|
Status?: AlarmMuteRuleStatus | undefined;
|
|
@@ -2078,7 +2335,8 @@ export interface GetAlarmMuteRuleOutput {
|
|
|
2078
2335
|
*/
|
|
2079
2336
|
LastUpdatedTimestamp?: Date | undefined;
|
|
2080
2337
|
/**
|
|
2081
|
-
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
2338
|
+
* <p>Indicates whether the mute rule is one-time or recurring. Valid values are
|
|
2339
|
+
* <code>ONE_TIME</code> or <code>RECURRING</code>.</p>
|
|
2082
2340
|
* @public
|
|
2083
2341
|
*/
|
|
2084
2342
|
MuteType?: string | undefined;
|
|
@@ -2105,7 +2363,7 @@ export interface GetDashboardOutput {
|
|
|
2105
2363
|
/**
|
|
2106
2364
|
* <p>The detailed information about the dashboard, including what widgets are included
|
|
2107
2365
|
* and their location on the dashboard. For more information about the
|
|
2108
|
-
*
|
|
2366
|
+
* <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
2367
|
* @public
|
|
2110
2368
|
*/
|
|
2111
2369
|
DashboardBody?: string | undefined;
|
|
@@ -2166,20 +2424,20 @@ export interface GetInsightRuleReportInput {
|
|
|
2166
2424
|
/**
|
|
2167
2425
|
* <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
2168
2426
|
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2169
|
-
*
|
|
2427
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2170
2428
|
* @public
|
|
2171
2429
|
*/
|
|
2172
2430
|
StartTime: Date | undefined;
|
|
2173
2431
|
/**
|
|
2174
2432
|
* <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it
|
|
2175
2433
|
* is formatted as <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
|
|
2176
|
-
*
|
|
2434
|
+
* <code>2019-07-01T23:59:59</code>.</p>
|
|
2177
2435
|
* @public
|
|
2178
2436
|
*/
|
|
2179
2437
|
EndTime: Date | undefined;
|
|
2180
2438
|
/**
|
|
2181
2439
|
* <p>The period, in seconds, to use for the statistics in the
|
|
2182
|
-
*
|
|
2440
|
+
* <code>InsightRuleMetricDatapoint</code> results.</p>
|
|
2183
2441
|
* @public
|
|
2184
2442
|
*/
|
|
2185
2443
|
Period: number | undefined;
|
|
@@ -2239,7 +2497,7 @@ export interface GetInsightRuleReportInput {
|
|
|
2239
2497
|
Metrics?: string[] | undefined;
|
|
2240
2498
|
/**
|
|
2241
2499
|
* <p>Determines what statistic to use to rank the contributors. Valid values are
|
|
2242
|
-
*
|
|
2500
|
+
* <code>Sum</code> and <code>Maximum</code>.</p>
|
|
2243
2501
|
* @public
|
|
2244
2502
|
*/
|
|
2245
2503
|
OrderBy?: string | undefined;
|
|
@@ -2404,14 +2662,14 @@ export interface GetInsightRuleReportOutput {
|
|
|
2404
2662
|
* display the correct time for your time zone. </p>
|
|
2405
2663
|
* <p>The <code>Timezone</code> value affects a label only if you have a time-based dynamic
|
|
2406
2664
|
* expression in the label. For more information about dynamic expressions in labels, see
|
|
2407
|
-
*
|
|
2408
|
-
*
|
|
2665
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic
|
|
2666
|
+
* Labels</a>.</p>
|
|
2409
2667
|
* @public
|
|
2410
2668
|
*/
|
|
2411
2669
|
export interface LabelOptions {
|
|
2412
2670
|
/**
|
|
2413
2671
|
* <p>The time zone to use for metric data return in this operation. The format is
|
|
2414
|
-
*
|
|
2672
|
+
* <code>+</code> or <code>-</code> followed by four digits. The first two digits
|
|
2415
2673
|
* indicate the number of hours ahead or behind of UTC, and the final two digits are the
|
|
2416
2674
|
* number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
|
|
2417
2675
|
* minutes ahead of UTC. The default is +0000. </p>
|
|
@@ -2450,8 +2708,8 @@ export interface GetMetricDataInput {
|
|
|
2450
2708
|
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2451
2709
|
* </li>
|
|
2452
2710
|
* </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
|
|
2711
|
+
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
2712
|
+
* is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
2455
2713
|
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2456
2714
|
* previous 10-second period, the start time of your request is rounded down and you
|
|
2457
2715
|
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
@@ -2511,9 +2769,9 @@ export interface GetMetricDataInput {
|
|
|
2511
2769
|
* <p>A message returned by the <code>GetMetricData</code>API, including a code and a
|
|
2512
2770
|
* description.</p>
|
|
2513
2771
|
* <p>If a cross-Region <code>GetMetricData</code> operation fails with a code of
|
|
2514
|
-
*
|
|
2772
|
+
* <code>Forbidden</code> and a value of <code>Authentication too complex to retrieve
|
|
2515
2773
|
* cross region data</code>, you can correct the problem by running the
|
|
2516
|
-
*
|
|
2774
|
+
* <code>GetMetricData</code> operation in the same Region where the metric data
|
|
2517
2775
|
* is.</p>
|
|
2518
2776
|
* @public
|
|
2519
2777
|
*/
|
|
@@ -2565,8 +2823,8 @@ export interface MetricDataResult {
|
|
|
2565
2823
|
* in the requested time range were returned. <code>PartialData</code> means that an
|
|
2566
2824
|
* incomplete set of data points were returned. You can use the <code>NextToken</code>
|
|
2567
2825
|
* value that was returned and repeat your request to get more data points.
|
|
2568
|
-
*
|
|
2569
|
-
*
|
|
2826
|
+
* <code>NextToken</code> is not returned if you are performing a math expression.
|
|
2827
|
+
* <code>InternalError</code> indicates that an error occurred. Retry your request
|
|
2570
2828
|
* using <code>NextToken</code>, if present.</p>
|
|
2571
2829
|
* @public
|
|
2572
2830
|
*/
|
|
@@ -2624,7 +2882,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2624
2882
|
* separate metric. If a specific combination of dimensions was not published, you can't
|
|
2625
2883
|
* retrieve statistics for it. You must specify the same dimensions that were used when the
|
|
2626
2884
|
* 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
|
-
*
|
|
2885
|
+
* 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
2886
|
* Guide</i>.</p>
|
|
2629
2887
|
* @public
|
|
2630
2888
|
*/
|
|
@@ -2650,8 +2908,8 @@ export interface GetMetricStatisticsInput {
|
|
|
2650
2908
|
* clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p>
|
|
2651
2909
|
* </li>
|
|
2652
2910
|
* </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
|
|
2911
|
+
* <p>If you set <code>Period</code> to 5, 10, 20, or 30, the start time of your request
|
|
2912
|
+
* is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second
|
|
2655
2913
|
* divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
|
|
2656
2914
|
* previous 10-second period, the start time of your request is rounded down and you
|
|
2657
2915
|
* receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous
|
|
@@ -2674,7 +2932,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2674
2932
|
* of 60. For high-resolution metrics that are collected at intervals of less than one
|
|
2675
2933
|
* minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution
|
|
2676
2934
|
* metrics are those metrics stored by a <code>PutMetricData</code> call that includes a
|
|
2677
|
-
*
|
|
2935
|
+
* <code>StorageResolution</code> of 1 second.</p>
|
|
2678
2936
|
* <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
|
|
2679
2937
|
* 3 hours ago, you must specify the period as follows or no data points in that time range
|
|
2680
2938
|
* is returned:</p>
|
|
@@ -2697,7 +2955,7 @@ export interface GetMetricStatisticsInput {
|
|
|
2697
2955
|
Period: number | undefined;
|
|
2698
2956
|
/**
|
|
2699
2957
|
* <p>The metric statistics, other than percentile. For percentile statistics, use
|
|
2700
|
-
*
|
|
2958
|
+
* <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you
|
|
2701
2959
|
* must specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not
|
|
2702
2960
|
* both.</p>
|
|
2703
2961
|
* @public
|
|
@@ -2705,8 +2963,8 @@ export interface GetMetricStatisticsInput {
|
|
|
2705
2963
|
Statistics?: Statistic[] | undefined;
|
|
2706
2964
|
/**
|
|
2707
2965
|
* <p>The percentile statistics. Specify values between p0.0 and p100. When calling
|
|
2708
|
-
*
|
|
2709
|
-
*
|
|
2966
|
+
* <code>GetMetricStatistics</code>, you must specify either <code>Statistics</code> or
|
|
2967
|
+
* <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
|
|
2710
2968
|
* available for metrics when any of the metric values are negative numbers.</p>
|
|
2711
2969
|
* @public
|
|
2712
2970
|
*/
|
|
@@ -2794,11 +3052,11 @@ export interface MetricStreamStatisticsMetric {
|
|
|
2794
3052
|
}
|
|
2795
3053
|
/**
|
|
2796
3054
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
2797
|
-
*
|
|
3055
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
2798
3056
|
* streamed. This structure contains information for one metric that includes additional
|
|
2799
3057
|
* statistics in the stream. For more information about statistics, see CloudWatch,
|
|
2800
3058
|
* listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
2801
|
-
*
|
|
3059
|
+
* CloudWatch statistics definitions</a>.</p>
|
|
2802
3060
|
* @public
|
|
2803
3061
|
*/
|
|
2804
3062
|
export interface MetricStreamStatisticsConfiguration {
|
|
@@ -2816,14 +3074,14 @@ export interface MetricStreamStatisticsConfiguration {
|
|
|
2816
3074
|
* the <code>IncludeMetrics</code> array in this structure. This list can include as many
|
|
2817
3075
|
* as 20 statistics.</p>
|
|
2818
3076
|
* <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry1.0</code> or
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
3077
|
+
* <code>opentelemetry0.7</code>, the only valid values are
|
|
3078
|
+
* <code>p<i>??</i>
|
|
2821
3079
|
* </code> percentile statistics such as
|
|
2822
|
-
*
|
|
3080
|
+
* <code>p90</code>, <code>p99</code> and so on.</p>
|
|
2823
3081
|
* <p>If the <code>OutputFormat</code> for the stream is <code>json</code>, the valid values
|
|
2824
3082
|
* 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
3083
|
* CloudWatch statistics definitions</a>. For example, this includes
|
|
2826
|
-
*
|
|
3084
|
+
* <code>tm98, </code>
|
|
2827
3085
|
* <code>wm90</code>, <code>PR(:300)</code>, and so on.</p>
|
|
2828
3086
|
* @public
|
|
2829
3087
|
*/
|
|
@@ -2869,7 +3127,7 @@ export interface GetMetricStreamOutput {
|
|
|
2869
3127
|
RoleArn?: string | undefined;
|
|
2870
3128
|
/**
|
|
2871
3129
|
* <p>The state of the metric stream. The possible values are <code>running</code> and
|
|
2872
|
-
*
|
|
3130
|
+
* <code>stopped</code>.</p>
|
|
2873
3131
|
* @public
|
|
2874
3132
|
*/
|
|
2875
3133
|
State?: string | undefined;
|
|
@@ -2885,7 +3143,7 @@ export interface GetMetricStreamOutput {
|
|
|
2885
3143
|
LastUpdateDate?: Date | undefined;
|
|
2886
3144
|
/**
|
|
2887
3145
|
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
2888
|
-
*
|
|
3146
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
2889
3147
|
* 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
3148
|
* @public
|
|
2891
3149
|
*/
|
|
@@ -2914,8 +3172,8 @@ export interface GetMetricWidgetImageInput {
|
|
|
2914
3172
|
* <p>A JSON string that defines the bitmap graph to be retrieved. The string includes
|
|
2915
3173
|
* the metrics to include in the graph, statistics, annotations, title, axis limits, and so
|
|
2916
3174
|
* 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/
|
|
3175
|
+
* <code>GetMetricWidgetImage</code> call.</p>
|
|
3176
|
+
* <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
3177
|
* <p>If any metric on the graph could not load all the requested data points, an orange
|
|
2920
3178
|
* triangle with an exclamation point appears next to the graph legend.</p>
|
|
2921
3179
|
* @public
|
|
@@ -2959,7 +3217,7 @@ export interface GetMetricWidgetImageInput {
|
|
|
2959
3217
|
* </p>
|
|
2960
3218
|
* <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For
|
|
2961
3219
|
* most use cases, and all actions using an Amazon Web Services SDK, you should use
|
|
2962
|
-
*
|
|
3220
|
+
* <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a
|
|
2963
3221
|
* content-type set to <code>image/png</code>, and the body of the response is a PNG
|
|
2964
3222
|
* image.</p>
|
|
2965
3223
|
* @public
|
|
@@ -2988,8 +3246,8 @@ export interface GetOTelEnrichmentInput {
|
|
|
2988
3246
|
export interface GetOTelEnrichmentOutput {
|
|
2989
3247
|
/**
|
|
2990
3248
|
* <p>The status of OTel enrichment for the account. Valid values are
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
3249
|
+
* <code>Running</code> (enrichment is enabled) and <code>Stopped</code> (enrichment is
|
|
3250
|
+
* disabled).</p>
|
|
2993
3251
|
* @public
|
|
2994
3252
|
*/
|
|
2995
3253
|
Status: OTelEnrichmentStatus | undefined;
|
|
@@ -2999,22 +3257,26 @@ export interface GetOTelEnrichmentOutput {
|
|
|
2999
3257
|
*/
|
|
3000
3258
|
export interface ListAlarmMuteRulesInput {
|
|
3001
3259
|
/**
|
|
3002
|
-
* <p>Filter results to show only mute rules that target the specified alarm
|
|
3260
|
+
* <p>Filter results to show only mute rules that target the specified alarm
|
|
3261
|
+
* name.</p>
|
|
3003
3262
|
* @public
|
|
3004
3263
|
*/
|
|
3005
3264
|
AlarmName?: string | undefined;
|
|
3006
3265
|
/**
|
|
3007
|
-
* <p>Filter results to show only mute rules with the specified statuses. Valid values
|
|
3266
|
+
* <p>Filter results to show only mute rules with the specified statuses. Valid values
|
|
3267
|
+
* are <code>SCHEDULED</code>, <code>ACTIVE</code>, or <code>EXPIRED</code>.</p>
|
|
3008
3268
|
* @public
|
|
3009
3269
|
*/
|
|
3010
3270
|
Statuses?: AlarmMuteRuleStatus[] | undefined;
|
|
3011
3271
|
/**
|
|
3012
|
-
* <p>The maximum number of mute rules to return in one call. The default is
|
|
3272
|
+
* <p>The maximum number of mute rules to return in one call. The default is
|
|
3273
|
+
* 50.</p>
|
|
3013
3274
|
* @public
|
|
3014
3275
|
*/
|
|
3015
3276
|
MaxRecords?: number | undefined;
|
|
3016
3277
|
/**
|
|
3017
|
-
* <p>The token returned from a previous call to indicate where to continue retrieving
|
|
3278
|
+
* <p>The token returned from a previous call to indicate where to continue retrieving
|
|
3279
|
+
* results.</p>
|
|
3018
3280
|
* @public
|
|
3019
3281
|
*/
|
|
3020
3282
|
NextToken?: string | undefined;
|
|
@@ -3029,7 +3291,8 @@ export interface ListAlarmMuteRulesOutput {
|
|
|
3029
3291
|
*/
|
|
3030
3292
|
AlarmMuteRuleSummaries?: AlarmMuteRuleSummary[] | undefined;
|
|
3031
3293
|
/**
|
|
3032
|
-
* <p>The token to use when requesting the next set of results. If this field is absent,
|
|
3294
|
+
* <p>The token to use when requesting the next set of results. If this field is absent,
|
|
3295
|
+
* there are no more results to retrieve.</p>
|
|
3033
3296
|
* @public
|
|
3034
3297
|
*/
|
|
3035
3298
|
NextToken?: string | undefined;
|
|
@@ -3097,7 +3360,7 @@ export interface ListManagedInsightRulesInput {
|
|
|
3097
3360
|
export interface ManagedRuleState {
|
|
3098
3361
|
/**
|
|
3099
3362
|
* <p> The name of the Contributor Insights rule that contains data for the specified
|
|
3100
|
-
*
|
|
3363
|
+
* Amazon Web Services resource. </p>
|
|
3101
3364
|
* @public
|
|
3102
3365
|
*/
|
|
3103
3366
|
RuleName: string | undefined;
|
|
@@ -3109,14 +3372,14 @@ export interface ManagedRuleState {
|
|
|
3109
3372
|
}
|
|
3110
3373
|
/**
|
|
3111
3374
|
* <p> Contains information about managed Contributor Insights rules, as returned by
|
|
3112
|
-
*
|
|
3375
|
+
* <code>ListManagedInsightRules</code>.
|
|
3113
3376
|
* </p>
|
|
3114
3377
|
* @public
|
|
3115
3378
|
*/
|
|
3116
3379
|
export interface ManagedRuleDescription {
|
|
3117
3380
|
/**
|
|
3118
3381
|
* <p> The template name for the managed rule. Used to enable managed rules using
|
|
3119
|
-
*
|
|
3382
|
+
* <code>PutManagedInsightRules</code>. </p>
|
|
3120
3383
|
* @public
|
|
3121
3384
|
*/
|
|
3122
3385
|
TemplateName?: string | undefined;
|
|
@@ -3168,8 +3431,9 @@ export interface ListMetricsInput {
|
|
|
3168
3431
|
*/
|
|
3169
3432
|
MetricName?: string | undefined;
|
|
3170
3433
|
/**
|
|
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
|
|
3434
|
+
* <p>The dimensions to filter against. Only the dimension with names that match exactly
|
|
3435
|
+
* will be returned. If you specify one dimension name and a metric has that dimension and
|
|
3436
|
+
* also other dimensions, it will be returned.</p>
|
|
3173
3437
|
* @public
|
|
3174
3438
|
*/
|
|
3175
3439
|
Dimensions?: DimensionFilter[] | undefined;
|
|
@@ -3278,13 +3542,13 @@ export interface MetricStreamEntry {
|
|
|
3278
3542
|
FirehoseArn?: string | undefined;
|
|
3279
3543
|
/**
|
|
3280
3544
|
* <p>The current state of this stream. Valid values are <code>running</code> and
|
|
3281
|
-
*
|
|
3545
|
+
* <code>stopped</code>.</p>
|
|
3282
3546
|
* @public
|
|
3283
3547
|
*/
|
|
3284
3548
|
State?: string | undefined;
|
|
3285
3549
|
/**
|
|
3286
3550
|
* <p>The output format of this metric stream. Valid values are <code>json</code>,
|
|
3287
|
-
*
|
|
3551
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>.</p>
|
|
3288
3552
|
* @public
|
|
3289
3553
|
*/
|
|
3290
3554
|
OutputFormat?: MetricStreamOutputFormat | undefined;
|
|
@@ -3312,19 +3576,19 @@ export interface ListTagsForResourceInput {
|
|
|
3312
3576
|
/**
|
|
3313
3577
|
* <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
|
|
3314
3578
|
* <p>The ARN format of an alarm is
|
|
3315
|
-
*
|
|
3579
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
3316
3580
|
* </code>
|
|
3317
3581
|
* </p>
|
|
3318
3582
|
* <p>The ARN format of a Contributor Insights rule is
|
|
3319
|
-
*
|
|
3583
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
3320
3584
|
* </code>
|
|
3321
3585
|
* </p>
|
|
3322
3586
|
* <p>The ARN format of a dashboard is
|
|
3323
|
-
*
|
|
3587
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
3324
3588
|
* </code>
|
|
3325
3589
|
* </p>
|
|
3326
3590
|
* <p>The ARN format of a metric stream is
|
|
3327
|
-
*
|
|
3591
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
3328
3592
|
* </code>
|
|
3329
3593
|
* </p>
|
|
3330
3594
|
* <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 +3597,6 @@ export interface ListTagsForResourceInput {
|
|
|
3333
3597
|
*/
|
|
3334
3598
|
ResourceARN: string | undefined;
|
|
3335
3599
|
}
|
|
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
3600
|
/**
|
|
3354
3601
|
* @public
|
|
3355
3602
|
*/
|
|
@@ -3385,17 +3632,24 @@ export interface PutAlarmMuteRuleInput {
|
|
|
3385
3632
|
*/
|
|
3386
3633
|
MuteTargets?: MuteTargets | undefined;
|
|
3387
3634
|
/**
|
|
3388
|
-
* <p>A list of key-value pairs to associate with the alarm mute rule. You can use tags
|
|
3635
|
+
* <p>A list of key-value pairs to associate with the alarm mute rule. You can use tags
|
|
3636
|
+
* to categorize and manage your mute rules.</p>
|
|
3389
3637
|
* @public
|
|
3390
3638
|
*/
|
|
3391
3639
|
Tags?: Tag[] | undefined;
|
|
3392
3640
|
/**
|
|
3393
|
-
* <p>The date and time after which the mute rule takes effect, specified as a timestamp
|
|
3641
|
+
* <p>The date and time after which the mute rule takes effect, specified as a timestamp
|
|
3642
|
+
* in ISO 8601 format (for example, <code>2026-04-15T08:00:00Z</code>). If not specified,
|
|
3643
|
+
* the mute rule takes effect immediately upon creation and the mutes are applied as per
|
|
3644
|
+
* the schedule expression.</p>
|
|
3394
3645
|
* @public
|
|
3395
3646
|
*/
|
|
3396
3647
|
StartDate?: Date | undefined;
|
|
3397
3648
|
/**
|
|
3398
|
-
* <p>The date and time when the mute rule expires and is no longer evaluated, specified
|
|
3649
|
+
* <p>The date and time when the mute rule expires and is no longer evaluated, specified
|
|
3650
|
+
* as a timestamp in ISO 8601 format (for example, <code>2026-12-31T23:59:59Z</code>).
|
|
3651
|
+
* After this time, the rule status becomes EXPIRED and will no longer mute the targeted
|
|
3652
|
+
* alarms.</p>
|
|
3399
3653
|
* @public
|
|
3400
3654
|
*/
|
|
3401
3655
|
ExpireDate?: Date | undefined;
|
|
@@ -3442,7 +3696,7 @@ export interface PutAnomalyDetectorInput {
|
|
|
3442
3696
|
Configuration?: AnomalyDetectorConfiguration | undefined;
|
|
3443
3697
|
/**
|
|
3444
3698
|
* <p>Use this object to include parameters to provide information about your metric to
|
|
3445
|
-
*
|
|
3699
|
+
* CloudWatch to help it build more accurate anomaly detection models.
|
|
3446
3700
|
* Currently, it includes the <code>PeriodicSpikes</code> parameter.</p>
|
|
3447
3701
|
* @public
|
|
3448
3702
|
*/
|
|
@@ -3474,12 +3728,12 @@ export interface PutAnomalyDetectorInput {
|
|
|
3474
3728
|
* </li>
|
|
3475
3729
|
* <li>
|
|
3476
3730
|
* <p>the <code>MetricMathAnomalyDetector</code> parameters of
|
|
3477
|
-
*
|
|
3731
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3478
3732
|
* </p>
|
|
3479
3733
|
* </li>
|
|
3480
3734
|
* </ul>
|
|
3481
3735
|
* <p>Instead, specify the single metric anomaly detector attributes as part of the property
|
|
3482
|
-
*
|
|
3736
|
+
* <code>SingleMetricAnomalyDetector</code>.</p>
|
|
3483
3737
|
* @public
|
|
3484
3738
|
*/
|
|
3485
3739
|
SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
|
|
@@ -3510,12 +3764,12 @@ export interface PutAnomalyDetectorInput {
|
|
|
3510
3764
|
* </li>
|
|
3511
3765
|
* <li>
|
|
3512
3766
|
* <p>the <code>SingleMetricAnomalyDetector</code> parameters of
|
|
3513
|
-
*
|
|
3767
|
+
* <code>PutAnomalyDetectorInput</code>
|
|
3514
3768
|
* </p>
|
|
3515
3769
|
* </li>
|
|
3516
3770
|
* </ul>
|
|
3517
3771
|
* <p>Instead, specify the metric math anomaly detector attributes as part of the property
|
|
3518
|
-
*
|
|
3772
|
+
* <code>MetricMathAnomalyDetector</code>.</p>
|
|
3519
3773
|
* @public
|
|
3520
3774
|
*/
|
|
3521
3775
|
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
|
|
@@ -3553,19 +3807,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3553
3807
|
* <ul>
|
|
3554
3808
|
* <li>
|
|
3555
3809
|
* <p>Invoke the latest version of a Lambda function:
|
|
3556
|
-
*
|
|
3810
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3557
3811
|
* </code>
|
|
3558
3812
|
* </p>
|
|
3559
3813
|
* </li>
|
|
3560
3814
|
* <li>
|
|
3561
3815
|
* <p>Invoke a specific version of a Lambda function:
|
|
3562
|
-
*
|
|
3816
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3563
3817
|
* </code>
|
|
3564
3818
|
* </p>
|
|
3565
3819
|
* </li>
|
|
3566
3820
|
* <li>
|
|
3567
3821
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3568
|
-
*
|
|
3822
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3569
3823
|
* </code>
|
|
3570
3824
|
* </p>
|
|
3571
3825
|
* </li>
|
|
@@ -3578,7 +3832,8 @@ export interface PutCompositeAlarmInput {
|
|
|
3578
3832
|
* </code>
|
|
3579
3833
|
* </p>
|
|
3580
3834
|
* <p>
|
|
3581
|
-
* <b>Start a Amazon Q Developer operational
|
|
3835
|
+
* <b>Start a Amazon Q Developer operational
|
|
3836
|
+
* investigation</b>
|
|
3582
3837
|
* </p>
|
|
3583
3838
|
* <p>
|
|
3584
3839
|
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i>
|
|
@@ -3612,19 +3867,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3612
3867
|
* <li>
|
|
3613
3868
|
* <p>
|
|
3614
3869
|
* <code>ALARM("<i>alarm-name</i> or
|
|
3615
|
-
*
|
|
3870
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3616
3871
|
* ALARM state.</p>
|
|
3617
3872
|
* </li>
|
|
3618
3873
|
* <li>
|
|
3619
3874
|
* <p>
|
|
3620
3875
|
* <code>OK("<i>alarm-name</i> or
|
|
3621
|
-
*
|
|
3876
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in OK
|
|
3622
3877
|
* state.</p>
|
|
3623
3878
|
* </li>
|
|
3624
3879
|
* <li>
|
|
3625
3880
|
* <p>
|
|
3626
3881
|
* <code>INSUFFICIENT_DATA("<i>alarm-name</i> or
|
|
3627
|
-
*
|
|
3882
|
+
* <i>alarm-ARN</i>")</code> is TRUE if the named alarm is in
|
|
3628
3883
|
* INSUFFICIENT_DATA state.</p>
|
|
3629
3884
|
* </li>
|
|
3630
3885
|
* <li>
|
|
@@ -3658,7 +3913,7 @@ export interface PutCompositeAlarmInput {
|
|
|
3658
3913
|
* <li>
|
|
3659
3914
|
* <p>
|
|
3660
3915
|
* <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
|
|
3661
|
-
*
|
|
3916
|
+
* OK(NetworkOutTooHigh)</code> goes into ALARM state if CPUUtilizationTooHigh
|
|
3662
3917
|
* OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
|
|
3663
3918
|
* state. This provides another example of using a composite alarm to prevent
|
|
3664
3919
|
* noise. This rule ensures that you are not notified with an alarm action on high
|
|
@@ -3666,14 +3921,14 @@ export interface PutCompositeAlarmInput {
|
|
|
3666
3921
|
* </li>
|
|
3667
3922
|
* </ul>
|
|
3668
3923
|
* <p>The <code>AlarmRule</code> can specify as many as 100 "children" alarms. The
|
|
3669
|
-
*
|
|
3924
|
+
* <code>AlarmRule</code> expression can have as many as 500 elements. Elements are
|
|
3670
3925
|
* child alarms, TRUE or FALSE statements, and parentheses.</p>
|
|
3671
3926
|
* @public
|
|
3672
3927
|
*/
|
|
3673
3928
|
AlarmRule: string | undefined;
|
|
3674
3929
|
/**
|
|
3675
3930
|
* <p>The actions to execute when this alarm transitions to the
|
|
3676
|
-
*
|
|
3931
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
3677
3932
|
* as an Amazon Resource Name (ARN).</p>
|
|
3678
3933
|
* <p>Valid Values: ]</p>
|
|
3679
3934
|
* <p>
|
|
@@ -3689,19 +3944,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3689
3944
|
* <ul>
|
|
3690
3945
|
* <li>
|
|
3691
3946
|
* <p>Invoke the latest version of a Lambda function:
|
|
3692
|
-
*
|
|
3947
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3693
3948
|
* </code>
|
|
3694
3949
|
* </p>
|
|
3695
3950
|
* </li>
|
|
3696
3951
|
* <li>
|
|
3697
3952
|
* <p>Invoke a specific version of a Lambda function:
|
|
3698
|
-
*
|
|
3953
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3699
3954
|
* </code>
|
|
3700
3955
|
* </p>
|
|
3701
3956
|
* </li>
|
|
3702
3957
|
* <li>
|
|
3703
3958
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3704
|
-
*
|
|
3959
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3705
3960
|
* </code>
|
|
3706
3961
|
* </p>
|
|
3707
3962
|
* </li>
|
|
@@ -3726,19 +3981,19 @@ export interface PutCompositeAlarmInput {
|
|
|
3726
3981
|
* <ul>
|
|
3727
3982
|
* <li>
|
|
3728
3983
|
* <p>Invoke the latest version of a Lambda function:
|
|
3729
|
-
*
|
|
3984
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
3730
3985
|
* </code>
|
|
3731
3986
|
* </p>
|
|
3732
3987
|
* </li>
|
|
3733
3988
|
* <li>
|
|
3734
3989
|
* <p>Invoke a specific version of a Lambda function:
|
|
3735
|
-
*
|
|
3990
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
3736
3991
|
* </code>
|
|
3737
3992
|
* </p>
|
|
3738
3993
|
* </li>
|
|
3739
3994
|
* <li>
|
|
3740
3995
|
* <p>Invoke a function by using an alias Lambda function:
|
|
3741
|
-
*
|
|
3996
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
3742
3997
|
* </code>
|
|
3743
3998
|
* </p>
|
|
3744
3999
|
* </li>
|
|
@@ -3805,7 +4060,7 @@ export interface PutDashboardInput {
|
|
|
3805
4060
|
/**
|
|
3806
4061
|
* <p>The detailed information about the dashboard in JSON format, including the widgets
|
|
3807
4062
|
* 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/
|
|
4063
|
+
* <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
4064
|
* @public
|
|
3810
4065
|
*/
|
|
3811
4066
|
DashboardBody: string | undefined;
|
|
@@ -3816,9 +4071,9 @@ export interface PutDashboardInput {
|
|
|
3816
4071
|
* scope user permissions by granting a user permission to access or change only dashboards
|
|
3817
4072
|
* with certain tag values.</p>
|
|
3818
4073
|
* <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>
|
|
4074
|
+
* <code>Tags</code> when updating an existing dashboard, the tag updates are ignored.
|
|
4075
|
+
* 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>.
|
|
4076
|
+
* To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
3822
4077
|
* @public
|
|
3823
4078
|
*/
|
|
3824
4079
|
Tags?: Tag[] | undefined;
|
|
@@ -3855,7 +4110,7 @@ export interface PutInsightRuleInput {
|
|
|
3855
4110
|
RuleState?: string | undefined;
|
|
3856
4111
|
/**
|
|
3857
4112
|
* <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
|
|
3858
|
-
*
|
|
4113
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights Rule Syntax</a>.</p>
|
|
3859
4114
|
* @public
|
|
3860
4115
|
*/
|
|
3861
4116
|
RuleDefinition: string | undefined;
|
|
@@ -3866,8 +4121,8 @@ export interface PutInsightRuleInput {
|
|
|
3866
4121
|
* scope user permissions, by granting a user permission to access or change only the
|
|
3867
4122
|
* resources that have certain tag values.</p>
|
|
3868
4123
|
* <p>To be able to associate tags with a rule, you must have the
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
4124
|
+
* <code>cloudwatch:TagResource</code> permission in addition to the
|
|
4125
|
+
* <code>cloudwatch:PutInsightRule</code> permission.</p>
|
|
3871
4126
|
* <p>If you are using this operation to update an existing Contributor Insights rule, any
|
|
3872
4127
|
* tags you specify in this parameter are ignored. To change the tags of an existing rule,
|
|
3873
4128
|
* use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
@@ -3875,16 +4130,18 @@ export interface PutInsightRuleInput {
|
|
|
3875
4130
|
*/
|
|
3876
4131
|
Tags?: Tag[] | undefined;
|
|
3877
4132
|
/**
|
|
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
|
-
*
|
|
4133
|
+
* <p>Specify <code>true</code> to have this rule evaluate log events after they have been
|
|
4134
|
+
* transformed by <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">Log
|
|
4135
|
+
* transformation</a>. If you specify <code>true</code>, then the log events in log
|
|
4136
|
+
* groups that have transformers will be evaluated by Contributor Insights after being
|
|
4137
|
+
* transformed. Log groups that don't have transformers will still have their original log
|
|
4138
|
+
* events evaluated by Contributor Insights.</p>
|
|
3882
4139
|
* <p>The default is <code>false</code>
|
|
3883
4140
|
* </p>
|
|
3884
4141
|
* <note>
|
|
3885
|
-
* <p>If a log group has a transformer, and transformation fails for some log events,
|
|
3886
|
-
*
|
|
3887
|
-
*
|
|
4142
|
+
* <p>If a log group has a transformer, and transformation fails for some log events,
|
|
4143
|
+
* those log events won't be evaluated by Contributor Insights. For information about
|
|
4144
|
+
* 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
4145
|
* </note>
|
|
3889
4146
|
* @public
|
|
3890
4147
|
*/
|
|
@@ -3895,6 +4152,189 @@ export interface PutInsightRuleInput {
|
|
|
3895
4152
|
*/
|
|
3896
4153
|
export interface PutInsightRuleOutput {
|
|
3897
4154
|
}
|
|
4155
|
+
/**
|
|
4156
|
+
* @public
|
|
4157
|
+
*/
|
|
4158
|
+
export interface PutLogAlarmInput {
|
|
4159
|
+
/**
|
|
4160
|
+
* <p>The name for the alarm. This name must be unique within the Amazon Web Services account and Region.</p>
|
|
4161
|
+
* @public
|
|
4162
|
+
*/
|
|
4163
|
+
AlarmName: string | undefined;
|
|
4164
|
+
/**
|
|
4165
|
+
* <p>The description for the alarm.</p>
|
|
4166
|
+
* @public
|
|
4167
|
+
*/
|
|
4168
|
+
AlarmDescription?: string | undefined;
|
|
4169
|
+
/**
|
|
4170
|
+
* <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>
|
|
4171
|
+
* @public
|
|
4172
|
+
*/
|
|
4173
|
+
ScheduledQueryConfiguration: ScheduledQueryConfiguration | undefined;
|
|
4174
|
+
/**
|
|
4175
|
+
* <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>
|
|
4176
|
+
* @public
|
|
4177
|
+
*/
|
|
4178
|
+
ActionLogLineCount?: number | undefined;
|
|
4179
|
+
/**
|
|
4180
|
+
* <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>
|
|
4181
|
+
* @public
|
|
4182
|
+
*/
|
|
4183
|
+
ActionLogLineRoleArn?: string | undefined;
|
|
4184
|
+
/**
|
|
4185
|
+
* <p>Indicates whether actions should be executed during any changes to the alarm state. The default is <code>true</code>.</p>
|
|
4186
|
+
* @public
|
|
4187
|
+
*/
|
|
4188
|
+
ActionsEnabled?: boolean | undefined;
|
|
4189
|
+
/**
|
|
4190
|
+
* <p>The actions to execute when this alarm transitions to the <code>OK</code> state
|
|
4191
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4192
|
+
* <p>Valid Values:</p>
|
|
4193
|
+
* <p>
|
|
4194
|
+
* <b>Amazon SNS actions:</b>
|
|
4195
|
+
* </p>
|
|
4196
|
+
* <p>
|
|
4197
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4198
|
+
* </code>
|
|
4199
|
+
* </p>
|
|
4200
|
+
* <p>
|
|
4201
|
+
* <b>Lambda actions:</b>
|
|
4202
|
+
* </p>
|
|
4203
|
+
* <ul>
|
|
4204
|
+
* <li>
|
|
4205
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4206
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4207
|
+
* </code>
|
|
4208
|
+
* </p>
|
|
4209
|
+
* </li>
|
|
4210
|
+
* <li>
|
|
4211
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4212
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4213
|
+
* </code>
|
|
4214
|
+
* </p>
|
|
4215
|
+
* </li>
|
|
4216
|
+
* <li>
|
|
4217
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4218
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4219
|
+
* </code>
|
|
4220
|
+
* </p>
|
|
4221
|
+
* </li>
|
|
4222
|
+
* </ul>
|
|
4223
|
+
* @public
|
|
4224
|
+
*/
|
|
4225
|
+
OKActions?: string[] | undefined;
|
|
4226
|
+
/**
|
|
4227
|
+
* <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
|
|
4228
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4229
|
+
* <p>Valid Values:</p>
|
|
4230
|
+
* <p>
|
|
4231
|
+
* <b>Amazon SNS actions:</b>
|
|
4232
|
+
* </p>
|
|
4233
|
+
* <p>
|
|
4234
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4235
|
+
* </code>
|
|
4236
|
+
* </p>
|
|
4237
|
+
* <p>
|
|
4238
|
+
* <b>Lambda actions:</b>
|
|
4239
|
+
* </p>
|
|
4240
|
+
* <ul>
|
|
4241
|
+
* <li>
|
|
4242
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4243
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4244
|
+
* </code>
|
|
4245
|
+
* </p>
|
|
4246
|
+
* </li>
|
|
4247
|
+
* <li>
|
|
4248
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4249
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4250
|
+
* </code>
|
|
4251
|
+
* </p>
|
|
4252
|
+
* </li>
|
|
4253
|
+
* <li>
|
|
4254
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4255
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4256
|
+
* </code>
|
|
4257
|
+
* </p>
|
|
4258
|
+
* </li>
|
|
4259
|
+
* </ul>
|
|
4260
|
+
* <p>
|
|
4261
|
+
* <b>Systems Manager actions:</b>
|
|
4262
|
+
* </p>
|
|
4263
|
+
* <p>
|
|
4264
|
+
* <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
|
|
4265
|
+
* </code>
|
|
4266
|
+
* </p>
|
|
4267
|
+
* @public
|
|
4268
|
+
*/
|
|
4269
|
+
AlarmActions?: string[] | undefined;
|
|
4270
|
+
/**
|
|
4271
|
+
* <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state
|
|
4272
|
+
* from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
|
|
4273
|
+
* <p>Valid Values:</p>
|
|
4274
|
+
* <p>
|
|
4275
|
+
* <b>Amazon SNS actions:</b>
|
|
4276
|
+
* </p>
|
|
4277
|
+
* <p>
|
|
4278
|
+
* <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
|
|
4279
|
+
* </code>
|
|
4280
|
+
* </p>
|
|
4281
|
+
* <p>
|
|
4282
|
+
* <b>Lambda actions:</b>
|
|
4283
|
+
* </p>
|
|
4284
|
+
* <ul>
|
|
4285
|
+
* <li>
|
|
4286
|
+
* <p>Invoke the latest version of a Lambda function:
|
|
4287
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4288
|
+
* </code>
|
|
4289
|
+
* </p>
|
|
4290
|
+
* </li>
|
|
4291
|
+
* <li>
|
|
4292
|
+
* <p>Invoke a specific version of a Lambda function:
|
|
4293
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4294
|
+
* </code>
|
|
4295
|
+
* </p>
|
|
4296
|
+
* </li>
|
|
4297
|
+
* <li>
|
|
4298
|
+
* <p>Invoke a function by using an alias Lambda function:
|
|
4299
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4300
|
+
* </code>
|
|
4301
|
+
* </p>
|
|
4302
|
+
* </li>
|
|
4303
|
+
* </ul>
|
|
4304
|
+
* @public
|
|
4305
|
+
*/
|
|
4306
|
+
InsufficientDataActions?: string[] | undefined;
|
|
4307
|
+
/**
|
|
4308
|
+
* <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>
|
|
4309
|
+
* @public
|
|
4310
|
+
*/
|
|
4311
|
+
QueryResultsToEvaluate: number | undefined;
|
|
4312
|
+
/**
|
|
4313
|
+
* <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>
|
|
4314
|
+
* @public
|
|
4315
|
+
*/
|
|
4316
|
+
QueryResultsToAlarm: number | undefined;
|
|
4317
|
+
/**
|
|
4318
|
+
* <p>The value to compare with the aggregated query result.</p>
|
|
4319
|
+
* @public
|
|
4320
|
+
*/
|
|
4321
|
+
Threshold: number | undefined;
|
|
4322
|
+
/**
|
|
4323
|
+
* <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>
|
|
4324
|
+
* @public
|
|
4325
|
+
*/
|
|
4326
|
+
ComparisonOperator: ComparisonOperator | undefined;
|
|
4327
|
+
/**
|
|
4328
|
+
* <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>
|
|
4329
|
+
* @public
|
|
4330
|
+
*/
|
|
4331
|
+
TreatMissingData?: string | undefined;
|
|
4332
|
+
/**
|
|
4333
|
+
* <p>A list of key-value pairs to associate with the alarm. You can use tags to categorize and manage your alarms.</p>
|
|
4334
|
+
* @public
|
|
4335
|
+
*/
|
|
4336
|
+
Tags?: Tag[] | undefined;
|
|
4337
|
+
}
|
|
3898
4338
|
/**
|
|
3899
4339
|
* <p> Contains the information that's required to enable a managed Contributor Insights
|
|
3900
4340
|
* rule for an Amazon Web Services resource.
|
|
@@ -3905,7 +4345,7 @@ export interface PutInsightRuleOutput {
|
|
|
3905
4345
|
export interface ManagedRule {
|
|
3906
4346
|
/**
|
|
3907
4347
|
* <p> The template name for the managed Contributor Insights rule, as returned by
|
|
3908
|
-
*
|
|
4348
|
+
* <code>ListManagedInsightRules</code>. </p>
|
|
3909
4349
|
* @public
|
|
3910
4350
|
*/
|
|
3911
4351
|
TemplateName: string | undefined;
|
|
@@ -3924,7 +4364,7 @@ export interface ManagedRule {
|
|
|
3924
4364
|
* permission in addition to the <code>cloudwatch:PutInsightRule</code> permission. If you
|
|
3925
4365
|
* are using this operation to update an existing Contributor Insights rule, any tags that
|
|
3926
4366
|
* you specify in this parameter are ignored. To change the tags of an existing rule, use
|
|
3927
|
-
*
|
|
4367
|
+
* <code>TagResource</code>. </p>
|
|
3928
4368
|
* @public
|
|
3929
4369
|
*/
|
|
3930
4370
|
Tags?: Tag[] | undefined;
|
|
@@ -4037,19 +4477,19 @@ export interface PutMetricAlarmInput {
|
|
|
4037
4477
|
* <ul>
|
|
4038
4478
|
* <li>
|
|
4039
4479
|
* <p>Invoke the latest version of a Lambda function:
|
|
4040
|
-
*
|
|
4480
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4041
4481
|
* </code>
|
|
4042
4482
|
* </p>
|
|
4043
4483
|
* </li>
|
|
4044
4484
|
* <li>
|
|
4045
4485
|
* <p>Invoke a specific version of a Lambda function:
|
|
4046
|
-
*
|
|
4486
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4047
4487
|
* </code>
|
|
4048
4488
|
* </p>
|
|
4049
4489
|
* </li>
|
|
4050
4490
|
* <li>
|
|
4051
4491
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4052
|
-
*
|
|
4492
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4053
4493
|
* </code>
|
|
4054
4494
|
* </p>
|
|
4055
4495
|
* </li>
|
|
@@ -4151,19 +4591,19 @@ export interface PutMetricAlarmInput {
|
|
|
4151
4591
|
* <ul>
|
|
4152
4592
|
* <li>
|
|
4153
4593
|
* <p>Invoke the latest version of a Lambda function:
|
|
4154
|
-
*
|
|
4594
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4155
4595
|
* </code>
|
|
4156
4596
|
* </p>
|
|
4157
4597
|
* </li>
|
|
4158
4598
|
* <li>
|
|
4159
4599
|
* <p>Invoke a specific version of a Lambda function:
|
|
4160
|
-
*
|
|
4600
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4161
4601
|
* </code>
|
|
4162
4602
|
* </p>
|
|
4163
4603
|
* </li>
|
|
4164
4604
|
* <li>
|
|
4165
4605
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4166
|
-
*
|
|
4606
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4167
4607
|
* </code>
|
|
4168
4608
|
* </p>
|
|
4169
4609
|
* </li>
|
|
@@ -4197,7 +4637,8 @@ export interface PutMetricAlarmInput {
|
|
|
4197
4637
|
* </li>
|
|
4198
4638
|
* </ul>
|
|
4199
4639
|
* <p>
|
|
4200
|
-
* <b>Start a Amazon Q Developer operational
|
|
4640
|
+
* <b>Start a Amazon Q Developer operational
|
|
4641
|
+
* investigation</b>
|
|
4201
4642
|
* </p>
|
|
4202
4643
|
* <p>
|
|
4203
4644
|
* <code>arn:aws:aiops:<i>region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i>
|
|
@@ -4208,7 +4649,7 @@ export interface PutMetricAlarmInput {
|
|
|
4208
4649
|
AlarmActions?: string[] | undefined;
|
|
4209
4650
|
/**
|
|
4210
4651
|
* <p>The actions to execute when this alarm transitions to the
|
|
4211
|
-
*
|
|
4652
|
+
* <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified
|
|
4212
4653
|
* as an Amazon Resource Name (ARN). Valid values:</p>
|
|
4213
4654
|
* <p>
|
|
4214
4655
|
* <b>EC2 actions:</b>
|
|
@@ -4272,19 +4713,19 @@ export interface PutMetricAlarmInput {
|
|
|
4272
4713
|
* <ul>
|
|
4273
4714
|
* <li>
|
|
4274
4715
|
* <p>Invoke the latest version of a Lambda function:
|
|
4275
|
-
*
|
|
4716
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>
|
|
4276
4717
|
* </code>
|
|
4277
4718
|
* </p>
|
|
4278
4719
|
* </li>
|
|
4279
4720
|
* <li>
|
|
4280
4721
|
* <p>Invoke a specific version of a Lambda function:
|
|
4281
|
-
*
|
|
4722
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>version-number</i>
|
|
4282
4723
|
* </code>
|
|
4283
4724
|
* </p>
|
|
4284
4725
|
* </li>
|
|
4285
4726
|
* <li>
|
|
4286
4727
|
* <p>Invoke a function by using an alias Lambda function:
|
|
4287
|
-
*
|
|
4728
|
+
* <code>arn:aws:lambda:<i>region</i>:<i>account-id</i>:function:<i>function-name</i>:<i>alias-name</i>
|
|
4288
4729
|
* </code>
|
|
4289
4730
|
* </p>
|
|
4290
4731
|
* </li>
|
|
@@ -4322,13 +4763,13 @@ export interface PutMetricAlarmInput {
|
|
|
4322
4763
|
InsufficientDataActions?: string[] | undefined;
|
|
4323
4764
|
/**
|
|
4324
4765
|
* <p>The name for the metric associated with the alarm. For each
|
|
4325
|
-
*
|
|
4326
|
-
*
|
|
4327
|
-
*
|
|
4766
|
+
* <code>PutMetricAlarm</code> operation, you must specify either
|
|
4767
|
+
* <code>MetricName</code>, a <code>Metrics</code> array, or an
|
|
4768
|
+
* <code>EvaluationCriteria</code>.</p>
|
|
4328
4769
|
* <p>If you are creating an alarm based on a math expression, you cannot specify this
|
|
4329
4770
|
* parameter, or any of the <code>Namespace</code>, <code>Dimensions</code>,
|
|
4330
|
-
*
|
|
4331
|
-
*
|
|
4771
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
4772
|
+
* <code>ExtendedStatistic</code> parameters. Instead, you specify all this information
|
|
4332
4773
|
* in the <code>Metrics</code> array.</p>
|
|
4333
4774
|
* @public
|
|
4334
4775
|
*/
|
|
@@ -4342,7 +4783,7 @@ export interface PutMetricAlarmInput {
|
|
|
4342
4783
|
/**
|
|
4343
4784
|
* <p>The statistic for the metric specified in <code>MetricName</code>, other than
|
|
4344
4785
|
* percentile. For percentile statistics, use <code>ExtendedStatistic</code>. When you call
|
|
4345
|
-
*
|
|
4786
|
+
* <code>PutMetricAlarm</code> and specify a <code>MetricName</code>, you must specify
|
|
4346
4787
|
* either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
|
|
4347
4788
|
* @public
|
|
4348
4789
|
*/
|
|
@@ -4421,24 +4862,25 @@ export interface PutMetricAlarmInput {
|
|
|
4421
4862
|
Dimensions?: Dimension[] | undefined;
|
|
4422
4863
|
/**
|
|
4423
4864
|
* <p>The length, in seconds, used each time the metric specified in
|
|
4424
|
-
*
|
|
4425
|
-
* 60.</p>
|
|
4865
|
+
* <code>MetricName</code> is evaluated. Valid values are 10, 20, 30, and any multiple
|
|
4866
|
+
* of 60.</p>
|
|
4426
4867
|
* <p>
|
|
4427
4868
|
* <code>Period</code> is required for alarms based on static thresholds. If you are
|
|
4428
4869
|
* creating an alarm based on a metric math expression, you specify the period for each
|
|
4429
4870
|
* metric within the objects in the <code>Metrics</code> array.</p>
|
|
4430
4871
|
* <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
|
-
*
|
|
4872
|
+
* <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you
|
|
4873
|
+
* specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution,
|
|
4874
|
+
* the alarm still attempts to gather data at the period rate that you specify. In this
|
|
4875
|
+
* case, it does not receive data for the attempts that do not correspond to a one-minute
|
|
4876
|
+
* data resolution, and the alarm might often lapse into INSUFFICENT_DATA status.
|
|
4877
|
+
* Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a
|
|
4878
|
+
* higher charge than other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
4879
|
+
* Pricing</a>.</p>
|
|
4439
4880
|
* <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
|
|
4881
|
+
* <code>Period</code> multiplied by <code>EvaluationPeriods</code> can't be more than
|
|
4882
|
+
* 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the
|
|
4883
|
+
* total evaluation period can't be longer than one day (86,400 seconds).</p>
|
|
4442
4884
|
* @public
|
|
4443
4885
|
*/
|
|
4444
4886
|
Period?: number | undefined;
|
|
@@ -4474,7 +4916,7 @@ export interface PutMetricAlarmInput {
|
|
|
4474
4916
|
* <p>The number of data points that must be breaching to trigger the alarm. This is used
|
|
4475
4917
|
* only if you are setting an "M out of N" alarm. In that case, this value is the M. For
|
|
4476
4918
|
* 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
|
-
*
|
|
4919
|
+
* Guide</i>.</p>
|
|
4478
4920
|
* @public
|
|
4479
4921
|
*/
|
|
4480
4922
|
DatapointsToAlarm?: number | undefined;
|
|
@@ -4489,21 +4931,21 @@ export interface PutMetricAlarmInput {
|
|
|
4489
4931
|
* <p> The arithmetic operation to use when comparing the specified statistic and
|
|
4490
4932
|
* threshold. The specified statistic value is used as the first operand.</p>
|
|
4491
4933
|
* <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
|
|
4492
|
-
*
|
|
4934
|
+
* <code>LessThanLowerThreshold</code>, and <code>GreaterThanUpperThreshold</code> are
|
|
4493
4935
|
* used only for alarms based on anomaly detection models.</p>
|
|
4494
4936
|
* @public
|
|
4495
4937
|
*/
|
|
4496
4938
|
ComparisonOperator?: ComparisonOperator | undefined;
|
|
4497
4939
|
/**
|
|
4498
4940
|
* <p> Sets how this alarm is to handle missing data points. If
|
|
4499
|
-
*
|
|
4500
|
-
*
|
|
4941
|
+
* <code>TreatMissingData</code> is omitted, the default behavior of
|
|
4942
|
+
* <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
4943
|
* <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>
|
|
4502
4944
|
* </p>
|
|
4503
4945
|
* <note>
|
|
4504
4946
|
* <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4947
|
+
* <code>ignore</code> missing data even if you choose a different option for
|
|
4948
|
+
* <code>TreatMissingData</code>. When an <code>AWS/DynamoDB</code> metric has
|
|
4507
4949
|
* missing data, alarms that evaluate that metric remain in their current state.</p>
|
|
4508
4950
|
* </note>
|
|
4509
4951
|
* <note>
|
|
@@ -4534,11 +4976,11 @@ export interface PutMetricAlarmInput {
|
|
|
4534
4976
|
* You designate this expression by setting <code>ReturnData</code> to true for this object
|
|
4535
4977
|
* in the array. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html">MetricDataQuery</a>.</p>
|
|
4536
4978
|
* <p>If you use the <code>Metrics</code> parameter, you cannot include the
|
|
4537
|
-
*
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4540
|
-
*
|
|
4541
|
-
*
|
|
4979
|
+
* <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>,
|
|
4980
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>, or
|
|
4981
|
+
* <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same
|
|
4982
|
+
* operation. Instead, you retrieve the metrics you are using in your math expression as
|
|
4983
|
+
* part of the <code>Metrics</code> array.</p>
|
|
4542
4984
|
* @public
|
|
4543
4985
|
*/
|
|
4544
4986
|
Metrics?: MetricDataQuery[] | undefined;
|
|
@@ -4553,7 +4995,7 @@ export interface PutMetricAlarmInput {
|
|
|
4553
4995
|
* 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
4996
|
* <p>To use this field to set tags for an alarm when you create it, you must be signed on
|
|
4555
4997
|
* with both the <code>cloudwatch:PutMetricAlarm</code> and
|
|
4556
|
-
*
|
|
4998
|
+
* <code>cloudwatch:TagResource</code> permissions.</p>
|
|
4557
4999
|
* @public
|
|
4558
5000
|
*/
|
|
4559
5001
|
Tags?: Tag[] | undefined;
|
|
@@ -4561,7 +5003,7 @@ export interface PutMetricAlarmInput {
|
|
|
4561
5003
|
* <p>If this is an alarm based on an anomaly detection model, make this value match the ID
|
|
4562
5004
|
* of the <code>ANOMALY_DETECTION_BAND</code> function.</p>
|
|
4563
5005
|
* <p>For an example of how to use this parameter, see the <b>Anomaly
|
|
4564
|
-
*
|
|
5006
|
+
* Detection Model Alarm</b> example on this page.</p>
|
|
4565
5007
|
* <p>If your alarm uses this parameter, it cannot have Auto Scaling actions.</p>
|
|
4566
5008
|
* @public
|
|
4567
5009
|
*/
|
|
@@ -4571,15 +5013,15 @@ export interface PutMetricAlarmInput {
|
|
|
4571
5013
|
* operation, you must specify either <code>MetricName</code>, a <code>Metrics</code>
|
|
4572
5014
|
* array, or an <code>EvaluationCriteria</code>.</p>
|
|
4573
5015
|
* <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>
|
|
5016
|
+
* <code>Namespace</code>, <code>MetricName</code>, <code>Dimensions</code>,
|
|
5017
|
+
* <code>Period</code>, <code>Unit</code>, <code>Statistic</code>,
|
|
5018
|
+
* <code>ExtendedStatistic</code>, <code>Metrics</code>, <code>Threshold</code>,
|
|
5019
|
+
* <code>ComparisonOperator</code>, <code>ThresholdMetricId</code>,
|
|
5020
|
+
* <code>EvaluationPeriods</code>, or <code>DatapointsToAlarm</code> parameters of
|
|
5021
|
+
* <code>PutMetricAlarm</code> in the same operation. Instead, all evaluation
|
|
5022
|
+
* parameters are defined within this structure.</p>
|
|
4581
5023
|
* <p>For an example of how to use this parameter, see the <b>PromQL
|
|
4582
|
-
*
|
|
5024
|
+
* alarm</b> example on this page.</p>
|
|
4583
5025
|
* @public
|
|
4584
5026
|
*/
|
|
4585
5027
|
EvaluationCriteria?: EvaluationCriteria | undefined;
|
|
@@ -4588,7 +5030,7 @@ export interface PutMetricAlarmInput {
|
|
|
4588
5030
|
* 20, 30, and any multiple of 60.</p>
|
|
4589
5031
|
* <p>This parameter is required for alarms that use <code>EvaluationCriteria</code>, and
|
|
4590
5032
|
* cannot be specified for alarms configured with <code>MetricName</code> or
|
|
4591
|
-
*
|
|
5033
|
+
* <code>Metrics</code>.</p>
|
|
4592
5034
|
* @public
|
|
4593
5035
|
*/
|
|
4594
5036
|
EvaluationInterval?: number | undefined;
|
|
@@ -4615,9 +5057,9 @@ export interface PutMetricDataInput {
|
|
|
4615
5057
|
*/
|
|
4616
5058
|
MetricData?: MetricDatum[] | undefined;
|
|
4617
5059
|
/**
|
|
4618
|
-
* <p>Data for metrics that contain associated entity information. You can include up to
|
|
4619
|
-
*
|
|
4620
|
-
*
|
|
5060
|
+
* <p>Data for metrics that contain associated entity information. You can include up to two
|
|
5061
|
+
* <code>EntityMetricData</code> objects, each of which can contain a single
|
|
5062
|
+
* <code>Entity</code> and associated metrics.</p>
|
|
4621
5063
|
* <p>The limit of metrics allowed, 1000, is the sum of both <code>EntityMetricData</code>
|
|
4622
5064
|
* and <code>MetricData</code> metrics.</p>
|
|
4623
5065
|
* @public
|
|
@@ -4633,14 +5075,13 @@ export interface PutMetricDataInput {
|
|
|
4633
5075
|
* </li>
|
|
4634
5076
|
* <li>
|
|
4635
5077
|
* <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>
|
|
5078
|
+
* associate the metric with the entity, but the metric data will still be accepted
|
|
5079
|
+
* and ingested. Validation errors in the metric data will fail the entire request,
|
|
5080
|
+
* and no data will be ingested.</p>
|
|
5081
|
+
* <p>In the case of an invalid entity, the operation will return a <code>200</code>
|
|
5082
|
+
* status, but an additional response header will contain information about the
|
|
5083
|
+
* validation errors. The new header, <code>X-Amzn-Failure-Message</code> is an
|
|
5084
|
+
* enumeration of the following values:</p>
|
|
4644
5085
|
* <ul>
|
|
4645
5086
|
* <li>
|
|
4646
5087
|
* <p>
|
|
@@ -4649,7 +5090,7 @@ export interface PutMetricDataInput {
|
|
|
4649
5090
|
* <li>
|
|
4650
5091
|
* <p>
|
|
4651
5092
|
* <code>InvalidKeyAttributes</code> - The provided
|
|
4652
|
-
*
|
|
5093
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4653
5094
|
* </li>
|
|
4654
5095
|
* <li>
|
|
4655
5096
|
* <p>
|
|
@@ -4659,24 +5100,22 @@ export interface PutMetricDataInput {
|
|
|
4659
5100
|
* <li>
|
|
4660
5101
|
* <p>
|
|
4661
5102
|
* <code>InvalidTypeValue</code> - The provided <code>Type</code> in the
|
|
4662
|
-
*
|
|
5103
|
+
* <code>KeyAttributes</code> of an entity is invalid.</p>
|
|
4663
5104
|
* </li>
|
|
4664
5105
|
* <li>
|
|
4665
5106
|
* <p>
|
|
4666
5107
|
* <code>EntitySizeTooLarge</code> - The number of
|
|
4667
|
-
*
|
|
5108
|
+
* <code>EntityMetricData</code> objects allowed is 2.</p>
|
|
4668
5109
|
* </li>
|
|
4669
5110
|
* <li>
|
|
4670
5111
|
* <p>
|
|
4671
|
-
* <code>MissingRequiredFields</code> - There are missing required
|
|
4672
|
-
*
|
|
5112
|
+
* <code>MissingRequiredFields</code> - There are missing required fields
|
|
5113
|
+
* in the <code>KeyAttributes</code> for the provided
|
|
4673
5114
|
* <code>Type</code>.</p>
|
|
4674
5115
|
* </li>
|
|
4675
5116
|
* </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>
|
|
5117
|
+
* <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
|
|
5118
|
+
* <i>CloudWatch User Guide</i>.</p>
|
|
4680
5119
|
* </li>
|
|
4681
5120
|
* </ul>
|
|
4682
5121
|
* <p>This parameter is <i>required</i> when <code>EntityMetricData</code> is
|
|
@@ -4738,7 +5177,7 @@ export interface PutMetricStreamInput {
|
|
|
4738
5177
|
RoleArn: string | undefined;
|
|
4739
5178
|
/**
|
|
4740
5179
|
* <p>The output format for the stream. Valid values are <code>json</code>,
|
|
4741
|
-
*
|
|
5180
|
+
* <code>opentelemetry1.0</code>, and <code>opentelemetry0.7</code>. For more
|
|
4742
5181
|
* information about metric stream output formats, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">
|
|
4743
5182
|
* Metric streams output formats</a>.</p>
|
|
4744
5183
|
* @public
|
|
@@ -4758,13 +5197,13 @@ export interface PutMetricStreamInput {
|
|
|
4758
5197
|
Tags?: Tag[] | undefined;
|
|
4759
5198
|
/**
|
|
4760
5199
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
4761
|
-
*
|
|
5200
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
4762
5201
|
* streamed. You can use this parameter to have the metric stream also send additional
|
|
4763
5202
|
* statistics in the stream. This array can have up to 100 members.</p>
|
|
4764
5203
|
* <p>For each entry in this array, you specify one or more metrics and the list of
|
|
4765
5204
|
* additional statistics to stream for those metrics. The additional statistics that you
|
|
4766
5205
|
* can stream depend on the stream's <code>OutputFormat</code>. If the
|
|
4767
|
-
*
|
|
5206
|
+
* <code>OutputFormat</code> is <code>json</code>, you can stream any additional
|
|
4768
5207
|
* statistic that is supported by CloudWatch, listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
|
|
4769
5208
|
* CloudWatch statistics definitions</a>. If the <code>OutputFormat</code>
|
|
4770
5209
|
* is <code>opentelemetry1.0</code> or <code>opentelemetry0.7</code>, you can stream
|
|
@@ -4880,19 +5319,19 @@ export interface TagResourceInput {
|
|
|
4880
5319
|
/**
|
|
4881
5320
|
* <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
|
|
4882
5321
|
* <p>The ARN format of an alarm is
|
|
4883
|
-
*
|
|
5322
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4884
5323
|
* </code>
|
|
4885
5324
|
* </p>
|
|
4886
5325
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4887
|
-
*
|
|
5326
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4888
5327
|
* </code>
|
|
4889
5328
|
* </p>
|
|
4890
5329
|
* <p>The ARN format of a dashboard is
|
|
4891
|
-
*
|
|
5330
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
4892
5331
|
* </code>
|
|
4893
5332
|
* </p>
|
|
4894
5333
|
* <p>The ARN format of a metric stream is
|
|
4895
|
-
*
|
|
5334
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
4896
5335
|
* </code>
|
|
4897
5336
|
* </p>
|
|
4898
5337
|
* <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 +5357,19 @@ export interface UntagResourceInput {
|
|
|
4918
5357
|
/**
|
|
4919
5358
|
* <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
|
|
4920
5359
|
* <p>The ARN format of an alarm is
|
|
4921
|
-
*
|
|
5360
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
|
|
4922
5361
|
* </code>
|
|
4923
5362
|
* </p>
|
|
4924
5363
|
* <p>The ARN format of a Contributor Insights rule is
|
|
4925
|
-
*
|
|
5364
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule/<i>insight-rule-name</i>
|
|
4926
5365
|
* </code>
|
|
4927
5366
|
* </p>
|
|
4928
5367
|
* <p>The ARN format of a dashboard is
|
|
4929
|
-
*
|
|
5368
|
+
* <code>arn:aws:cloudwatch::<i>account-id</i>:dashboard/<i>dashboard-name</i>
|
|
4930
5369
|
* </code>
|
|
4931
5370
|
* </p>
|
|
4932
5371
|
* <p>The ARN format of a metric stream is
|
|
4933
|
-
*
|
|
5372
|
+
* <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:metric-stream/<i>metric-stream-name</i>
|
|
4934
5373
|
* </code>
|
|
4935
5374
|
* </p>
|
|
4936
5375
|
* <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
|