@aws-sdk/client-devops-guru 3.379.1 → 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.
@@ -23,11 +23,13 @@ export declare class AccessDeniedException extends __BaseException {
23
23
  */
24
24
  export interface AccountInsightHealth {
25
25
  /**
26
+ * @public
26
27
  * <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
27
28
  * account.</p>
28
29
  */
29
30
  OpenProactiveInsights?: number;
30
31
  /**
32
+ * @public
31
33
  * <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
32
34
  * account.</p>
33
35
  */
@@ -41,10 +43,12 @@ export interface AccountInsightHealth {
41
43
  */
42
44
  export interface AccountHealth {
43
45
  /**
46
+ * @public
44
47
  * <p>The ID of the Amazon Web Services account. </p>
45
48
  */
46
49
  AccountId?: string;
47
50
  /**
51
+ * @public
48
52
  * <p> Information about the health of the Amazon Web Services resources in your account, including the
49
53
  * number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
50
54
  * </p>
@@ -88,6 +92,7 @@ export type InsightSeverity = (typeof InsightSeverity)[keyof typeof InsightSever
88
92
  */
89
93
  export interface NotificationFilterConfig {
90
94
  /**
95
+ * @public
91
96
  * <p>
92
97
  * The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with <code>HIGH</code> and <code>MEDIUM</code> severity levels.
93
98
  * For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a>.
@@ -95,6 +100,7 @@ export interface NotificationFilterConfig {
95
100
  */
96
101
  Severities?: (InsightSeverity | string)[];
97
102
  /**
103
+ * @public
98
104
  * <p>
99
105
  * The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.
100
106
  * </p>
@@ -114,6 +120,7 @@ export interface NotificationFilterConfig {
114
120
  */
115
121
  export interface SnsChannelConfig {
116
122
  /**
123
+ * @public
117
124
  * <p> The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p>
118
125
  */
119
126
  TopicArn?: string;
@@ -126,6 +133,7 @@ export interface SnsChannelConfig {
126
133
  */
127
134
  export interface NotificationChannelConfig {
128
135
  /**
136
+ * @public
129
137
  * <p> Information about a notification channel configured in DevOps Guru to send notifications
130
138
  * when insights are created. </p>
131
139
  * <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
@@ -138,6 +146,7 @@ export interface NotificationChannelConfig {
138
146
  */
139
147
  Sns: SnsChannelConfig | undefined;
140
148
  /**
149
+ * @public
141
150
  * <p>
142
151
  * The filter configurations for the Amazon SNS notification topic you use with DevOps Guru.
143
152
  * If you do not provide filter configurations, the default configurations are to receive notifications for all message types of <code>High</code> or <code>Medium</code> severity.
@@ -150,6 +159,7 @@ export interface NotificationChannelConfig {
150
159
  */
151
160
  export interface AddNotificationChannelRequest {
152
161
  /**
162
+ * @public
153
163
  * <p> A <code>NotificationChannelConfig</code> object that specifies what type of
154
164
  * notification channel to add. The one
155
165
  * supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>
@@ -161,6 +171,7 @@ export interface AddNotificationChannelRequest {
161
171
  */
162
172
  export interface AddNotificationChannelResponse {
163
173
  /**
174
+ * @public
164
175
  * <p> The ID of the added notification channel. </p>
165
176
  */
166
177
  Id: string | undefined;
@@ -174,10 +185,12 @@ export declare class ConflictException extends __BaseException {
174
185
  readonly $fault: "client";
175
186
  Message: string | undefined;
176
187
  /**
188
+ * @public
177
189
  * <p> The ID of the Amazon Web Services resource in which a conflict occurred. </p>
178
190
  */
179
191
  ResourceId: string | undefined;
180
192
  /**
193
+ * @public
181
194
  * <p> The type of the Amazon Web Services resource in which a conflict occurred. </p>
182
195
  */
183
196
  ResourceType: string | undefined;
@@ -195,6 +208,7 @@ export declare class InternalServerException extends __BaseException {
195
208
  readonly $fault: "server";
196
209
  Message: string | undefined;
197
210
  /**
211
+ * @public
198
212
  * <p> The number of seconds after which the action that caused the internal server
199
213
  * exception can be retried. </p>
200
214
  */
@@ -213,10 +227,12 @@ export declare class ResourceNotFoundException extends __BaseException {
213
227
  readonly $fault: "client";
214
228
  Message: string | undefined;
215
229
  /**
230
+ * @public
216
231
  * <p> The ID of the Amazon Web Services resource that could not be found. </p>
217
232
  */
218
233
  ResourceId: string | undefined;
219
234
  /**
235
+ * @public
220
236
  * <p> The type of the Amazon Web Services resource that could not be found. </p>
221
237
  */
222
238
  ResourceType: string | undefined;
@@ -247,14 +263,17 @@ export declare class ThrottlingException extends __BaseException {
247
263
  readonly $fault: "client";
248
264
  Message: string | undefined;
249
265
  /**
266
+ * @public
250
267
  * <p> The code of the quota that was exceeded, causing the throttling exception. </p>
251
268
  */
252
269
  QuotaCode?: string;
253
270
  /**
271
+ * @public
254
272
  * <p> The code of the service that caused the throttling exception. </p>
255
273
  */
256
274
  ServiceCode?: string;
257
275
  /**
276
+ * @public
258
277
  * <p> The number of seconds after which the action that caused the throttling exception can
259
278
  * be retried. </p>
260
279
  */
@@ -270,10 +289,12 @@ export declare class ThrottlingException extends __BaseException {
270
289
  */
271
290
  export interface ValidationExceptionField {
272
291
  /**
292
+ * @public
273
293
  * <p> The name of the field. </p>
274
294
  */
275
295
  Name: string | undefined;
276
296
  /**
297
+ * @public
277
298
  * <p> The message associated with the validation exception with information to help
278
299
  * determine its cause. </p>
279
300
  */
@@ -304,14 +325,17 @@ export declare class ValidationException extends __BaseException {
304
325
  readonly name: "ValidationException";
305
326
  readonly $fault: "client";
306
327
  /**
328
+ * @public
307
329
  * <p> A message that describes the validation exception. </p>
308
330
  */
309
331
  Message: string | undefined;
310
332
  /**
333
+ * @public
311
334
  * <p> The reason the validation exception was thrown. </p>
312
335
  */
313
336
  Reason?: ValidationExceptionReason | string;
314
337
  /**
338
+ * @public
315
339
  * <p> An array of fields that are associated with the validation exception. </p>
316
340
  */
317
341
  Fields?: ValidationExceptionField[];
@@ -340,6 +364,7 @@ export type EventSourceOptInStatus = (typeof EventSourceOptInStatus)[keyof typeo
340
364
  */
341
365
  export interface AmazonCodeGuruProfilerIntegration {
342
366
  /**
367
+ * @public
343
368
  * <p>The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to
344
369
  * consume recommendations that are generated from Amazon CodeGuru Profiler.</p>
345
370
  */
@@ -371,42 +396,49 @@ export type LogAnomalyType = (typeof LogAnomalyType)[keyof typeof LogAnomalyType
371
396
  */
372
397
  export interface LogAnomalyClass {
373
398
  /**
399
+ * @public
374
400
  * <p>
375
401
  * The name of the Amazon CloudWatch log stream that the anomalous log event belongs to. A log stream is a sequence of log events that share the same source.
376
402
  * </p>
377
403
  */
378
404
  LogStreamName?: string;
379
405
  /**
406
+ * @public
380
407
  * <p>
381
408
  * The type of log anomaly that has been detected.
382
409
  * </p>
383
410
  */
384
411
  LogAnomalyType?: LogAnomalyType | string;
385
412
  /**
413
+ * @public
386
414
  * <p>
387
415
  * The token where the anomaly was detected. This may refer to an exception or another location, or it may be blank for log anomalies such as format anomalies.
388
416
  * </p>
389
417
  */
390
418
  LogAnomalyToken?: string;
391
419
  /**
420
+ * @public
392
421
  * <p>
393
422
  * The ID of the log event.
394
423
  * </p>
395
424
  */
396
425
  LogEventId?: string;
397
426
  /**
427
+ * @public
398
428
  * <p>
399
429
  * The explanation for why the log event is considered an anomaly.
400
430
  * </p>
401
431
  */
402
432
  Explanation?: string;
403
433
  /**
434
+ * @public
404
435
  * <p>
405
436
  * The number of log lines where this anomalous log event occurs.
406
437
  * </p>
407
438
  */
408
439
  NumberOfLogLinesOccurrences?: number;
409
440
  /**
441
+ * @public
410
442
  * <p>
411
443
  * The time of the first occurrence of the anomalous log event.
412
444
  * </p>
@@ -421,6 +453,7 @@ export interface LogAnomalyClass {
421
453
  */
422
454
  export interface LogAnomalyShowcase {
423
455
  /**
456
+ * @public
424
457
  * <p>
425
458
  * A list of anomalous log events that may be related.
426
459
  * </p>
@@ -435,30 +468,35 @@ export interface LogAnomalyShowcase {
435
468
  */
436
469
  export interface AnomalousLogGroup {
437
470
  /**
471
+ * @public
438
472
  * <p>
439
473
  * The name of the CloudWatch log group.
440
474
  * </p>
441
475
  */
442
476
  LogGroupName?: string;
443
477
  /**
478
+ * @public
444
479
  * <p>
445
480
  * The time the anomalous log events began. The impact start time indicates the time of the first log anomaly event that occurs.
446
481
  * </p>
447
482
  */
448
483
  ImpactStartTime?: Date;
449
484
  /**
485
+ * @public
450
486
  * <p>
451
487
  * The time the anomalous log events stopped.
452
488
  * </p>
453
489
  */
454
490
  ImpactEndTime?: Date;
455
491
  /**
492
+ * @public
456
493
  * <p>
457
494
  * The number of log lines that were scanned for anomalous log events.
458
495
  * </p>
459
496
  */
460
497
  NumberOfLogLinesScanned?: number;
461
498
  /**
499
+ * @public
462
500
  * <p>
463
501
  * The log anomalies in the log group. Each log anomaly displayed represents a cluster of similar anomalous log events.
464
502
  * </p>
@@ -473,10 +511,12 @@ export interface AnomalousLogGroup {
473
511
  */
474
512
  export interface AnomalyReportedTimeRange {
475
513
  /**
514
+ * @public
476
515
  * <p> The time when an anomaly is opened. </p>
477
516
  */
478
517
  OpenTime: Date | undefined;
479
518
  /**
519
+ * @public
480
520
  * <p> The time when an anomaly is closed. </p>
481
521
  */
482
522
  CloseTime?: Date;
@@ -490,10 +530,12 @@ export interface AnomalyReportedTimeRange {
490
530
  */
491
531
  export interface AnomalyResource {
492
532
  /**
533
+ * @public
493
534
  * <p>The name of the Amazon Web Services resource.</p>
494
535
  */
495
536
  Name?: string;
496
537
  /**
538
+ * @public
497
539
  * <p>The type of the Amazon Web Services resource.</p>
498
540
  */
499
541
  Type?: string;
@@ -520,10 +562,12 @@ export type AnomalySeverity = (typeof AnomalySeverity)[keyof typeof AnomalySever
520
562
  */
521
563
  export interface CloudWatchMetricsDimension {
522
564
  /**
565
+ * @public
523
566
  * <p> The name of the CloudWatch dimension. </p>
524
567
  */
525
568
  Name?: string;
526
569
  /**
570
+ * @public
527
571
  * <p> The value of the CloudWatch dimension. </p>
528
572
  */
529
573
  Value?: string;
@@ -547,10 +591,12 @@ export type CloudWatchMetricDataStatusCode = (typeof CloudWatchMetricDataStatusC
547
591
  */
548
592
  export interface TimestampMetricValuePair {
549
593
  /**
594
+ * @public
550
595
  * <p>A <code>Timestamp</code> that specifies the time the event occurred. </p>
551
596
  */
552
597
  Timestamp?: Date;
553
598
  /**
599
+ * @public
554
600
  * <p>Value of the anomalous metric data point at respective Timestamp.</p>
555
601
  */
556
602
  MetricValue?: number;
@@ -562,10 +608,12 @@ export interface TimestampMetricValuePair {
562
608
  */
563
609
  export interface CloudWatchMetricsDataSummary {
564
610
  /**
611
+ * @public
565
612
  * <p>This is a list of Amazon CloudWatch metric values at given timestamp.</p>
566
613
  */
567
614
  TimestampMetricValuePairList?: TimestampMetricValuePair[];
568
615
  /**
616
+ * @public
569
617
  * <p>This is an enum of the status showing whether the metric value pair list has partial
570
618
  * or complete data, or if there was an error.</p>
571
619
  */
@@ -595,33 +643,40 @@ export type CloudWatchMetricsStat = (typeof CloudWatchMetricsStat)[keyof typeof
595
643
  */
596
644
  export interface CloudWatchMetricsDetail {
597
645
  /**
646
+ * @public
598
647
  * <p> The name of the CloudWatch metric. </p>
599
648
  */
600
649
  MetricName?: string;
601
650
  /**
651
+ * @public
602
652
  * <p> The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
603
653
  * </p>
604
654
  */
605
655
  Namespace?: string;
606
656
  /**
657
+ * @public
607
658
  * <p> An array of CloudWatch dimensions associated with </p>
608
659
  */
609
660
  Dimensions?: CloudWatchMetricsDimension[];
610
661
  /**
662
+ * @public
611
663
  * <p> The type of statistic associated with the CloudWatch metric. For more information, see
612
664
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
613
665
  */
614
666
  Stat?: CloudWatchMetricsStat | string;
615
667
  /**
668
+ * @public
616
669
  * <p> The unit of measure used for the CloudWatch metric. For example, <code>Bytes</code>,
617
670
  * <code>Seconds</code>, <code>Count</code>, and <code>Percent</code>. </p>
618
671
  */
619
672
  Unit?: string;
620
673
  /**
674
+ * @public
621
675
  * <p> The length of time associated with the CloudWatch metric in number of seconds. </p>
622
676
  */
623
677
  Period?: number;
624
678
  /**
679
+ * @public
625
680
  * <p>This object returns anomaly metric data.</p>
626
681
  */
627
682
  MetricDataSummary?: CloudWatchMetricsDataSummary;
@@ -656,6 +711,7 @@ export interface CloudWatchMetricsDetail {
656
711
  */
657
712
  export interface PerformanceInsightsMetricDimensionGroup {
658
713
  /**
714
+ * @public
659
715
  * <p>The name of the dimension group. Its valid values are:</p>
660
716
  * <ul>
661
717
  * <li>
@@ -704,6 +760,7 @@ export interface PerformanceInsightsMetricDimensionGroup {
704
760
  */
705
761
  Group?: string;
706
762
  /**
763
+ * @public
707
764
  * <p>A list of specific dimensions from a dimension group. If this parameter is not
708
765
  * present, then it signifies that all of the dimensions in the group were requested or are
709
766
  * present in the response.</p>
@@ -797,6 +854,7 @@ export interface PerformanceInsightsMetricDimensionGroup {
797
854
  */
798
855
  Dimensions?: string[];
799
856
  /**
857
+ * @public
800
858
  * <p>The maximum number of items to fetch for this dimension group.</p>
801
859
  */
802
860
  Limit?: number;
@@ -829,6 +887,7 @@ export interface PerformanceInsightsMetricDimensionGroup {
829
887
  */
830
888
  export interface PerformanceInsightsMetricQuery {
831
889
  /**
890
+ * @public
832
891
  * <p>The name of the meteric used used when querying an Performance Insights
833
892
  * <code>GetResourceMetrics</code> API for anomaly metrics.</p>
834
893
  * <p>Valid values for <code>Metric</code> are:</p>
@@ -854,6 +913,7 @@ export interface PerformanceInsightsMetricQuery {
854
913
  */
855
914
  Metric?: string;
856
915
  /**
916
+ * @public
857
917
  * <p>The specification for how to aggregate the data points from a Performance Insights
858
918
  * <code>GetResourceMetrics</code> API query. The Performance Insights query returns all of the
859
919
  * dimensions within that group, unless you provide the names of specific dimensions within
@@ -862,6 +922,7 @@ export interface PerformanceInsightsMetricQuery {
862
922
  */
863
923
  GroupBy?: PerformanceInsightsMetricDimensionGroup;
864
924
  /**
925
+ * @public
865
926
  * <p>One or more filters to apply to a Performance Insights <code>GetResourceMetrics</code> API query.
866
927
  * Restrictions:</p>
867
928
  * <ul>
@@ -882,6 +943,7 @@ export interface PerformanceInsightsMetricQuery {
882
943
  */
883
944
  export interface PerformanceInsightsReferenceMetric {
884
945
  /**
946
+ * @public
885
947
  * <p>A query to be processed on the metric.</p>
886
948
  */
887
949
  MetricQuery?: PerformanceInsightsMetricQuery;
@@ -893,6 +955,7 @@ export interface PerformanceInsightsReferenceMetric {
893
955
  */
894
956
  export interface PerformanceInsightsReferenceScalar {
895
957
  /**
958
+ * @public
896
959
  * <p>The reference value.</p>
897
960
  */
898
961
  Value?: number;
@@ -906,12 +969,14 @@ export interface PerformanceInsightsReferenceScalar {
906
969
  */
907
970
  export interface PerformanceInsightsReferenceComparisonValues {
908
971
  /**
972
+ * @public
909
973
  * <p>A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This
910
974
  * reference value is used to determine if an actual metric value should be considered
911
975
  * anomalous.</p>
912
976
  */
913
977
  ReferenceScalar?: PerformanceInsightsReferenceScalar;
914
978
  /**
979
+ * @public
915
980
  * <p>A metric that DevOps Guru compares to actual metric values. This reference metric is used to
916
981
  * determine if an actual metric should be considered anomalous.</p>
917
982
  */
@@ -924,10 +989,12 @@ export interface PerformanceInsightsReferenceComparisonValues {
924
989
  */
925
990
  export interface PerformanceInsightsReferenceData {
926
991
  /**
992
+ * @public
927
993
  * <p>The name of the reference data.</p>
928
994
  */
929
995
  Name?: string;
930
996
  /**
997
+ * @public
931
998
  * <p>The specific reference values used to evaluate the Performance Insights. For more information, see
932
999
  * <code>
933
1000
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html">PerformanceInsightsReferenceComparisonValues</a>
@@ -941,10 +1008,12 @@ export interface PerformanceInsightsReferenceData {
941
1008
  */
942
1009
  export interface PerformanceInsightsStat {
943
1010
  /**
1011
+ * @public
944
1012
  * <p>The statistic type.</p>
945
1013
  */
946
1014
  Type?: string;
947
1015
  /**
1016
+ * @public
948
1017
  * <p>The value of the statistic.</p>
949
1018
  */
950
1019
  Value?: number;
@@ -972,30 +1041,36 @@ export interface PerformanceInsightsStat {
972
1041
  */
973
1042
  export interface PerformanceInsightsMetricsDetail {
974
1043
  /**
1044
+ * @public
975
1045
  * <p>The name used for a specific Performance Insights metric.</p>
976
1046
  */
977
1047
  MetricDisplayName?: string;
978
1048
  /**
1049
+ * @public
979
1050
  * <p>The unit of measure for a metric. For example, a session or a process.</p>
980
1051
  */
981
1052
  Unit?: string;
982
1053
  /**
1054
+ * @public
983
1055
  * <p>A single query to be processed for the metric. For more information, see <code>
984
1056
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsMetricQuery.html">PerformanceInsightsMetricQuery</a>
985
1057
  * </code>.</p>
986
1058
  */
987
1059
  MetricQuery?: PerformanceInsightsMetricQuery;
988
1060
  /**
1061
+ * @public
989
1062
  * <p> For more information, see <code>
990
1063
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceData.html">PerformanceInsightsReferenceData</a>
991
1064
  * </code>. </p>
992
1065
  */
993
1066
  ReferenceData?: PerformanceInsightsReferenceData[];
994
1067
  /**
1068
+ * @public
995
1069
  * <p>The metric statistics during the anomalous period detected by DevOps Guru;</p>
996
1070
  */
997
1071
  StatsAtAnomaly?: PerformanceInsightsStat[];
998
1072
  /**
1073
+ * @public
999
1074
  * <p>Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes
1000
1075
  * metrics, it compares them to <code>StatsAtBaseline</code> to help determine if they are
1001
1076
  * anomalous.</p>
@@ -1009,11 +1084,13 @@ export interface PerformanceInsightsMetricsDetail {
1009
1084
  */
1010
1085
  export interface AnomalySourceDetails {
1011
1086
  /**
1087
+ * @public
1012
1088
  * <p>An array of <code>CloudWatchMetricsDetail</code> objects that contain information
1013
1089
  * about analyzed CloudWatch metrics that show anomalous behavior. </p>
1014
1090
  */
1015
1091
  CloudWatchMetrics?: CloudWatchMetricsDetail[];
1016
1092
  /**
1093
+ * @public
1017
1094
  * <p>An array of <code>PerformanceInsightsMetricsDetail</code> objects that contain
1018
1095
  * information about analyzed Performance Insights metrics that show anomalous behavior.</p>
1019
1096
  */
@@ -1027,14 +1104,17 @@ export interface AnomalySourceDetails {
1027
1104
  */
1028
1105
  export interface AnomalySourceMetadata {
1029
1106
  /**
1107
+ * @public
1030
1108
  * <p>The source of the anomaly.</p>
1031
1109
  */
1032
1110
  Source?: string;
1033
1111
  /**
1112
+ * @public
1034
1113
  * <p>The name of the anomaly's resource.</p>
1035
1114
  */
1036
1115
  SourceResourceName?: string;
1037
1116
  /**
1117
+ * @public
1038
1118
  * <p>The anomaly's resource type.</p>
1039
1119
  */
1040
1120
  SourceResourceType?: string;
@@ -1059,10 +1139,12 @@ export type AnomalyStatus = (typeof AnomalyStatus)[keyof typeof AnomalyStatus];
1059
1139
  */
1060
1140
  export interface AnomalyTimeRange {
1061
1141
  /**
1142
+ * @public
1062
1143
  * <p> The time when the anomalous behavior started. </p>
1063
1144
  */
1064
1145
  StartTime: Date | undefined;
1065
1146
  /**
1147
+ * @public
1066
1148
  * <p> The time when the anomalous behavior ended. </p>
1067
1149
  */
1068
1150
  EndTime?: Date;
@@ -1084,6 +1166,7 @@ export type AnomalyType = (typeof AnomalyType)[keyof typeof AnomalyType];
1084
1166
  */
1085
1167
  export interface DeleteInsightRequest {
1086
1168
  /**
1169
+ * @public
1087
1170
  * <p>The ID of the insight.</p>
1088
1171
  */
1089
1172
  Id: string | undefined;
@@ -1103,26 +1186,31 @@ export interface DescribeAccountHealthRequest {
1103
1186
  */
1104
1187
  export interface DescribeAccountHealthResponse {
1105
1188
  /**
1189
+ * @public
1106
1190
  * <p> An integer that specifies the number of open reactive insights in your Amazon Web Services account.
1107
1191
  * </p>
1108
1192
  */
1109
1193
  OpenReactiveInsights: number | undefined;
1110
1194
  /**
1195
+ * @public
1111
1196
  * <p> An integer that specifies the number of open proactive insights in your Amazon Web Services
1112
1197
  * account. </p>
1113
1198
  */
1114
1199
  OpenProactiveInsights: number | undefined;
1115
1200
  /**
1201
+ * @public
1116
1202
  * <p> An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services
1117
1203
  * account. </p>
1118
1204
  */
1119
1205
  MetricsAnalyzed: number | undefined;
1120
1206
  /**
1207
+ * @public
1121
1208
  * <p>The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in
1122
1209
  * the last hour. </p>
1123
1210
  */
1124
1211
  ResourceHours: number | undefined;
1125
1212
  /**
1213
+ * @public
1126
1214
  * <p>
1127
1215
  * Number of resources that DevOps Guru is monitoring in your Amazon Web Services account.
1128
1216
  * </p>
@@ -1134,12 +1222,14 @@ export interface DescribeAccountHealthResponse {
1134
1222
  */
1135
1223
  export interface DescribeAccountOverviewRequest {
1136
1224
  /**
1225
+ * @public
1137
1226
  * <p> The start of the time range passed in. The start time granularity is at the day
1138
1227
  * level. The floor of the start time is used. Returned information occurred after this
1139
1228
  * day. </p>
1140
1229
  */
1141
1230
  FromTime: Date | undefined;
1142
1231
  /**
1232
+ * @public
1143
1233
  * <p> The end of the time range passed in. The start time granularity is at the day level.
1144
1234
  * The floor of the start time is used. Returned information occurred before this day. If
1145
1235
  * this is not specified, then the current day is used. </p>
@@ -1151,16 +1241,19 @@ export interface DescribeAccountOverviewRequest {
1151
1241
  */
1152
1242
  export interface DescribeAccountOverviewResponse {
1153
1243
  /**
1244
+ * @public
1154
1245
  * <p> An integer that specifies the number of open reactive insights in your Amazon Web Services account
1155
1246
  * that were created during the time range passed in. </p>
1156
1247
  */
1157
1248
  ReactiveInsights: number | undefined;
1158
1249
  /**
1250
+ * @public
1159
1251
  * <p> An integer that specifies the number of open proactive insights in your Amazon Web Services account
1160
1252
  * that were created during the time range passed in. </p>
1161
1253
  */
1162
1254
  ProactiveInsights: number | undefined;
1163
1255
  /**
1256
+ * @public
1164
1257
  * <p> The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.
1165
1258
  * </p>
1166
1259
  */
@@ -1171,10 +1264,12 @@ export interface DescribeAccountOverviewResponse {
1171
1264
  */
1172
1265
  export interface DescribeAnomalyRequest {
1173
1266
  /**
1267
+ * @public
1174
1268
  * <p> The ID of the anomaly. </p>
1175
1269
  */
1176
1270
  Id: string | undefined;
1177
1271
  /**
1272
+ * @public
1178
1273
  * <p>The ID of the member account.</p>
1179
1274
  */
1180
1275
  AccountId?: string;
@@ -1186,11 +1281,13 @@ export interface DescribeAnomalyRequest {
1186
1281
  */
1187
1282
  export interface PredictionTimeRange {
1188
1283
  /**
1284
+ * @public
1189
1285
  * <p> The time range during which a metric limit is expected to be exceeded. This applies
1190
1286
  * to proactive insights only. </p>
1191
1287
  */
1192
1288
  StartTime: Date | undefined;
1193
1289
  /**
1290
+ * @public
1194
1291
  * <p> The time when the behavior in a proactive insight is expected to end. </p>
1195
1292
  */
1196
1293
  EndTime?: Date;
@@ -1204,6 +1301,7 @@ export interface PredictionTimeRange {
1204
1301
  */
1205
1302
  export interface CloudFormationCollection {
1206
1303
  /**
1304
+ * @public
1207
1305
  * <p> An array of CloudFormation stack names. </p>
1208
1306
  */
1209
1307
  StackNames?: string[];
@@ -1247,6 +1345,7 @@ export interface CloudFormationCollection {
1247
1345
  */
1248
1346
  export interface TagCollection {
1249
1347
  /**
1348
+ * @public
1250
1349
  * <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
1251
1350
  * DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
1252
1351
  * up your DevOps Guru application and analysis boundary.</p>
@@ -1264,6 +1363,7 @@ export interface TagCollection {
1264
1363
  */
1265
1364
  AppBoundaryKey: string | undefined;
1266
1365
  /**
1366
+ * @public
1267
1367
  * <p>The values in an Amazon Web Services tag collection.</p>
1268
1368
  * <p>The tag's <i>value</i> is an optional field used to associate a string with
1269
1369
  * the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
@@ -1283,11 +1383,13 @@ export interface TagCollection {
1283
1383
  */
1284
1384
  export interface ResourceCollection {
1285
1385
  /**
1386
+ * @public
1286
1387
  * <p> An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that
1287
1388
  * DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
1288
1389
  */
1289
1390
  CloudFormation?: CloudFormationCollection;
1290
1391
  /**
1392
+ * @public
1291
1393
  * <p>The Amazon Web Services tags that are used by resources in the resource collection.</p>
1292
1394
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
1293
1395
  * tagging, so you can assign the same tag to resources from different services to indicate
@@ -1332,10 +1434,12 @@ export interface ResourceCollection {
1332
1434
  */
1333
1435
  export interface ProactiveAnomaly {
1334
1436
  /**
1437
+ * @public
1335
1438
  * <p> The ID of a proactive anomaly. </p>
1336
1439
  */
1337
1440
  Id?: string;
1338
1441
  /**
1442
+ * @public
1339
1443
  * <p>The severity of the anomaly. The severity of anomalies that generate
1340
1444
  * an insight determine that insight's severity. For more information, see
1341
1445
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -1343,41 +1447,49 @@ export interface ProactiveAnomaly {
1343
1447
  */
1344
1448
  Severity?: AnomalySeverity | string;
1345
1449
  /**
1450
+ * @public
1346
1451
  * <p> The status of a proactive anomaly. </p>
1347
1452
  */
1348
1453
  Status?: AnomalyStatus | string;
1349
1454
  /**
1455
+ * @public
1350
1456
  * <p> The time of the anomaly's most recent update. </p>
1351
1457
  */
1352
1458
  UpdateTime?: Date;
1353
1459
  /**
1460
+ * @public
1354
1461
  * <p> A time range that specifies when the observed unusual behavior in an anomaly started
1355
1462
  * and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
1356
1463
  * the time range when DevOps Guru opens and then closes an anomaly. </p>
1357
1464
  */
1358
1465
  AnomalyTimeRange?: AnomalyTimeRange;
1359
1466
  /**
1467
+ * @public
1360
1468
  * <p>
1361
1469
  * An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
1362
1470
  * </p>
1363
1471
  */
1364
1472
  AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
1365
1473
  /**
1474
+ * @public
1366
1475
  * <p> The time range during which anomalous behavior in a proactive anomaly or an insight
1367
1476
  * is expected to occur. </p>
1368
1477
  */
1369
1478
  PredictionTimeRange?: PredictionTimeRange;
1370
1479
  /**
1480
+ * @public
1371
1481
  * <p> Details about the source of the analyzed operational data that triggered the anomaly.
1372
1482
  * The one supported source is Amazon CloudWatch metrics. </p>
1373
1483
  */
1374
1484
  SourceDetails?: AnomalySourceDetails;
1375
1485
  /**
1486
+ * @public
1376
1487
  * <p> The ID of the insight that contains this anomaly. An insight is composed of related
1377
1488
  * anomalies. </p>
1378
1489
  */
1379
1490
  AssociatedInsightId?: string;
1380
1491
  /**
1492
+ * @public
1381
1493
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
1382
1494
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
1383
1495
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -1385,19 +1497,23 @@ export interface ProactiveAnomaly {
1385
1497
  */
1386
1498
  ResourceCollection?: ResourceCollection;
1387
1499
  /**
1500
+ * @public
1388
1501
  * <p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this
1389
1502
  * threshold is related to the anomalous behavior that generated this anomaly. </p>
1390
1503
  */
1391
1504
  Limit?: number;
1392
1505
  /**
1506
+ * @public
1393
1507
  * <p>The metadata for the anomaly.</p>
1394
1508
  */
1395
1509
  SourceMetadata?: AnomalySourceMetadata;
1396
1510
  /**
1511
+ * @public
1397
1512
  * <p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>
1398
1513
  */
1399
1514
  AnomalyResources?: AnomalyResource[];
1400
1515
  /**
1516
+ * @public
1401
1517
  * <p>
1402
1518
  * A description of the proactive anomaly.
1403
1519
  * </p>
@@ -1411,10 +1527,12 @@ export interface ProactiveAnomaly {
1411
1527
  */
1412
1528
  export interface ReactiveAnomaly {
1413
1529
  /**
1530
+ * @public
1414
1531
  * <p>The ID of the reactive anomaly. </p>
1415
1532
  */
1416
1533
  Id?: string;
1417
1534
  /**
1535
+ * @public
1418
1536
  * <p>The severity of the anomaly. The severity of anomalies that generate
1419
1537
  * an insight determine that insight's severity. For more information, see
1420
1538
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -1422,32 +1540,38 @@ export interface ReactiveAnomaly {
1422
1540
  */
1423
1541
  Severity?: AnomalySeverity | string;
1424
1542
  /**
1543
+ * @public
1425
1544
  * <p> The status of the anomaly. </p>
1426
1545
  */
1427
1546
  Status?: AnomalyStatus | string;
1428
1547
  /**
1548
+ * @public
1429
1549
  * <p> A time range that specifies when the observed unusual behavior in an anomaly started
1430
1550
  * and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
1431
1551
  * the time range when DevOps Guru opens and then closes an anomaly. </p>
1432
1552
  */
1433
1553
  AnomalyTimeRange?: AnomalyTimeRange;
1434
1554
  /**
1555
+ * @public
1435
1556
  * <p>
1436
1557
  * An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
1437
1558
  * </p>
1438
1559
  */
1439
1560
  AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
1440
1561
  /**
1562
+ * @public
1441
1563
  * <p> Details about the source of the analyzed operational data that triggered the anomaly.
1442
1564
  * The one supported source is Amazon CloudWatch metrics. </p>
1443
1565
  */
1444
1566
  SourceDetails?: AnomalySourceDetails;
1445
1567
  /**
1568
+ * @public
1446
1569
  * <p> The ID of the insight that contains this anomaly. An insight is composed of related
1447
1570
  * anomalies. </p>
1448
1571
  */
1449
1572
  AssociatedInsightId?: string;
1450
1573
  /**
1574
+ * @public
1451
1575
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
1452
1576
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
1453
1577
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -1455,6 +1579,7 @@ export interface ReactiveAnomaly {
1455
1579
  */
1456
1580
  ResourceCollection?: ResourceCollection;
1457
1581
  /**
1582
+ * @public
1458
1583
  * <p>The type of the reactive anomaly. It can be one of the following types.</p>
1459
1584
  * <ul>
1460
1585
  * <li>
@@ -1469,19 +1594,23 @@ export interface ReactiveAnomaly {
1469
1594
  */
1470
1595
  Type?: AnomalyType | string;
1471
1596
  /**
1597
+ * @public
1472
1598
  * <p>The name of the reactive anomaly.</p>
1473
1599
  */
1474
1600
  Name?: string;
1475
1601
  /**
1602
+ * @public
1476
1603
  * <p>A description of the reactive anomaly.</p>
1477
1604
  */
1478
1605
  Description?: string;
1479
1606
  /**
1607
+ * @public
1480
1608
  * <p>The ID of the causal anomaly that is associated with this
1481
1609
  * reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>
1482
1610
  */
1483
1611
  CausalAnomalyId?: string;
1484
1612
  /**
1613
+ * @public
1485
1614
  * <p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>
1486
1615
  */
1487
1616
  AnomalyResources?: AnomalyResource[];
@@ -1491,10 +1620,12 @@ export interface ReactiveAnomaly {
1491
1620
  */
1492
1621
  export interface DescribeAnomalyResponse {
1493
1622
  /**
1623
+ * @public
1494
1624
  * <p> A <code>ProactiveAnomaly</code> object that represents the requested anomaly. </p>
1495
1625
  */
1496
1626
  ProactiveAnomaly?: ProactiveAnomaly;
1497
1627
  /**
1628
+ * @public
1498
1629
  * <p> A <code>ReactiveAnomaly</code> object that represents the requested anomaly. </p>
1499
1630
  */
1500
1631
  ReactiveAnomaly?: ReactiveAnomaly;
@@ -1511,6 +1642,7 @@ export interface DescribeEventSourcesConfigRequest {
1511
1642
  */
1512
1643
  export interface EventSourcesConfig {
1513
1644
  /**
1645
+ * @public
1514
1646
  * <p>Information about whether DevOps Guru is configured to consume recommendations which
1515
1647
  * are generated from AWS CodeGuru Profiler.</p>
1516
1648
  */
@@ -1521,6 +1653,7 @@ export interface EventSourcesConfig {
1521
1653
  */
1522
1654
  export interface DescribeEventSourcesConfigResponse {
1523
1655
  /**
1656
+ * @public
1524
1657
  * <p>Lists the event sources in the configuration.</p>
1525
1658
  */
1526
1659
  EventSources?: EventSourcesConfig;
@@ -1530,6 +1663,7 @@ export interface DescribeEventSourcesConfigResponse {
1530
1663
  */
1531
1664
  export interface DescribeFeedbackRequest {
1532
1665
  /**
1666
+ * @public
1533
1667
  * <p> The ID of the insight for which the feedback was provided. </p>
1534
1668
  */
1535
1669
  InsightId?: string;
@@ -1555,10 +1689,12 @@ export type InsightFeedbackOption = (typeof InsightFeedbackOption)[keyof typeof
1555
1689
  */
1556
1690
  export interface InsightFeedback {
1557
1691
  /**
1692
+ * @public
1558
1693
  * <p> The insight feedback ID. </p>
1559
1694
  */
1560
1695
  Id?: string;
1561
1696
  /**
1697
+ * @public
1562
1698
  * <p> The feedback provided by the customer. </p>
1563
1699
  */
1564
1700
  Feedback?: InsightFeedbackOption | string;
@@ -1568,6 +1704,7 @@ export interface InsightFeedback {
1568
1704
  */
1569
1705
  export interface DescribeFeedbackResponse {
1570
1706
  /**
1707
+ * @public
1571
1708
  * <p> Information about insight feedback received from a customer. </p>
1572
1709
  */
1573
1710
  InsightFeedback?: InsightFeedback;
@@ -1577,10 +1714,12 @@ export interface DescribeFeedbackResponse {
1577
1714
  */
1578
1715
  export interface DescribeInsightRequest {
1579
1716
  /**
1717
+ * @public
1580
1718
  * <p> The ID of the insight. </p>
1581
1719
  */
1582
1720
  Id: string | undefined;
1583
1721
  /**
1722
+ * @public
1584
1723
  * <p>The ID of the member account in the organization.</p>
1585
1724
  */
1586
1725
  AccountId?: string;
@@ -1592,10 +1731,12 @@ export interface DescribeInsightRequest {
1592
1731
  */
1593
1732
  export interface InsightTimeRange {
1594
1733
  /**
1734
+ * @public
1595
1735
  * <p> The time when the behavior described in an insight started. </p>
1596
1736
  */
1597
1737
  StartTime: Date | undefined;
1598
1738
  /**
1739
+ * @public
1599
1740
  * <p> The time when the behavior described in an insight ended. </p>
1600
1741
  */
1601
1742
  EndTime?: Date;
@@ -1619,34 +1760,41 @@ export type InsightStatus = (typeof InsightStatus)[keyof typeof InsightStatus];
1619
1760
  */
1620
1761
  export interface ProactiveInsight {
1621
1762
  /**
1763
+ * @public
1622
1764
  * <p>The ID of the proactive insight. </p>
1623
1765
  */
1624
1766
  Id?: string;
1625
1767
  /**
1768
+ * @public
1626
1769
  * <p>The name of the proactive insight. </p>
1627
1770
  */
1628
1771
  Name?: string;
1629
1772
  /**
1773
+ * @public
1630
1774
  * <p>The severity of the insight. For more information, see
1631
1775
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
1632
1776
  * insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
1633
1777
  */
1634
1778
  Severity?: InsightSeverity | string;
1635
1779
  /**
1780
+ * @public
1636
1781
  * <p>The status of the proactive insight. </p>
1637
1782
  */
1638
1783
  Status?: InsightStatus | string;
1639
1784
  /**
1785
+ * @public
1640
1786
  * <p> A time ranged that specifies when the observed behavior in an insight started and
1641
1787
  * ended. </p>
1642
1788
  */
1643
1789
  InsightTimeRange?: InsightTimeRange;
1644
1790
  /**
1791
+ * @public
1645
1792
  * <p> The time range during which anomalous behavior in a proactive anomaly or an insight
1646
1793
  * is expected to occur. </p>
1647
1794
  */
1648
1795
  PredictionTimeRange?: PredictionTimeRange;
1649
1796
  /**
1797
+ * @public
1650
1798
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
1651
1799
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
1652
1800
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -1654,11 +1802,13 @@ export interface ProactiveInsight {
1654
1802
  */
1655
1803
  ResourceCollection?: ResourceCollection;
1656
1804
  /**
1805
+ * @public
1657
1806
  * <p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
1658
1807
  * the creation of OpstItems insights before they are created for each insight. </p>
1659
1808
  */
1660
1809
  SsmOpsItemId?: string;
1661
1810
  /**
1811
+ * @public
1662
1812
  * <p>Describes the proactive insight.</p>
1663
1813
  */
1664
1814
  Description?: string;
@@ -1670,29 +1820,35 @@ export interface ProactiveInsight {
1670
1820
  */
1671
1821
  export interface ReactiveInsight {
1672
1822
  /**
1823
+ * @public
1673
1824
  * <p> The ID of a reactive insight. </p>
1674
1825
  */
1675
1826
  Id?: string;
1676
1827
  /**
1828
+ * @public
1677
1829
  * <p> The name of a reactive insight. </p>
1678
1830
  */
1679
1831
  Name?: string;
1680
1832
  /**
1833
+ * @public
1681
1834
  * <p>The severity of the insight. For more information, see
1682
1835
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
1683
1836
  * insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
1684
1837
  */
1685
1838
  Severity?: InsightSeverity | string;
1686
1839
  /**
1840
+ * @public
1687
1841
  * <p> The status of a reactive insight. </p>
1688
1842
  */
1689
1843
  Status?: InsightStatus | string;
1690
1844
  /**
1845
+ * @public
1691
1846
  * <p> A time ranged that specifies when the observed behavior in an insight started and
1692
1847
  * ended. </p>
1693
1848
  */
1694
1849
  InsightTimeRange?: InsightTimeRange;
1695
1850
  /**
1851
+ * @public
1696
1852
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
1697
1853
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
1698
1854
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -1700,11 +1856,13 @@ export interface ReactiveInsight {
1700
1856
  */
1701
1857
  ResourceCollection?: ResourceCollection;
1702
1858
  /**
1859
+ * @public
1703
1860
  * <p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
1704
1861
  * the creation of OpstItems insights before they are created for each insight. </p>
1705
1862
  */
1706
1863
  SsmOpsItemId?: string;
1707
1864
  /**
1865
+ * @public
1708
1866
  * <p>Describes the reactive insight.</p>
1709
1867
  */
1710
1868
  Description?: string;
@@ -1714,10 +1872,12 @@ export interface ReactiveInsight {
1714
1872
  */
1715
1873
  export interface DescribeInsightResponse {
1716
1874
  /**
1875
+ * @public
1717
1876
  * <p> A <code>ProactiveInsight</code> object that represents the requested insight. </p>
1718
1877
  */
1719
1878
  ProactiveInsight?: ProactiveInsight;
1720
1879
  /**
1880
+ * @public
1721
1881
  * <p> A <code>ReactiveInsight</code> object that represents the requested insight. </p>
1722
1882
  */
1723
1883
  ReactiveInsight?: ReactiveInsight;
@@ -1727,10 +1887,12 @@ export interface DescribeInsightResponse {
1727
1887
  */
1728
1888
  export interface DescribeOrganizationHealthRequest {
1729
1889
  /**
1890
+ * @public
1730
1891
  * <p>The ID of the Amazon Web Services account.</p>
1731
1892
  */
1732
1893
  AccountIds?: string[];
1733
1894
  /**
1895
+ * @public
1734
1896
  * <p>The ID of the organizational unit.</p>
1735
1897
  */
1736
1898
  OrganizationalUnitIds?: string[];
@@ -1740,21 +1902,25 @@ export interface DescribeOrganizationHealthRequest {
1740
1902
  */
1741
1903
  export interface DescribeOrganizationHealthResponse {
1742
1904
  /**
1905
+ * @public
1743
1906
  * <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
1744
1907
  * account.</p>
1745
1908
  */
1746
1909
  OpenReactiveInsights: number | undefined;
1747
1910
  /**
1911
+ * @public
1748
1912
  * <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
1749
1913
  * account.</p>
1750
1914
  */
1751
1915
  OpenProactiveInsights: number | undefined;
1752
1916
  /**
1917
+ * @public
1753
1918
  * <p>An integer that specifies the number of metrics that have been analyzed in your
1754
1919
  * organization.</p>
1755
1920
  */
1756
1921
  MetricsAnalyzed: number | undefined;
1757
1922
  /**
1923
+ * @public
1758
1924
  * <p>The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in
1759
1925
  * the last hour. </p>
1760
1926
  */
@@ -1765,22 +1931,26 @@ export interface DescribeOrganizationHealthResponse {
1765
1931
  */
1766
1932
  export interface DescribeOrganizationOverviewRequest {
1767
1933
  /**
1934
+ * @public
1768
1935
  * <p> The start of the time range passed in. The start time granularity is at the day
1769
1936
  * level. The floor of the start time is used. Returned information occurred after this
1770
1937
  * day. </p>
1771
1938
  */
1772
1939
  FromTime: Date | undefined;
1773
1940
  /**
1941
+ * @public
1774
1942
  * <p> The end of the time range passed in. The start time granularity is at the day level.
1775
1943
  * The floor of the start time is used. Returned information occurred before this day. If
1776
1944
  * this is not specified, then the current day is used. </p>
1777
1945
  */
1778
1946
  ToTime?: Date;
1779
1947
  /**
1948
+ * @public
1780
1949
  * <p>The ID of the Amazon Web Services account.</p>
1781
1950
  */
1782
1951
  AccountIds?: string[];
1783
1952
  /**
1953
+ * @public
1784
1954
  * <p>The ID of the organizational unit.</p>
1785
1955
  */
1786
1956
  OrganizationalUnitIds?: string[];
@@ -1790,11 +1960,13 @@ export interface DescribeOrganizationOverviewRequest {
1790
1960
  */
1791
1961
  export interface DescribeOrganizationOverviewResponse {
1792
1962
  /**
1963
+ * @public
1793
1964
  * <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
1794
1965
  * account.</p>
1795
1966
  */
1796
1967
  ReactiveInsights: number | undefined;
1797
1968
  /**
1969
+ * @public
1798
1970
  * <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
1799
1971
  * account.</p>
1800
1972
  */
@@ -1819,6 +1991,7 @@ export type OrganizationResourceCollectionType = (typeof OrganizationResourceCol
1819
1991
  */
1820
1992
  export interface DescribeOrganizationResourceCollectionHealthRequest {
1821
1993
  /**
1994
+ * @public
1822
1995
  * <p> An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources
1823
1996
  * are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
1824
1997
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -1826,19 +1999,23 @@ export interface DescribeOrganizationResourceCollectionHealthRequest {
1826
1999
  */
1827
2000
  OrganizationResourceCollectionType: OrganizationResourceCollectionType | string | undefined;
1828
2001
  /**
2002
+ * @public
1829
2003
  * <p>The ID of the Amazon Web Services account.</p>
1830
2004
  */
1831
2005
  AccountIds?: string[];
1832
2006
  /**
2007
+ * @public
1833
2008
  * <p>The ID of the organizational unit.</p>
1834
2009
  */
1835
2010
  OrganizationalUnitIds?: string[];
1836
2011
  /**
2012
+ * @public
1837
2013
  * <p>The pagination token to use to retrieve
1838
2014
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
1839
2015
  */
1840
2016
  NextToken?: string;
1841
2017
  /**
2018
+ * @public
1842
2019
  * <p>The maximum number of results to return with a single call.
1843
2020
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
1844
2021
  */
@@ -1851,14 +2028,17 @@ export interface DescribeOrganizationResourceCollectionHealthRequest {
1851
2028
  */
1852
2029
  export interface InsightHealth {
1853
2030
  /**
2031
+ * @public
1854
2032
  * <p> The number of open proactive insights. </p>
1855
2033
  */
1856
2034
  OpenProactiveInsights?: number;
1857
2035
  /**
2036
+ * @public
1858
2037
  * <p> The number of open reactive insights. </p>
1859
2038
  */
1860
2039
  OpenReactiveInsights?: number;
1861
2040
  /**
2041
+ * @public
1862
2042
  * <p> The Meant Time to Recover (MTTR) for the insight. </p>
1863
2043
  */
1864
2044
  MeanTimeToRecoverInMilliseconds?: number;
@@ -1870,16 +2050,19 @@ export interface InsightHealth {
1870
2050
  */
1871
2051
  export interface CloudFormationHealth {
1872
2052
  /**
2053
+ * @public
1873
2054
  * <p> The name of the CloudFormation stack. </p>
1874
2055
  */
1875
2056
  StackName?: string;
1876
2057
  /**
2058
+ * @public
1877
2059
  * <p> Information about the health of the Amazon Web Services resources in your account that are
1878
2060
  * specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive
1879
2061
  * insights, and the Mean Time to Recover (MTTR) of closed insights. </p>
1880
2062
  */
1881
2063
  Insight?: InsightHealth;
1882
2064
  /**
2065
+ * @public
1883
2066
  * <p>
1884
2067
  * Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.
1885
2068
  * </p>
@@ -1893,10 +2076,12 @@ export interface CloudFormationHealth {
1893
2076
  */
1894
2077
  export interface ServiceInsightHealth {
1895
2078
  /**
2079
+ * @public
1896
2080
  * <p>The number of open proactive insights in the Amazon Web Services service</p>
1897
2081
  */
1898
2082
  OpenProactiveInsights?: number;
1899
2083
  /**
2084
+ * @public
1900
2085
  * <p>The number of open reactive insights in the Amazon Web Services service</p>
1901
2086
  */
1902
2087
  OpenReactiveInsights?: number;
@@ -1942,16 +2127,19 @@ export type ServiceName = (typeof ServiceName)[keyof typeof ServiceName];
1942
2127
  */
1943
2128
  export interface ServiceHealth {
1944
2129
  /**
2130
+ * @public
1945
2131
  * <p>The name of the Amazon Web Services service.</p>
1946
2132
  */
1947
2133
  ServiceName?: ServiceName | string;
1948
2134
  /**
2135
+ * @public
1949
2136
  * <p>Represents the health of an Amazon Web Services service. This is a <code>ServiceInsightHealth</code>
1950
2137
  * that contains the number of open proactive and reactive insights for this
1951
2138
  * service.</p>
1952
2139
  */
1953
2140
  Insight?: ServiceInsightHealth;
1954
2141
  /**
2142
+ * @public
1955
2143
  * <p>
1956
2144
  * Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.
1957
2145
  * </p>
@@ -1965,6 +2153,7 @@ export interface ServiceHealth {
1965
2153
  */
1966
2154
  export interface TagHealth {
1967
2155
  /**
2156
+ * @public
1968
2157
  * <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
1969
2158
  * DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
1970
2159
  * up your DevOps Guru application and analysis boundary.</p>
@@ -1982,6 +2171,7 @@ export interface TagHealth {
1982
2171
  */
1983
2172
  AppBoundaryKey?: string;
1984
2173
  /**
2174
+ * @public
1985
2175
  * <p>The value in an Amazon Web Services tag.</p>
1986
2176
  * <p>The tag's <i>value</i> is an optional field used to associate a string with
1987
2177
  * the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
@@ -1992,12 +2182,14 @@ export interface TagHealth {
1992
2182
  */
1993
2183
  TagValue?: string;
1994
2184
  /**
2185
+ * @public
1995
2186
  * <p>Information about the health of the Amazon Web Services resources in your account that are specified
1996
2187
  * by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the
1997
2188
  * Mean Time to Recover (MTTR) of closed insights. </p>
1998
2189
  */
1999
2190
  Insight?: InsightHealth;
2000
2191
  /**
2192
+ * @public
2001
2193
  * <p>
2002
2194
  * Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.
2003
2195
  * </p>
@@ -2009,26 +2201,31 @@ export interface TagHealth {
2009
2201
  */
2010
2202
  export interface DescribeOrganizationResourceCollectionHealthResponse {
2011
2203
  /**
2204
+ * @public
2012
2205
  * <p>The returned <code>CloudFormationHealthOverview</code> object that contains an
2013
2206
  * <code>InsightHealthOverview</code> object with the requested system health
2014
2207
  * information.</p>
2015
2208
  */
2016
2209
  CloudFormation?: CloudFormationHealth[];
2017
2210
  /**
2211
+ * @public
2018
2212
  * <p>An array of <code>ServiceHealth</code> objects that describes the health of the Amazon Web Services
2019
2213
  * services associated with the resources in the collection.</p>
2020
2214
  */
2021
2215
  Service?: ServiceHealth[];
2022
2216
  /**
2217
+ * @public
2023
2218
  * <p>The name of the organization's account.</p>
2024
2219
  */
2025
2220
  Account?: AccountHealth[];
2026
2221
  /**
2222
+ * @public
2027
2223
  * <p>The pagination token to use to retrieve
2028
2224
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2029
2225
  */
2030
2226
  NextToken?: string;
2031
2227
  /**
2228
+ * @public
2032
2229
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
2033
2230
  * tagging, so you can assign the same tag to resources from different services to indicate
2034
2231
  * that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
@@ -2083,6 +2280,7 @@ export type ResourceCollectionType = (typeof ResourceCollectionType)[keyof typeo
2083
2280
  */
2084
2281
  export interface DescribeResourceCollectionHealthRequest {
2085
2282
  /**
2283
+ * @public
2086
2284
  * <p> An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources
2087
2285
  * are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
2088
2286
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -2090,6 +2288,7 @@ export interface DescribeResourceCollectionHealthRequest {
2090
2288
  */
2091
2289
  ResourceCollectionType: ResourceCollectionType | string | undefined;
2092
2290
  /**
2291
+ * @public
2093
2292
  * <p>The pagination token to use to retrieve
2094
2293
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
2095
2294
  */
@@ -2100,22 +2299,26 @@ export interface DescribeResourceCollectionHealthRequest {
2100
2299
  */
2101
2300
  export interface DescribeResourceCollectionHealthResponse {
2102
2301
  /**
2302
+ * @public
2103
2303
  * <p> The returned <code>CloudFormationHealthOverview</code> object that contains an
2104
2304
  * <code>InsightHealthOverview</code> object with the requested system health
2105
2305
  * information. </p>
2106
2306
  */
2107
2307
  CloudFormation?: CloudFormationHealth[];
2108
2308
  /**
2309
+ * @public
2109
2310
  * <p>An array of <code>ServiceHealth</code> objects that describes the health of the Amazon Web Services
2110
2311
  * services associated with the resources in the collection.</p>
2111
2312
  */
2112
2313
  Service?: ServiceHealth[];
2113
2314
  /**
2315
+ * @public
2114
2316
  * <p>The pagination token to use to retrieve
2115
2317
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2116
2318
  */
2117
2319
  NextToken?: string;
2118
2320
  /**
2321
+ * @public
2119
2322
  * <p>The Amazon Web Services tags that are used by resources in the resource collection.</p>
2120
2323
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
2121
2324
  * tagging, so you can assign the same tag to resources from different services to indicate
@@ -2190,6 +2393,7 @@ export type ServerSideEncryptionType = (typeof ServerSideEncryptionType)[keyof t
2190
2393
  */
2191
2394
  export interface KMSServerSideEncryptionIntegration {
2192
2395
  /**
2396
+ * @public
2193
2397
  * <p>
2194
2398
  * Describes the specified KMS key.
2195
2399
  * </p>
@@ -2207,12 +2411,14 @@ export interface KMSServerSideEncryptionIntegration {
2207
2411
  */
2208
2412
  KMSKeyId?: string;
2209
2413
  /**
2414
+ * @public
2210
2415
  * <p>
2211
2416
  * Specifies if DevOps Guru is enabled for customer managed keys.
2212
2417
  * </p>
2213
2418
  */
2214
2419
  OptInStatus?: OptInStatus | string;
2215
2420
  /**
2421
+ * @public
2216
2422
  * <p>
2217
2423
  * The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.
2218
2424
  * </p>
@@ -2227,6 +2433,7 @@ export interface KMSServerSideEncryptionIntegration {
2227
2433
  */
2228
2434
  export interface LogsAnomalyDetectionIntegration {
2229
2435
  /**
2436
+ * @public
2230
2437
  * <p>Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.</p>
2231
2438
  */
2232
2439
  OptInStatus?: OptInStatus | string;
@@ -2238,6 +2445,7 @@ export interface LogsAnomalyDetectionIntegration {
2238
2445
  */
2239
2446
  export interface OpsCenterIntegration {
2240
2447
  /**
2448
+ * @public
2241
2449
  * <p> Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created
2242
2450
  * insight. </p>
2243
2451
  */
@@ -2250,17 +2458,20 @@ export interface OpsCenterIntegration {
2250
2458
  */
2251
2459
  export interface ServiceIntegrationConfig {
2252
2460
  /**
2461
+ * @public
2253
2462
  * <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
2254
2463
  * OpsCenter for each created insight. </p>
2255
2464
  */
2256
2465
  OpsCenter?: OpsCenterIntegration;
2257
2466
  /**
2467
+ * @public
2258
2468
  * <p>
2259
2469
  * Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.
2260
2470
  * </p>
2261
2471
  */
2262
2472
  LogsAnomalyDetection?: LogsAnomalyDetectionIntegration;
2263
2473
  /**
2474
+ * @public
2264
2475
  * <p>
2265
2476
  * Information about whether DevOps Guru is configured to encrypt server-side data using KMS.
2266
2477
  * </p>
@@ -2272,6 +2483,7 @@ export interface ServiceIntegrationConfig {
2272
2483
  */
2273
2484
  export interface DescribeServiceIntegrationResponse {
2274
2485
  /**
2486
+ * @public
2275
2487
  * <p> Information about the integration of DevOps Guru with another Amazon Web Services service, such as
2276
2488
  * Amazon Web Services Systems Manager. </p>
2277
2489
  */
@@ -2282,6 +2494,7 @@ export interface DescribeServiceIntegrationResponse {
2282
2494
  */
2283
2495
  export interface GetCostEstimationRequest {
2284
2496
  /**
2497
+ * @public
2285
2498
  * <p>The pagination token to use to retrieve
2286
2499
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
2287
2500
  */
@@ -2309,10 +2522,12 @@ export type CostEstimationServiceResourceState = (typeof CostEstimationServiceRe
2309
2522
  */
2310
2523
  export interface ServiceResourceCost {
2311
2524
  /**
2525
+ * @public
2312
2526
  * <p>The type of the Amazon Web Services resource.</p>
2313
2527
  */
2314
2528
  Type?: string;
2315
2529
  /**
2530
+ * @public
2316
2531
  * <p>The state of the resource. The resource is <code>ACTIVE</code> if it produces metrics,
2317
2532
  * events, or logs within an hour, otherwise it is <code>INACTIVE</code>. You pay for the
2318
2533
  * number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are
@@ -2320,11 +2535,13 @@ export interface ServiceResourceCost {
2320
2535
  */
2321
2536
  State?: CostEstimationServiceResourceState | string;
2322
2537
  /**
2538
+ * @public
2323
2539
  * <p>The number of active resources analyzed for this service to create a monthly cost
2324
2540
  * estimate.</p>
2325
2541
  */
2326
2542
  Count?: number;
2327
2543
  /**
2544
+ * @public
2328
2545
  * <p>The price per hour to analyze the resources in the service.
2329
2546
  * For more information,
2330
2547
  * see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html">Estimate your
@@ -2333,6 +2550,7 @@ export interface ServiceResourceCost {
2333
2550
  */
2334
2551
  UnitCost?: number;
2335
2552
  /**
2553
+ * @public
2336
2554
  * <p>The total estimated monthly cost to analyze the active resources for this
2337
2555
  * resource.</p>
2338
2556
  */
@@ -2348,6 +2566,7 @@ export interface ServiceResourceCost {
2348
2566
  */
2349
2567
  export interface CloudFormationCostEstimationResourceCollectionFilter {
2350
2568
  /**
2569
+ * @public
2351
2570
  * <p>An array of CloudFormation stack names. Its size is fixed at 1 item.</p>
2352
2571
  */
2353
2572
  StackNames?: string[];
@@ -2363,6 +2582,7 @@ export interface CloudFormationCostEstimationResourceCollectionFilter {
2363
2582
  */
2364
2583
  export interface TagCostEstimationResourceCollectionFilter {
2365
2584
  /**
2585
+ * @public
2366
2586
  * <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
2367
2587
  * DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
2368
2588
  * up your DevOps Guru application and analysis boundary.</p>
@@ -2380,6 +2600,7 @@ export interface TagCostEstimationResourceCollectionFilter {
2380
2600
  */
2381
2601
  AppBoundaryKey: string | undefined;
2382
2602
  /**
2603
+ * @public
2383
2604
  * <p>The values in an Amazon Web Services tag collection.</p>
2384
2605
  * <p>The tag's <i>value</i> is an optional field used to associate a string with
2385
2606
  * the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
@@ -2400,11 +2621,13 @@ export interface TagCostEstimationResourceCollectionFilter {
2400
2621
  */
2401
2622
  export interface CostEstimationResourceCollectionFilter {
2402
2623
  /**
2624
+ * @public
2403
2625
  * <p>An object that specifies the CloudFormation stack that defines the Amazon Web Services resources
2404
2626
  * used to create a monthly estimate for DevOps Guru.</p>
2405
2627
  */
2406
2628
  CloudFormation?: CloudFormationCostEstimationResourceCollectionFilter;
2407
2629
  /**
2630
+ * @public
2408
2631
  * <p>The Amazon Web Services tags used to filter the resource collection that is used for a cost
2409
2632
  * estimate.</p>
2410
2633
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
@@ -2461,10 +2684,12 @@ export type CostEstimationStatus = (typeof CostEstimationStatus)[keyof typeof Co
2461
2684
  */
2462
2685
  export interface CostEstimationTimeRange {
2463
2686
  /**
2687
+ * @public
2464
2688
  * <p>The start time of the cost estimation.</p>
2465
2689
  */
2466
2690
  StartTime?: Date;
2467
2691
  /**
2692
+ * @public
2468
2693
  * <p>The end time of the cost estimation.</p>
2469
2694
  */
2470
2695
  EndTime?: Date;
@@ -2474,32 +2699,38 @@ export interface CostEstimationTimeRange {
2474
2699
  */
2475
2700
  export interface GetCostEstimationResponse {
2476
2701
  /**
2702
+ * @public
2477
2703
  * <p>The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost
2478
2704
  * estimate.</p>
2479
2705
  */
2480
2706
  ResourceCollection?: CostEstimationResourceCollectionFilter;
2481
2707
  /**
2708
+ * @public
2482
2709
  * <p>The status of creating this cost estimate. If it's still in progress, the status
2483
2710
  * <code>ONGOING</code> is returned. If it is finished, the status
2484
2711
  * <code>COMPLETED</code> is returned.</p>
2485
2712
  */
2486
2713
  Status?: CostEstimationStatus | string;
2487
2714
  /**
2715
+ * @public
2488
2716
  * <p>An array of <code>ResourceCost</code> objects that each contains details about the
2489
2717
  * monthly cost estimate to analyze one of your Amazon Web Services resources.</p>
2490
2718
  */
2491
2719
  Costs?: ServiceResourceCost[];
2492
2720
  /**
2721
+ * @public
2493
2722
  * <p>The start and end time of the cost estimation.</p>
2494
2723
  */
2495
2724
  TimeRange?: CostEstimationTimeRange;
2496
2725
  /**
2726
+ * @public
2497
2727
  * <p>The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of
2498
2728
  * the estimated costs to analyze each resource in the <code>Costs</code> object in this
2499
2729
  * response.</p>
2500
2730
  */
2501
2731
  TotalCost?: number;
2502
2732
  /**
2733
+ * @public
2503
2734
  * <p>The pagination token to use to retrieve
2504
2735
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2505
2736
  */
@@ -2510,11 +2741,13 @@ export interface GetCostEstimationResponse {
2510
2741
  */
2511
2742
  export interface GetResourceCollectionRequest {
2512
2743
  /**
2744
+ * @public
2513
2745
  * <p> The type of Amazon Web Services resource collections to return. The one valid value is
2514
2746
  * <code>CLOUD_FORMATION</code> for Amazon Web Services CloudFormation stacks. </p>
2515
2747
  */
2516
2748
  ResourceCollectionType: ResourceCollectionType | string | undefined;
2517
2749
  /**
2750
+ * @public
2518
2751
  * <p>The pagination token to use to retrieve
2519
2752
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
2520
2753
  */
@@ -2529,6 +2762,7 @@ export interface GetResourceCollectionRequest {
2529
2762
  */
2530
2763
  export interface CloudFormationCollectionFilter {
2531
2764
  /**
2765
+ * @public
2532
2766
  * <p> An array of CloudFormation stack names. </p>
2533
2767
  */
2534
2768
  StackNames?: string[];
@@ -2540,6 +2774,7 @@ export interface CloudFormationCollectionFilter {
2540
2774
  */
2541
2775
  export interface TagCollectionFilter {
2542
2776
  /**
2777
+ * @public
2543
2778
  * <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
2544
2779
  * DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
2545
2780
  * up your DevOps Guru application and analysis boundary.</p>
@@ -2557,6 +2792,7 @@ export interface TagCollectionFilter {
2557
2792
  */
2558
2793
  AppBoundaryKey: string | undefined;
2559
2794
  /**
2795
+ * @public
2560
2796
  * <p>The values in an Amazon Web Services tag collection.</p>
2561
2797
  * <p>The tag's <i>value</i> is an optional field used to associate a string with
2562
2798
  * the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
@@ -2574,6 +2810,7 @@ export interface TagCollectionFilter {
2574
2810
  */
2575
2811
  export interface ResourceCollectionFilter {
2576
2812
  /**
2813
+ * @public
2577
2814
  * <p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500
2578
2815
  * stacks to specify which Amazon Web Services resources in your account to analyze. For more
2579
2816
  * information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
@@ -2581,6 +2818,7 @@ export interface ResourceCollectionFilter {
2581
2818
  */
2582
2819
  CloudFormation?: CloudFormationCollectionFilter;
2583
2820
  /**
2821
+ * @public
2584
2822
  * <p>The Amazon Web Services tags used to filter the resources in the resource collection.</p>
2585
2823
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
2586
2824
  * tagging, so you can assign the same tag to resources from different services to indicate
@@ -2623,6 +2861,7 @@ export interface ResourceCollectionFilter {
2623
2861
  */
2624
2862
  export interface GetResourceCollectionResponse {
2625
2863
  /**
2864
+ * @public
2626
2865
  * <p> The requested list of Amazon Web Services resource collections.
2627
2866
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
2628
2867
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -2630,6 +2869,7 @@ export interface GetResourceCollectionResponse {
2630
2869
  */
2631
2870
  ResourceCollection?: ResourceCollectionFilter;
2632
2871
  /**
2872
+ * @public
2633
2873
  * <p>The pagination token to use to retrieve
2634
2874
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2635
2875
  */
@@ -2641,6 +2881,7 @@ export interface GetResourceCollectionResponse {
2641
2881
  */
2642
2882
  export interface ServiceCollection {
2643
2883
  /**
2884
+ * @public
2644
2885
  * <p>An array of strings that each specifies the name of an Amazon Web Services service.</p>
2645
2886
  */
2646
2887
  ServiceNames?: (ServiceName | string)[];
@@ -2653,6 +2894,7 @@ export interface ServiceCollection {
2653
2894
  */
2654
2895
  export interface ListAnomaliesForInsightFilters {
2655
2896
  /**
2897
+ * @public
2656
2898
  * <p>A collection of the names of Amazon Web Services services.</p>
2657
2899
  */
2658
2900
  ServiceCollection?: ServiceCollection;
@@ -2664,10 +2906,12 @@ export interface ListAnomaliesForInsightFilters {
2664
2906
  */
2665
2907
  export interface StartTimeRange {
2666
2908
  /**
2909
+ * @public
2667
2910
  * <p> The start time of the time range. </p>
2668
2911
  */
2669
2912
  FromTime?: Date;
2670
2913
  /**
2914
+ * @public
2671
2915
  * <p> The end time of the time range. </p>
2672
2916
  */
2673
2917
  ToTime?: Date;
@@ -2677,29 +2921,35 @@ export interface StartTimeRange {
2677
2921
  */
2678
2922
  export interface ListAnomaliesForInsightRequest {
2679
2923
  /**
2924
+ * @public
2680
2925
  * <p> The ID of the insight. The returned anomalies belong to this insight. </p>
2681
2926
  */
2682
2927
  InsightId: string | undefined;
2683
2928
  /**
2929
+ * @public
2684
2930
  * <p> A time range used to specify when the requested anomalies started. All returned
2685
2931
  * anomalies started during this time range. </p>
2686
2932
  */
2687
2933
  StartTimeRange?: StartTimeRange;
2688
2934
  /**
2935
+ * @public
2689
2936
  * <p>The maximum number of results to return with a single call.
2690
2937
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2691
2938
  */
2692
2939
  MaxResults?: number;
2693
2940
  /**
2941
+ * @public
2694
2942
  * <p>The pagination token to use to retrieve
2695
2943
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
2696
2944
  */
2697
2945
  NextToken?: string;
2698
2946
  /**
2947
+ * @public
2699
2948
  * <p>The ID of the Amazon Web Services account. </p>
2700
2949
  */
2701
2950
  AccountId?: string;
2702
2951
  /**
2952
+ * @public
2703
2953
  * <p>
2704
2954
  * Specifies one or more service names that are used to list anomalies.
2705
2955
  * </p>
@@ -2714,10 +2964,12 @@ export interface ListAnomaliesForInsightRequest {
2714
2964
  */
2715
2965
  export interface ProactiveAnomalySummary {
2716
2966
  /**
2967
+ * @public
2717
2968
  * <p>The ID of the anomaly.</p>
2718
2969
  */
2719
2970
  Id?: string;
2720
2971
  /**
2972
+ * @public
2721
2973
  * <p>The severity of the anomaly. The severity of anomalies that generate
2722
2974
  * an insight determine that insight's severity. For more information, see
2723
2975
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -2725,41 +2977,49 @@ export interface ProactiveAnomalySummary {
2725
2977
  */
2726
2978
  Severity?: AnomalySeverity | string;
2727
2979
  /**
2980
+ * @public
2728
2981
  * <p>The status of the anomaly.</p>
2729
2982
  */
2730
2983
  Status?: AnomalyStatus | string;
2731
2984
  /**
2985
+ * @public
2732
2986
  * <p> The time of the anomaly's most recent update. </p>
2733
2987
  */
2734
2988
  UpdateTime?: Date;
2735
2989
  /**
2990
+ * @public
2736
2991
  * <p> A time range that specifies when the observed unusual behavior in an anomaly started
2737
2992
  * and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
2738
2993
  * the time range when DevOps Guru opens and then closes an anomaly. </p>
2739
2994
  */
2740
2995
  AnomalyTimeRange?: AnomalyTimeRange;
2741
2996
  /**
2997
+ * @public
2742
2998
  * <p>
2743
2999
  * An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
2744
3000
  * </p>
2745
3001
  */
2746
3002
  AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
2747
3003
  /**
3004
+ * @public
2748
3005
  * <p> The time range during which anomalous behavior in a proactive anomaly or an insight
2749
3006
  * is expected to occur. </p>
2750
3007
  */
2751
3008
  PredictionTimeRange?: PredictionTimeRange;
2752
3009
  /**
3010
+ * @public
2753
3011
  * <p> Details about the source of the analyzed operational data that triggered the anomaly.
2754
3012
  * The one supported source is Amazon CloudWatch metrics. </p>
2755
3013
  */
2756
3014
  SourceDetails?: AnomalySourceDetails;
2757
3015
  /**
3016
+ * @public
2758
3017
  * <p> The ID of the insight that contains this anomaly. An insight is composed of related
2759
3018
  * anomalies. </p>
2760
3019
  */
2761
3020
  AssociatedInsightId?: string;
2762
3021
  /**
3022
+ * @public
2763
3023
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
2764
3024
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
2765
3025
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -2767,19 +3027,23 @@ export interface ProactiveAnomalySummary {
2767
3027
  */
2768
3028
  ResourceCollection?: ResourceCollection;
2769
3029
  /**
3030
+ * @public
2770
3031
  * <p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this
2771
3032
  * threshold is related to the anomalous behavior that generated this anomaly. </p>
2772
3033
  */
2773
3034
  Limit?: number;
2774
3035
  /**
3036
+ * @public
2775
3037
  * <p>The metadata of the source which detects proactive anomalies.</p>
2776
3038
  */
2777
3039
  SourceMetadata?: AnomalySourceMetadata;
2778
3040
  /**
3041
+ * @public
2779
3042
  * <p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>
2780
3043
  */
2781
3044
  AnomalyResources?: AnomalyResource[];
2782
3045
  /**
3046
+ * @public
2783
3047
  * <p>
2784
3048
  * A description of the proactive anomaly.
2785
3049
  * </p>
@@ -2794,10 +3058,12 @@ export interface ProactiveAnomalySummary {
2794
3058
  */
2795
3059
  export interface ReactiveAnomalySummary {
2796
3060
  /**
3061
+ * @public
2797
3062
  * <p> The ID of the reactive anomaly. </p>
2798
3063
  */
2799
3064
  Id?: string;
2800
3065
  /**
3066
+ * @public
2801
3067
  * <p>The severity of the anomaly. The severity of anomalies that generate
2802
3068
  * an insight determine that insight's severity. For more information, see
2803
3069
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -2805,32 +3071,38 @@ export interface ReactiveAnomalySummary {
2805
3071
  */
2806
3072
  Severity?: AnomalySeverity | string;
2807
3073
  /**
3074
+ * @public
2808
3075
  * <p> The status of the reactive anomaly. </p>
2809
3076
  */
2810
3077
  Status?: AnomalyStatus | string;
2811
3078
  /**
3079
+ * @public
2812
3080
  * <p> A time range that specifies when the observed unusual behavior in an anomaly started
2813
3081
  * and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
2814
3082
  * the time range when DevOps Guru opens and then closes an anomaly. </p>
2815
3083
  */
2816
3084
  AnomalyTimeRange?: AnomalyTimeRange;
2817
3085
  /**
3086
+ * @public
2818
3087
  * <p>
2819
3088
  * An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
2820
3089
  * </p>
2821
3090
  */
2822
3091
  AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
2823
3092
  /**
3093
+ * @public
2824
3094
  * <p> Details about the source of the analyzed operational data that triggered the anomaly.
2825
3095
  * The one supported source is Amazon CloudWatch metrics. </p>
2826
3096
  */
2827
3097
  SourceDetails?: AnomalySourceDetails;
2828
3098
  /**
3099
+ * @public
2829
3100
  * <p> The ID of the insight that contains this anomaly. An insight is composed of related
2830
3101
  * anomalies. </p>
2831
3102
  */
2832
3103
  AssociatedInsightId?: string;
2833
3104
  /**
3105
+ * @public
2834
3106
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
2835
3107
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
2836
3108
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -2838,6 +3110,7 @@ export interface ReactiveAnomalySummary {
2838
3110
  */
2839
3111
  ResourceCollection?: ResourceCollection;
2840
3112
  /**
3113
+ * @public
2841
3114
  * <p>The type of the reactive anomaly. It can be one of the following types.</p>
2842
3115
  * <ul>
2843
3116
  * <li>
@@ -2852,19 +3125,23 @@ export interface ReactiveAnomalySummary {
2852
3125
  */
2853
3126
  Type?: AnomalyType | string;
2854
3127
  /**
3128
+ * @public
2855
3129
  * <p>The name of the reactive anomaly.</p>
2856
3130
  */
2857
3131
  Name?: string;
2858
3132
  /**
3133
+ * @public
2859
3134
  * <p>A description of the reactive anomaly.</p>
2860
3135
  */
2861
3136
  Description?: string;
2862
3137
  /**
3138
+ * @public
2863
3139
  * <p>The ID of the causal anomaly that is associated with this
2864
3140
  * reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>
2865
3141
  */
2866
3142
  CausalAnomalyId?: string;
2867
3143
  /**
3144
+ * @public
2868
3145
  * <p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>
2869
3146
  */
2870
3147
  AnomalyResources?: AnomalyResource[];
@@ -2874,16 +3151,19 @@ export interface ReactiveAnomalySummary {
2874
3151
  */
2875
3152
  export interface ListAnomaliesForInsightResponse {
2876
3153
  /**
3154
+ * @public
2877
3155
  * <p> An array of <code>ProactiveAnomalySummary</code> objects that represent the requested
2878
3156
  * anomalies </p>
2879
3157
  */
2880
3158
  ProactiveAnomalies?: ProactiveAnomalySummary[];
2881
3159
  /**
3160
+ * @public
2882
3161
  * <p> An array of <code>ReactiveAnomalySummary</code> objects that represent the requested
2883
3162
  * anomalies </p>
2884
3163
  */
2885
3164
  ReactiveAnomalies?: ReactiveAnomalySummary[];
2886
3165
  /**
3166
+ * @public
2887
3167
  * <p>The pagination token to use to retrieve
2888
3168
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2889
3169
  */
@@ -2894,17 +3174,20 @@ export interface ListAnomaliesForInsightResponse {
2894
3174
  */
2895
3175
  export interface ListAnomalousLogGroupsRequest {
2896
3176
  /**
3177
+ * @public
2897
3178
  * <p>
2898
3179
  * The ID of the insight containing the log groups.
2899
3180
  * </p>
2900
3181
  */
2901
3182
  InsightId: string | undefined;
2902
3183
  /**
3184
+ * @public
2903
3185
  * <p>The maximum number of results to return with a single call.
2904
3186
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2905
3187
  */
2906
3188
  MaxResults?: number;
2907
3189
  /**
3190
+ * @public
2908
3191
  * <p>The pagination token to use to retrieve
2909
3192
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
2910
3193
  */
@@ -2915,18 +3198,21 @@ export interface ListAnomalousLogGroupsRequest {
2915
3198
  */
2916
3199
  export interface ListAnomalousLogGroupsResponse {
2917
3200
  /**
3201
+ * @public
2918
3202
  * <p>
2919
3203
  * The ID of the insight containing the log groups.
2920
3204
  * </p>
2921
3205
  */
2922
3206
  InsightId: string | undefined;
2923
3207
  /**
3208
+ * @public
2924
3209
  * <p>
2925
3210
  * The list of Amazon CloudWatch log groups that are related to an insight.
2926
3211
  * </p>
2927
3212
  */
2928
3213
  AnomalousLogGroups: AnomalousLogGroup[] | undefined;
2929
3214
  /**
3215
+ * @public
2930
3216
  * <p>The pagination token to use to retrieve
2931
3217
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
2932
3218
  */
@@ -2967,10 +3253,12 @@ export type EventClass = (typeof EventClass)[keyof typeof EventClass];
2967
3253
  */
2968
3254
  export interface EventTimeRange {
2969
3255
  /**
3256
+ * @public
2970
3257
  * <p> The time when the event started. </p>
2971
3258
  */
2972
3259
  FromTime: Date | undefined;
2973
3260
  /**
3261
+ * @public
2974
3262
  * <p> The time when the event ended. </p>
2975
3263
  */
2976
3264
  ToTime: Date | undefined;
@@ -2982,28 +3270,34 @@ export interface EventTimeRange {
2982
3270
  */
2983
3271
  export interface ListEventsFilters {
2984
3272
  /**
3273
+ * @public
2985
3274
  * <p> An ID of an insight that is related to the events you want to filter for. </p>
2986
3275
  */
2987
3276
  InsightId?: string;
2988
3277
  /**
3278
+ * @public
2989
3279
  * <p> A time range during which you want the filtered events to have occurred. </p>
2990
3280
  */
2991
3281
  EventTimeRange?: EventTimeRange;
2992
3282
  /**
3283
+ * @public
2993
3284
  * <p> The class of the events you want to filter for, such as an infrastructure change, a
2994
3285
  * deployment, or a schema change. </p>
2995
3286
  */
2996
3287
  EventClass?: EventClass | string;
2997
3288
  /**
3289
+ * @public
2998
3290
  * <p> The Amazon Web Services source that emitted the events you want to filter for. </p>
2999
3291
  */
3000
3292
  EventSource?: string;
3001
3293
  /**
3294
+ * @public
3002
3295
  * <p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, of the
3003
3296
  * events you want returned. </p>
3004
3297
  */
3005
3298
  DataSource?: EventDataSource | string;
3006
3299
  /**
3300
+ * @public
3007
3301
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3008
3302
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3009
3303
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3016,21 +3310,25 @@ export interface ListEventsFilters {
3016
3310
  */
3017
3311
  export interface ListEventsRequest {
3018
3312
  /**
3313
+ * @public
3019
3314
  * <p> A <code>ListEventsFilters</code> object used to specify which events to return.
3020
3315
  * </p>
3021
3316
  */
3022
3317
  Filters: ListEventsFilters | undefined;
3023
3318
  /**
3319
+ * @public
3024
3320
  * <p>The maximum number of results to return with a single call.
3025
3321
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3026
3322
  */
3027
3323
  MaxResults?: number;
3028
3324
  /**
3325
+ * @public
3029
3326
  * <p>The pagination token to use to retrieve
3030
3327
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3031
3328
  */
3032
3329
  NextToken?: string;
3033
3330
  /**
3331
+ * @public
3034
3332
  * <p>The ID of the Amazon Web Services account. </p>
3035
3333
  */
3036
3334
  AccountId?: string;
@@ -3043,14 +3341,17 @@ export interface ListEventsRequest {
3043
3341
  */
3044
3342
  export interface EventResource {
3045
3343
  /**
3344
+ * @public
3046
3345
  * <p> The type of resource that emitted an event. </p>
3047
3346
  */
3048
3347
  Type?: string;
3049
3348
  /**
3349
+ * @public
3050
3350
  * <p> The name of the resource that emitted an event. </p>
3051
3351
  */
3052
3352
  Name?: string;
3053
3353
  /**
3354
+ * @public
3054
3355
  * <p> The Amazon Resource Name (ARN) of the resource that emitted an event. </p>
3055
3356
  */
3056
3357
  Arn?: string;
@@ -3063,6 +3364,7 @@ export interface EventResource {
3063
3364
  */
3064
3365
  export interface Event {
3065
3366
  /**
3367
+ * @public
3066
3368
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3067
3369
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3068
3370
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3070,32 +3372,39 @@ export interface Event {
3070
3372
  */
3071
3373
  ResourceCollection?: ResourceCollection;
3072
3374
  /**
3375
+ * @public
3073
3376
  * <p> The ID of the event. </p>
3074
3377
  */
3075
3378
  Id?: string;
3076
3379
  /**
3380
+ * @public
3077
3381
  * <p> A <code>Timestamp</code> that specifies the time the event occurred. </p>
3078
3382
  */
3079
3383
  Time?: Date;
3080
3384
  /**
3385
+ * @public
3081
3386
  * <p> The Amazon Web Services source that emitted the event. </p>
3082
3387
  */
3083
3388
  EventSource?: string;
3084
3389
  /**
3390
+ * @public
3085
3391
  * <p> The name of the event. </p>
3086
3392
  */
3087
3393
  Name?: string;
3088
3394
  /**
3395
+ * @public
3089
3396
  * <p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, where DevOps Guru
3090
3397
  * analysis found the event. </p>
3091
3398
  */
3092
3399
  DataSource?: EventDataSource | string;
3093
3400
  /**
3401
+ * @public
3094
3402
  * <p> The class of the event. The class specifies what the event is related to, such as an
3095
3403
  * infrastructure change, a deployment, or a schema change. </p>
3096
3404
  */
3097
3405
  EventClass?: EventClass | string;
3098
3406
  /**
3407
+ * @public
3099
3408
  * <p> An <code>EventResource</code> object that contains information about the resource
3100
3409
  * that emitted the event. </p>
3101
3410
  */
@@ -3106,10 +3415,12 @@ export interface Event {
3106
3415
  */
3107
3416
  export interface ListEventsResponse {
3108
3417
  /**
3418
+ * @public
3109
3419
  * <p> A list of the requested events. </p>
3110
3420
  */
3111
3421
  Events: Event[] | undefined;
3112
3422
  /**
3423
+ * @public
3113
3424
  * <p>The pagination token to use to retrieve
3114
3425
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3115
3426
  */
@@ -3133,11 +3444,13 @@ export type InsightType = (typeof InsightType)[keyof typeof InsightType];
3133
3444
  */
3134
3445
  export interface ListInsightsAnyStatusFilter {
3135
3446
  /**
3447
+ * @public
3136
3448
  * <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
3137
3449
  * </p>
3138
3450
  */
3139
3451
  Type: InsightType | string | undefined;
3140
3452
  /**
3453
+ * @public
3141
3454
  * <p> A time range used to specify when the behavior of the filtered insights started.
3142
3455
  * </p>
3143
3456
  */
@@ -3150,10 +3463,12 @@ export interface ListInsightsAnyStatusFilter {
3150
3463
  */
3151
3464
  export interface EndTimeRange {
3152
3465
  /**
3466
+ * @public
3153
3467
  * <p> The earliest end time in the time range. </p>
3154
3468
  */
3155
3469
  FromTime?: Date;
3156
3470
  /**
3471
+ * @public
3157
3472
  * <p> The latest end time in the time range. </p>
3158
3473
  */
3159
3474
  ToTime?: Date;
@@ -3164,11 +3479,13 @@ export interface EndTimeRange {
3164
3479
  */
3165
3480
  export interface ListInsightsClosedStatusFilter {
3166
3481
  /**
3482
+ * @public
3167
3483
  * <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
3168
3484
  * </p>
3169
3485
  */
3170
3486
  Type: InsightType | string | undefined;
3171
3487
  /**
3488
+ * @public
3172
3489
  * <p> A time range used to specify when the behavior of the filtered insights ended.
3173
3490
  * </p>
3174
3491
  */
@@ -3180,6 +3497,7 @@ export interface ListInsightsClosedStatusFilter {
3180
3497
  */
3181
3498
  export interface ListInsightsOngoingStatusFilter {
3182
3499
  /**
3500
+ * @public
3183
3501
  * <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
3184
3502
  * </p>
3185
3503
  */
@@ -3192,16 +3510,19 @@ export interface ListInsightsOngoingStatusFilter {
3192
3510
  */
3193
3511
  export interface ListInsightsStatusFilter {
3194
3512
  /**
3513
+ * @public
3195
3514
  * <p> A <code>ListInsightsAnyStatusFilter</code> that specifies ongoing insights that are
3196
3515
  * either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
3197
3516
  */
3198
3517
  Ongoing?: ListInsightsOngoingStatusFilter;
3199
3518
  /**
3519
+ * @public
3200
3520
  * <p> A <code>ListInsightsClosedStatusFilter</code> that specifies closed insights that are
3201
3521
  * either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
3202
3522
  */
3203
3523
  Closed?: ListInsightsClosedStatusFilter;
3204
3524
  /**
3525
+ * @public
3205
3526
  * <p> A <code>ListInsightsAnyStatusFilter</code> that specifies insights of any status that
3206
3527
  * are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
3207
3528
  */
@@ -3212,16 +3533,19 @@ export interface ListInsightsStatusFilter {
3212
3533
  */
3213
3534
  export interface ListInsightsRequest {
3214
3535
  /**
3536
+ * @public
3215
3537
  * <p> A filter used to filter the returned insights by their status. You can specify one
3216
3538
  * status filter. </p>
3217
3539
  */
3218
3540
  StatusFilter: ListInsightsStatusFilter | undefined;
3219
3541
  /**
3542
+ * @public
3220
3543
  * <p>The maximum number of results to return with a single call.
3221
3544
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3222
3545
  */
3223
3546
  MaxResults?: number;
3224
3547
  /**
3548
+ * @public
3225
3549
  * <p>The pagination token to use to retrieve
3226
3550
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3227
3551
  */
@@ -3235,34 +3559,41 @@ export interface ListInsightsRequest {
3235
3559
  */
3236
3560
  export interface ProactiveInsightSummary {
3237
3561
  /**
3562
+ * @public
3238
3563
  * <p>The ID of the proactive insight. </p>
3239
3564
  */
3240
3565
  Id?: string;
3241
3566
  /**
3567
+ * @public
3242
3568
  * <p>The name of the proactive insight. </p>
3243
3569
  */
3244
3570
  Name?: string;
3245
3571
  /**
3572
+ * @public
3246
3573
  * <p>The severity of the insight. For more information, see
3247
3574
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
3248
3575
  * insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
3249
3576
  */
3250
3577
  Severity?: InsightSeverity | string;
3251
3578
  /**
3579
+ * @public
3252
3580
  * <p>The status of the proactive insight. </p>
3253
3581
  */
3254
3582
  Status?: InsightStatus | string;
3255
3583
  /**
3584
+ * @public
3256
3585
  * <p> A time ranged that specifies when the observed behavior in an insight started and
3257
3586
  * ended. </p>
3258
3587
  */
3259
3588
  InsightTimeRange?: InsightTimeRange;
3260
3589
  /**
3590
+ * @public
3261
3591
  * <p> The time range during which anomalous behavior in a proactive anomaly or an insight
3262
3592
  * is expected to occur. </p>
3263
3593
  */
3264
3594
  PredictionTimeRange?: PredictionTimeRange;
3265
3595
  /**
3596
+ * @public
3266
3597
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3267
3598
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3268
3599
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3270,10 +3601,12 @@ export interface ProactiveInsightSummary {
3270
3601
  */
3271
3602
  ResourceCollection?: ResourceCollection;
3272
3603
  /**
3604
+ * @public
3273
3605
  * <p>A collection of the names of Amazon Web Services services.</p>
3274
3606
  */
3275
3607
  ServiceCollection?: ServiceCollection;
3276
3608
  /**
3609
+ * @public
3277
3610
  * <p>The Amazon Resource Names (ARNs)
3278
3611
  * of the Amazon Web Services resources that generated this insight.</p>
3279
3612
  */
@@ -3287,29 +3620,35 @@ export interface ProactiveInsightSummary {
3287
3620
  */
3288
3621
  export interface ReactiveInsightSummary {
3289
3622
  /**
3623
+ * @public
3290
3624
  * <p> The ID of a reactive summary. </p>
3291
3625
  */
3292
3626
  Id?: string;
3293
3627
  /**
3628
+ * @public
3294
3629
  * <p> The name of a reactive insight. </p>
3295
3630
  */
3296
3631
  Name?: string;
3297
3632
  /**
3633
+ * @public
3298
3634
  * <p>The severity of the insight. For more information, see
3299
3635
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
3300
3636
  * insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
3301
3637
  */
3302
3638
  Severity?: InsightSeverity | string;
3303
3639
  /**
3640
+ * @public
3304
3641
  * <p> The status of a reactive insight. </p>
3305
3642
  */
3306
3643
  Status?: InsightStatus | string;
3307
3644
  /**
3645
+ * @public
3308
3646
  * <p> A time ranged that specifies when the observed behavior in an insight started and
3309
3647
  * ended. </p>
3310
3648
  */
3311
3649
  InsightTimeRange?: InsightTimeRange;
3312
3650
  /**
3651
+ * @public
3313
3652
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3314
3653
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3315
3654
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3317,10 +3656,12 @@ export interface ReactiveInsightSummary {
3317
3656
  */
3318
3657
  ResourceCollection?: ResourceCollection;
3319
3658
  /**
3659
+ * @public
3320
3660
  * <p>A collection of the names of Amazon Web Services services.</p>
3321
3661
  */
3322
3662
  ServiceCollection?: ServiceCollection;
3323
3663
  /**
3664
+ * @public
3324
3665
  * <p>The Amazon Resource Names (ARNs)
3325
3666
  * of the Amazon Web Services resources that generated this insight.</p>
3326
3667
  */
@@ -3331,14 +3672,17 @@ export interface ReactiveInsightSummary {
3331
3672
  */
3332
3673
  export interface ListInsightsResponse {
3333
3674
  /**
3675
+ * @public
3334
3676
  * <p> The returned list of proactive insights. </p>
3335
3677
  */
3336
3678
  ProactiveInsights?: ProactiveInsightSummary[];
3337
3679
  /**
3680
+ * @public
3338
3681
  * <p> The returned list of reactive insights. </p>
3339
3682
  */
3340
3683
  ReactiveInsights?: ReactiveInsightSummary[];
3341
3684
  /**
3685
+ * @public
3342
3686
  * <p>The pagination token to use to retrieve
3343
3687
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3344
3688
  */
@@ -3401,12 +3745,14 @@ export type ResourceTypeFilter = (typeof ResourceTypeFilter)[keyof typeof Resour
3401
3745
  */
3402
3746
  export interface ListMonitoredResourcesFilters {
3403
3747
  /**
3748
+ * @public
3404
3749
  * <p>
3405
3750
  * The permission status of a resource.
3406
3751
  * </p>
3407
3752
  */
3408
3753
  ResourcePermission: ResourcePermission | string | undefined;
3409
3754
  /**
3755
+ * @public
3410
3756
  * <p>
3411
3757
  * The type of resource that you wish to retrieve, such as log groups.
3412
3758
  * </p>
@@ -3418,17 +3764,20 @@ export interface ListMonitoredResourcesFilters {
3418
3764
  */
3419
3765
  export interface ListMonitoredResourcesRequest {
3420
3766
  /**
3767
+ * @public
3421
3768
  * <p>
3422
3769
  * Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.
3423
3770
  * </p>
3424
3771
  */
3425
3772
  Filters?: ListMonitoredResourcesFilters;
3426
3773
  /**
3774
+ * @public
3427
3775
  * <p>The maximum number of results to return with a single call.
3428
3776
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3429
3777
  */
3430
3778
  MaxResults?: number;
3431
3779
  /**
3780
+ * @public
3432
3781
  * <p>The pagination token to use to retrieve
3433
3782
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3434
3783
  */
@@ -3442,30 +3791,35 @@ export interface ListMonitoredResourcesRequest {
3442
3791
  */
3443
3792
  export interface MonitoredResourceIdentifier {
3444
3793
  /**
3794
+ * @public
3445
3795
  * <p>
3446
3796
  * The name of the resource being monitored.
3447
3797
  * </p>
3448
3798
  */
3449
3799
  MonitoredResourceName?: string;
3450
3800
  /**
3801
+ * @public
3451
3802
  * <p>
3452
3803
  * The type of resource being monitored.
3453
3804
  * </p>
3454
3805
  */
3455
3806
  Type?: string;
3456
3807
  /**
3808
+ * @public
3457
3809
  * <p>
3458
3810
  * The permission status of a resource.
3459
3811
  * </p>
3460
3812
  */
3461
3813
  ResourcePermission?: ResourcePermission | string;
3462
3814
  /**
3815
+ * @public
3463
3816
  * <p>
3464
3817
  * The time at which DevOps Guru last updated this resource.
3465
3818
  * </p>
3466
3819
  */
3467
3820
  LastUpdated?: Date;
3468
3821
  /**
3822
+ * @public
3469
3823
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3470
3824
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3471
3825
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3478,12 +3832,14 @@ export interface MonitoredResourceIdentifier {
3478
3832
  */
3479
3833
  export interface ListMonitoredResourcesResponse {
3480
3834
  /**
3835
+ * @public
3481
3836
  * <p>
3482
3837
  * Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.
3483
3838
  * </p>
3484
3839
  */
3485
3840
  MonitoredResourceIdentifiers: MonitoredResourceIdentifier[] | undefined;
3486
3841
  /**
3842
+ * @public
3487
3843
  * <p>The pagination token to use to retrieve
3488
3844
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3489
3845
  */
@@ -3494,6 +3850,7 @@ export interface ListMonitoredResourcesResponse {
3494
3850
  */
3495
3851
  export interface ListNotificationChannelsRequest {
3496
3852
  /**
3853
+ * @public
3497
3854
  * <p>The pagination token to use to retrieve
3498
3855
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3499
3856
  */
@@ -3514,10 +3871,12 @@ export interface ListNotificationChannelsRequest {
3514
3871
  */
3515
3872
  export interface NotificationChannel {
3516
3873
  /**
3874
+ * @public
3517
3875
  * <p> The ID of a notification channel. </p>
3518
3876
  */
3519
3877
  Id?: string;
3520
3878
  /**
3879
+ * @public
3521
3880
  * <p> A <code>NotificationChannelConfig</code> object that contains information about
3522
3881
  * configured notification channels. </p>
3523
3882
  */
@@ -3528,10 +3887,12 @@ export interface NotificationChannel {
3528
3887
  */
3529
3888
  export interface ListNotificationChannelsResponse {
3530
3889
  /**
3890
+ * @public
3531
3891
  * <p> An array that contains the requested notification channels. </p>
3532
3892
  */
3533
3893
  Channels?: NotificationChannel[];
3534
3894
  /**
3895
+ * @public
3535
3896
  * <p>The pagination token to use to retrieve
3536
3897
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3537
3898
  */
@@ -3542,24 +3903,29 @@ export interface ListNotificationChannelsResponse {
3542
3903
  */
3543
3904
  export interface ListOrganizationInsightsRequest {
3544
3905
  /**
3906
+ * @public
3545
3907
  * <p> A filter used by <code>ListInsights</code> to specify which insights to return.
3546
3908
  * </p>
3547
3909
  */
3548
3910
  StatusFilter: ListInsightsStatusFilter | undefined;
3549
3911
  /**
3912
+ * @public
3550
3913
  * <p>The maximum number of results to return with a single call.
3551
3914
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3552
3915
  */
3553
3916
  MaxResults?: number;
3554
3917
  /**
3918
+ * @public
3555
3919
  * <p>The ID of the Amazon Web Services account. </p>
3556
3920
  */
3557
3921
  AccountIds?: string[];
3558
3922
  /**
3923
+ * @public
3559
3924
  * <p>The ID of the organizational unit.</p>
3560
3925
  */
3561
3926
  OrganizationalUnitIds?: string[];
3562
3927
  /**
3928
+ * @public
3563
3929
  * <p>The pagination token to use to retrieve
3564
3930
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3565
3931
  */
@@ -3572,22 +3938,27 @@ export interface ListOrganizationInsightsRequest {
3572
3938
  */
3573
3939
  export interface ProactiveOrganizationInsightSummary {
3574
3940
  /**
3941
+ * @public
3575
3942
  * <p>The ID of the insight summary.</p>
3576
3943
  */
3577
3944
  Id?: string;
3578
3945
  /**
3946
+ * @public
3579
3947
  * <p>The ID of the Amazon Web Services account.</p>
3580
3948
  */
3581
3949
  AccountId?: string;
3582
3950
  /**
3951
+ * @public
3583
3952
  * <p>The ID of the organizational unit.</p>
3584
3953
  */
3585
3954
  OrganizationalUnitId?: string;
3586
3955
  /**
3956
+ * @public
3587
3957
  * <p>The name of the insight summary.</p>
3588
3958
  */
3589
3959
  Name?: string;
3590
3960
  /**
3961
+ * @public
3591
3962
  * <p> An array of severity values used to search for insights.
3592
3963
  * For more information, see
3593
3964
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -3595,20 +3966,24 @@ export interface ProactiveOrganizationInsightSummary {
3595
3966
  */
3596
3967
  Severity?: InsightSeverity | string;
3597
3968
  /**
3969
+ * @public
3598
3970
  * <p> An array of status values used to search for insights. </p>
3599
3971
  */
3600
3972
  Status?: InsightStatus | string;
3601
3973
  /**
3974
+ * @public
3602
3975
  * <p> A time ranged that specifies when the observed behavior in an insight started and
3603
3976
  * ended. </p>
3604
3977
  */
3605
3978
  InsightTimeRange?: InsightTimeRange;
3606
3979
  /**
3980
+ * @public
3607
3981
  * <p> The time range during which anomalous behavior in a proactive anomaly or an insight
3608
3982
  * is expected to occur. </p>
3609
3983
  */
3610
3984
  PredictionTimeRange?: PredictionTimeRange;
3611
3985
  /**
3986
+ * @public
3612
3987
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3613
3988
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3614
3989
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3616,6 +3991,7 @@ export interface ProactiveOrganizationInsightSummary {
3616
3991
  */
3617
3992
  ResourceCollection?: ResourceCollection;
3618
3993
  /**
3994
+ * @public
3619
3995
  * <p>A collection of the names of Amazon Web Services services.</p>
3620
3996
  */
3621
3997
  ServiceCollection?: ServiceCollection;
@@ -3627,22 +4003,27 @@ export interface ProactiveOrganizationInsightSummary {
3627
4003
  */
3628
4004
  export interface ReactiveOrganizationInsightSummary {
3629
4005
  /**
4006
+ * @public
3630
4007
  * <p>The ID of the insight summary.</p>
3631
4008
  */
3632
4009
  Id?: string;
3633
4010
  /**
4011
+ * @public
3634
4012
  * <p>The ID of the Amazon Web Services account. </p>
3635
4013
  */
3636
4014
  AccountId?: string;
3637
4015
  /**
4016
+ * @public
3638
4017
  * <p>The ID of the organizational unit.</p>
3639
4018
  */
3640
4019
  OrganizationalUnitId?: string;
3641
4020
  /**
4021
+ * @public
3642
4022
  * <p>The name of the insight summary.</p>
3643
4023
  */
3644
4024
  Name?: string;
3645
4025
  /**
4026
+ * @public
3646
4027
  * <p> An array of severity values used to search for insights.
3647
4028
  * For more information, see
3648
4029
  * <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
@@ -3650,15 +4031,18 @@ export interface ReactiveOrganizationInsightSummary {
3650
4031
  */
3651
4032
  Severity?: InsightSeverity | string;
3652
4033
  /**
4034
+ * @public
3653
4035
  * <p> An array of status values used to search for insights. </p>
3654
4036
  */
3655
4037
  Status?: InsightStatus | string;
3656
4038
  /**
4039
+ * @public
3657
4040
  * <p> A time ranged that specifies when the observed behavior in an insight started and
3658
4041
  * ended. </p>
3659
4042
  */
3660
4043
  InsightTimeRange?: InsightTimeRange;
3661
4044
  /**
4045
+ * @public
3662
4046
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3663
4047
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3664
4048
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3666,6 +4050,7 @@ export interface ReactiveOrganizationInsightSummary {
3666
4050
  */
3667
4051
  ResourceCollection?: ResourceCollection;
3668
4052
  /**
4053
+ * @public
3669
4054
  * <p>A collection of the names of Amazon Web Services services.</p>
3670
4055
  */
3671
4056
  ServiceCollection?: ServiceCollection;
@@ -3675,16 +4060,19 @@ export interface ReactiveOrganizationInsightSummary {
3675
4060
  */
3676
4061
  export interface ListOrganizationInsightsResponse {
3677
4062
  /**
4063
+ * @public
3678
4064
  * <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
3679
4065
  * account.</p>
3680
4066
  */
3681
4067
  ProactiveInsights?: ProactiveOrganizationInsightSummary[];
3682
4068
  /**
4069
+ * @public
3683
4070
  * <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
3684
4071
  * account.</p>
3685
4072
  */
3686
4073
  ReactiveInsights?: ReactiveOrganizationInsightSummary[];
3687
4074
  /**
4075
+ * @public
3688
4076
  * <p>The pagination token to use to retrieve
3689
4077
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3690
4078
  */
@@ -3716,19 +4104,23 @@ export type Locale = (typeof Locale)[keyof typeof Locale];
3716
4104
  */
3717
4105
  export interface ListRecommendationsRequest {
3718
4106
  /**
4107
+ * @public
3719
4108
  * <p> The ID of the requested insight. </p>
3720
4109
  */
3721
4110
  InsightId: string | undefined;
3722
4111
  /**
4112
+ * @public
3723
4113
  * <p>The pagination token to use to retrieve
3724
4114
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3725
4115
  */
3726
4116
  NextToken?: string;
3727
4117
  /**
4118
+ * @public
3728
4119
  * <p>A locale that specifies the language to use for recommendations.</p>
3729
4120
  */
3730
4121
  Locale?: Locale | string;
3731
4122
  /**
4123
+ * @public
3732
4124
  * <p>The ID of the Amazon Web Services account. </p>
3733
4125
  */
3734
4126
  AccountId?: string;
@@ -3739,10 +4131,12 @@ export interface ListRecommendationsRequest {
3739
4131
  */
3740
4132
  export interface RecommendationRelatedAnomalyResource {
3741
4133
  /**
4134
+ * @public
3742
4135
  * <p> The name of the resource. </p>
3743
4136
  */
3744
4137
  Name?: string;
3745
4138
  /**
4139
+ * @public
3746
4140
  * <p> The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation
3747
4141
  * resource type identifiers, <code>service-provider::service-name::data-type-name</code>.
3748
4142
  * For example, <code>AWS::RDS::DBCluster</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services
@@ -3758,10 +4152,12 @@ export interface RecommendationRelatedAnomalyResource {
3758
4152
  */
3759
4153
  export interface RecommendationRelatedCloudWatchMetricsSourceDetail {
3760
4154
  /**
4155
+ * @public
3761
4156
  * <p>The name of the CloudWatch metric.</p>
3762
4157
  */
3763
4158
  MetricName?: string;
3764
4159
  /**
4160
+ * @public
3765
4161
  * <p>The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.</p>
3766
4162
  */
3767
4163
  Namespace?: string;
@@ -3773,6 +4169,7 @@ export interface RecommendationRelatedCloudWatchMetricsSourceDetail {
3773
4169
  */
3774
4170
  export interface RecommendationRelatedAnomalySourceDetail {
3775
4171
  /**
4172
+ * @public
3776
4173
  * <p> An array of <code>CloudWatchMetricsDetail</code> objects that contains information
3777
4174
  * about the analyzed metrics that displayed anomalous behavior. </p>
3778
4175
  */
@@ -3784,16 +4181,19 @@ export interface RecommendationRelatedAnomalySourceDetail {
3784
4181
  */
3785
4182
  export interface RecommendationRelatedAnomaly {
3786
4183
  /**
4184
+ * @public
3787
4185
  * <p> An array of objects that represent resources in which DevOps Guru detected anomalous
3788
4186
  * behavior. Each object contains the name and type of the resource. </p>
3789
4187
  */
3790
4188
  Resources?: RecommendationRelatedAnomalyResource[];
3791
4189
  /**
4190
+ * @public
3792
4191
  * <p> Information about where the anomalous behavior related the recommendation was found.
3793
4192
  * For example, details in Amazon CloudWatch metrics. </p>
3794
4193
  */
3795
4194
  SourceDetails?: RecommendationRelatedAnomalySourceDetail[];
3796
4195
  /**
4196
+ * @public
3797
4197
  * <p>The ID of an anomaly that generated the insight with this recommendation.</p>
3798
4198
  */
3799
4199
  AnomalyId?: string;
@@ -3805,11 +4205,13 @@ export interface RecommendationRelatedAnomaly {
3805
4205
  */
3806
4206
  export interface RecommendationRelatedEventResource {
3807
4207
  /**
4208
+ * @public
3808
4209
  * <p> The name of the resource that emitted the event. This corresponds to the
3809
4210
  * <code>Name</code> field in an <code>EventResource</code> object. </p>
3810
4211
  */
3811
4212
  Name?: string;
3812
4213
  /**
4214
+ * @public
3813
4215
  * <p> The type of the resource that emitted the event. This corresponds to the
3814
4216
  * <code>Type</code> field in an <code>EventResource</code> object. </p>
3815
4217
  */
@@ -3821,11 +4223,13 @@ export interface RecommendationRelatedEventResource {
3821
4223
  */
3822
4224
  export interface RecommendationRelatedEvent {
3823
4225
  /**
4226
+ * @public
3824
4227
  * <p> The name of the event. This corresponds to the <code>Name</code> field in an
3825
4228
  * <code>Event</code> object. </p>
3826
4229
  */
3827
4230
  Name?: string;
3828
4231
  /**
4232
+ * @public
3829
4233
  * <p> A <code>ResourceCollection</code> object that contains arrays of the names of Amazon Web Services
3830
4234
  * CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
3831
4235
  */
@@ -3838,32 +4242,39 @@ export interface RecommendationRelatedEvent {
3838
4242
  */
3839
4243
  export interface Recommendation {
3840
4244
  /**
4245
+ * @public
3841
4246
  * <p> A description of the problem. </p>
3842
4247
  */
3843
4248
  Description?: string;
3844
4249
  /**
4250
+ * @public
3845
4251
  * <p> A hyperlink to information to help you address the problem. </p>
3846
4252
  */
3847
4253
  Link?: string;
3848
4254
  /**
4255
+ * @public
3849
4256
  * <p> The name of the recommendation. </p>
3850
4257
  */
3851
4258
  Name?: string;
3852
4259
  /**
4260
+ * @public
3853
4261
  * <p> The reason DevOps Guru flagged the anomalous behavior as a problem. </p>
3854
4262
  */
3855
4263
  Reason?: string;
3856
4264
  /**
4265
+ * @public
3857
4266
  * <p> Events that are related to the problem. Use these events to learn more about what's
3858
4267
  * happening and to help address the issue. </p>
3859
4268
  */
3860
4269
  RelatedEvents?: RecommendationRelatedEvent[];
3861
4270
  /**
4271
+ * @public
3862
4272
  * <p> Anomalies that are related to the problem. Use these Anomalies to learn more about
3863
4273
  * what's happening and to help address the issue. </p>
3864
4274
  */
3865
4275
  RelatedAnomalies?: RecommendationRelatedAnomaly[];
3866
4276
  /**
4277
+ * @public
3867
4278
  * <p>The category type of the recommendation.</p>
3868
4279
  */
3869
4280
  Category?: string;
@@ -3873,10 +4284,12 @@ export interface Recommendation {
3873
4284
  */
3874
4285
  export interface ListRecommendationsResponse {
3875
4286
  /**
4287
+ * @public
3876
4288
  * <p> An array of the requested recommendations. </p>
3877
4289
  */
3878
4290
  Recommendations?: Recommendation[];
3879
4291
  /**
4292
+ * @public
3880
4293
  * <p>The pagination token to use to retrieve
3881
4294
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3882
4295
  */
@@ -3887,6 +4300,7 @@ export interface ListRecommendationsResponse {
3887
4300
  */
3888
4301
  export interface PutFeedbackRequest {
3889
4302
  /**
4303
+ * @public
3890
4304
  * <p> The feedback from customers is about the recommendations in this insight. </p>
3891
4305
  */
3892
4306
  InsightFeedback?: InsightFeedback;
@@ -3901,6 +4315,7 @@ export interface PutFeedbackResponse {
3901
4315
  */
3902
4316
  export interface RemoveNotificationChannelRequest {
3903
4317
  /**
4318
+ * @public
3904
4319
  * <p> The ID of the notification channel to be removed. </p>
3905
4320
  */
3906
4321
  Id: string | undefined;
@@ -3919,14 +4334,17 @@ export interface RemoveNotificationChannelResponse {
3919
4334
  */
3920
4335
  export interface SearchInsightsFilters {
3921
4336
  /**
4337
+ * @public
3922
4338
  * <p> An array of severity values used to search for insights. </p>
3923
4339
  */
3924
4340
  Severities?: (InsightSeverity | string)[];
3925
4341
  /**
4342
+ * @public
3926
4343
  * <p> An array of status values used to search for insights. </p>
3927
4344
  */
3928
4345
  Statuses?: (InsightStatus | string)[];
3929
4346
  /**
4347
+ * @public
3930
4348
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
3931
4349
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
3932
4350
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -3934,6 +4352,7 @@ export interface SearchInsightsFilters {
3934
4352
  */
3935
4353
  ResourceCollection?: ResourceCollection;
3936
4354
  /**
4355
+ * @public
3937
4356
  * <p>A collection of the names of Amazon Web Services services.</p>
3938
4357
  */
3939
4358
  ServiceCollection?: ServiceCollection;
@@ -3943,26 +4362,31 @@ export interface SearchInsightsFilters {
3943
4362
  */
3944
4363
  export interface SearchInsightsRequest {
3945
4364
  /**
4365
+ * @public
3946
4366
  * <p> The start of the time range passed in. Returned insights occurred after this time.
3947
4367
  * </p>
3948
4368
  */
3949
4369
  StartTimeRange: StartTimeRange | undefined;
3950
4370
  /**
4371
+ * @public
3951
4372
  * <p> A <code>SearchInsightsFilters</code> object that is used to set the severity and
3952
4373
  * status filters on your insight search. </p>
3953
4374
  */
3954
4375
  Filters?: SearchInsightsFilters;
3955
4376
  /**
4377
+ * @public
3956
4378
  * <p>The maximum number of results to return with a single call.
3957
4379
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3958
4380
  */
3959
4381
  MaxResults?: number;
3960
4382
  /**
4383
+ * @public
3961
4384
  * <p>The pagination token to use to retrieve
3962
4385
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
3963
4386
  */
3964
4387
  NextToken?: string;
3965
4388
  /**
4389
+ * @public
3966
4390
  * <p> The type of insights you are searching for (<code>REACTIVE</code> or
3967
4391
  * <code>PROACTIVE</code>). </p>
3968
4392
  */
@@ -3973,14 +4397,17 @@ export interface SearchInsightsRequest {
3973
4397
  */
3974
4398
  export interface SearchInsightsResponse {
3975
4399
  /**
4400
+ * @public
3976
4401
  * <p> The returned proactive insights. </p>
3977
4402
  */
3978
4403
  ProactiveInsights?: ProactiveInsightSummary[];
3979
4404
  /**
4405
+ * @public
3980
4406
  * <p> The returned reactive insights. </p>
3981
4407
  */
3982
4408
  ReactiveInsights?: ReactiveInsightSummary[];
3983
4409
  /**
4410
+ * @public
3984
4411
  * <p>The pagination token to use to retrieve
3985
4412
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
3986
4413
  */
@@ -3993,14 +4420,17 @@ export interface SearchInsightsResponse {
3993
4420
  */
3994
4421
  export interface SearchOrganizationInsightsFilters {
3995
4422
  /**
4423
+ * @public
3996
4424
  * <p> An array of severity values used to search for insights. </p>
3997
4425
  */
3998
4426
  Severities?: (InsightSeverity | string)[];
3999
4427
  /**
4428
+ * @public
4000
4429
  * <p> An array of status values used to search for insights. </p>
4001
4430
  */
4002
4431
  Statuses?: (InsightStatus | string)[];
4003
4432
  /**
4433
+ * @public
4004
4434
  * <p> A collection of Amazon Web Services resources supported by DevOps Guru.
4005
4435
  * The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
4006
4436
  * Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
@@ -4008,6 +4438,7 @@ export interface SearchOrganizationInsightsFilters {
4008
4438
  */
4009
4439
  ResourceCollection?: ResourceCollection;
4010
4440
  /**
4441
+ * @public
4011
4442
  * <p>A collection of the names of Amazon Web Services services.</p>
4012
4443
  */
4013
4444
  ServiceCollection?: ServiceCollection;
@@ -4017,30 +4448,36 @@ export interface SearchOrganizationInsightsFilters {
4017
4448
  */
4018
4449
  export interface SearchOrganizationInsightsRequest {
4019
4450
  /**
4451
+ * @public
4020
4452
  * <p>The ID of the Amazon Web Services account. </p>
4021
4453
  */
4022
4454
  AccountIds: string[] | undefined;
4023
4455
  /**
4456
+ * @public
4024
4457
  * <p> A time range used to specify when the behavior of an insight or anomaly started.
4025
4458
  * </p>
4026
4459
  */
4027
4460
  StartTimeRange: StartTimeRange | undefined;
4028
4461
  /**
4462
+ * @public
4029
4463
  * <p> A <code>SearchOrganizationInsightsFilters</code> object that is used to set the
4030
4464
  * severity and status filters on your insight search. </p>
4031
4465
  */
4032
4466
  Filters?: SearchOrganizationInsightsFilters;
4033
4467
  /**
4468
+ * @public
4034
4469
  * <p>The maximum number of results to return with a single call.
4035
4470
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
4036
4471
  */
4037
4472
  MaxResults?: number;
4038
4473
  /**
4474
+ * @public
4039
4475
  * <p>The pagination token to use to retrieve
4040
4476
  * the next page of results for this operation. If this value is null, it retrieves the first page.</p>
4041
4477
  */
4042
4478
  NextToken?: string;
4043
4479
  /**
4480
+ * @public
4044
4481
  * <p> The type of insights you are searching for (<code>REACTIVE</code> or
4045
4482
  * <code>PROACTIVE</code>). </p>
4046
4483
  */
@@ -4051,16 +4488,19 @@ export interface SearchOrganizationInsightsRequest {
4051
4488
  */
4052
4489
  export interface SearchOrganizationInsightsResponse {
4053
4490
  /**
4491
+ * @public
4054
4492
  * <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
4055
4493
  * account.</p>
4056
4494
  */
4057
4495
  ProactiveInsights?: ProactiveInsightSummary[];
4058
4496
  /**
4497
+ * @public
4059
4498
  * <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
4060
4499
  * account.</p>
4061
4500
  */
4062
4501
  ReactiveInsights?: ReactiveInsightSummary[];
4063
4502
  /**
4503
+ * @public
4064
4504
  * <p>The pagination token to use to retrieve
4065
4505
  * the next page of results for this operation. If there are no more pages, this value is null.</p>
4066
4506
  */
@@ -4071,10 +4511,12 @@ export interface SearchOrganizationInsightsResponse {
4071
4511
  */
4072
4512
  export interface StartCostEstimationRequest {
4073
4513
  /**
4514
+ * @public
4074
4515
  * <p>The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.</p>
4075
4516
  */
4076
4517
  ResourceCollection: CostEstimationResourceCollectionFilter | undefined;
4077
4518
  /**
4519
+ * @public
4078
4520
  * <p>The idempotency token used to identify each cost estimate request.</p>
4079
4521
  */
4080
4522
  ClientToken?: string;
@@ -4089,6 +4531,7 @@ export interface StartCostEstimationResponse {
4089
4531
  */
4090
4532
  export interface UpdateEventSourcesConfigRequest {
4091
4533
  /**
4534
+ * @public
4092
4535
  * <p>Configuration information about the integration of DevOps Guru as the Consumer via
4093
4536
  * EventBridge with another AWS Service.</p>
4094
4537
  */
@@ -4118,6 +4561,7 @@ export type UpdateResourceCollectionAction = (typeof UpdateResourceCollectionAct
4118
4561
  */
4119
4562
  export interface UpdateCloudFormationCollectionFilter {
4120
4563
  /**
4564
+ * @public
4121
4565
  * <p> An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.
4122
4566
  * </p>
4123
4567
  */
@@ -4130,6 +4574,7 @@ export interface UpdateCloudFormationCollectionFilter {
4130
4574
  */
4131
4575
  export interface UpdateTagCollectionFilter {
4132
4576
  /**
4577
+ * @public
4133
4578
  * <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
4134
4579
  * DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
4135
4580
  * up your DevOps Guru application and analysis boundary.</p>
@@ -4147,6 +4592,7 @@ export interface UpdateTagCollectionFilter {
4147
4592
  */
4148
4593
  AppBoundaryKey: string | undefined;
4149
4594
  /**
4595
+ * @public
4150
4596
  * <p>The values in an Amazon Web Services tag collection.</p>
4151
4597
  * <p>The tag's <i>value</i> is an optional field used to associate a string with
4152
4598
  * the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
@@ -4163,10 +4609,12 @@ export interface UpdateTagCollectionFilter {
4163
4609
  */
4164
4610
  export interface UpdateResourceCollectionFilter {
4165
4611
  /**
4612
+ * @public
4166
4613
  * <p> A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
4167
4614
  */
4168
4615
  CloudFormation?: UpdateCloudFormationCollectionFilter;
4169
4616
  /**
4617
+ * @public
4170
4618
  * <p>The updated Amazon Web Services tags used to filter the resources in the resource collection.</p>
4171
4619
  * <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
4172
4620
  * tagging, so you can assign the same tag to resources from different services to indicate
@@ -4209,11 +4657,13 @@ export interface UpdateResourceCollectionFilter {
4209
4657
  */
4210
4658
  export interface UpdateResourceCollectionRequest {
4211
4659
  /**
4660
+ * @public
4212
4661
  * <p> Specifies if the resource collection in the request is added or deleted to the
4213
4662
  * resource collection. </p>
4214
4663
  */
4215
4664
  Action: UpdateResourceCollectionAction | string | undefined;
4216
4665
  /**
4666
+ * @public
4217
4667
  * <p> Contains information used to update a collection of Amazon Web Services resources. </p>
4218
4668
  */
4219
4669
  ResourceCollection: UpdateResourceCollectionFilter | undefined;
@@ -4231,6 +4681,7 @@ export interface UpdateResourceCollectionResponse {
4231
4681
  */
4232
4682
  export interface KMSServerSideEncryptionIntegrationConfig {
4233
4683
  /**
4684
+ * @public
4234
4685
  * <p>
4235
4686
  * Describes the specified KMS key.</p>
4236
4687
  * <p>To specify a KMS key, use its key ID, key ARN,
@@ -4247,12 +4698,14 @@ export interface KMSServerSideEncryptionIntegrationConfig {
4247
4698
  */
4248
4699
  KMSKeyId?: string;
4249
4700
  /**
4701
+ * @public
4250
4702
  * <p>
4251
4703
  * Specifies if DevOps Guru is enabled for KMS integration.
4252
4704
  * </p>
4253
4705
  */
4254
4706
  OptInStatus?: OptInStatus | string;
4255
4707
  /**
4708
+ * @public
4256
4709
  * <p>
4257
4710
  * The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.
4258
4711
  * </p>
@@ -4267,6 +4720,7 @@ export interface KMSServerSideEncryptionIntegrationConfig {
4267
4720
  */
4268
4721
  export interface LogsAnomalyDetectionIntegrationConfig {
4269
4722
  /**
4723
+ * @public
4270
4724
  * <p>Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.</p>
4271
4725
  */
4272
4726
  OptInStatus?: OptInStatus | string;
@@ -4278,6 +4732,7 @@ export interface LogsAnomalyDetectionIntegrationConfig {
4278
4732
  */
4279
4733
  export interface OpsCenterIntegrationConfig {
4280
4734
  /**
4735
+ * @public
4281
4736
  * <p> Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created
4282
4737
  * insight. </p>
4283
4738
  */
@@ -4290,17 +4745,20 @@ export interface OpsCenterIntegrationConfig {
4290
4745
  */
4291
4746
  export interface UpdateServiceIntegrationConfig {
4292
4747
  /**
4748
+ * @public
4293
4749
  * <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
4294
4750
  * OpsCenter for each created insight. You can use this to update the configuration.</p>
4295
4751
  */
4296
4752
  OpsCenter?: OpsCenterIntegrationConfig;
4297
4753
  /**
4754
+ * @public
4298
4755
  * <p>
4299
4756
  * Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.
4300
4757
  * </p>
4301
4758
  */
4302
4759
  LogsAnomalyDetection?: LogsAnomalyDetectionIntegrationConfig;
4303
4760
  /**
4761
+ * @public
4304
4762
  * <p>
4305
4763
  * Information about whether DevOps Guru is configured to encrypt server-side data using KMS.
4306
4764
  * </p>
@@ -4312,6 +4770,7 @@ export interface UpdateServiceIntegrationConfig {
4312
4770
  */
4313
4771
  export interface UpdateServiceIntegrationRequest {
4314
4772
  /**
4773
+ * @public
4315
4774
  * <p> An <code>IntegratedServiceConfig</code> object used to specify the integrated service
4316
4775
  * you want to update, and whether you want to update it to enabled or disabled. </p>
4317
4776
  */