@aws-sdk/client-cloudwatch 3.378.0 → 3.382.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.
@@ -44,26 +44,32 @@ export type HistoryItemType = (typeof HistoryItemType)[keyof typeof HistoryItemT
44
44
  */
45
45
  export interface AlarmHistoryItem {
46
46
  /**
47
+ * @public
47
48
  * <p>The descriptive name for the alarm.</p>
48
49
  */
49
50
  AlarmName?: string;
50
51
  /**
52
+ * @public
51
53
  * <p>The type of alarm, either metric alarm or composite alarm.</p>
52
54
  */
53
55
  AlarmType?: AlarmType | string;
54
56
  /**
57
+ * @public
55
58
  * <p>The time stamp for the alarm history item.</p>
56
59
  */
57
60
  Timestamp?: Date;
58
61
  /**
62
+ * @public
59
63
  * <p>The type of alarm history item.</p>
60
64
  */
61
65
  HistoryItemType?: HistoryItemType | string;
62
66
  /**
67
+ * @public
63
68
  * <p>A summary of the alarm history, in text format.</p>
64
69
  */
65
70
  HistorySummary?: string;
66
71
  /**
72
+ * @public
67
73
  * <p>Data about the alarm, in JSON format.</p>
68
74
  */
69
75
  HistoryData?: string;
@@ -75,11 +81,13 @@ export interface AlarmHistoryItem {
75
81
  */
76
82
  export interface Range {
77
83
  /**
84
+ * @public
78
85
  * <p>The start time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
79
86
  * <code>2019-07-01T23:59:59</code>.</p>
80
87
  */
81
88
  StartTime: Date | undefined;
82
89
  /**
90
+ * @public
83
91
  * <p>The end time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
84
92
  * <code>2019-07-01T23:59:59</code>.</p>
85
93
  */
@@ -93,12 +101,14 @@ export interface Range {
93
101
  */
94
102
  export interface AnomalyDetectorConfiguration {
95
103
  /**
104
+ * @public
96
105
  * <p>An array of time ranges to exclude from use when the anomaly detection model is trained. Use
97
106
  * this to make sure that events that could cause unusual values for the metric, such as
98
107
  * deployments, aren't used when CloudWatch creates the model.</p>
99
108
  */
100
109
  ExcludedTimeRanges?: Range[];
101
110
  /**
111
+ * @public
102
112
  * <p>The time zone to use for the metric. This is useful to enable the model to automatically
103
113
  * account for daylight savings time changes if the metric is sensitive to such time
104
114
  * changes.</p>
@@ -118,6 +128,7 @@ export interface AnomalyDetectorConfiguration {
118
128
  */
119
129
  export interface Dimension {
120
130
  /**
131
+ * @public
121
132
  * <p>The name of the dimension. Dimension names must contain only ASCII characters, must include
122
133
  * at least one non-whitespace character, and cannot start with a colon (<code>:</code>).
123
134
  * ASCII
@@ -125,6 +136,7 @@ export interface Dimension {
125
136
  */
126
137
  Name: string | undefined;
127
138
  /**
139
+ * @public
128
140
  * <p>The value of the dimension. Dimension values must contain only ASCII characters and must include
129
141
  * at least one non-whitespace character. ASCII
130
142
  * control characters are not supported as part of dimension values.</p>
@@ -137,14 +149,17 @@ export interface Dimension {
137
149
  */
138
150
  export interface Metric {
139
151
  /**
152
+ * @public
140
153
  * <p>The namespace of the metric.</p>
141
154
  */
142
155
  Namespace?: string;
143
156
  /**
157
+ * @public
144
158
  * <p>The name of the metric. This is a required field.</p>
145
159
  */
146
160
  MetricName?: string;
147
161
  /**
162
+ * @public
148
163
  * <p>The dimensions for the metric.</p>
149
164
  */
150
165
  Dimensions?: Dimension[];
@@ -192,10 +207,12 @@ export type StandardUnit = (typeof StandardUnit)[keyof typeof StandardUnit];
192
207
  */
193
208
  export interface MetricStat {
194
209
  /**
210
+ * @public
195
211
  * <p>The metric to return, including the metric name, namespace, and dimensions.</p>
196
212
  */
197
213
  Metric: Metric | undefined;
198
214
  /**
215
+ * @public
199
216
  * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
200
217
  * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
201
218
  * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
@@ -216,10 +233,12 @@ export interface MetricStat {
216
233
  */
217
234
  Period: number | undefined;
218
235
  /**
236
+ * @public
219
237
  * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic.</p>
220
238
  */
221
239
  Stat: string | undefined;
222
240
  /**
241
+ * @public
223
242
  * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
224
243
  * <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
225
244
  * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
@@ -252,6 +271,7 @@ export interface MetricStat {
252
271
  */
253
272
  export interface MetricDataQuery {
254
273
  /**
274
+ * @public
255
275
  * <p>A short name used to tie this object to the results in the response. This name must be
256
276
  * unique within a single call to <code>GetMetricData</code>. If you are performing math
257
277
  * expressions on this set of data, this name represents that data and can serve as a
@@ -260,6 +280,7 @@ export interface MetricDataQuery {
260
280
  */
261
281
  Id: string | undefined;
262
282
  /**
283
+ * @public
263
284
  * <p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric
264
285
  * and not performing a math expression on returned data.</p>
265
286
  * <p>Within one MetricDataQuery object, you must specify either
@@ -267,6 +288,7 @@ export interface MetricDataQuery {
267
288
  */
268
289
  MetricStat?: MetricStat;
269
290
  /**
291
+ * @public
270
292
  * <p>This field can contain either a Metrics Insights query, or a metric math expression to be performed on the
271
293
  * returned data. For more information about Metrics Insights queries, see
272
294
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage">Metrics Insights query components and syntax</a> in the
@@ -282,6 +304,7 @@ export interface MetricDataQuery {
282
304
  */
283
305
  Expression?: string;
284
306
  /**
307
+ * @public
285
308
  * <p>A human-readable label for this metric or expression. This is especially useful
286
309
  * if this is an expression, so that you know
287
310
  * what the value represents. If the metric or expression is shown in a
@@ -292,6 +315,7 @@ export interface MetricDataQuery {
292
315
  */
293
316
  Label?: string;
294
317
  /**
318
+ * @public
295
319
  * <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
296
320
  * timestamps and raw data values of this metric. If you are performing this call just to
297
321
  * do math expressions and do not also need the raw data returned, you can specify
@@ -302,6 +326,7 @@ export interface MetricDataQuery {
302
326
  */
303
327
  ReturnData?: boolean;
304
328
  /**
329
+ * @public
305
330
  * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
306
331
  * period can be as short as one minute (60 seconds) and must be a multiple of 60.
307
332
  * For high-resolution metrics that are collected at intervals of less than one minute,
@@ -310,6 +335,7 @@ export interface MetricDataQuery {
310
335
  */
311
336
  Period?: number;
312
337
  /**
338
+ * @public
313
339
  * <p>The ID of the account where the metrics are located.</p>
314
340
  * <p>If you are performing a <code>GetMetricData</code> operation in a monitoring account, use this to specify
315
341
  * which account to retrieve this metric from.</p>
@@ -326,6 +352,7 @@ export interface MetricDataQuery {
326
352
  */
327
353
  export interface MetricMathAnomalyDetector {
328
354
  /**
355
+ * @public
329
356
  * <p>An array of metric data query structures
330
357
  * that enables you to create an anomaly detector
331
358
  * based on the result of a metric math expression.
@@ -348,18 +375,22 @@ export interface MetricMathAnomalyDetector {
348
375
  */
349
376
  export interface SingleMetricAnomalyDetector {
350
377
  /**
378
+ * @public
351
379
  * <p>The namespace of the metric to create the anomaly detection model for.</p>
352
380
  */
353
381
  Namespace?: string;
354
382
  /**
383
+ * @public
355
384
  * <p>The name of the metric to create the anomaly detection model for.</p>
356
385
  */
357
386
  MetricName?: string;
358
387
  /**
388
+ * @public
359
389
  * <p>The metric dimensions to create the anomaly detection model for.</p>
360
390
  */
361
391
  Dimensions?: Dimension[];
362
392
  /**
393
+ * @public
363
394
  * <p>The statistic to use for the metric and anomaly detection model.</p>
364
395
  */
365
396
  Stat?: string;
@@ -385,30 +416,35 @@ export type AnomalyDetectorStateValue = (typeof AnomalyDetectorStateValue)[keyof
385
416
  */
386
417
  export interface AnomalyDetector {
387
418
  /**
419
+ * @public
388
420
  * @deprecated
389
421
  *
390
422
  * <p>The namespace of the metric associated with the anomaly detection model.</p>
391
423
  */
392
424
  Namespace?: string;
393
425
  /**
426
+ * @public
394
427
  * @deprecated
395
428
  *
396
429
  * <p>The name of the metric associated with the anomaly detection model.</p>
397
430
  */
398
431
  MetricName?: string;
399
432
  /**
433
+ * @public
400
434
  * @deprecated
401
435
  *
402
436
  * <p>The metric dimensions associated with the anomaly detection model.</p>
403
437
  */
404
438
  Dimensions?: Dimension[];
405
439
  /**
440
+ * @public
406
441
  * @deprecated
407
442
  *
408
443
  * <p>The statistic associated with the anomaly detection model.</p>
409
444
  */
410
445
  Stat?: string;
411
446
  /**
447
+ * @public
412
448
  * <p>The configuration specifies details about how the
413
449
  * anomaly detection model is to be trained, including time ranges to
414
450
  * exclude from use for training the model, and the time zone to use for
@@ -416,15 +452,18 @@ export interface AnomalyDetector {
416
452
  */
417
453
  Configuration?: AnomalyDetectorConfiguration;
418
454
  /**
455
+ * @public
419
456
  * <p>The current status of the anomaly detector's training. The possible values are <code>TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA</code>
420
457
  * </p>
421
458
  */
422
459
  StateValue?: AnomalyDetectorStateValue | string;
423
460
  /**
461
+ * @public
424
462
  * <p>The CloudWatch metric and statistic for this anomaly detector.</p>
425
463
  */
426
464
  SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
427
465
  /**
466
+ * @public
428
467
  * <p>The CloudWatch metric math expression for this anomaly detector.</p>
429
468
  */
430
469
  MetricMathAnomalyDetector?: MetricMathAnomalyDetector;
@@ -448,18 +487,22 @@ export type AnomalyDetectorType = (typeof AnomalyDetectorType)[keyof typeof Anom
448
487
  */
449
488
  export interface PartialFailure {
450
489
  /**
490
+ * @public
451
491
  * <p>The specified rule that could not be deleted.</p>
452
492
  */
453
493
  FailureResource?: string;
454
494
  /**
495
+ * @public
455
496
  * <p>The type of error.</p>
456
497
  */
457
498
  ExceptionType?: string;
458
499
  /**
500
+ * @public
459
501
  * <p>The code of the error.</p>
460
502
  */
461
503
  FailureCode?: string;
462
504
  /**
505
+ * @public
463
506
  * <p>A description of the error.</p>
464
507
  */
465
508
  FailureDescription?: string;
@@ -500,58 +543,72 @@ export type StateValue = (typeof StateValue)[keyof typeof StateValue];
500
543
  */
501
544
  export interface CompositeAlarm {
502
545
  /**
546
+ * @public
503
547
  * <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
504
548
  */
505
549
  ActionsEnabled?: boolean;
506
550
  /**
551
+ * @public
507
552
  * <p>The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
508
553
  */
509
554
  AlarmActions?: string[];
510
555
  /**
556
+ * @public
511
557
  * <p>The Amazon Resource Name (ARN) of the alarm.</p>
512
558
  */
513
559
  AlarmArn?: string;
514
560
  /**
561
+ * @public
515
562
  * <p>The time stamp of the last update to the alarm configuration.</p>
516
563
  */
517
564
  AlarmConfigurationUpdatedTimestamp?: Date;
518
565
  /**
566
+ * @public
519
567
  * <p>The description of the alarm.</p>
520
568
  */
521
569
  AlarmDescription?: string;
522
570
  /**
571
+ * @public
523
572
  * <p>The name of the alarm.</p>
524
573
  */
525
574
  AlarmName?: string;
526
575
  /**
576
+ * @public
527
577
  * <p>The rule that this alarm uses to evaluate its alarm state.</p>
528
578
  */
529
579
  AlarmRule?: string;
530
580
  /**
581
+ * @public
531
582
  * <p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
532
583
  */
533
584
  InsufficientDataActions?: string[];
534
585
  /**
586
+ * @public
535
587
  * <p>The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
536
588
  */
537
589
  OKActions?: string[];
538
590
  /**
591
+ * @public
539
592
  * <p>An explanation for the alarm state, in text format.</p>
540
593
  */
541
594
  StateReason?: string;
542
595
  /**
596
+ * @public
543
597
  * <p>An explanation for the alarm state, in JSON format.</p>
544
598
  */
545
599
  StateReasonData?: string;
546
600
  /**
601
+ * @public
547
602
  * <p>Tracks the timestamp of any state update, even if <code>StateValue</code> doesn't change.</p>
548
603
  */
549
604
  StateUpdatedTimestamp?: Date;
550
605
  /**
606
+ * @public
551
607
  * <p>The state value for the alarm.</p>
552
608
  */
553
609
  StateValue?: StateValue | string;
554
610
  /**
611
+ * @public
555
612
  * <p>
556
613
  * The timestamp
557
614
  * of the last change
@@ -560,6 +617,7 @@ export interface CompositeAlarm {
560
617
  */
561
618
  StateTransitionedTimestamp?: Date;
562
619
  /**
620
+ * @public
563
621
  * <p>
564
622
  * When the value is <code>ALARM</code>,
565
623
  * it means
@@ -592,12 +650,14 @@ export interface CompositeAlarm {
592
650
  */
593
651
  ActionsSuppressedBy?: ActionsSuppressedBy | string;
594
652
  /**
653
+ * @public
595
654
  * <p>
596
655
  * Captures the reason for action suppression.
597
656
  * </p>
598
657
  */
599
658
  ActionsSuppressedReason?: string;
600
659
  /**
660
+ * @public
601
661
  * <p>
602
662
  * Actions will be suppressed
603
663
  * if the suppressor alarm is
@@ -608,6 +668,7 @@ export interface CompositeAlarm {
608
668
  */
609
669
  ActionsSuppressor?: string;
610
670
  /**
671
+ * @public
611
672
  * <p>
612
673
  * The maximum time
613
674
  * in seconds
@@ -628,6 +689,7 @@ export interface CompositeAlarm {
628
689
  */
629
690
  ActionsSuppressorWaitPeriod?: number;
630
691
  /**
692
+ * @public
631
693
  * <p>
632
694
  * The maximum time
633
695
  * in seconds
@@ -666,19 +728,23 @@ export declare class ConcurrentModificationException extends __BaseException {
666
728
  */
667
729
  export interface DashboardEntry {
668
730
  /**
731
+ * @public
669
732
  * <p>The name of the dashboard.</p>
670
733
  */
671
734
  DashboardName?: string;
672
735
  /**
736
+ * @public
673
737
  * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
674
738
  */
675
739
  DashboardArn?: string;
676
740
  /**
741
+ * @public
677
742
  * <p>The time stamp of when the dashboard was last modified, either by an API call or
678
743
  * through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
679
744
  */
680
745
  LastModified?: Date;
681
746
  /**
747
+ * @public
682
748
  * <p>The size of the dashboard, in bytes.</p>
683
749
  */
684
750
  Size?: number;
@@ -689,10 +755,12 @@ export interface DashboardEntry {
689
755
  */
690
756
  export interface DashboardValidationMessage {
691
757
  /**
758
+ * @public
692
759
  * <p>The data path related to the message.</p>
693
760
  */
694
761
  DataPath?: string;
695
762
  /**
763
+ * @public
696
764
  * <p>A message describing the error or warning.</p>
697
765
  */
698
766
  Message?: string;
@@ -728,35 +796,43 @@ export declare class DashboardNotFoundError extends __BaseException {
728
796
  */
729
797
  export interface Datapoint {
730
798
  /**
799
+ * @public
731
800
  * <p>The time stamp used for the data point.</p>
732
801
  */
733
802
  Timestamp?: Date;
734
803
  /**
804
+ * @public
735
805
  * <p>The number of metric values that contributed to the aggregate value of this
736
806
  * data point.</p>
737
807
  */
738
808
  SampleCount?: number;
739
809
  /**
810
+ * @public
740
811
  * <p>The average of the metric values that correspond to the data point.</p>
741
812
  */
742
813
  Average?: number;
743
814
  /**
815
+ * @public
744
816
  * <p>The sum of the metric values for the data point.</p>
745
817
  */
746
818
  Sum?: number;
747
819
  /**
820
+ * @public
748
821
  * <p>The minimum metric value for the data point.</p>
749
822
  */
750
823
  Minimum?: number;
751
824
  /**
825
+ * @public
752
826
  * <p>The maximum metric value for the data point.</p>
753
827
  */
754
828
  Maximum?: number;
755
829
  /**
830
+ * @public
756
831
  * <p>The standard unit for the data point.</p>
757
832
  */
758
833
  Unit?: StandardUnit | string;
759
834
  /**
835
+ * @public
760
836
  * <p>The percentile statistic for the data point.</p>
761
837
  */
762
838
  ExtendedStatistics?: Record<string, number>;
@@ -766,6 +842,7 @@ export interface Datapoint {
766
842
  */
767
843
  export interface DeleteAlarmsInput {
768
844
  /**
845
+ * @public
769
846
  * <p>The alarms to be deleted. Do not enclose the alarm names in quote marks.</p>
770
847
  */
771
848
  AlarmNames: string[] | undefined;
@@ -787,30 +864,35 @@ export declare class ResourceNotFound extends __BaseException {
787
864
  */
788
865
  export interface DeleteAnomalyDetectorInput {
789
866
  /**
867
+ * @public
790
868
  * @deprecated
791
869
  *
792
870
  * <p>The namespace associated with the anomaly detection model to delete.</p>
793
871
  */
794
872
  Namespace?: string;
795
873
  /**
874
+ * @public
796
875
  * @deprecated
797
876
  *
798
877
  * <p>The metric name associated with the anomaly detection model to delete.</p>
799
878
  */
800
879
  MetricName?: string;
801
880
  /**
881
+ * @public
802
882
  * @deprecated
803
883
  *
804
884
  * <p>The metric dimensions associated with the anomaly detection model to delete.</p>
805
885
  */
806
886
  Dimensions?: Dimension[];
807
887
  /**
888
+ * @public
808
889
  * @deprecated
809
890
  *
810
891
  * <p>The statistic associated with the anomaly detection model to delete.</p>
811
892
  */
812
893
  Stat?: string;
813
894
  /**
895
+ * @public
814
896
  * <p>A single metric anomaly detector to be deleted.</p>
815
897
  * <p>When using <code>SingleMetricAnomalyDetector</code>,
816
898
  * you cannot include the following parameters in the same operation:</p>
@@ -844,6 +926,7 @@ export interface DeleteAnomalyDetectorInput {
844
926
  */
845
927
  SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
846
928
  /**
929
+ * @public
847
930
  * <p>The metric math anomaly detector to be deleted.</p>
848
931
  * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include following parameters in the same operation:</p>
849
932
  * <ul>
@@ -889,6 +972,7 @@ export declare class InternalServiceFault extends __BaseException {
889
972
  readonly name: "InternalServiceFault";
890
973
  readonly $fault: "server";
891
974
  /**
975
+ * @public
892
976
  * <p></p>
893
977
  */
894
978
  Message?: string;
@@ -953,6 +1037,7 @@ export declare class ResourceNotFoundException extends __BaseException {
953
1037
  */
954
1038
  export interface DeleteDashboardsInput {
955
1039
  /**
1040
+ * @public
956
1041
  * <p>The dashboards to be deleted. This parameter is required.</p>
957
1042
  */
958
1043
  DashboardNames: string[] | undefined;
@@ -967,6 +1052,7 @@ export interface DeleteDashboardsOutput {
967
1052
  */
968
1053
  export interface DeleteInsightRulesInput {
969
1054
  /**
1055
+ * @public
970
1056
  * <p>An array of the rule names to delete. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
971
1057
  */
972
1058
  RuleNames: string[] | undefined;
@@ -976,6 +1062,7 @@ export interface DeleteInsightRulesInput {
976
1062
  */
977
1063
  export interface DeleteInsightRulesOutput {
978
1064
  /**
1065
+ * @public
979
1066
  * <p>An array listing the rules that could not be deleted. You cannot delete built-in rules.</p>
980
1067
  */
981
1068
  Failures?: PartialFailure[];
@@ -985,6 +1072,7 @@ export interface DeleteInsightRulesOutput {
985
1072
  */
986
1073
  export interface DeleteMetricStreamInput {
987
1074
  /**
1075
+ * @public
988
1076
  * <p>The name of the metric stream to delete.</p>
989
1077
  */
990
1078
  Name: string | undefined;
@@ -1011,36 +1099,44 @@ export type ScanBy = (typeof ScanBy)[keyof typeof ScanBy];
1011
1099
  */
1012
1100
  export interface DescribeAlarmHistoryInput {
1013
1101
  /**
1102
+ * @public
1014
1103
  * <p>The name of the alarm.</p>
1015
1104
  */
1016
1105
  AlarmName?: string;
1017
1106
  /**
1107
+ * @public
1018
1108
  * <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
1019
1109
  * only metric alarms are returned.</p>
1020
1110
  */
1021
1111
  AlarmTypes?: (AlarmType | string)[];
1022
1112
  /**
1113
+ * @public
1023
1114
  * <p>The type of alarm histories to retrieve.</p>
1024
1115
  */
1025
1116
  HistoryItemType?: HistoryItemType | string;
1026
1117
  /**
1118
+ * @public
1027
1119
  * <p>The starting date to retrieve alarm history.</p>
1028
1120
  */
1029
1121
  StartDate?: Date;
1030
1122
  /**
1123
+ * @public
1031
1124
  * <p>The ending date to retrieve alarm history.</p>
1032
1125
  */
1033
1126
  EndDate?: Date;
1034
1127
  /**
1128
+ * @public
1035
1129
  * <p>The maximum number of alarm history records to retrieve.</p>
1036
1130
  */
1037
1131
  MaxRecords?: number;
1038
1132
  /**
1133
+ * @public
1039
1134
  * <p>The token returned by a previous call to indicate that there is more data
1040
1135
  * available.</p>
1041
1136
  */
1042
1137
  NextToken?: string;
1043
1138
  /**
1139
+ * @public
1044
1140
  * <p>Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest
1045
1141
  * event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.</p>
1046
1142
  */
@@ -1051,10 +1147,12 @@ export interface DescribeAlarmHistoryInput {
1051
1147
  */
1052
1148
  export interface DescribeAlarmHistoryOutput {
1053
1149
  /**
1150
+ * @public
1054
1151
  * <p>The alarm histories, in JSON format.</p>
1055
1152
  */
1056
1153
  AlarmHistoryItems?: AlarmHistoryItem[];
1057
1154
  /**
1155
+ * @public
1058
1156
  * <p>The token that marks the start of the next batch of returned results.</p>
1059
1157
  */
1060
1158
  NextToken?: string;
@@ -1076,10 +1174,12 @@ export declare class InvalidNextToken extends __BaseException {
1076
1174
  */
1077
1175
  export interface DescribeAlarmsInput {
1078
1176
  /**
1177
+ * @public
1079
1178
  * <p>The names of the alarms to retrieve information about.</p>
1080
1179
  */
1081
1180
  AlarmNames?: string[];
1082
1181
  /**
1182
+ * @public
1083
1183
  * <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names
1084
1184
  * that start with this prefix.</p>
1085
1185
  * <p>If this parameter
@@ -1087,11 +1187,13 @@ export interface DescribeAlarmsInput {
1087
1187
  */
1088
1188
  AlarmNamePrefix?: string;
1089
1189
  /**
1190
+ * @public
1090
1191
  * <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
1091
1192
  * only metric alarms are returned.</p>
1092
1193
  */
1093
1194
  AlarmTypes?: (AlarmType | string)[];
1094
1195
  /**
1196
+ * @public
1095
1197
  * <p>If you use this parameter and specify the name of a composite alarm, the operation returns
1096
1198
  * information about the "children" alarms
1097
1199
  * of the alarm you specify. These are the metric alarms and composite alarms referenced in the
@@ -1112,6 +1214,7 @@ export interface DescribeAlarmsInput {
1112
1214
  */
1113
1215
  ChildrenOfAlarmName?: string;
1114
1216
  /**
1217
+ * @public
1115
1218
  * <p>If you use this parameter and specify the name of a metric or composite alarm, the operation returns
1116
1219
  * information about the "parent" alarms
1117
1220
  * of the alarm you specify. These are the composite alarms that have <code>AlarmRule</code>
@@ -1129,20 +1232,24 @@ export interface DescribeAlarmsInput {
1129
1232
  */
1130
1233
  ParentsOfAlarmName?: string;
1131
1234
  /**
1235
+ * @public
1132
1236
  * <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
1133
1237
  */
1134
1238
  StateValue?: StateValue | string;
1135
1239
  /**
1240
+ * @public
1136
1241
  * <p>Use this parameter to filter the results of the operation to only those alarms that
1137
1242
  * use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all
1138
1243
  * alarms that send notifications to that topic.</p>
1139
1244
  */
1140
1245
  ActionPrefix?: string;
1141
1246
  /**
1247
+ * @public
1142
1248
  * <p>The maximum number of alarm descriptions to retrieve.</p>
1143
1249
  */
1144
1250
  MaxRecords?: number;
1145
1251
  /**
1252
+ * @public
1146
1253
  * <p>The token returned by a previous call to indicate that there is more data
1147
1254
  * available.</p>
1148
1255
  */
@@ -1180,106 +1287,130 @@ export type Statistic = (typeof Statistic)[keyof typeof Statistic];
1180
1287
  */
1181
1288
  export interface MetricAlarm {
1182
1289
  /**
1290
+ * @public
1183
1291
  * <p>The name of the alarm.</p>
1184
1292
  */
1185
1293
  AlarmName?: string;
1186
1294
  /**
1295
+ * @public
1187
1296
  * <p>The Amazon Resource Name (ARN) of the alarm.</p>
1188
1297
  */
1189
1298
  AlarmArn?: string;
1190
1299
  /**
1300
+ * @public
1191
1301
  * <p>The description of the alarm.</p>
1192
1302
  */
1193
1303
  AlarmDescription?: string;
1194
1304
  /**
1305
+ * @public
1195
1306
  * <p>The time stamp of the last update to the alarm configuration.</p>
1196
1307
  */
1197
1308
  AlarmConfigurationUpdatedTimestamp?: Date;
1198
1309
  /**
1310
+ * @public
1199
1311
  * <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
1200
1312
  */
1201
1313
  ActionsEnabled?: boolean;
1202
1314
  /**
1315
+ * @public
1203
1316
  * <p>The actions to execute when this alarm transitions to the <code>OK</code> state
1204
1317
  * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
1205
1318
  */
1206
1319
  OKActions?: string[];
1207
1320
  /**
1321
+ * @public
1208
1322
  * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
1209
1323
  * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
1210
1324
  */
1211
1325
  AlarmActions?: string[];
1212
1326
  /**
1327
+ * @public
1213
1328
  * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state
1214
1329
  * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
1215
1330
  */
1216
1331
  InsufficientDataActions?: string[];
1217
1332
  /**
1333
+ * @public
1218
1334
  * <p>The state value for the alarm.</p>
1219
1335
  */
1220
1336
  StateValue?: StateValue | string;
1221
1337
  /**
1338
+ * @public
1222
1339
  * <p>An explanation for the alarm state, in text format.</p>
1223
1340
  */
1224
1341
  StateReason?: string;
1225
1342
  /**
1343
+ * @public
1226
1344
  * <p>An explanation for the alarm state, in JSON format.</p>
1227
1345
  */
1228
1346
  StateReasonData?: string;
1229
1347
  /**
1348
+ * @public
1230
1349
  * <p>The time stamp of the last update to the value of either the
1231
1350
  * <code>StateValue</code> or <code>EvaluationState</code> parameters.</p>
1232
1351
  */
1233
1352
  StateUpdatedTimestamp?: Date;
1234
1353
  /**
1354
+ * @public
1235
1355
  * <p>The name of the metric associated with the alarm, if this is an alarm
1236
1356
  * based on a single metric.</p>
1237
1357
  */
1238
1358
  MetricName?: string;
1239
1359
  /**
1360
+ * @public
1240
1361
  * <p>The namespace of the metric associated with the alarm.</p>
1241
1362
  */
1242
1363
  Namespace?: string;
1243
1364
  /**
1365
+ * @public
1244
1366
  * <p>The statistic for the metric associated with the alarm, other than percentile.
1245
1367
  * For percentile statistics, use <code>ExtendedStatistic</code>.</p>
1246
1368
  */
1247
1369
  Statistic?: Statistic | string;
1248
1370
  /**
1371
+ * @public
1249
1372
  * <p>The percentile statistic for the metric associated with the alarm. Specify a value between
1250
1373
  * p0.0 and p100.</p>
1251
1374
  */
1252
1375
  ExtendedStatistic?: string;
1253
1376
  /**
1377
+ * @public
1254
1378
  * <p>The dimensions for the metric associated with the alarm.</p>
1255
1379
  */
1256
1380
  Dimensions?: Dimension[];
1257
1381
  /**
1382
+ * @public
1258
1383
  * <p>The period, in seconds, over which the statistic is applied.</p>
1259
1384
  */
1260
1385
  Period?: number;
1261
1386
  /**
1387
+ * @public
1262
1388
  * <p>The unit of the metric associated with the alarm.</p>
1263
1389
  */
1264
1390
  Unit?: StandardUnit | string;
1265
1391
  /**
1392
+ * @public
1266
1393
  * <p>The number of periods over which data is compared to the specified threshold.</p>
1267
1394
  */
1268
1395
  EvaluationPeriods?: number;
1269
1396
  /**
1397
+ * @public
1270
1398
  * <p>The number of data points that must be breaching to trigger the alarm.</p>
1271
1399
  */
1272
1400
  DatapointsToAlarm?: number;
1273
1401
  /**
1402
+ * @public
1274
1403
  * <p>The value to compare with the specified statistic.</p>
1275
1404
  */
1276
1405
  Threshold?: number;
1277
1406
  /**
1407
+ * @public
1278
1408
  * <p>The arithmetic operation to use when comparing the specified
1279
1409
  * statistic and threshold. The specified statistic value is used as the first operand.</p>
1280
1410
  */
1281
1411
  ComparisonOperator?: ComparisonOperator | string;
1282
1412
  /**
1413
+ * @public
1283
1414
  * <p>Sets how this alarm is to handle missing data points. The valid values
1284
1415
  * are <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and
1285
1416
  * <code>missing</code>. For more information, see
@@ -1289,6 +1420,7 @@ export interface MetricAlarm {
1289
1420
  */
1290
1421
  TreatMissingData?: string;
1291
1422
  /**
1423
+ * @public
1292
1424
  * <p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state does not change
1293
1425
  * during periods with too few data points to be statistically significant. If <code>evaluate</code> or this
1294
1426
  * parameter is not used, the alarm is always evaluated and possibly changes state no matter
@@ -1296,6 +1428,7 @@ export interface MetricAlarm {
1296
1428
  */
1297
1429
  EvaluateLowSampleCountPercentile?: string;
1298
1430
  /**
1431
+ * @public
1299
1432
  * <p>An array of MetricDataQuery structures, used in an alarm based on a
1300
1433
  * metric math expression. Each structure either retrieves a
1301
1434
  * metric or performs a math expression.
@@ -1306,12 +1439,14 @@ export interface MetricAlarm {
1306
1439
  */
1307
1440
  Metrics?: MetricDataQuery[];
1308
1441
  /**
1442
+ * @public
1309
1443
  * <p>In an alarm based on an anomaly detection model, this is the ID of the
1310
1444
  * <code>ANOMALY_DETECTION_BAND</code> function
1311
1445
  * used as the threshold for the alarm.</p>
1312
1446
  */
1313
1447
  ThresholdMetricId?: string;
1314
1448
  /**
1449
+ * @public
1315
1450
  * <p>If the value of this field is
1316
1451
  * <code>PARTIAL_DATA</code>, the alarm is being evaluated based on only partial data. This happens if the
1317
1452
  * query used for the alarm returns more than 10,000 metrics. For
@@ -1320,6 +1455,7 @@ export interface MetricAlarm {
1320
1455
  */
1321
1456
  EvaluationState?: EvaluationState | string;
1322
1457
  /**
1458
+ * @public
1323
1459
  * <p>The date and time that the alarm's <code>StateValue</code> most recently changed.</p>
1324
1460
  */
1325
1461
  StateTransitionedTimestamp?: Date;
@@ -1329,14 +1465,17 @@ export interface MetricAlarm {
1329
1465
  */
1330
1466
  export interface DescribeAlarmsOutput {
1331
1467
  /**
1468
+ * @public
1332
1469
  * <p>The information about any composite alarms returned by the operation.</p>
1333
1470
  */
1334
1471
  CompositeAlarms?: CompositeAlarm[];
1335
1472
  /**
1473
+ * @public
1336
1474
  * <p>The information about any metric alarms returned by the operation.</p>
1337
1475
  */
1338
1476
  MetricAlarms?: MetricAlarm[];
1339
1477
  /**
1478
+ * @public
1340
1479
  * <p>The token that marks the start of the next batch of returned results.</p>
1341
1480
  */
1342
1481
  NextToken?: string;
@@ -1346,33 +1485,40 @@ export interface DescribeAlarmsOutput {
1346
1485
  */
1347
1486
  export interface DescribeAlarmsForMetricInput {
1348
1487
  /**
1488
+ * @public
1349
1489
  * <p>The name of the metric.</p>
1350
1490
  */
1351
1491
  MetricName: string | undefined;
1352
1492
  /**
1493
+ * @public
1353
1494
  * <p>The namespace of the metric.</p>
1354
1495
  */
1355
1496
  Namespace: string | undefined;
1356
1497
  /**
1498
+ * @public
1357
1499
  * <p>The statistic for the metric, other than percentiles.
1358
1500
  * For percentile statistics, use <code>ExtendedStatistics</code>.</p>
1359
1501
  */
1360
1502
  Statistic?: Statistic | string;
1361
1503
  /**
1504
+ * @public
1362
1505
  * <p>The percentile statistic for the metric. Specify a value between
1363
1506
  * p0.0 and p100.</p>
1364
1507
  */
1365
1508
  ExtendedStatistic?: string;
1366
1509
  /**
1510
+ * @public
1367
1511
  * <p>The dimensions associated with the metric. If the metric has any associated
1368
1512
  * dimensions, you must specify them in order for the call to succeed.</p>
1369
1513
  */
1370
1514
  Dimensions?: Dimension[];
1371
1515
  /**
1516
+ * @public
1372
1517
  * <p>The period, in seconds, over which the statistic is applied.</p>
1373
1518
  */
1374
1519
  Period?: number;
1375
1520
  /**
1521
+ * @public
1376
1522
  * <p>The unit for the metric.</p>
1377
1523
  */
1378
1524
  Unit?: StandardUnit | string;
@@ -1382,6 +1528,7 @@ export interface DescribeAlarmsForMetricInput {
1382
1528
  */
1383
1529
  export interface DescribeAlarmsForMetricOutput {
1384
1530
  /**
1531
+ * @public
1385
1532
  * <p>The information for each alarm with the specified metric.</p>
1386
1533
  */
1387
1534
  MetricAlarms?: MetricAlarm[];
@@ -1391,10 +1538,12 @@ export interface DescribeAlarmsForMetricOutput {
1391
1538
  */
1392
1539
  export interface DescribeAnomalyDetectorsInput {
1393
1540
  /**
1541
+ * @public
1394
1542
  * <p>Use the token returned by the previous operation to request the next page of results.</p>
1395
1543
  */
1396
1544
  NextToken?: string;
1397
1545
  /**
1546
+ * @public
1398
1547
  * <p>The maximum number of results to return in one operation. The maximum
1399
1548
  * value that you can specify is 100.</p>
1400
1549
  * <p>To retrieve the remaining results, make another call with the returned
@@ -1402,23 +1551,27 @@ export interface DescribeAnomalyDetectorsInput {
1402
1551
  */
1403
1552
  MaxResults?: number;
1404
1553
  /**
1554
+ * @public
1405
1555
  * <p>Limits the results to only the anomaly detection models that
1406
1556
  * are associated with the specified namespace.</p>
1407
1557
  */
1408
1558
  Namespace?: string;
1409
1559
  /**
1560
+ * @public
1410
1561
  * <p>Limits the results to only the anomaly detection models that are associated with the
1411
1562
  * specified metric name. If there are multiple metrics with this name in different
1412
1563
  * namespaces that have anomaly detection models, they're all returned.</p>
1413
1564
  */
1414
1565
  MetricName?: string;
1415
1566
  /**
1567
+ * @public
1416
1568
  * <p>Limits the results to only the anomaly detection models that are associated with the
1417
1569
  * specified metric dimensions. If there are multiple metrics that have these dimensions
1418
1570
  * and have anomaly detection models associated, they're all returned.</p>
1419
1571
  */
1420
1572
  Dimensions?: Dimension[];
1421
1573
  /**
1574
+ * @public
1422
1575
  * <p>The anomaly detector types to request when using <code>DescribeAnomalyDetectorsInput</code>.
1423
1576
  * If empty, defaults to <code>SINGLE_METRIC</code>.</p>
1424
1577
  */
@@ -1429,10 +1582,12 @@ export interface DescribeAnomalyDetectorsInput {
1429
1582
  */
1430
1583
  export interface DescribeAnomalyDetectorsOutput {
1431
1584
  /**
1585
+ * @public
1432
1586
  * <p>The list of anomaly detection models returned by the operation.</p>
1433
1587
  */
1434
1588
  AnomalyDetectors?: AnomalyDetector[];
1435
1589
  /**
1590
+ * @public
1436
1591
  * <p>A token that you can use in a subsequent operation to
1437
1592
  * retrieve the next set of results.</p>
1438
1593
  */
@@ -1443,10 +1598,12 @@ export interface DescribeAnomalyDetectorsOutput {
1443
1598
  */
1444
1599
  export interface DescribeInsightRulesInput {
1445
1600
  /**
1601
+ * @public
1446
1602
  * <p>Include this value, if it was returned by the previous operation, to get the next set of rules.</p>
1447
1603
  */
1448
1604
  NextToken?: string;
1449
1605
  /**
1606
+ * @public
1450
1607
  * <p>The maximum number of results to return in one operation. If you omit this
1451
1608
  * parameter, the default of 500 is used.</p>
1452
1609
  */
@@ -1463,20 +1620,24 @@ export interface DescribeInsightRulesInput {
1463
1620
  */
1464
1621
  export interface InsightRule {
1465
1622
  /**
1623
+ * @public
1466
1624
  * <p>The name of the rule.</p>
1467
1625
  */
1468
1626
  Name: string | undefined;
1469
1627
  /**
1628
+ * @public
1470
1629
  * <p>Indicates whether the rule is enabled or disabled.</p>
1471
1630
  */
1472
1631
  State: string | undefined;
1473
1632
  /**
1633
+ * @public
1474
1634
  * <p>For rules that you create, this is always <code>\{"Name": "CloudWatchLogRule", "Version": 1\}</code>. For managed rules,
1475
1635
  * this is <code>\{"Name": "ServiceLogRule", "Version": 1\}</code>
1476
1636
  * </p>
1477
1637
  */
1478
1638
  Schema: string | undefined;
1479
1639
  /**
1640
+ * @public
1480
1641
  * <p>The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors,
1481
1642
  * the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see
1482
1643
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
@@ -1484,6 +1645,7 @@ export interface InsightRule {
1484
1645
  */
1485
1646
  Definition: string | undefined;
1486
1647
  /**
1648
+ * @public
1487
1649
  * <p>
1488
1650
  * An optional built-in rule that Amazon Web Services manages.
1489
1651
  * </p>
@@ -1495,10 +1657,12 @@ export interface InsightRule {
1495
1657
  */
1496
1658
  export interface DescribeInsightRulesOutput {
1497
1659
  /**
1660
+ * @public
1498
1661
  * <p>If this parameter is present, it is a token that marks the start of the next batch of returned results. </p>
1499
1662
  */
1500
1663
  NextToken?: string;
1501
1664
  /**
1665
+ * @public
1502
1666
  * <p>The rules returned by the operation.</p>
1503
1667
  */
1504
1668
  InsightRules?: InsightRule[];
@@ -1509,10 +1673,12 @@ export interface DescribeInsightRulesOutput {
1509
1673
  */
1510
1674
  export interface DimensionFilter {
1511
1675
  /**
1676
+ * @public
1512
1677
  * <p>The dimension name to be matched.</p>
1513
1678
  */
1514
1679
  Name: string | undefined;
1515
1680
  /**
1681
+ * @public
1516
1682
  * <p>The value of the dimension to be matched.</p>
1517
1683
  */
1518
1684
  Value?: string;
@@ -1522,6 +1688,7 @@ export interface DimensionFilter {
1522
1688
  */
1523
1689
  export interface DisableAlarmActionsInput {
1524
1690
  /**
1691
+ * @public
1525
1692
  * <p>The names of the alarms.</p>
1526
1693
  */
1527
1694
  AlarmNames: string[] | undefined;
@@ -1531,6 +1698,7 @@ export interface DisableAlarmActionsInput {
1531
1698
  */
1532
1699
  export interface DisableInsightRulesInput {
1533
1700
  /**
1701
+ * @public
1534
1702
  * <p>An array of the rule names to disable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
1535
1703
  */
1536
1704
  RuleNames: string[] | undefined;
@@ -1540,6 +1708,7 @@ export interface DisableInsightRulesInput {
1540
1708
  */
1541
1709
  export interface DisableInsightRulesOutput {
1542
1710
  /**
1711
+ * @public
1543
1712
  * <p>An array listing the rules that could not be disabled. You cannot disable built-in rules.</p>
1544
1713
  */
1545
1714
  Failures?: PartialFailure[];
@@ -1549,6 +1718,7 @@ export interface DisableInsightRulesOutput {
1549
1718
  */
1550
1719
  export interface EnableAlarmActionsInput {
1551
1720
  /**
1721
+ * @public
1552
1722
  * <p>The names of the alarms.</p>
1553
1723
  */
1554
1724
  AlarmNames: string[] | undefined;
@@ -1558,6 +1728,7 @@ export interface EnableAlarmActionsInput {
1558
1728
  */
1559
1729
  export interface EnableInsightRulesInput {
1560
1730
  /**
1731
+ * @public
1561
1732
  * <p>An array of the rule names to enable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
1562
1733
  */
1563
1734
  RuleNames: string[] | undefined;
@@ -1567,6 +1738,7 @@ export interface EnableInsightRulesInput {
1567
1738
  */
1568
1739
  export interface EnableInsightRulesOutput {
1569
1740
  /**
1741
+ * @public
1570
1742
  * <p>An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.</p>
1571
1743
  */
1572
1744
  Failures?: PartialFailure[];
@@ -1589,6 +1761,7 @@ export declare class LimitExceededException extends __BaseException {
1589
1761
  */
1590
1762
  export interface GetDashboardInput {
1591
1763
  /**
1764
+ * @public
1592
1765
  * <p>The name of the dashboard to be described.</p>
1593
1766
  */
1594
1767
  DashboardName: string | undefined;
@@ -1598,16 +1771,19 @@ export interface GetDashboardInput {
1598
1771
  */
1599
1772
  export interface GetDashboardOutput {
1600
1773
  /**
1774
+ * @public
1601
1775
  * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
1602
1776
  */
1603
1777
  DashboardArn?: string;
1604
1778
  /**
1779
+ * @public
1605
1780
  * <p>The detailed information about the dashboard, including what widgets are included and their location
1606
1781
  * on the dashboard. For more information about the <code>DashboardBody</code> syntax,
1607
1782
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>. </p>
1608
1783
  */
1609
1784
  DashboardBody?: string;
1610
1785
  /**
1786
+ * @public
1611
1787
  * <p>The name of the dashboard.</p>
1612
1788
  */
1613
1789
  DashboardName?: string;
@@ -1617,30 +1793,36 @@ export interface GetDashboardOutput {
1617
1793
  */
1618
1794
  export interface GetInsightRuleReportInput {
1619
1795
  /**
1796
+ * @public
1620
1797
  * <p>The name of the rule that you want to see data from.</p>
1621
1798
  */
1622
1799
  RuleName: string | undefined;
1623
1800
  /**
1801
+ * @public
1624
1802
  * <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
1625
1803
  * <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
1626
1804
  * <code>2019-07-01T23:59:59</code>.</p>
1627
1805
  */
1628
1806
  StartTime: Date | undefined;
1629
1807
  /**
1808
+ * @public
1630
1809
  * <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
1631
1810
  * <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
1632
1811
  * <code>2019-07-01T23:59:59</code>.</p>
1633
1812
  */
1634
1813
  EndTime: Date | undefined;
1635
1814
  /**
1815
+ * @public
1636
1816
  * <p>The period, in seconds, to use for the statistics in the <code>InsightRuleMetricDatapoint</code> results.</p>
1637
1817
  */
1638
1818
  Period: number | undefined;
1639
1819
  /**
1820
+ * @public
1640
1821
  * <p>The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.</p>
1641
1822
  */
1642
1823
  MaxContributorCount?: number;
1643
1824
  /**
1825
+ * @public
1644
1826
  * <p>Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more
1645
1827
  * of the following metrics:</p>
1646
1828
  * <ul>
@@ -1680,6 +1862,7 @@ export interface GetInsightRuleReportInput {
1680
1862
  */
1681
1863
  Metrics?: string[];
1682
1864
  /**
1865
+ * @public
1683
1866
  * <p>Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.</p>
1684
1867
  */
1685
1868
  OrderBy?: string;
@@ -1692,10 +1875,12 @@ export interface GetInsightRuleReportInput {
1692
1875
  */
1693
1876
  export interface InsightRuleContributorDatapoint {
1694
1877
  /**
1878
+ * @public
1695
1879
  * <p>The timestamp of the data point.</p>
1696
1880
  */
1697
1881
  Timestamp: Date | undefined;
1698
1882
  /**
1883
+ * @public
1699
1884
  * <p>The approximate value that this contributor added during this timestamp.</p>
1700
1885
  */
1701
1886
  ApproximateValue: number | undefined;
@@ -1709,14 +1894,17 @@ export interface InsightRuleContributorDatapoint {
1709
1894
  */
1710
1895
  export interface InsightRuleContributor {
1711
1896
  /**
1897
+ * @public
1712
1898
  * <p>One of the log entry field keywords that is used to define contributors for this rule.</p>
1713
1899
  */
1714
1900
  Keys: string[] | undefined;
1715
1901
  /**
1902
+ * @public
1716
1903
  * <p>An approximation of the aggregate value that comes from this contributor.</p>
1717
1904
  */
1718
1905
  ApproximateAggregateValue: number | undefined;
1719
1906
  /**
1907
+ * @public
1720
1908
  * <p>An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.</p>
1721
1909
  */
1722
1910
  Datapoints: InsightRuleContributorDatapoint[] | undefined;
@@ -1728,15 +1916,18 @@ export interface InsightRuleContributor {
1728
1916
  */
1729
1917
  export interface InsightRuleMetricDatapoint {
1730
1918
  /**
1919
+ * @public
1731
1920
  * <p>The timestamp of the data point.</p>
1732
1921
  */
1733
1922
  Timestamp: Date | undefined;
1734
1923
  /**
1924
+ * @public
1735
1925
  * <p>The number of unique contributors who published data during this timestamp.</p>
1736
1926
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1737
1927
  */
1738
1928
  UniqueContributors?: number;
1739
1929
  /**
1930
+ * @public
1740
1931
  * <p>The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately,
1741
1932
  * so the identity of the max contributor
1742
1933
  * could be different for each timestamp.</p>
@@ -1744,26 +1935,31 @@ export interface InsightRuleMetricDatapoint {
1744
1935
  */
1745
1936
  MaxContributorValue?: number;
1746
1937
  /**
1938
+ * @public
1747
1939
  * <p>The number of occurrences that matched the rule during this data point.</p>
1748
1940
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1749
1941
  */
1750
1942
  SampleCount?: number;
1751
1943
  /**
1944
+ * @public
1752
1945
  * <p>The average value from all contributors during the time period represented by that data point.</p>
1753
1946
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1754
1947
  */
1755
1948
  Average?: number;
1756
1949
  /**
1950
+ * @public
1757
1951
  * <p>The sum of the values from all contributors during the time period represented by that data point.</p>
1758
1952
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1759
1953
  */
1760
1954
  Sum?: number;
1761
1955
  /**
1956
+ * @public
1762
1957
  * <p>The minimum value from a single contributor during the time period represented by that data point.</p>
1763
1958
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1764
1959
  */
1765
1960
  Minimum?: number;
1766
1961
  /**
1962
+ * @public
1767
1963
  * <p>The maximum value from a single occurence from a single contributor during the time period represented by that data point.</p>
1768
1964
  * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1769
1965
  */
@@ -1774,28 +1970,34 @@ export interface InsightRuleMetricDatapoint {
1774
1970
  */
1775
1971
  export interface GetInsightRuleReportOutput {
1776
1972
  /**
1973
+ * @public
1777
1974
  * <p>An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors.
1778
1975
  * If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.</p>
1779
1976
  */
1780
1977
  KeyLabels?: string[];
1781
1978
  /**
1979
+ * @public
1782
1980
  * <p>Specifies whether this rule aggregates contributor data by COUNT or SUM.</p>
1783
1981
  */
1784
1982
  AggregationStatistic?: string;
1785
1983
  /**
1984
+ * @public
1786
1985
  * <p>The sum of the values from all individual contributors that match the rule.</p>
1787
1986
  */
1788
1987
  AggregateValue?: number;
1789
1988
  /**
1989
+ * @public
1790
1990
  * <p>An approximate count of the unique contributors found by this rule in this time period.</p>
1791
1991
  */
1792
1992
  ApproximateUniqueCount?: number;
1793
1993
  /**
1994
+ * @public
1794
1995
  * <p>An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values
1795
1996
  * for the keys counts as a unique contributor.</p>
1796
1997
  */
1797
1998
  Contributors?: InsightRuleContributor[];
1798
1999
  /**
2000
+ * @public
1799
2001
  * <p>A time series of metric data points that matches the time period in the rule request.</p>
1800
2002
  */
1801
2003
  MetricDatapoints?: InsightRuleMetricDatapoint[];
@@ -1812,6 +2014,7 @@ export interface GetInsightRuleReportOutput {
1812
2014
  */
1813
2015
  export interface LabelOptions {
1814
2016
  /**
2017
+ * @public
1815
2018
  * <p>The time zone to use for metric data return in this operation.
1816
2019
  * The format is <code>+</code> or <code>-</code> followed by four digits.
1817
2020
  * The first two digits indicate the number of hours ahead or behind of UTC, and
@@ -1825,6 +2028,7 @@ export interface LabelOptions {
1825
2028
  */
1826
2029
  export interface GetMetricDataInput {
1827
2030
  /**
2031
+ * @public
1828
2032
  * <p>The metric queries to be returned. A single <code>GetMetricData</code> call can
1829
2033
  * include as many as 500 <code>MetricDataQuery</code>
1830
2034
  * structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,
@@ -1832,6 +2036,7 @@ export interface GetMetricDataInput {
1832
2036
  */
1833
2037
  MetricDataQueries: MetricDataQuery[] | undefined;
1834
2038
  /**
2039
+ * @public
1835
2040
  * <p>The time stamp indicating the earliest data to be returned.</p>
1836
2041
  * <p>The value specified is inclusive; results include data points with the specified time stamp. </p>
1837
2042
  * <p>CloudWatch rounds the specified time stamp as follows:</p>
@@ -1865,6 +2070,7 @@ export interface GetMetricDataInput {
1865
2070
  */
1866
2071
  StartTime: Date | undefined;
1867
2072
  /**
2073
+ * @public
1868
2074
  * <p>The time stamp indicating the latest data to be returned.</p>
1869
2075
  * <p>The value specified is exclusive; results include data points up to the specified time stamp.</p>
1870
2076
  * <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code>
@@ -1875,22 +2081,26 @@ export interface GetMetricDataInput {
1875
2081
  */
1876
2082
  EndTime: Date | undefined;
1877
2083
  /**
2084
+ * @public
1878
2085
  * <p>Include this value, if it was returned by the previous <code>GetMetricData</code> operation,
1879
2086
  * to get the next set of data points.</p>
1880
2087
  */
1881
2088
  NextToken?: string;
1882
2089
  /**
2090
+ * @public
1883
2091
  * <p>The order in which data points should be returned. <code>TimestampDescending</code> returns the newest data first and paginates
1884
2092
  * when the <code>MaxDatapoints</code> limit is reached. <code>TimestampAscending</code> returns the oldest data first and paginates
1885
2093
  * when the <code>MaxDatapoints</code> limit is reached.</p>
1886
2094
  */
1887
2095
  ScanBy?: ScanBy | string;
1888
2096
  /**
2097
+ * @public
1889
2098
  * <p>The maximum number of data points the request should return before paginating. If you omit
1890
2099
  * this, the default of 100,800 is used.</p>
1891
2100
  */
1892
2101
  MaxDatapoints?: number;
1893
2102
  /**
2103
+ * @public
1894
2104
  * <p>This structure includes the <code>Timezone</code> parameter, which you can use
1895
2105
  * to specify your time zone so that the labels of returned data display the
1896
2106
  * correct time
@@ -1908,10 +2118,12 @@ export interface GetMetricDataInput {
1908
2118
  */
1909
2119
  export interface MessageData {
1910
2120
  /**
2121
+ * @public
1911
2122
  * <p>The error code or status code associated with the message.</p>
1912
2123
  */
1913
2124
  Code?: string;
1914
2125
  /**
2126
+ * @public
1915
2127
  * <p>The message text.</p>
1916
2128
  */
1917
2129
  Value?: string;
@@ -1938,26 +2150,31 @@ export type StatusCode = (typeof StatusCode)[keyof typeof StatusCode];
1938
2150
  */
1939
2151
  export interface MetricDataResult {
1940
2152
  /**
2153
+ * @public
1941
2154
  * <p>The short name you specified to represent this metric.</p>
1942
2155
  */
1943
2156
  Id?: string;
1944
2157
  /**
2158
+ * @public
1945
2159
  * <p>The human-readable label associated with the data.</p>
1946
2160
  */
1947
2161
  Label?: string;
1948
2162
  /**
2163
+ * @public
1949
2164
  * <p>The timestamps for the data points, formatted in Unix timestamp format. The number of
1950
2165
  * timestamps always matches the number of values and the value for Timestamps[x] is
1951
2166
  * Values[x].</p>
1952
2167
  */
1953
2168
  Timestamps?: Date[];
1954
2169
  /**
2170
+ * @public
1955
2171
  * <p>The data points for the metric corresponding to <code>Timestamps</code>. The number of
1956
2172
  * values always matches the number of timestamps and the timestamp for Values[x] is
1957
2173
  * Timestamps[x].</p>
1958
2174
  */
1959
2175
  Values?: number[];
1960
2176
  /**
2177
+ * @public
1961
2178
  * <p>The status of the returned data. <code>Complete</code> indicates that all data points in the requested time range were returned.
1962
2179
  * <code>PartialData</code> means that an incomplete set of data points were returned.
1963
2180
  * You can use the <code>NextToken</code> value that was returned and repeat your request to get more data points.
@@ -1966,6 +2183,7 @@ export interface MetricDataResult {
1966
2183
  */
1967
2184
  StatusCode?: StatusCode | string;
1968
2185
  /**
2186
+ * @public
1969
2187
  * <p>A list of messages with additional information about the data returned.</p>
1970
2188
  */
1971
2189
  Messages?: MessageData[];
@@ -1975,14 +2193,17 @@ export interface MetricDataResult {
1975
2193
  */
1976
2194
  export interface GetMetricDataOutput {
1977
2195
  /**
2196
+ * @public
1978
2197
  * <p>The metrics that are returned, including the metric name, namespace, and dimensions.</p>
1979
2198
  */
1980
2199
  MetricDataResults?: MetricDataResult[];
1981
2200
  /**
2201
+ * @public
1982
2202
  * <p>A token that marks the next batch of returned results.</p>
1983
2203
  */
1984
2204
  NextToken?: string;
1985
2205
  /**
2206
+ * @public
1986
2207
  * <p>Contains a message about this <code>GetMetricData</code> operation, if the operation results in such a message.
1987
2208
  * An example of a message that
1988
2209
  * might be returned is <code>Maximum number of allowed metrics exceeded</code>. If there is a message, as much of the
@@ -1997,14 +2218,17 @@ export interface GetMetricDataOutput {
1997
2218
  */
1998
2219
  export interface GetMetricStatisticsInput {
1999
2220
  /**
2221
+ * @public
2000
2222
  * <p>The namespace of the metric, with or without spaces.</p>
2001
2223
  */
2002
2224
  Namespace: string | undefined;
2003
2225
  /**
2226
+ * @public
2004
2227
  * <p>The name of the metric, with or without spaces.</p>
2005
2228
  */
2006
2229
  MetricName: string | undefined;
2007
2230
  /**
2231
+ * @public
2008
2232
  * <p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension.
2009
2233
  * CloudWatch treats each unique combination of dimensions as a separate metric.
2010
2234
  * If a specific combination of dimensions was not published, you can't retrieve statistics for it.
@@ -2014,6 +2238,7 @@ export interface GetMetricStatisticsInput {
2014
2238
  */
2015
2239
  Dimensions?: Dimension[];
2016
2240
  /**
2241
+ * @public
2017
2242
  * <p>The time stamp that determines the first data point to return. Start times are
2018
2243
  * evaluated relative to the time that CloudWatch receives the request.</p>
2019
2244
  * <p>The value specified is inclusive; results include data points with the specified time stamp.
@@ -2044,12 +2269,14 @@ export interface GetMetricStatisticsInput {
2044
2269
  */
2045
2270
  StartTime: Date | undefined;
2046
2271
  /**
2272
+ * @public
2047
2273
  * <p>The time stamp that determines the last data point to return.</p>
2048
2274
  * <p>The value specified is exclusive; results include data points up to the specified time stamp.
2049
2275
  * In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).</p>
2050
2276
  */
2051
2277
  EndTime: Date | undefined;
2052
2278
  /**
2279
+ * @public
2053
2280
  * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
2054
2281
  * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
2055
2282
  * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
@@ -2070,18 +2297,21 @@ export interface GetMetricStatisticsInput {
2070
2297
  */
2071
2298
  Period: number | undefined;
2072
2299
  /**
2300
+ * @public
2073
2301
  * <p>The metric statistics, other than percentile. For percentile statistics,
2074
2302
  * use <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you must
2075
2303
  * specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both.</p>
2076
2304
  */
2077
2305
  Statistics?: (Statistic | string)[];
2078
2306
  /**
2307
+ * @public
2079
2308
  * <p>The percentile statistics. Specify values between p0.0 and p100. When calling <code>GetMetricStatistics</code>, you must
2080
2309
  * specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
2081
2310
  * available for metrics when any of the metric values are negative numbers.</p>
2082
2311
  */
2083
2312
  ExtendedStatistics?: string[];
2084
2313
  /**
2314
+ * @public
2085
2315
  * <p>The unit for a given metric.
2086
2316
  * If you omit <code>Unit</code>, all data that was collected with any unit is returned, along with the corresponding units that were specified
2087
2317
  * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
@@ -2094,10 +2324,12 @@ export interface GetMetricStatisticsInput {
2094
2324
  */
2095
2325
  export interface GetMetricStatisticsOutput {
2096
2326
  /**
2327
+ * @public
2097
2328
  * <p>A label for the specified metric.</p>
2098
2329
  */
2099
2330
  Label?: string;
2100
2331
  /**
2332
+ * @public
2101
2333
  * <p>The data points for the specified metric.</p>
2102
2334
  */
2103
2335
  Datapoints?: Datapoint[];
@@ -2107,6 +2339,7 @@ export interface GetMetricStatisticsOutput {
2107
2339
  */
2108
2340
  export interface GetMetricStreamInput {
2109
2341
  /**
2342
+ * @public
2110
2343
  * <p>The name of the metric stream to retrieve information about.</p>
2111
2344
  */
2112
2345
  Name: string | undefined;
@@ -2123,12 +2356,14 @@ export interface GetMetricStreamInput {
2123
2356
  */
2124
2357
  export interface MetricStreamFilter {
2125
2358
  /**
2359
+ * @public
2126
2360
  * <p>The name of the metric namespace for this filter.</p>
2127
2361
  * <p>The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must
2128
2362
  * contain at least one non-whitespace character.</p>
2129
2363
  */
2130
2364
  Namespace?: string;
2131
2365
  /**
2366
+ * @public
2132
2367
  * <p>The names of the metrics to either include or exclude from the metric stream. </p>
2133
2368
  * <p>If you omit this parameter, all metrics in the namespace are included or excluded,
2134
2369
  * depending on whether this filter is specified as an exclude filter or an include filter.</p>
@@ -2156,10 +2391,12 @@ export type MetricStreamOutputFormat = (typeof MetricStreamOutputFormat)[keyof t
2156
2391
  */
2157
2392
  export interface MetricStreamStatisticsMetric {
2158
2393
  /**
2394
+ * @public
2159
2395
  * <p>The namespace of the metric.</p>
2160
2396
  */
2161
2397
  Namespace: string | undefined;
2162
2398
  /**
2399
+ * @public
2163
2400
  * <p>The name of the metric.</p>
2164
2401
  */
2165
2402
  MetricName: string | undefined;
@@ -2175,6 +2412,7 @@ export interface MetricStreamStatisticsMetric {
2175
2412
  */
2176
2413
  export interface MetricStreamStatisticsConfiguration {
2177
2414
  /**
2415
+ * @public
2178
2416
  * <p>An array of metric name and namespace pairs that stream the additional statistics listed
2179
2417
  * in the value of the <code>AdditionalStatistics</code> parameter. There can be as many as
2180
2418
  * 100 pairs in the array.</p>
@@ -2183,6 +2421,7 @@ export interface MetricStreamStatisticsConfiguration {
2183
2421
  */
2184
2422
  IncludeMetrics: MetricStreamStatisticsMetric[] | undefined;
2185
2423
  /**
2424
+ * @public
2186
2425
  * <p>The list of additional statistics that are to be streamed for the metrics listed
2187
2426
  * in the <code>IncludeMetrics</code> array in this structure. This list can include as many as 20 statistics.</p>
2188
2427
  * <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry0.7</code>, the only
@@ -2202,48 +2441,58 @@ export interface MetricStreamStatisticsConfiguration {
2202
2441
  */
2203
2442
  export interface GetMetricStreamOutput {
2204
2443
  /**
2444
+ * @public
2205
2445
  * <p>The ARN of the metric stream.</p>
2206
2446
  */
2207
2447
  Arn?: string;
2208
2448
  /**
2449
+ * @public
2209
2450
  * <p>The name of the metric stream.</p>
2210
2451
  */
2211
2452
  Name?: string;
2212
2453
  /**
2454
+ * @public
2213
2455
  * <p>If this array of metric namespaces is present, then these
2214
2456
  * namespaces are the only
2215
2457
  * metric namespaces that are streamed by this metric stream.</p>
2216
2458
  */
2217
2459
  IncludeFilters?: MetricStreamFilter[];
2218
2460
  /**
2461
+ * @public
2219
2462
  * <p>If this array of metric namespaces is present, then these namespaces are the only
2220
2463
  * metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in
2221
2464
  * the account are streamed by this metric stream.</p>
2222
2465
  */
2223
2466
  ExcludeFilters?: MetricStreamFilter[];
2224
2467
  /**
2468
+ * @public
2225
2469
  * <p>The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric
2226
2470
  * stream.</p>
2227
2471
  */
2228
2472
  FirehoseArn?: string;
2229
2473
  /**
2474
+ * @public
2230
2475
  * <p>The ARN of the IAM role that is used by this metric stream.</p>
2231
2476
  */
2232
2477
  RoleArn?: string;
2233
2478
  /**
2479
+ * @public
2234
2480
  * <p>The state of the metric stream. The possible values are <code>running</code>
2235
2481
  * and <code>stopped</code>.</p>
2236
2482
  */
2237
2483
  State?: string;
2238
2484
  /**
2485
+ * @public
2239
2486
  * <p>The date that the metric stream was created.</p>
2240
2487
  */
2241
2488
  CreationDate?: Date;
2242
2489
  /**
2490
+ * @public
2243
2491
  * <p>The date of the most recent update to the metric stream's configuration.</p>
2244
2492
  */
2245
2493
  LastUpdateDate?: Date;
2246
2494
  /**
2495
+ * @public
2247
2496
  * <p>The output format for the stream.
2248
2497
  * Valid values are <code>json</code> and <code>opentelemetry0.7</code>.
2249
2498
  * For more information about metric stream output formats,
@@ -2251,6 +2500,7 @@ export interface GetMetricStreamOutput {
2251
2500
  */
2252
2501
  OutputFormat?: MetricStreamOutputFormat | string;
2253
2502
  /**
2503
+ * @public
2254
2504
  * <p>Each entry in this array displays information about one or more metrics that include additional statistics
2255
2505
  * in the metric stream. For more information about the additional statistics, see
2256
2506
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
@@ -2258,6 +2508,7 @@ export interface GetMetricStreamOutput {
2258
2508
  */
2259
2509
  StatisticsConfigurations?: MetricStreamStatisticsConfiguration[];
2260
2510
  /**
2511
+ * @public
2261
2512
  * <p>If this is <code>true</code> and this metric stream is in a monitoring account, then the stream includes
2262
2513
  * metrics from source accounts that the monitoring account is linked to.</p>
2263
2514
  */
@@ -2268,6 +2519,7 @@ export interface GetMetricStreamOutput {
2268
2519
  */
2269
2520
  export interface GetMetricWidgetImageInput {
2270
2521
  /**
2522
+ * @public
2271
2523
  * <p>A JSON string that defines the bitmap graph to be retrieved. The string includes the
2272
2524
  * metrics to include in the graph, statistics, annotations, title, axis limits, and so on.
2273
2525
  * You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p>
@@ -2278,6 +2530,7 @@ export interface GetMetricWidgetImageInput {
2278
2530
  */
2279
2531
  MetricWidget: string | undefined;
2280
2532
  /**
2533
+ * @public
2281
2534
  * <p>The format of the resulting image. Only PNG images are supported.</p>
2282
2535
  * <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the
2283
2536
  * content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code>
@@ -2325,6 +2578,7 @@ export interface GetMetricWidgetImageInput {
2325
2578
  */
2326
2579
  export interface GetMetricWidgetImageOutput {
2327
2580
  /**
2581
+ * @public
2328
2582
  * <p>The image of the graph, in the output format specified. The output is base64-encoded.</p>
2329
2583
  */
2330
2584
  MetricWidgetImage?: Uint8Array;
@@ -2334,6 +2588,7 @@ export interface GetMetricWidgetImageOutput {
2334
2588
  */
2335
2589
  export interface ListDashboardsInput {
2336
2590
  /**
2591
+ * @public
2337
2592
  * <p>If you specify this parameter, only
2338
2593
  * the dashboards with names starting with the specified string are listed. The maximum length is 255, and
2339
2594
  * valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
@@ -2342,6 +2597,7 @@ export interface ListDashboardsInput {
2342
2597
  */
2343
2598
  DashboardNamePrefix?: string;
2344
2599
  /**
2600
+ * @public
2345
2601
  * <p>The token returned by a previous call to indicate that there is more data available.</p>
2346
2602
  */
2347
2603
  NextToken?: string;
@@ -2351,10 +2607,12 @@ export interface ListDashboardsInput {
2351
2607
  */
2352
2608
  export interface ListDashboardsOutput {
2353
2609
  /**
2610
+ * @public
2354
2611
  * <p>The list of matching dashboards.</p>
2355
2612
  */
2356
2613
  DashboardEntries?: DashboardEntry[];
2357
2614
  /**
2615
+ * @public
2358
2616
  * <p>The token that marks the start of the next batch of returned results.</p>
2359
2617
  */
2360
2618
  NextToken?: string;
@@ -2364,6 +2622,7 @@ export interface ListDashboardsOutput {
2364
2622
  */
2365
2623
  export interface ListManagedInsightRulesInput {
2366
2624
  /**
2625
+ * @public
2367
2626
  * <p>
2368
2627
  * The ARN
2369
2628
  * of an Amazon Web Services resource
@@ -2372,6 +2631,7 @@ export interface ListManagedInsightRulesInput {
2372
2631
  */
2373
2632
  ResourceARN: string | undefined;
2374
2633
  /**
2634
+ * @public
2375
2635
  * <p>
2376
2636
  * Include this value
2377
2637
  * to get
@@ -2383,6 +2643,7 @@ export interface ListManagedInsightRulesInput {
2383
2643
  */
2384
2644
  NextToken?: string;
2385
2645
  /**
2646
+ * @public
2386
2647
  * <p>
2387
2648
  * The maximum number
2388
2649
  * of results
@@ -2404,6 +2665,7 @@ export interface ListManagedInsightRulesInput {
2404
2665
  */
2405
2666
  export interface ManagedRuleState {
2406
2667
  /**
2668
+ * @public
2407
2669
  * <p>
2408
2670
  * The name
2409
2671
  * of the Contributor Insights rule
@@ -2413,6 +2675,7 @@ export interface ManagedRuleState {
2413
2675
  */
2414
2676
  RuleName: string | undefined;
2415
2677
  /**
2678
+ * @public
2416
2679
  * <p>
2417
2680
  * Indicates whether the rule is enabled or disabled.
2418
2681
  * </p>
@@ -2431,6 +2694,7 @@ export interface ManagedRuleState {
2431
2694
  */
2432
2695
  export interface ManagedRuleDescription {
2433
2696
  /**
2697
+ * @public
2434
2698
  * <p>
2435
2699
  * The template name
2436
2700
  * for the managed rule.
@@ -2440,6 +2704,7 @@ export interface ManagedRuleDescription {
2440
2704
  */
2441
2705
  TemplateName?: string;
2442
2706
  /**
2707
+ * @public
2443
2708
  * <p>
2444
2709
  * If a managed rule is enabled,
2445
2710
  * this is the ARN
@@ -2448,6 +2713,7 @@ export interface ManagedRuleDescription {
2448
2713
  */
2449
2714
  ResourceARN?: string;
2450
2715
  /**
2716
+ * @public
2451
2717
  * <p>
2452
2718
  * Describes the state
2453
2719
  * of a managed rule.
@@ -2465,6 +2731,7 @@ export interface ManagedRuleDescription {
2465
2731
  */
2466
2732
  export interface ListManagedInsightRulesOutput {
2467
2733
  /**
2734
+ * @public
2468
2735
  * <p>
2469
2736
  * The managed rules
2470
2737
  * that are available
@@ -2473,6 +2740,7 @@ export interface ListManagedInsightRulesOutput {
2473
2740
  */
2474
2741
  ManagedRules?: ManagedRuleDescription[];
2475
2742
  /**
2743
+ * @public
2476
2744
  * <p>
2477
2745
  * Include this value
2478
2746
  * to get
@@ -2500,26 +2768,31 @@ export type RecentlyActive = (typeof RecentlyActive)[keyof typeof RecentlyActive
2500
2768
  */
2501
2769
  export interface ListMetricsInput {
2502
2770
  /**
2771
+ * @public
2503
2772
  * <p>The metric namespace to filter against. Only the namespace that matches exactly
2504
2773
  * will be returned.</p>
2505
2774
  */
2506
2775
  Namespace?: string;
2507
2776
  /**
2777
+ * @public
2508
2778
  * <p>The name of the metric to filter against. Only the metrics with names that match exactly
2509
2779
  * will be returned.</p>
2510
2780
  */
2511
2781
  MetricName?: string;
2512
2782
  /**
2783
+ * @public
2513
2784
  * <p>The dimensions to filter against. Only the dimensions that match exactly
2514
2785
  * will be returned.</p>
2515
2786
  */
2516
2787
  Dimensions?: DimensionFilter[];
2517
2788
  /**
2789
+ * @public
2518
2790
  * <p>The token returned by a previous call to indicate that there is more data
2519
2791
  * available.</p>
2520
2792
  */
2521
2793
  NextToken?: string;
2522
2794
  /**
2795
+ * @public
2523
2796
  * <p>To filter the results to show only metrics that have had data points published
2524
2797
  * in the past three hours, specify this parameter
2525
2798
  * with a value of <code>PT3H</code>. This is the only valid value
@@ -2530,12 +2803,14 @@ export interface ListMetricsInput {
2530
2803
  */
2531
2804
  RecentlyActive?: RecentlyActive | string;
2532
2805
  /**
2806
+ * @public
2533
2807
  * <p>If you are using this operation in a monitoring account,
2534
2808
  * specify <code>true</code> to include metrics from source accounts in the returned data.</p>
2535
2809
  * <p>The default is <code>false</code>.</p>
2536
2810
  */
2537
2811
  IncludeLinkedAccounts?: boolean;
2538
2812
  /**
2813
+ * @public
2539
2814
  * <p>When you use this operation in a monitoring account, use this field to return metrics only from one source account.
2540
2815
  * To do so, specify that source account ID in this field, and also
2541
2816
  * specify <code>true</code> for <code>IncludeLinkedAccounts</code>.</p>
@@ -2547,14 +2822,17 @@ export interface ListMetricsInput {
2547
2822
  */
2548
2823
  export interface ListMetricsOutput {
2549
2824
  /**
2825
+ * @public
2550
2826
  * <p>The metrics that match your request. </p>
2551
2827
  */
2552
2828
  Metrics?: Metric[];
2553
2829
  /**
2830
+ * @public
2554
2831
  * <p>The token that marks the start of the next batch of returned results. </p>
2555
2832
  */
2556
2833
  NextToken?: string;
2557
2834
  /**
2835
+ * @public
2558
2836
  * <p>If you are using this operation in a monitoring account, this array contains the account IDs of the source
2559
2837
  * accounts where the metrics in the returned data
2560
2838
  * are from.</p>
@@ -2567,10 +2845,12 @@ export interface ListMetricsOutput {
2567
2845
  */
2568
2846
  export interface ListMetricStreamsInput {
2569
2847
  /**
2848
+ * @public
2570
2849
  * <p>Include this value, if it was returned by the previous call, to get the next set of metric streams.</p>
2571
2850
  */
2572
2851
  NextToken?: string;
2573
2852
  /**
2853
+ * @public
2574
2854
  * <p>The maximum number of results to return in one operation.</p>
2575
2855
  */
2576
2856
  MaxResults?: number;
@@ -2581,30 +2861,37 @@ export interface ListMetricStreamsInput {
2581
2861
  */
2582
2862
  export interface MetricStreamEntry {
2583
2863
  /**
2864
+ * @public
2584
2865
  * <p>The ARN of the metric stream.</p>
2585
2866
  */
2586
2867
  Arn?: string;
2587
2868
  /**
2869
+ * @public
2588
2870
  * <p>The date that the metric stream was originally created.</p>
2589
2871
  */
2590
2872
  CreationDate?: Date;
2591
2873
  /**
2874
+ * @public
2592
2875
  * <p>The date that the configuration of this metric stream was most recently updated.</p>
2593
2876
  */
2594
2877
  LastUpdateDate?: Date;
2595
2878
  /**
2879
+ * @public
2596
2880
  * <p>The name of the metric stream.</p>
2597
2881
  */
2598
2882
  Name?: string;
2599
2883
  /**
2884
+ * @public
2600
2885
  * <p>The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.</p>
2601
2886
  */
2602
2887
  FirehoseArn?: string;
2603
2888
  /**
2889
+ * @public
2604
2890
  * <p>The current state of this stream. Valid values are <code>running</code> and <code>stopped</code>.</p>
2605
2891
  */
2606
2892
  State?: string;
2607
2893
  /**
2894
+ * @public
2608
2895
  * <p>The output format of this metric stream. Valid values are
2609
2896
  * <code>json</code>
2610
2897
  * and <code>opentelemetry0.7</code>.</p>
@@ -2616,11 +2903,13 @@ export interface MetricStreamEntry {
2616
2903
  */
2617
2904
  export interface ListMetricStreamsOutput {
2618
2905
  /**
2906
+ * @public
2619
2907
  * <p>The token that marks the start of the next batch of returned results. You can use this
2620
2908
  * token in a subsequent operation to get the next batch of results.</p>
2621
2909
  */
2622
2910
  NextToken?: string;
2623
2911
  /**
2912
+ * @public
2624
2913
  * <p>The array of metric stream information.</p>
2625
2914
  */
2626
2915
  Entries?: MetricStreamEntry[];
@@ -2630,6 +2919,7 @@ export interface ListMetricStreamsOutput {
2630
2919
  */
2631
2920
  export interface ListTagsForResourceInput {
2632
2921
  /**
2922
+ * @public
2633
2923
  * <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
2634
2924
  * <p>The ARN format of an alarm is
2635
2925
  * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
@@ -2651,11 +2941,13 @@ export interface ListTagsForResourceInput {
2651
2941
  */
2652
2942
  export interface Tag {
2653
2943
  /**
2944
+ * @public
2654
2945
  * <p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your
2655
2946
  * resources.</p>
2656
2947
  */
2657
2948
  Key: string | undefined;
2658
2949
  /**
2950
+ * @public
2659
2951
  * <p>The value for the specified tag key.</p>
2660
2952
  */
2661
2953
  Value: string | undefined;
@@ -2665,6 +2957,7 @@ export interface Tag {
2665
2957
  */
2666
2958
  export interface ListTagsForResourceOutput {
2667
2959
  /**
2960
+ * @public
2668
2961
  * <p>The list of tag keys and values associated with the resource you specified.</p>
2669
2962
  */
2670
2963
  Tags?: Tag[];
@@ -2674,30 +2967,35 @@ export interface ListTagsForResourceOutput {
2674
2967
  */
2675
2968
  export interface PutAnomalyDetectorInput {
2676
2969
  /**
2970
+ * @public
2677
2971
  * @deprecated
2678
2972
  *
2679
2973
  * <p>The namespace of the metric to create the anomaly detection model for.</p>
2680
2974
  */
2681
2975
  Namespace?: string;
2682
2976
  /**
2977
+ * @public
2683
2978
  * @deprecated
2684
2979
  *
2685
2980
  * <p>The name of the metric to create the anomaly detection model for.</p>
2686
2981
  */
2687
2982
  MetricName?: string;
2688
2983
  /**
2984
+ * @public
2689
2985
  * @deprecated
2690
2986
  *
2691
2987
  * <p>The metric dimensions to create the anomaly detection model for.</p>
2692
2988
  */
2693
2989
  Dimensions?: Dimension[];
2694
2990
  /**
2991
+ * @public
2695
2992
  * @deprecated
2696
2993
  *
2697
2994
  * <p>The statistic to use for the metric and the anomaly detection model.</p>
2698
2995
  */
2699
2996
  Stat?: string;
2700
2997
  /**
2998
+ * @public
2701
2999
  * <p>The configuration specifies details about how the
2702
3000
  * anomaly detection model is to be trained, including
2703
3001
  * time ranges to exclude when training and updating the model.
@@ -2707,6 +3005,7 @@ export interface PutAnomalyDetectorInput {
2707
3005
  */
2708
3006
  Configuration?: AnomalyDetectorConfiguration;
2709
3007
  /**
3008
+ * @public
2710
3009
  * <p>A single metric anomaly detector to be created.</p>
2711
3010
  * <p>When using <code>SingleMetricAnomalyDetector</code>,
2712
3011
  * you cannot include the following parameters in the same operation:</p>
@@ -2741,6 +3040,7 @@ export interface PutAnomalyDetectorInput {
2741
3040
  */
2742
3041
  SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector;
2743
3042
  /**
3043
+ * @public
2744
3044
  * <p>The metric math anomaly detector to be created.</p>
2745
3045
  * <p>When using <code>MetricMathAnomalyDetector</code>, you cannot include the following parameters in the same operation:</p>
2746
3046
  * <ul>
@@ -2796,11 +3096,13 @@ export declare class LimitExceededFault extends __BaseException {
2796
3096
  */
2797
3097
  export interface PutCompositeAlarmInput {
2798
3098
  /**
3099
+ * @public
2799
3100
  * <p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is
2800
3101
  * <code>TRUE</code>.</p>
2801
3102
  */
2802
3103
  ActionsEnabled?: boolean;
2803
3104
  /**
3105
+ * @public
2804
3106
  * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
2805
3107
  * Each action is specified as an Amazon Resource Name (ARN).</p>
2806
3108
  * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
@@ -2811,14 +3113,17 @@ export interface PutCompositeAlarmInput {
2811
3113
  */
2812
3114
  AlarmActions?: string[];
2813
3115
  /**
3116
+ * @public
2814
3117
  * <p>The description for the composite alarm.</p>
2815
3118
  */
2816
3119
  AlarmDescription?: string;
2817
3120
  /**
3121
+ * @public
2818
3122
  * <p>The name for the composite alarm. This name must be unique within the Region.</p>
2819
3123
  */
2820
3124
  AlarmName: string | undefined;
2821
3125
  /**
3126
+ * @public
2822
3127
  * <p>An expression that specifies which other alarms are to be evaluated to determine this
2823
3128
  * composite alarm's state. For each alarm that you reference, you
2824
3129
  * designate a function that
@@ -2885,6 +3190,7 @@ export interface PutCompositeAlarmInput {
2885
3190
  */
2886
3191
  AlarmRule: string | undefined;
2887
3192
  /**
3193
+ * @public
2888
3194
  * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
2889
3195
  * Each action is specified as an Amazon Resource Name (ARN).</p>
2890
3196
  * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
@@ -2893,6 +3199,7 @@ export interface PutCompositeAlarmInput {
2893
3199
  */
2894
3200
  InsufficientDataActions?: string[];
2895
3201
  /**
3202
+ * @public
2896
3203
  * <p>The actions to execute when this alarm transitions to an <code>OK</code> state
2897
3204
  * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
2898
3205
  * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
@@ -2901,6 +3208,7 @@ export interface PutCompositeAlarmInput {
2901
3208
  */
2902
3209
  OKActions?: string[];
2903
3210
  /**
3211
+ * @public
2904
3212
  * <p>A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.</p>
2905
3213
  * <p>Tags can help you organize and categorize your
2906
3214
  * resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
@@ -2908,6 +3216,7 @@ export interface PutCompositeAlarmInput {
2908
3216
  */
2909
3217
  Tags?: Tag[];
2910
3218
  /**
3219
+ * @public
2911
3220
  * <p>
2912
3221
  * Actions will be suppressed
2913
3222
  * if the suppressor alarm is
@@ -2918,6 +3227,7 @@ export interface PutCompositeAlarmInput {
2918
3227
  */
2919
3228
  ActionsSuppressor?: string;
2920
3229
  /**
3230
+ * @public
2921
3231
  * <p>
2922
3232
  * The maximum time
2923
3233
  * in seconds
@@ -2938,6 +3248,7 @@ export interface PutCompositeAlarmInput {
2938
3248
  */
2939
3249
  ActionsSuppressorWaitPeriod?: number;
2940
3250
  /**
3251
+ * @public
2941
3252
  * <p>
2942
3253
  * The maximum time
2943
3254
  * in seconds
@@ -2962,12 +3273,14 @@ export interface PutCompositeAlarmInput {
2962
3273
  */
2963
3274
  export interface PutDashboardInput {
2964
3275
  /**
3276
+ * @public
2965
3277
  * <p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing
2966
3278
  * its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are
2967
3279
  * A-Z, a-z, 0-9, "-", and "_". This parameter is required.</p>
2968
3280
  */
2969
3281
  DashboardName: string | undefined;
2970
3282
  /**
3283
+ * @public
2971
3284
  * <p>The detailed information about the dashboard in JSON format, including the widgets to include and their location
2972
3285
  * on the dashboard. This parameter is required.</p>
2973
3286
  * <p>For more information about the syntax,
@@ -2980,6 +3293,7 @@ export interface PutDashboardInput {
2980
3293
  */
2981
3294
  export interface PutDashboardOutput {
2982
3295
  /**
3296
+ * @public
2983
3297
  * <p>If the input for <code>PutDashboard</code> was correct and the dashboard was successfully created or modified, this result is empty.</p>
2984
3298
  * <p>If this result includes only warning messages, then the input was valid enough for the dashboard to be
2985
3299
  * created or modified, but some elements of the dashboard
@@ -2993,20 +3307,24 @@ export interface PutDashboardOutput {
2993
3307
  */
2994
3308
  export interface PutInsightRuleInput {
2995
3309
  /**
3310
+ * @public
2996
3311
  * <p>A unique name for the rule.</p>
2997
3312
  */
2998
3313
  RuleName: string | undefined;
2999
3314
  /**
3315
+ * @public
3000
3316
  * <p>The state of the rule. Valid values are ENABLED and DISABLED.</p>
3001
3317
  */
3002
3318
  RuleState?: string;
3003
3319
  /**
3320
+ * @public
3004
3321
  * <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
3005
3322
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
3006
3323
  * Rule Syntax</a>.</p>
3007
3324
  */
3008
3325
  RuleDefinition: string | undefined;
3009
3326
  /**
3327
+ * @public
3010
3328
  * <p>A list of key-value pairs to associate with the Contributor Insights rule.
3011
3329
  * You can associate as many as 50 tags with a rule.</p>
3012
3330
  * <p>Tags can help you organize and categorize your
@@ -3038,6 +3356,7 @@ export interface PutInsightRuleOutput {
3038
3356
  */
3039
3357
  export interface ManagedRule {
3040
3358
  /**
3359
+ * @public
3041
3360
  * <p>
3042
3361
  * The template name
3043
3362
  * for the managed Contributor Insights rule,
@@ -3047,6 +3366,7 @@ export interface ManagedRule {
3047
3366
  */
3048
3367
  TemplateName: string | undefined;
3049
3368
  /**
3369
+ * @public
3050
3370
  * <p>
3051
3371
  * The ARN
3052
3372
  * of an Amazon Web Services resource
@@ -3055,6 +3375,7 @@ export interface ManagedRule {
3055
3375
  */
3056
3376
  ResourceARN: string | undefined;
3057
3377
  /**
3378
+ * @public
3058
3379
  * <p>
3059
3380
  * A list
3060
3381
  * of key-value pairs
@@ -3090,6 +3411,7 @@ export interface ManagedRule {
3090
3411
  */
3091
3412
  export interface PutManagedInsightRulesInput {
3092
3413
  /**
3414
+ * @public
3093
3415
  * <p>
3094
3416
  * A list
3095
3417
  * of <code>ManagedRules</code>
@@ -3103,6 +3425,7 @@ export interface PutManagedInsightRulesInput {
3103
3425
  */
3104
3426
  export interface PutManagedInsightRulesOutput {
3105
3427
  /**
3428
+ * @public
3106
3429
  * <p>
3107
3430
  * An array
3108
3431
  * that lists the rules
@@ -3116,21 +3439,25 @@ export interface PutManagedInsightRulesOutput {
3116
3439
  */
3117
3440
  export interface PutMetricAlarmInput {
3118
3441
  /**
3442
+ * @public
3119
3443
  * <p>The name for the alarm. This name must be unique within the Region.</p>
3120
3444
  * <p>The name must contain only UTF-8
3121
3445
  * characters, and can't contain ASCII control characters</p>
3122
3446
  */
3123
3447
  AlarmName: string | undefined;
3124
3448
  /**
3449
+ * @public
3125
3450
  * <p>The description for the alarm.</p>
3126
3451
  */
3127
3452
  AlarmDescription?: string;
3128
3453
  /**
3454
+ * @public
3129
3455
  * <p>Indicates whether actions should be executed during any changes to the alarm state. The default is
3130
3456
  * <code>TRUE</code>.</p>
3131
3457
  */
3132
3458
  ActionsEnabled?: boolean;
3133
3459
  /**
3460
+ * @public
3134
3461
  * <p>The actions to execute when this alarm transitions to an <code>OK</code> state
3135
3462
  * from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
3136
3463
  * <p>
@@ -3220,6 +3547,7 @@ export interface PutMetricAlarmInput {
3220
3547
  */
3221
3548
  OKActions?: string[];
3222
3549
  /**
3550
+ * @public
3223
3551
  * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
3224
3552
  * Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
3225
3553
  * <p>
@@ -3309,6 +3637,7 @@ export interface PutMetricAlarmInput {
3309
3637
  */
3310
3638
  AlarmActions?: string[];
3311
3639
  /**
3640
+ * @public
3312
3641
  * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
3313
3642
  * Each action is specified as an Amazon Resource Name (ARN). Valid values:</p>
3314
3643
  * <p>
@@ -3398,6 +3727,7 @@ export interface PutMetricAlarmInput {
3398
3727
  */
3399
3728
  InsufficientDataActions?: string[];
3400
3729
  /**
3730
+ * @public
3401
3731
  * <p>The name for the metric associated with the alarm. For each <code>PutMetricAlarm</code>
3402
3732
  * operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
3403
3733
  * <p>If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
@@ -3407,10 +3737,12 @@ export interface PutMetricAlarmInput {
3407
3737
  */
3408
3738
  MetricName?: string;
3409
3739
  /**
3740
+ * @public
3410
3741
  * <p>The namespace for the metric associated specified in <code>MetricName</code>.</p>
3411
3742
  */
3412
3743
  Namespace?: string;
3413
3744
  /**
3745
+ * @public
3414
3746
  * <p>The statistic for the metric specified in <code>MetricName</code>, other than percentile.
3415
3747
  * For percentile statistics, use <code>ExtendedStatistic</code>. When you call <code>PutMetricAlarm</code> and specify
3416
3748
  * a <code>MetricName</code>, you must
@@ -3418,6 +3750,7 @@ export interface PutMetricAlarmInput {
3418
3750
  */
3419
3751
  Statistic?: Statistic | string;
3420
3752
  /**
3753
+ * @public
3421
3754
  * <p>The percentile statistic for the metric specified in <code>MetricName</code>. Specify a value
3422
3755
  * between p0.0 and p100. When you call <code>PutMetricAlarm</code> and specify
3423
3756
  * a <code>MetricName</code>, you must
@@ -3425,10 +3758,12 @@ export interface PutMetricAlarmInput {
3425
3758
  */
3426
3759
  ExtendedStatistic?: string;
3427
3760
  /**
3761
+ * @public
3428
3762
  * <p>The dimensions for the metric specified in <code>MetricName</code>.</p>
3429
3763
  */
3430
3764
  Dimensions?: Dimension[];
3431
3765
  /**
3766
+ * @public
3432
3767
  * <p>The length, in seconds, used each time the metric specified in <code>MetricName</code> is
3433
3768
  * evaluated. Valid values are 10, 30, and any multiple of 60.</p>
3434
3769
  * <p>
@@ -3446,6 +3781,7 @@ export interface PutMetricAlarmInput {
3446
3781
  */
3447
3782
  Period?: number;
3448
3783
  /**
3784
+ * @public
3449
3785
  * <p>The unit of measure for the statistic. For example, the units for the Amazon EC2
3450
3786
  * NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
3451
3787
  * receives on all network interfaces. You can also specify a unit when you create a custom
@@ -3465,6 +3801,7 @@ export interface PutMetricAlarmInput {
3465
3801
  */
3466
3802
  Unit?: StandardUnit | string;
3467
3803
  /**
3804
+ * @public
3468
3805
  * <p>The number of periods over which data is compared to the specified threshold. If you are
3469
3806
  * setting an alarm that requires that a number of consecutive data points be breaching to
3470
3807
  * trigger the alarm, this value specifies that number. If you are setting an "M out of N"
@@ -3474,6 +3811,7 @@ export interface PutMetricAlarmInput {
3474
3811
  */
3475
3812
  EvaluationPeriods: number | undefined;
3476
3813
  /**
3814
+ * @public
3477
3815
  * <p>The number of data points that must be breaching to trigger the alarm. This is used only if you are setting
3478
3816
  * an "M out of N" alarm. In that case, this value is the M. For more information, see
3479
3817
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation">Evaluating an Alarm</a> in the
@@ -3481,12 +3819,14 @@ export interface PutMetricAlarmInput {
3481
3819
  */
3482
3820
  DatapointsToAlarm?: number;
3483
3821
  /**
3822
+ * @public
3484
3823
  * <p>The value against which the specified statistic is compared.</p>
3485
3824
  * <p>This parameter is required for alarms based on static thresholds, but should
3486
3825
  * not be used for alarms based on anomaly detection models.</p>
3487
3826
  */
3488
3827
  Threshold?: number;
3489
3828
  /**
3829
+ * @public
3490
3830
  * <p> The arithmetic operation to use when comparing the specified statistic and
3491
3831
  * threshold. The specified statistic value is used as the first operand.</p>
3492
3832
  * <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
@@ -3495,6 +3835,7 @@ export interface PutMetricAlarmInput {
3495
3835
  */
3496
3836
  ComparisonOperator: ComparisonOperator | string | undefined;
3497
3837
  /**
3838
+ * @public
3498
3839
  * <p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used.
3499
3840
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring How CloudWatch
3500
3841
  * Alarms Treats Missing Data</a>.</p>
@@ -3508,6 +3849,7 @@ export interface PutMetricAlarmInput {
3508
3849
  */
3509
3850
  TreatMissingData?: string;
3510
3851
  /**
3852
+ * @public
3511
3853
  * <p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be
3512
3854
  * statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state
3513
3855
  * no matter how many data points are available. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p>
@@ -3516,6 +3858,7 @@ export interface PutMetricAlarmInput {
3516
3858
  */
3517
3859
  EvaluateLowSampleCountPercentile?: string;
3518
3860
  /**
3861
+ * @public
3519
3862
  * <p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a
3520
3863
  * metric math expression. For each <code>PutMetricAlarm</code>
3521
3864
  * operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
@@ -3529,6 +3872,7 @@ export interface PutMetricAlarmInput {
3529
3872
  */
3530
3873
  Metrics?: MetricDataQuery[];
3531
3874
  /**
3875
+ * @public
3532
3876
  * <p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.</p>
3533
3877
  * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
3534
3878
  * permissions by granting a user
@@ -3540,6 +3884,7 @@ export interface PutMetricAlarmInput {
3540
3884
  */
3541
3885
  Tags?: Tag[];
3542
3886
  /**
3887
+ * @public
3543
3888
  * <p>If this is an alarm based on an anomaly detection model, make this value match
3544
3889
  * the ID of
3545
3890
  * the <code>ANOMALY_DETECTION_BAND</code> function.</p>
@@ -3556,18 +3901,22 @@ export interface PutMetricAlarmInput {
3556
3901
  */
3557
3902
  export interface StatisticSet {
3558
3903
  /**
3904
+ * @public
3559
3905
  * <p>The number of samples used for the statistic set.</p>
3560
3906
  */
3561
3907
  SampleCount: number | undefined;
3562
3908
  /**
3909
+ * @public
3563
3910
  * <p>The sum of values for the sample set.</p>
3564
3911
  */
3565
3912
  Sum: number | undefined;
3566
3913
  /**
3914
+ * @public
3567
3915
  * <p>The minimum value of the sample set.</p>
3568
3916
  */
3569
3917
  Minimum: number | undefined;
3570
3918
  /**
3919
+ * @public
3571
3920
  * <p>The maximum value of the sample set.</p>
3572
3921
  */
3573
3922
  Maximum: number | undefined;
@@ -3579,18 +3928,22 @@ export interface StatisticSet {
3579
3928
  */
3580
3929
  export interface MetricDatum {
3581
3930
  /**
3931
+ * @public
3582
3932
  * <p>The name of the metric.</p>
3583
3933
  */
3584
3934
  MetricName: string | undefined;
3585
3935
  /**
3936
+ * @public
3586
3937
  * <p>The dimensions associated with the metric. </p>
3587
3938
  */
3588
3939
  Dimensions?: Dimension[];
3589
3940
  /**
3941
+ * @public
3590
3942
  * <p>The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
3591
3943
  */
3592
3944
  Timestamp?: Date;
3593
3945
  /**
3946
+ * @public
3594
3947
  * <p>The value for the metric.</p>
3595
3948
  * <p>Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or
3596
3949
  * too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)
@@ -3598,10 +3951,12 @@ export interface MetricDatum {
3598
3951
  */
3599
3952
  Value?: number;
3600
3953
  /**
3954
+ * @public
3601
3955
  * <p>The statistical values for the metric.</p>
3602
3956
  */
3603
3957
  StatisticValues?: StatisticSet;
3604
3958
  /**
3959
+ * @public
3605
3960
  * <p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once
3606
3961
  * in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period.
3607
3962
  * You can include up to 150 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p>
@@ -3612,6 +3967,7 @@ export interface MetricDatum {
3612
3967
  */
3613
3968
  Values?: number[];
3614
3969
  /**
3970
+ * @public
3615
3971
  * <p>Array of numbers that is used along with the <code>Values</code> array. Each number in the <code>Count</code> array
3616
3972
  * is the number of times the corresponding value in the <code>Values</code> array occurred during the period. </p>
3617
3973
  * <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for each count. If you
@@ -3619,12 +3975,14 @@ export interface MetricDatum {
3619
3975
  */
3620
3976
  Counts?: number[];
3621
3977
  /**
3978
+ * @public
3622
3979
  * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
3623
3980
  * <p>In
3624
3981
  * a <code>Get</code> operation, this displays the unit that is used for the metric.</p>
3625
3982
  */
3626
3983
  Unit?: StandardUnit | string;
3627
3984
  /**
3985
+ * @public
3628
3986
  * <p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with
3629
3987
  * sub-minute resolution down to one second.
3630
3988
  * Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available
@@ -3641,6 +3999,7 @@ export interface MetricDatum {
3641
3999
  */
3642
4000
  export interface PutMetricDataInput {
3643
4001
  /**
4002
+ * @public
3644
4003
  * <p>The namespace for the metric data. You can use ASCII characters for the namespace, except for
3645
4004
  * control characters which are not supported.</p>
3646
4005
  * <p>To avoid conflicts
@@ -3649,6 +4008,7 @@ export interface PutMetricDataInput {
3649
4008
  */
3650
4009
  Namespace: string | undefined;
3651
4010
  /**
4011
+ * @public
3652
4012
  * <p>The data for the metric. The array can include no more than 1000 metrics per call.</p>
3653
4013
  */
3654
4014
  MetricData: MetricDatum[] | undefined;
@@ -3658,6 +4018,7 @@ export interface PutMetricDataInput {
3658
4018
  */
3659
4019
  export interface PutMetricStreamInput {
3660
4020
  /**
4021
+ * @public
3661
4022
  * <p>If you are creating a new metric stream, this is the name for the new stream. The name
3662
4023
  * must be different than the names of other metric streams in this account and Region.</p>
3663
4024
  * <p>If you are updating a metric stream, specify the name of that stream here.</p>
@@ -3665,6 +4026,7 @@ export interface PutMetricStreamInput {
3665
4026
  */
3666
4027
  Name: string | undefined;
3667
4028
  /**
4029
+ * @public
3668
4030
  * <p>If you specify this parameter, the stream sends only the
3669
4031
  * metrics from the metric namespaces that you specify here.</p>
3670
4032
  * <p>You cannot include <code>IncludeFilters</code> and <code>ExcludeFilters</code>
@@ -3672,6 +4034,7 @@ export interface PutMetricStreamInput {
3672
4034
  */
3673
4035
  IncludeFilters?: MetricStreamFilter[];
3674
4036
  /**
4037
+ * @public
3675
4038
  * <p>If you specify this parameter, the stream sends metrics from all
3676
4039
  * metric namespaces except for the namespaces that you specify here.</p>
3677
4040
  * <p>You cannot include <code>ExcludeFilters</code> and <code>IncludeFilters</code> in
@@ -3679,12 +4042,14 @@ export interface PutMetricStreamInput {
3679
4042
  */
3680
4043
  ExcludeFilters?: MetricStreamFilter[];
3681
4044
  /**
4045
+ * @public
3682
4046
  * <p>The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.
3683
4047
  * This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the
3684
4048
  * same account as the metric stream.</p>
3685
4049
  */
3686
4050
  FirehoseArn: string | undefined;
3687
4051
  /**
4052
+ * @public
3688
4053
  * <p>The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data
3689
4054
  * Firehose resources. This IAM role must already exist and must be in the same account as
3690
4055
  * the metric stream. This IAM role must include the following permissions:</p>
@@ -3699,6 +4064,7 @@ export interface PutMetricStreamInput {
3699
4064
  */
3700
4065
  RoleArn: string | undefined;
3701
4066
  /**
4067
+ * @public
3702
4068
  * <p>The output format for the stream. Valid values are <code>json</code>
3703
4069
  * and <code>opentelemetry0.7</code>. For more information about metric stream
3704
4070
  * output formats, see
@@ -3707,6 +4073,7 @@ export interface PutMetricStreamInput {
3707
4073
  */
3708
4074
  OutputFormat: MetricStreamOutputFormat | string | undefined;
3709
4075
  /**
4076
+ * @public
3710
4077
  * <p>A list of key-value pairs to associate with the metric stream. You can associate as
3711
4078
  * many as 50 tags with a metric stream.</p>
3712
4079
  * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
@@ -3719,6 +4086,7 @@ export interface PutMetricStreamInput {
3719
4086
  */
3720
4087
  Tags?: Tag[];
3721
4088
  /**
4089
+ * @public
3722
4090
  * <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
3723
4091
  * and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use this parameter to have
3724
4092
  * the metric stream also send additional statistics in the stream. This
@@ -3734,6 +4102,7 @@ export interface PutMetricStreamInput {
3734
4102
  */
3735
4103
  StatisticsConfigurations?: MetricStreamStatisticsConfiguration[];
3736
4104
  /**
4105
+ * @public
3737
4106
  * <p>If you are creating a metric stream in a monitoring account,
3738
4107
  * specify <code>true</code> to include metrics from source accounts in the metric stream.</p>
3739
4108
  */
@@ -3744,6 +4113,7 @@ export interface PutMetricStreamInput {
3744
4113
  */
3745
4114
  export interface PutMetricStreamOutput {
3746
4115
  /**
4116
+ * @public
3747
4117
  * <p>The ARN of the metric stream.</p>
3748
4118
  */
3749
4119
  Arn?: string;
@@ -3765,18 +4135,22 @@ export declare class InvalidFormatFault extends __BaseException {
3765
4135
  */
3766
4136
  export interface SetAlarmStateInput {
3767
4137
  /**
4138
+ * @public
3768
4139
  * <p>The name of the alarm.</p>
3769
4140
  */
3770
4141
  AlarmName: string | undefined;
3771
4142
  /**
4143
+ * @public
3772
4144
  * <p>The value of the state.</p>
3773
4145
  */
3774
4146
  StateValue: StateValue | string | undefined;
3775
4147
  /**
4148
+ * @public
3776
4149
  * <p>The reason that this alarm is set to this specific state, in text format.</p>
3777
4150
  */
3778
4151
  StateReason: string | undefined;
3779
4152
  /**
4153
+ * @public
3780
4154
  * <p>The reason that this alarm is set to this specific state, in JSON format.</p>
3781
4155
  * <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling
3782
4156
  * alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.</p>
@@ -3788,6 +4162,7 @@ export interface SetAlarmStateInput {
3788
4162
  */
3789
4163
  export interface StartMetricStreamsInput {
3790
4164
  /**
4165
+ * @public
3791
4166
  * <p>The array of the names of metric streams to start streaming.</p>
3792
4167
  * <p>This is an "all or nothing" operation. If you do not have
3793
4168
  * permission to access all of the metric streams that you list here, then none of the streams that you list
@@ -3805,6 +4180,7 @@ export interface StartMetricStreamsOutput {
3805
4180
  */
3806
4181
  export interface StopMetricStreamsInput {
3807
4182
  /**
4183
+ * @public
3808
4184
  * <p>The array of the names of metric streams to stop streaming.</p>
3809
4185
  * <p>This is an "all or nothing" operation. If you do not have
3810
4186
  * permission to access all of the metric streams that you list here, then none of the streams that you list
@@ -3822,6 +4198,7 @@ export interface StopMetricStreamsOutput {
3822
4198
  */
3823
4199
  export interface TagResourceInput {
3824
4200
  /**
4201
+ * @public
3825
4202
  * <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
3826
4203
  * <p>The ARN format of an alarm is
3827
4204
  * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
@@ -3837,6 +4214,7 @@ export interface TagResourceInput {
3837
4214
  */
3838
4215
  ResourceARN: string | undefined;
3839
4216
  /**
4217
+ * @public
3840
4218
  * <p>The list of key-value pairs to associate with the alarm.</p>
3841
4219
  */
3842
4220
  Tags: Tag[] | undefined;
@@ -3851,6 +4229,7 @@ export interface TagResourceOutput {
3851
4229
  */
3852
4230
  export interface UntagResourceInput {
3853
4231
  /**
4232
+ * @public
3854
4233
  * <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
3855
4234
  * <p>The ARN format of an alarm is
3856
4235
  * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
@@ -3866,6 +4245,7 @@ export interface UntagResourceInput {
3866
4245
  */
3867
4246
  ResourceARN: string | undefined;
3868
4247
  /**
4248
+ * @public
3869
4249
  * <p>The list of tag keys to remove from the resource.</p>
3870
4250
  */
3871
4251
  TagKeys: string[] | undefined;