@aws-sdk/client-application-insights 3.380.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,14 +50,17 @@ export type Tier = (typeof Tier)[keyof typeof Tier];
50
50
  */
51
51
  export interface WorkloadConfiguration {
52
52
  /**
53
+ * @public
53
54
  * <p>The name of the workload.</p>
54
55
  */
55
56
  WorkloadName?: string;
56
57
  /**
58
+ * @public
57
59
  * <p>The configuration of the workload tier.</p>
58
60
  */
59
61
  Tier?: Tier | string;
60
62
  /**
63
+ * @public
61
64
  * <p>The configuration settings of the workload.</p>
62
65
  */
63
66
  Configuration?: string;
@@ -67,14 +70,17 @@ export interface WorkloadConfiguration {
67
70
  */
68
71
  export interface AddWorkloadRequest {
69
72
  /**
73
+ * @public
70
74
  * <p>The name of the resource group.</p>
71
75
  */
72
76
  ResourceGroupName: string | undefined;
73
77
  /**
78
+ * @public
74
79
  * <p>The name of the component.</p>
75
80
  */
76
81
  ComponentName: string | undefined;
77
82
  /**
83
+ * @public
78
84
  * <p>The configuration settings of the workload. The value is the escaped JSON of the configuration.</p>
79
85
  */
80
86
  WorkloadConfiguration: WorkloadConfiguration | undefined;
@@ -84,10 +90,12 @@ export interface AddWorkloadRequest {
84
90
  */
85
91
  export interface AddWorkloadResponse {
86
92
  /**
93
+ * @public
87
94
  * <p>The ID of the workload.</p>
88
95
  */
89
96
  WorkloadId?: string;
90
97
  /**
98
+ * @public
91
99
  * <p>The configuration settings of the workload. The value is the escaped JSON of the configuration.</p>
92
100
  */
93
101
  WorkloadConfiguration?: WorkloadConfiguration;
@@ -163,32 +171,39 @@ export type OsType = (typeof OsType)[keyof typeof OsType];
163
171
  */
164
172
  export interface ApplicationComponent {
165
173
  /**
174
+ * @public
166
175
  * <p>The name of the component.</p>
167
176
  */
168
177
  ComponentName?: string;
169
178
  /**
179
+ * @public
170
180
  * <p> If logging is supported for the resource type, indicates whether the component has
171
181
  * configured logs to be monitored. </p>
172
182
  */
173
183
  ComponentRemarks?: string;
174
184
  /**
185
+ * @public
175
186
  * <p>The resource type. Supported resource types include EC2 instances, Auto Scaling group,
176
187
  * Classic ELB, Application ELB, and SQS Queue.</p>
177
188
  */
178
189
  ResourceType?: string;
179
190
  /**
191
+ * @public
180
192
  * <p> The operating system of the component. </p>
181
193
  */
182
194
  OsType?: OsType | string;
183
195
  /**
196
+ * @public
184
197
  * <p>The stack tier of the application component.</p>
185
198
  */
186
199
  Tier?: Tier | string;
187
200
  /**
201
+ * @public
188
202
  * <p>Indicates whether the application component is monitored. </p>
189
203
  */
190
204
  Monitor?: boolean;
191
205
  /**
206
+ * @public
192
207
  * <p> Workloads detected in the application component. </p>
193
208
  */
194
209
  DetectedWorkload?: Record<string, Record<string, string>>;
@@ -211,34 +226,41 @@ export type DiscoveryType = (typeof DiscoveryType)[keyof typeof DiscoveryType];
211
226
  */
212
227
  export interface ApplicationInfo {
213
228
  /**
229
+ * @public
214
230
  * <p>The AWS account ID for the owner of the application.</p>
215
231
  */
216
232
  AccountId?: string;
217
233
  /**
234
+ * @public
218
235
  * <p>The name of the resource group used for the application.</p>
219
236
  */
220
237
  ResourceGroupName?: string;
221
238
  /**
239
+ * @public
222
240
  * <p>The lifecycle of the application. </p>
223
241
  */
224
242
  LifeCycle?: string;
225
243
  /**
244
+ * @public
226
245
  * <p> The SNS topic provided to Application Insights that is associated to the created
227
246
  * opsItems to receive SNS notifications for opsItem updates. </p>
228
247
  */
229
248
  OpsItemSNSTopicArn?: string;
230
249
  /**
250
+ * @public
231
251
  * <p> Indicates whether Application Insights will create opsItems for any problem detected by
232
252
  * Application Insights for an application. </p>
233
253
  */
234
254
  OpsCenterEnabled?: boolean;
235
255
  /**
256
+ * @public
236
257
  * <p> Indicates whether Application Insights can listen to CloudWatch events for the
237
258
  * application resources, such as <code>instance terminated</code>, <code>failed
238
259
  * deployment</code>, and others. </p>
239
260
  */
240
261
  CWEMonitorEnabled?: boolean;
241
262
  /**
263
+ * @public
242
264
  * <p>The issues on the user side that block Application Insights from successfully monitoring
243
265
  * an application. Example remarks include:</p>
244
266
  * <ul>
@@ -252,10 +274,12 @@ export interface ApplicationInfo {
252
274
  */
253
275
  Remarks?: string;
254
276
  /**
277
+ * @public
255
278
  * <p> Indicates whether auto-configuration is turned on for this application. </p>
256
279
  */
257
280
  AutoConfigEnabled?: boolean;
258
281
  /**
282
+ * @public
259
283
  * <p> The method used by Application Insights to onboard your resources. </p>
260
284
  */
261
285
  DiscoveryType?: DiscoveryType | string;
@@ -320,36 +344,44 @@ export type ConfigurationEventStatus = (typeof ConfigurationEventStatus)[keyof t
320
344
  */
321
345
  export interface ConfigurationEvent {
322
346
  /**
347
+ * @public
323
348
  * <p>The name of the resource group of the application to which the configuration event belongs.</p>
324
349
  */
325
350
  ResourceGroupName?: string;
326
351
  /**
352
+ * @public
327
353
  * <p>The AWS account ID for the owner of the application to which the configuration event belongs.</p>
328
354
  */
329
355
  AccountId?: string;
330
356
  /**
357
+ * @public
331
358
  * <p> The resource monitored by Application Insights. </p>
332
359
  */
333
360
  MonitoredResourceARN?: string;
334
361
  /**
362
+ * @public
335
363
  * <p> The status of the configuration update event. Possible values include INFO, WARN, and
336
364
  * ERROR. </p>
337
365
  */
338
366
  EventStatus?: ConfigurationEventStatus | string;
339
367
  /**
368
+ * @public
340
369
  * <p> The resource type that Application Insights attempted to configure, for example,
341
370
  * CLOUDWATCH_ALARM. </p>
342
371
  */
343
372
  EventResourceType?: ConfigurationEventResourceType | string;
344
373
  /**
374
+ * @public
345
375
  * <p> The timestamp of the event. </p>
346
376
  */
347
377
  EventTime?: Date;
348
378
  /**
379
+ * @public
349
380
  * <p> The details of the event in plain text. </p>
350
381
  */
351
382
  EventDetail?: string;
352
383
  /**
384
+ * @public
353
385
  * <p> The name of the resource Application Insights attempted to configure. </p>
354
386
  */
355
387
  EventResourceName?: string;
@@ -395,11 +427,13 @@ export type GroupingType = (typeof GroupingType)[keyof typeof GroupingType];
395
427
  */
396
428
  export interface Tag {
397
429
  /**
430
+ * @public
398
431
  * <p>One part of a key-value pair that defines a tag. The maximum length of a tag key is 128
399
432
  * characters. The minimum length is 1 character.</p>
400
433
  */
401
434
  Key: string | undefined;
402
435
  /**
436
+ * @public
403
437
  * <p>The optional part of a key-value pair that defines a tag. The maximum length of a tag
404
438
  * value is 256 characters. The minimum length is 0 characters. If you don't want an
405
439
  * application to have a specific tag value, don't specify a value for this parameter.</p>
@@ -411,42 +445,50 @@ export interface Tag {
411
445
  */
412
446
  export interface CreateApplicationRequest {
413
447
  /**
448
+ * @public
414
449
  * <p>The name of the resource group.</p>
415
450
  */
416
451
  ResourceGroupName?: string;
417
452
  /**
453
+ * @public
418
454
  * <p> When set to <code>true</code>, creates opsItems for any problems detected on an
419
455
  * application. </p>
420
456
  */
421
457
  OpsCenterEnabled?: boolean;
422
458
  /**
459
+ * @public
423
460
  * <p> Indicates whether Application Insights can listen to CloudWatch events for the
424
461
  * application resources, such as <code>instance terminated</code>, <code>failed
425
462
  * deployment</code>, and others. </p>
426
463
  */
427
464
  CWEMonitorEnabled?: boolean;
428
465
  /**
466
+ * @public
429
467
  * <p> The SNS topic provided to Application Insights that is associated to the created
430
468
  * opsItem. Allows you to receive notifications for updates to the opsItem. </p>
431
469
  */
432
470
  OpsItemSNSTopicArn?: string;
433
471
  /**
472
+ * @public
434
473
  * <p>List of tags to add to the application. tag key (<code>Key</code>) and an associated tag
435
474
  * value (<code>Value</code>). The maximum length of a tag key is 128 characters. The maximum
436
475
  * length of a tag value is 256 characters.</p>
437
476
  */
438
477
  Tags?: Tag[];
439
478
  /**
479
+ * @public
440
480
  * <p> Indicates whether Application Insights automatically configures unmonitored resources
441
481
  * in the resource group. </p>
442
482
  */
443
483
  AutoConfigEnabled?: boolean;
444
484
  /**
485
+ * @public
445
486
  * <p> Configures all of the resources in the resource group by applying the recommended
446
487
  * configurations. </p>
447
488
  */
448
489
  AutoCreate?: boolean;
449
490
  /**
491
+ * @public
450
492
  * <p>Application Insights can create applications based on a resource group or on an account.
451
493
  * To create an account-based application using all of the resources in the account, set this
452
494
  * parameter to <code>ACCOUNT_BASED</code>. </p>
@@ -458,6 +500,7 @@ export interface CreateApplicationRequest {
458
500
  */
459
501
  export interface CreateApplicationResponse {
460
502
  /**
503
+ * @public
461
504
  * <p>Information about the application.</p>
462
505
  */
463
506
  ApplicationInfo?: ApplicationInfo;
@@ -480,14 +523,17 @@ export declare class TagsAlreadyExistException extends __BaseException {
480
523
  */
481
524
  export interface CreateComponentRequest {
482
525
  /**
526
+ * @public
483
527
  * <p>The name of the resource group.</p>
484
528
  */
485
529
  ResourceGroupName: string | undefined;
486
530
  /**
531
+ * @public
487
532
  * <p>The name of the component.</p>
488
533
  */
489
534
  ComponentName: string | undefined;
490
535
  /**
536
+ * @public
491
537
  * <p>The list of resource ARNs that belong to the component.</p>
492
538
  */
493
539
  ResourceList: string[] | undefined;
@@ -502,23 +548,28 @@ export interface CreateComponentResponse {
502
548
  */
503
549
  export interface CreateLogPatternRequest {
504
550
  /**
551
+ * @public
505
552
  * <p>The name of the resource group.</p>
506
553
  */
507
554
  ResourceGroupName: string | undefined;
508
555
  /**
556
+ * @public
509
557
  * <p>The name of the log pattern set.</p>
510
558
  */
511
559
  PatternSetName: string | undefined;
512
560
  /**
561
+ * @public
513
562
  * <p>The name of the log pattern.</p>
514
563
  */
515
564
  PatternName: string | undefined;
516
565
  /**
566
+ * @public
517
567
  * <p>The log pattern. The pattern must be DFA compatible. Patterns that utilize forward
518
568
  * lookahead or backreference constructions are not supported.</p>
519
569
  */
520
570
  Pattern: string | undefined;
521
571
  /**
572
+ * @public
522
573
  * <p>Rank of the log pattern. Must be a value between <code>1</code> and
523
574
  * <code>1,000,000</code>. The patterns are sorted by rank, so we recommend that you set
524
575
  * your highest priority patterns with the lowest rank. A pattern of rank <code>1</code> will
@@ -539,24 +590,28 @@ export interface CreateLogPatternRequest {
539
590
  */
540
591
  export interface LogPattern {
541
592
  /**
593
+ * @public
542
594
  * <p>The name of the log pattern. A log pattern name can contain as many as 30 characters,
543
595
  * and it cannot be empty. The characters can be Unicode letters, digits, or one of the
544
596
  * following symbols: period, dash, underscore.</p>
545
597
  */
546
598
  PatternSetName?: string;
547
599
  /**
600
+ * @public
548
601
  * <p>The name of the log pattern. A log pattern name can contain as many as 50 characters,
549
602
  * and it cannot be empty. The characters can be Unicode letters, digits, or one of the
550
603
  * following symbols: period, dash, underscore.</p>
551
604
  */
552
605
  PatternName?: string;
553
606
  /**
607
+ * @public
554
608
  * <p>A regular expression that defines the log pattern. A log pattern can contain as many as
555
609
  * 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that
556
610
  * utilize forward lookahead or backreference constructions are not supported.</p>
557
611
  */
558
612
  Pattern?: string;
559
613
  /**
614
+ * @public
560
615
  * <p>Rank of the log pattern. Must be a value between <code>1</code> and
561
616
  * <code>1,000,000</code>. The patterns are sorted by rank, so we recommend that you set
562
617
  * your highest priority patterns with the lowest rank. A pattern of rank <code>1</code> will
@@ -575,10 +630,12 @@ export interface LogPattern {
575
630
  */
576
631
  export interface CreateLogPatternResponse {
577
632
  /**
633
+ * @public
578
634
  * <p>The successfully created log pattern.</p>
579
635
  */
580
636
  LogPattern?: LogPattern;
581
637
  /**
638
+ * @public
582
639
  * <p>The name of the resource group.</p>
583
640
  */
584
641
  ResourceGroupName?: string;
@@ -588,6 +645,7 @@ export interface CreateLogPatternResponse {
588
645
  */
589
646
  export interface DeleteApplicationRequest {
590
647
  /**
648
+ * @public
591
649
  * <p>The name of the resource group.</p>
592
650
  */
593
651
  ResourceGroupName: string | undefined;
@@ -602,10 +660,12 @@ export interface DeleteApplicationResponse {
602
660
  */
603
661
  export interface DeleteComponentRequest {
604
662
  /**
663
+ * @public
605
664
  * <p>The name of the resource group.</p>
606
665
  */
607
666
  ResourceGroupName: string | undefined;
608
667
  /**
668
+ * @public
609
669
  * <p>The name of the component.</p>
610
670
  */
611
671
  ComponentName: string | undefined;
@@ -620,14 +680,17 @@ export interface DeleteComponentResponse {
620
680
  */
621
681
  export interface DeleteLogPatternRequest {
622
682
  /**
683
+ * @public
623
684
  * <p>The name of the resource group.</p>
624
685
  */
625
686
  ResourceGroupName: string | undefined;
626
687
  /**
688
+ * @public
627
689
  * <p>The name of the log pattern set.</p>
628
690
  */
629
691
  PatternSetName: string | undefined;
630
692
  /**
693
+ * @public
631
694
  * <p>The name of the log pattern.</p>
632
695
  */
633
696
  PatternName: string | undefined;
@@ -642,10 +705,12 @@ export interface DeleteLogPatternResponse {
642
705
  */
643
706
  export interface DescribeApplicationRequest {
644
707
  /**
708
+ * @public
645
709
  * <p>The name of the resource group.</p>
646
710
  */
647
711
  ResourceGroupName: string | undefined;
648
712
  /**
713
+ * @public
649
714
  * <p>The AWS account ID for the resource group owner.</p>
650
715
  */
651
716
  AccountId?: string;
@@ -655,6 +720,7 @@ export interface DescribeApplicationRequest {
655
720
  */
656
721
  export interface DescribeApplicationResponse {
657
722
  /**
723
+ * @public
658
724
  * <p>Information about the application.</p>
659
725
  */
660
726
  ApplicationInfo?: ApplicationInfo;
@@ -664,14 +730,17 @@ export interface DescribeApplicationResponse {
664
730
  */
665
731
  export interface DescribeComponentRequest {
666
732
  /**
733
+ * @public
667
734
  * <p>The name of the resource group.</p>
668
735
  */
669
736
  ResourceGroupName: string | undefined;
670
737
  /**
738
+ * @public
671
739
  * <p>The name of the component.</p>
672
740
  */
673
741
  ComponentName: string | undefined;
674
742
  /**
743
+ * @public
675
744
  * <p>The AWS account ID for the resource group owner.</p>
676
745
  */
677
746
  AccountId?: string;
@@ -681,11 +750,13 @@ export interface DescribeComponentRequest {
681
750
  */
682
751
  export interface DescribeComponentResponse {
683
752
  /**
753
+ * @public
684
754
  * <p>Describes a standalone resource or similarly grouped resources that the application is
685
755
  * made up of.</p>
686
756
  */
687
757
  ApplicationComponent?: ApplicationComponent;
688
758
  /**
759
+ * @public
689
760
  * <p>The list of resource ARNs that belong to the component.</p>
690
761
  */
691
762
  ResourceList?: string[];
@@ -695,14 +766,17 @@ export interface DescribeComponentResponse {
695
766
  */
696
767
  export interface DescribeComponentConfigurationRequest {
697
768
  /**
769
+ * @public
698
770
  * <p>The name of the resource group.</p>
699
771
  */
700
772
  ResourceGroupName: string | undefined;
701
773
  /**
774
+ * @public
702
775
  * <p>The name of the component.</p>
703
776
  */
704
777
  ComponentName: string | undefined;
705
778
  /**
779
+ * @public
706
780
  * <p>The AWS account ID for the resource group owner.</p>
707
781
  */
708
782
  AccountId?: string;
@@ -712,10 +786,12 @@ export interface DescribeComponentConfigurationRequest {
712
786
  */
713
787
  export interface DescribeComponentConfigurationResponse {
714
788
  /**
789
+ * @public
715
790
  * <p>Indicates whether the application component is monitored.</p>
716
791
  */
717
792
  Monitor?: boolean;
718
793
  /**
794
+ * @public
719
795
  * <p>The tier of the application component. Supported tiers include
720
796
  * <code>DOT_NET_CORE</code>, <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB</code>,
721
797
  * <code>SQL_SERVER</code>, and <code>DEFAULT</code>
@@ -723,6 +799,7 @@ export interface DescribeComponentConfigurationResponse {
723
799
  */
724
800
  Tier?: Tier | string;
725
801
  /**
802
+ * @public
726
803
  * <p>The configuration settings of the component. The value is the escaped JSON of the
727
804
  * configuration.</p>
728
805
  */
@@ -746,18 +823,22 @@ export type RecommendationType = (typeof RecommendationType)[keyof typeof Recomm
746
823
  */
747
824
  export interface DescribeComponentConfigurationRecommendationRequest {
748
825
  /**
826
+ * @public
749
827
  * <p>The name of the resource group.</p>
750
828
  */
751
829
  ResourceGroupName: string | undefined;
752
830
  /**
831
+ * @public
753
832
  * <p>The name of the component.</p>
754
833
  */
755
834
  ComponentName: string | undefined;
756
835
  /**
836
+ * @public
757
837
  * <p>The tier of the application component.</p>
758
838
  */
759
839
  Tier: Tier | string | undefined;
760
840
  /**
841
+ * @public
761
842
  * <p>The recommended configuration type.</p>
762
843
  */
763
844
  RecommendationType?: RecommendationType | string;
@@ -767,6 +848,7 @@ export interface DescribeComponentConfigurationRecommendationRequest {
767
848
  */
768
849
  export interface DescribeComponentConfigurationRecommendationResponse {
769
850
  /**
851
+ * @public
770
852
  * <p>The recommended configuration settings of the component. The value is the escaped JSON
771
853
  * of the configuration.</p>
772
854
  */
@@ -777,18 +859,22 @@ export interface DescribeComponentConfigurationRecommendationResponse {
777
859
  */
778
860
  export interface DescribeLogPatternRequest {
779
861
  /**
862
+ * @public
780
863
  * <p>The name of the resource group.</p>
781
864
  */
782
865
  ResourceGroupName: string | undefined;
783
866
  /**
867
+ * @public
784
868
  * <p>The name of the log pattern set.</p>
785
869
  */
786
870
  PatternSetName: string | undefined;
787
871
  /**
872
+ * @public
788
873
  * <p>The name of the log pattern.</p>
789
874
  */
790
875
  PatternName: string | undefined;
791
876
  /**
877
+ * @public
792
878
  * <p>The AWS account ID for the resource group owner.</p>
793
879
  */
794
880
  AccountId?: string;
@@ -798,14 +884,17 @@ export interface DescribeLogPatternRequest {
798
884
  */
799
885
  export interface DescribeLogPatternResponse {
800
886
  /**
887
+ * @public
801
888
  * <p>The name of the resource group.</p>
802
889
  */
803
890
  ResourceGroupName?: string;
804
891
  /**
892
+ * @public
805
893
  * <p>The AWS account ID for the resource group owner.</p>
806
894
  */
807
895
  AccountId?: string;
808
896
  /**
897
+ * @public
809
898
  * <p>The successfully created log pattern.</p>
810
899
  */
811
900
  LogPattern?: LogPattern;
@@ -815,10 +904,12 @@ export interface DescribeLogPatternResponse {
815
904
  */
816
905
  export interface DescribeObservationRequest {
817
906
  /**
907
+ * @public
818
908
  * <p>The ID of the observation.</p>
819
909
  */
820
910
  ObservationId: string | undefined;
821
911
  /**
912
+ * @public
822
913
  * <p>The AWS account ID for the resource group owner.</p>
823
914
  */
824
915
  AccountId?: string;
@@ -842,193 +933,238 @@ export type LogFilter = (typeof LogFilter)[keyof typeof LogFilter];
842
933
  */
843
934
  export interface Observation {
844
935
  /**
936
+ * @public
845
937
  * <p>The ID of the observation type.</p>
846
938
  */
847
939
  Id?: string;
848
940
  /**
941
+ * @public
849
942
  * <p>The time when the observation was first detected, in epoch seconds.</p>
850
943
  */
851
944
  StartTime?: Date;
852
945
  /**
946
+ * @public
853
947
  * <p>The time when the observation ended, in epoch seconds.</p>
854
948
  */
855
949
  EndTime?: Date;
856
950
  /**
951
+ * @public
857
952
  * <p>The source type of the observation.</p>
858
953
  */
859
954
  SourceType?: string;
860
955
  /**
956
+ * @public
861
957
  * <p>The source resource ARN of the observation.</p>
862
958
  */
863
959
  SourceARN?: string;
864
960
  /**
961
+ * @public
865
962
  * <p>The log group name.</p>
866
963
  */
867
964
  LogGroup?: string;
868
965
  /**
966
+ * @public
869
967
  * <p>The timestamp in the CloudWatch Logs that specifies when the matched line
870
968
  * occurred.</p>
871
969
  */
872
970
  LineTime?: Date;
873
971
  /**
972
+ * @public
874
973
  * <p>The log text of the observation.</p>
875
974
  */
876
975
  LogText?: string;
877
976
  /**
977
+ * @public
878
978
  * <p>The log filter of the observation.</p>
879
979
  */
880
980
  LogFilter?: LogFilter | string;
881
981
  /**
982
+ * @public
882
983
  * <p>The namespace of the observation metric.</p>
883
984
  */
884
985
  MetricNamespace?: string;
885
986
  /**
987
+ * @public
886
988
  * <p>The name of the observation metric.</p>
887
989
  */
888
990
  MetricName?: string;
889
991
  /**
992
+ * @public
890
993
  * <p>The unit of the source observation metric.</p>
891
994
  */
892
995
  Unit?: string;
893
996
  /**
997
+ * @public
894
998
  * <p>The value of the source observation metric.</p>
895
999
  */
896
1000
  Value?: number;
897
1001
  /**
1002
+ * @public
898
1003
  * <p> The ID of the CloudWatch Event-based observation related to the detected problem.
899
1004
  * </p>
900
1005
  */
901
1006
  CloudWatchEventId?: string;
902
1007
  /**
1008
+ * @public
903
1009
  * <p> The source of the CloudWatch Event. </p>
904
1010
  */
905
1011
  CloudWatchEventSource?: CloudWatchEventSource | string;
906
1012
  /**
1013
+ * @public
907
1014
  * <p> The detail type of the CloudWatch Event-based observation, for example, <code>EC2
908
1015
  * Instance State-change Notification</code>. </p>
909
1016
  */
910
1017
  CloudWatchEventDetailType?: string;
911
1018
  /**
1019
+ * @public
912
1020
  * <p> The Amazon Resource Name (ARN) of the AWS Health Event-based observation.</p>
913
1021
  */
914
1022
  HealthEventArn?: string;
915
1023
  /**
1024
+ * @public
916
1025
  * <p> The service to which the AWS Health Event belongs, such as EC2. </p>
917
1026
  */
918
1027
  HealthService?: string;
919
1028
  /**
1029
+ * @public
920
1030
  * <p> The type of the AWS Health event, for example,
921
1031
  * <code>AWS_EC2_POWER_CONNECTIVITY_ISSUE</code>. </p>
922
1032
  */
923
1033
  HealthEventTypeCode?: string;
924
1034
  /**
1035
+ * @public
925
1036
  * <p> The category of the AWS Health event, such as <code>issue</code>. </p>
926
1037
  */
927
1038
  HealthEventTypeCategory?: string;
928
1039
  /**
1040
+ * @public
929
1041
  * <p> The description of the AWS Health event provided by the service, such as Amazon EC2.
930
1042
  * </p>
931
1043
  */
932
1044
  HealthEventDescription?: string;
933
1045
  /**
1046
+ * @public
934
1047
  * <p> The deployment ID of the CodeDeploy-based observation related to the detected problem.
935
1048
  * </p>
936
1049
  */
937
1050
  CodeDeployDeploymentId?: string;
938
1051
  /**
1052
+ * @public
939
1053
  * <p> The deployment group to which the CodeDeploy deployment belongs. </p>
940
1054
  */
941
1055
  CodeDeployDeploymentGroup?: string;
942
1056
  /**
1057
+ * @public
943
1058
  * <p> The status of the CodeDeploy deployment, for example <code>SUCCESS</code> or <code>
944
1059
  * FAILURE</code>. </p>
945
1060
  */
946
1061
  CodeDeployState?: string;
947
1062
  /**
1063
+ * @public
948
1064
  * <p> The CodeDeploy application to which the deployment belongs. </p>
949
1065
  */
950
1066
  CodeDeployApplication?: string;
951
1067
  /**
1068
+ * @public
952
1069
  * <p> The instance group to which the CodeDeploy instance belongs. </p>
953
1070
  */
954
1071
  CodeDeployInstanceGroupId?: string;
955
1072
  /**
1073
+ * @public
956
1074
  * <p> The state of the instance, such as <code>STOPPING</code> or <code>TERMINATING</code>.
957
1075
  * </p>
958
1076
  */
959
1077
  Ec2State?: string;
960
1078
  /**
1079
+ * @public
961
1080
  * <p> The category of an RDS event. </p>
962
1081
  */
963
1082
  RdsEventCategories?: string;
964
1083
  /**
1084
+ * @public
965
1085
  * <p> The message of an RDS event. </p>
966
1086
  */
967
1087
  RdsEventMessage?: string;
968
1088
  /**
1089
+ * @public
969
1090
  * <p> The name of the S3 CloudWatch Event-based observation. </p>
970
1091
  */
971
1092
  S3EventName?: string;
972
1093
  /**
1094
+ * @public
973
1095
  * <p> The Amazon Resource Name (ARN) of the step function execution-based observation.
974
1096
  * </p>
975
1097
  */
976
1098
  StatesExecutionArn?: string;
977
1099
  /**
1100
+ * @public
978
1101
  * <p> The Amazon Resource Name (ARN) of the step function-based observation. </p>
979
1102
  */
980
1103
  StatesArn?: string;
981
1104
  /**
1105
+ * @public
982
1106
  * <p> The status of the step function-related observation. </p>
983
1107
  */
984
1108
  StatesStatus?: string;
985
1109
  /**
1110
+ * @public
986
1111
  * <p> The input to the step function-based observation. </p>
987
1112
  */
988
1113
  StatesInput?: string;
989
1114
  /**
1115
+ * @public
990
1116
  * <p> The type of EBS CloudWatch event, such as <code>createVolume</code>,
991
1117
  * <code>deleteVolume</code> or <code>attachVolume</code>. </p>
992
1118
  */
993
1119
  EbsEvent?: string;
994
1120
  /**
1121
+ * @public
995
1122
  * <p> The result of an EBS CloudWatch event, such as <code>failed</code> or
996
1123
  * <code>succeeded</code>. </p>
997
1124
  */
998
1125
  EbsResult?: string;
999
1126
  /**
1127
+ * @public
1000
1128
  * <p> The cause of an EBS CloudWatch event. </p>
1001
1129
  */
1002
1130
  EbsCause?: string;
1003
1131
  /**
1132
+ * @public
1004
1133
  * <p> The request ID of an EBS CloudWatch event. </p>
1005
1134
  */
1006
1135
  EbsRequestId?: string;
1007
1136
  /**
1137
+ * @public
1008
1138
  * <p> The X-Ray request fault percentage for this node. </p>
1009
1139
  */
1010
1140
  XRayFaultPercent?: number;
1011
1141
  /**
1142
+ * @public
1012
1143
  * <p> The X-Ray request throttle percentage for this node. </p>
1013
1144
  */
1014
1145
  XRayThrottlePercent?: number;
1015
1146
  /**
1147
+ * @public
1016
1148
  * <p> The X-Ray request error percentage for this node. </p>
1017
1149
  */
1018
1150
  XRayErrorPercent?: number;
1019
1151
  /**
1152
+ * @public
1020
1153
  * <p> The X-Ray request count for this node. </p>
1021
1154
  */
1022
1155
  XRayRequestCount?: number;
1023
1156
  /**
1157
+ * @public
1024
1158
  * <p> The X-Ray node request average latency for this node. </p>
1025
1159
  */
1026
1160
  XRayRequestAverageLatency?: number;
1027
1161
  /**
1162
+ * @public
1028
1163
  * <p> The name of the X-Ray node. </p>
1029
1164
  */
1030
1165
  XRayNodeName?: string;
1031
1166
  /**
1167
+ * @public
1032
1168
  * <p> The type of the X-Ray node. </p>
1033
1169
  */
1034
1170
  XRayNodeType?: string;
@@ -1038,6 +1174,7 @@ export interface Observation {
1038
1174
  */
1039
1175
  export interface DescribeObservationResponse {
1040
1176
  /**
1177
+ * @public
1041
1178
  * <p>Information about the observation.</p>
1042
1179
  */
1043
1180
  Observation?: Observation;
@@ -1047,10 +1184,12 @@ export interface DescribeObservationResponse {
1047
1184
  */
1048
1185
  export interface DescribeProblemRequest {
1049
1186
  /**
1187
+ * @public
1050
1188
  * <p>The ID of the problem.</p>
1051
1189
  */
1052
1190
  ProblemId: string | undefined;
1053
1191
  /**
1192
+ * @public
1054
1193
  * <p>The AWS account ID for the owner of the resource group affected by the problem.</p>
1055
1194
  */
1056
1195
  AccountId?: string;
@@ -1139,64 +1278,79 @@ export type Visibility = (typeof Visibility)[keyof typeof Visibility];
1139
1278
  */
1140
1279
  export interface Problem {
1141
1280
  /**
1281
+ * @public
1142
1282
  * <p>The ID of the problem.</p>
1143
1283
  */
1144
1284
  Id?: string;
1145
1285
  /**
1286
+ * @public
1146
1287
  * <p>The name of the problem.</p>
1147
1288
  */
1148
1289
  Title?: string;
1149
1290
  /**
1291
+ * @public
1150
1292
  * <p>A detailed analysis of the problem using machine learning.</p>
1151
1293
  */
1152
1294
  Insights?: string;
1153
1295
  /**
1296
+ * @public
1154
1297
  * <p>The status of the problem.</p>
1155
1298
  */
1156
1299
  Status?: Status | string;
1157
1300
  /**
1301
+ * @public
1158
1302
  * <p>The resource affected by the problem.</p>
1159
1303
  */
1160
1304
  AffectedResource?: string;
1161
1305
  /**
1306
+ * @public
1162
1307
  * <p>The time when the problem started, in epoch seconds.</p>
1163
1308
  */
1164
1309
  StartTime?: Date;
1165
1310
  /**
1311
+ * @public
1166
1312
  * <p>The time when the problem ended, in epoch seconds.</p>
1167
1313
  */
1168
1314
  EndTime?: Date;
1169
1315
  /**
1316
+ * @public
1170
1317
  * <p>A measure of the level of impact of the problem.</p>
1171
1318
  */
1172
1319
  SeverityLevel?: SeverityLevel | string;
1173
1320
  /**
1321
+ * @public
1174
1322
  * <p>The AWS account ID for the owner of the resource group affected by the problem.</p>
1175
1323
  */
1176
1324
  AccountId?: string;
1177
1325
  /**
1326
+ * @public
1178
1327
  * <p>The name of the resource group affected by the problem.</p>
1179
1328
  */
1180
1329
  ResourceGroupName?: string;
1181
1330
  /**
1331
+ * @public
1182
1332
  * <p>Feedback provided by the user about the problem.</p>
1183
1333
  */
1184
1334
  Feedback?: Record<string, FeedbackValue | string>;
1185
1335
  /**
1336
+ * @public
1186
1337
  * <p> The number of times that the same problem reoccurred after the first time it was
1187
1338
  * resolved. </p>
1188
1339
  */
1189
1340
  RecurringCount?: number;
1190
1341
  /**
1342
+ * @public
1191
1343
  * <p> The last time that the problem reoccurred after its last resolution. </p>
1192
1344
  */
1193
1345
  LastRecurrenceTime?: Date;
1194
1346
  /**
1347
+ * @public
1195
1348
  * <p>Specifies whether or not you can view the problem. Updates to ignored problems do not
1196
1349
  * generate notifications.</p>
1197
1350
  */
1198
1351
  Visibility?: Visibility | string;
1199
1352
  /**
1353
+ * @public
1200
1354
  * <p>Specifies how the problem was resolved. If the value is <code>AUTOMATIC</code>, the
1201
1355
  * system resolved the problem. If the value is <code>MANUAL</code>, the user resolved the
1202
1356
  * problem. If the value is <code>UNRESOLVED</code>, then the problem is not resolved.</p>
@@ -1208,6 +1362,7 @@ export interface Problem {
1208
1362
  */
1209
1363
  export interface DescribeProblemResponse {
1210
1364
  /**
1365
+ * @public
1211
1366
  * <p>Information about the problem. </p>
1212
1367
  */
1213
1368
  Problem?: Problem;
@@ -1217,10 +1372,12 @@ export interface DescribeProblemResponse {
1217
1372
  */
1218
1373
  export interface DescribeProblemObservationsRequest {
1219
1374
  /**
1375
+ * @public
1220
1376
  * <p>The ID of the problem.</p>
1221
1377
  */
1222
1378
  ProblemId: string | undefined;
1223
1379
  /**
1380
+ * @public
1224
1381
  * <p>The AWS account ID for the resource group owner.</p>
1225
1382
  */
1226
1383
  AccountId?: string;
@@ -1231,6 +1388,7 @@ export interface DescribeProblemObservationsRequest {
1231
1388
  */
1232
1389
  export interface RelatedObservations {
1233
1390
  /**
1391
+ * @public
1234
1392
  * <p>The list of observations related to the problem.</p>
1235
1393
  */
1236
1394
  ObservationList?: Observation[];
@@ -1240,6 +1398,7 @@ export interface RelatedObservations {
1240
1398
  */
1241
1399
  export interface DescribeProblemObservationsResponse {
1242
1400
  /**
1401
+ * @public
1243
1402
  * <p>Observations related to the problem.</p>
1244
1403
  */
1245
1404
  RelatedObservations?: RelatedObservations;
@@ -1249,18 +1408,22 @@ export interface DescribeProblemObservationsResponse {
1249
1408
  */
1250
1409
  export interface DescribeWorkloadRequest {
1251
1410
  /**
1411
+ * @public
1252
1412
  * <p>The name of the resource group.</p>
1253
1413
  */
1254
1414
  ResourceGroupName: string | undefined;
1255
1415
  /**
1416
+ * @public
1256
1417
  * <p>The name of the component.</p>
1257
1418
  */
1258
1419
  ComponentName: string | undefined;
1259
1420
  /**
1421
+ * @public
1260
1422
  * <p>The ID of the workload.</p>
1261
1423
  */
1262
1424
  WorkloadId: string | undefined;
1263
1425
  /**
1426
+ * @public
1264
1427
  * <p>The AWS account ID for the workload owner.</p>
1265
1428
  */
1266
1429
  AccountId?: string;
@@ -1270,14 +1433,17 @@ export interface DescribeWorkloadRequest {
1270
1433
  */
1271
1434
  export interface DescribeWorkloadResponse {
1272
1435
  /**
1436
+ * @public
1273
1437
  * <p>The ID of the workload.</p>
1274
1438
  */
1275
1439
  WorkloadId?: string;
1276
1440
  /**
1441
+ * @public
1277
1442
  * <p>If logging is supported for the resource type, shows whether the component has configured logs to be monitored.</p>
1278
1443
  */
1279
1444
  WorkloadRemarks?: string;
1280
1445
  /**
1446
+ * @public
1281
1447
  * <p>The configuration settings of the workload. The value is the escaped JSON of the configuration.</p>
1282
1448
  */
1283
1449
  WorkloadConfiguration?: WorkloadConfiguration;
@@ -1287,15 +1453,18 @@ export interface DescribeWorkloadResponse {
1287
1453
  */
1288
1454
  export interface ListApplicationsRequest {
1289
1455
  /**
1456
+ * @public
1290
1457
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1291
1458
  * results, make another call with the returned <code>NextToken</code> value.</p>
1292
1459
  */
1293
1460
  MaxResults?: number;
1294
1461
  /**
1462
+ * @public
1295
1463
  * <p>The token to request the next page of results.</p>
1296
1464
  */
1297
1465
  NextToken?: string;
1298
1466
  /**
1467
+ * @public
1299
1468
  * <p>The AWS account ID for the resource group owner.</p>
1300
1469
  */
1301
1470
  AccountId?: string;
@@ -1305,10 +1474,12 @@ export interface ListApplicationsRequest {
1305
1474
  */
1306
1475
  export interface ListApplicationsResponse {
1307
1476
  /**
1477
+ * @public
1308
1478
  * <p>The list of applications.</p>
1309
1479
  */
1310
1480
  ApplicationInfoList?: ApplicationInfo[];
1311
1481
  /**
1482
+ * @public
1312
1483
  * <p>The token used to retrieve the next page of results. This value is <code>null</code>
1313
1484
  * when there are no more results to return. </p>
1314
1485
  */
@@ -1319,19 +1490,23 @@ export interface ListApplicationsResponse {
1319
1490
  */
1320
1491
  export interface ListComponentsRequest {
1321
1492
  /**
1493
+ * @public
1322
1494
  * <p>The name of the resource group.</p>
1323
1495
  */
1324
1496
  ResourceGroupName: string | undefined;
1325
1497
  /**
1498
+ * @public
1326
1499
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1327
1500
  * results, make another call with the returned <code>NextToken</code> value.</p>
1328
1501
  */
1329
1502
  MaxResults?: number;
1330
1503
  /**
1504
+ * @public
1331
1505
  * <p>The token to request the next page of results.</p>
1332
1506
  */
1333
1507
  NextToken?: string;
1334
1508
  /**
1509
+ * @public
1335
1510
  * <p>The AWS account ID for the resource group owner.</p>
1336
1511
  */
1337
1512
  AccountId?: string;
@@ -1341,10 +1516,12 @@ export interface ListComponentsRequest {
1341
1516
  */
1342
1517
  export interface ListComponentsResponse {
1343
1518
  /**
1519
+ * @public
1344
1520
  * <p>The list of application components.</p>
1345
1521
  */
1346
1522
  ApplicationComponentList?: ApplicationComponent[];
1347
1523
  /**
1524
+ * @public
1348
1525
  * <p>The token to request the next page of results.</p>
1349
1526
  */
1350
1527
  NextToken?: string;
@@ -1354,23 +1531,28 @@ export interface ListComponentsResponse {
1354
1531
  */
1355
1532
  export interface ListConfigurationHistoryRequest {
1356
1533
  /**
1534
+ * @public
1357
1535
  * <p>Resource group to which the application belongs. </p>
1358
1536
  */
1359
1537
  ResourceGroupName?: string;
1360
1538
  /**
1539
+ * @public
1361
1540
  * <p>The start time of the event. </p>
1362
1541
  */
1363
1542
  StartTime?: Date;
1364
1543
  /**
1544
+ * @public
1365
1545
  * <p>The end time of the event.</p>
1366
1546
  */
1367
1547
  EndTime?: Date;
1368
1548
  /**
1549
+ * @public
1369
1550
  * <p>The status of the configuration update event. Possible values include INFO, WARN, and
1370
1551
  * ERROR.</p>
1371
1552
  */
1372
1553
  EventStatus?: ConfigurationEventStatus | string;
1373
1554
  /**
1555
+ * @public
1374
1556
  * <p> The maximum number of results returned by <code>ListConfigurationHistory</code> in
1375
1557
  * paginated output. When this parameter is used, <code>ListConfigurationHistory</code>
1376
1558
  * returns only <code>MaxResults</code> in a single page along with a <code>NextToken</code>
@@ -1381,6 +1563,7 @@ export interface ListConfigurationHistoryRequest {
1381
1563
  */
1382
1564
  MaxResults?: number;
1383
1565
  /**
1566
+ * @public
1384
1567
  * <p>The <code>NextToken</code> value returned from a previous paginated
1385
1568
  * <code>ListConfigurationHistory</code> request where <code>MaxResults</code> was used and
1386
1569
  * the results exceeded the value of that parameter. Pagination continues from the end of the
@@ -1389,6 +1572,7 @@ export interface ListConfigurationHistoryRequest {
1389
1572
  */
1390
1573
  NextToken?: string;
1391
1574
  /**
1575
+ * @public
1392
1576
  * <p>The AWS account ID for the resource group owner.</p>
1393
1577
  */
1394
1578
  AccountId?: string;
@@ -1398,10 +1582,12 @@ export interface ListConfigurationHistoryRequest {
1398
1582
  */
1399
1583
  export interface ListConfigurationHistoryResponse {
1400
1584
  /**
1585
+ * @public
1401
1586
  * <p> The list of configuration events and their corresponding details. </p>
1402
1587
  */
1403
1588
  EventList?: ConfigurationEvent[];
1404
1589
  /**
1590
+ * @public
1405
1591
  * <p>The <code>NextToken</code> value to include in a future
1406
1592
  * <code>ListConfigurationHistory</code> request. When the results of a
1407
1593
  * <code>ListConfigurationHistory</code> request exceed <code>MaxResults</code>, this value
@@ -1415,23 +1601,28 @@ export interface ListConfigurationHistoryResponse {
1415
1601
  */
1416
1602
  export interface ListLogPatternsRequest {
1417
1603
  /**
1604
+ * @public
1418
1605
  * <p>The name of the resource group.</p>
1419
1606
  */
1420
1607
  ResourceGroupName: string | undefined;
1421
1608
  /**
1609
+ * @public
1422
1610
  * <p>The name of the log pattern set.</p>
1423
1611
  */
1424
1612
  PatternSetName?: string;
1425
1613
  /**
1614
+ * @public
1426
1615
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1427
1616
  * results, make another call with the returned <code>NextToken</code> value.</p>
1428
1617
  */
1429
1618
  MaxResults?: number;
1430
1619
  /**
1620
+ * @public
1431
1621
  * <p>The token to request the next page of results.</p>
1432
1622
  */
1433
1623
  NextToken?: string;
1434
1624
  /**
1625
+ * @public
1435
1626
  * <p>The AWS account ID for the resource group owner.</p>
1436
1627
  */
1437
1628
  AccountId?: string;
@@ -1441,18 +1632,22 @@ export interface ListLogPatternsRequest {
1441
1632
  */
1442
1633
  export interface ListLogPatternsResponse {
1443
1634
  /**
1635
+ * @public
1444
1636
  * <p>The name of the resource group.</p>
1445
1637
  */
1446
1638
  ResourceGroupName?: string;
1447
1639
  /**
1640
+ * @public
1448
1641
  * <p>The AWS account ID for the resource group owner.</p>
1449
1642
  */
1450
1643
  AccountId?: string;
1451
1644
  /**
1645
+ * @public
1452
1646
  * <p>The list of log patterns.</p>
1453
1647
  */
1454
1648
  LogPatterns?: LogPattern[];
1455
1649
  /**
1650
+ * @public
1456
1651
  * <p>The token used to retrieve the next page of results. This value is <code>null</code>
1457
1652
  * when there are no more results to return. </p>
1458
1653
  */
@@ -1463,19 +1658,23 @@ export interface ListLogPatternsResponse {
1463
1658
  */
1464
1659
  export interface ListLogPatternSetsRequest {
1465
1660
  /**
1661
+ * @public
1466
1662
  * <p>The name of the resource group.</p>
1467
1663
  */
1468
1664
  ResourceGroupName: string | undefined;
1469
1665
  /**
1666
+ * @public
1470
1667
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1471
1668
  * results, make another call with the returned <code>NextToken</code> value.</p>
1472
1669
  */
1473
1670
  MaxResults?: number;
1474
1671
  /**
1672
+ * @public
1475
1673
  * <p>The token to request the next page of results.</p>
1476
1674
  */
1477
1675
  NextToken?: string;
1478
1676
  /**
1677
+ * @public
1479
1678
  * <p>The AWS account ID for the resource group owner.</p>
1480
1679
  */
1481
1680
  AccountId?: string;
@@ -1485,18 +1684,22 @@ export interface ListLogPatternSetsRequest {
1485
1684
  */
1486
1685
  export interface ListLogPatternSetsResponse {
1487
1686
  /**
1687
+ * @public
1488
1688
  * <p>The name of the resource group.</p>
1489
1689
  */
1490
1690
  ResourceGroupName?: string;
1491
1691
  /**
1692
+ * @public
1492
1693
  * <p>The AWS account ID for the resource group owner.</p>
1493
1694
  */
1494
1695
  AccountId?: string;
1495
1696
  /**
1697
+ * @public
1496
1698
  * <p>The list of log pattern sets.</p>
1497
1699
  */
1498
1700
  LogPatternSets?: string[];
1499
1701
  /**
1702
+ * @public
1500
1703
  * <p>The token used to retrieve the next page of results. This value is <code>null</code>
1501
1704
  * when there are no more results to return. </p>
1502
1705
  */
@@ -1507,37 +1710,45 @@ export interface ListLogPatternSetsResponse {
1507
1710
  */
1508
1711
  export interface ListProblemsRequest {
1509
1712
  /**
1713
+ * @public
1510
1714
  * <p>The AWS account ID for the resource group owner.</p>
1511
1715
  */
1512
1716
  AccountId?: string;
1513
1717
  /**
1718
+ * @public
1514
1719
  * <p>The name of the resource group.</p>
1515
1720
  */
1516
1721
  ResourceGroupName?: string;
1517
1722
  /**
1723
+ * @public
1518
1724
  * <p>The time when the problem was detected, in epoch seconds. If you don't specify a time
1519
1725
  * frame for the request, problems within the past seven days are returned.</p>
1520
1726
  */
1521
1727
  StartTime?: Date;
1522
1728
  /**
1729
+ * @public
1523
1730
  * <p>The time when the problem ended, in epoch seconds. If not specified, problems within the
1524
1731
  * past seven days are returned.</p>
1525
1732
  */
1526
1733
  EndTime?: Date;
1527
1734
  /**
1735
+ * @public
1528
1736
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1529
1737
  * results, make another call with the returned <code>NextToken</code> value.</p>
1530
1738
  */
1531
1739
  MaxResults?: number;
1532
1740
  /**
1741
+ * @public
1533
1742
  * <p>The token to request the next page of results.</p>
1534
1743
  */
1535
1744
  NextToken?: string;
1536
1745
  /**
1746
+ * @public
1537
1747
  * <p> The name of the component. </p>
1538
1748
  */
1539
1749
  ComponentName?: string;
1540
1750
  /**
1751
+ * @public
1541
1752
  * <p>Specifies whether or not you can view the problem. If not specified, visible and
1542
1753
  * ignored problems are returned.</p>
1543
1754
  */
@@ -1548,19 +1759,23 @@ export interface ListProblemsRequest {
1548
1759
  */
1549
1760
  export interface ListProblemsResponse {
1550
1761
  /**
1762
+ * @public
1551
1763
  * <p>The list of problems. </p>
1552
1764
  */
1553
1765
  ProblemList?: Problem[];
1554
1766
  /**
1767
+ * @public
1555
1768
  * <p>The token used to retrieve the next page of results. This value is <code>null</code>
1556
1769
  * when there are no more results to return. </p>
1557
1770
  */
1558
1771
  NextToken?: string;
1559
1772
  /**
1773
+ * @public
1560
1774
  * <p> The name of the resource group. </p>
1561
1775
  */
1562
1776
  ResourceGroupName?: string;
1563
1777
  /**
1778
+ * @public
1564
1779
  * <p>The AWS account ID for the resource group owner.</p>
1565
1780
  */
1566
1781
  AccountId?: string;
@@ -1570,6 +1785,7 @@ export interface ListProblemsResponse {
1570
1785
  */
1571
1786
  export interface ListTagsForResourceRequest {
1572
1787
  /**
1788
+ * @public
1573
1789
  * <p>The Amazon Resource Name (ARN) of the application that you want to retrieve tag
1574
1790
  * information for.</p>
1575
1791
  */
@@ -1580,6 +1796,7 @@ export interface ListTagsForResourceRequest {
1580
1796
  */
1581
1797
  export interface ListTagsForResourceResponse {
1582
1798
  /**
1799
+ * @public
1583
1800
  * <p>An array that lists all the tags that are associated with the application. Each tag
1584
1801
  * consists of a required tag key (<code>Key</code>) and an associated tag value
1585
1802
  * (<code>Value</code>).</p>
@@ -1591,23 +1808,28 @@ export interface ListTagsForResourceResponse {
1591
1808
  */
1592
1809
  export interface ListWorkloadsRequest {
1593
1810
  /**
1811
+ * @public
1594
1812
  * <p>The name of the resource group.</p>
1595
1813
  */
1596
1814
  ResourceGroupName: string | undefined;
1597
1815
  /**
1816
+ * @public
1598
1817
  * <p>The name of the component.</p>
1599
1818
  */
1600
1819
  ComponentName: string | undefined;
1601
1820
  /**
1821
+ * @public
1602
1822
  * <p>The maximum number of results to return in a single call. To retrieve the remaining
1603
1823
  * results, make another call with the returned <code>NextToken</code> value.</p>
1604
1824
  */
1605
1825
  MaxResults?: number;
1606
1826
  /**
1827
+ * @public
1607
1828
  * <p>The token to request the next page of results.</p>
1608
1829
  */
1609
1830
  NextToken?: string;
1610
1831
  /**
1832
+ * @public
1611
1833
  * <p>The AWS account ID of the owner of the workload.</p>
1612
1834
  */
1613
1835
  AccountId?: string;
@@ -1618,22 +1840,27 @@ export interface ListWorkloadsRequest {
1618
1840
  */
1619
1841
  export interface Workload {
1620
1842
  /**
1843
+ * @public
1621
1844
  * <p>The ID of the workload.</p>
1622
1845
  */
1623
1846
  WorkloadId?: string;
1624
1847
  /**
1848
+ * @public
1625
1849
  * <p>The name of the component.</p>
1626
1850
  */
1627
1851
  ComponentName?: string;
1628
1852
  /**
1853
+ * @public
1629
1854
  * <p>The name of the workload.</p>
1630
1855
  */
1631
1856
  WorkloadName?: string;
1632
1857
  /**
1858
+ * @public
1633
1859
  * <p>The tier of the workload.</p>
1634
1860
  */
1635
1861
  Tier?: Tier | string;
1636
1862
  /**
1863
+ * @public
1637
1864
  * <p>If logging is supported for the resource type, shows whether the component has configured logs to be monitored.</p>
1638
1865
  */
1639
1866
  WorkloadRemarks?: string;
@@ -1643,10 +1870,12 @@ export interface Workload {
1643
1870
  */
1644
1871
  export interface ListWorkloadsResponse {
1645
1872
  /**
1873
+ * @public
1646
1874
  * <p>The list of workloads.</p>
1647
1875
  */
1648
1876
  WorkloadList?: Workload[];
1649
1877
  /**
1878
+ * @public
1650
1879
  * <p>The token to request the next page of results.</p>
1651
1880
  */
1652
1881
  NextToken?: string;
@@ -1656,14 +1885,17 @@ export interface ListWorkloadsResponse {
1656
1885
  */
1657
1886
  export interface RemoveWorkloadRequest {
1658
1887
  /**
1888
+ * @public
1659
1889
  * <p>The name of the resource group.</p>
1660
1890
  */
1661
1891
  ResourceGroupName: string | undefined;
1662
1892
  /**
1893
+ * @public
1663
1894
  * <p>The name of the component.</p>
1664
1895
  */
1665
1896
  ComponentName: string | undefined;
1666
1897
  /**
1898
+ * @public
1667
1899
  * <p>The ID of the workload.</p>
1668
1900
  */
1669
1901
  WorkloadId: string | undefined;
@@ -1678,11 +1910,13 @@ export interface RemoveWorkloadResponse {
1678
1910
  */
1679
1911
  export interface TagResourceRequest {
1680
1912
  /**
1913
+ * @public
1681
1914
  * <p>The Amazon Resource Name (ARN) of the application that you want to add one or more tags
1682
1915
  * to.</p>
1683
1916
  */
1684
1917
  ResourceARN: string | undefined;
1685
1918
  /**
1919
+ * @public
1686
1920
  * <p>A list of tags that to add to the application. A tag consists of a required tag key
1687
1921
  * (<code>Key</code>) and an associated tag value (<code>Value</code>). The maximum length
1688
1922
  * of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
@@ -1704,6 +1938,7 @@ export declare class TooManyTagsException extends __BaseException {
1704
1938
  readonly $fault: "client";
1705
1939
  Message?: string;
1706
1940
  /**
1941
+ * @public
1707
1942
  * <p>The name of the resource with too many tags.</p>
1708
1943
  */
1709
1944
  ResourceName?: string;
@@ -1717,11 +1952,13 @@ export declare class TooManyTagsException extends __BaseException {
1717
1952
  */
1718
1953
  export interface UntagResourceRequest {
1719
1954
  /**
1955
+ * @public
1720
1956
  * <p>The Amazon Resource Name (ARN) of the application that you want to remove one or more
1721
1957
  * tags from.</p>
1722
1958
  */
1723
1959
  ResourceARN: string | undefined;
1724
1960
  /**
1961
+ * @public
1725
1962
  * <p>The tags (tag keys) that you want to remove from the resource. When you specify a tag
1726
1963
  * key, the action removes both that key and its associated tag value.</p>
1727
1964
  * <p>To remove more than one tag from the application, append the <code>TagKeys</code>
@@ -1740,30 +1977,36 @@ export interface UntagResourceResponse {
1740
1977
  */
1741
1978
  export interface UpdateApplicationRequest {
1742
1979
  /**
1980
+ * @public
1743
1981
  * <p>The name of the resource group.</p>
1744
1982
  */
1745
1983
  ResourceGroupName: string | undefined;
1746
1984
  /**
1985
+ * @public
1747
1986
  * <p> When set to <code>true</code>, creates opsItems for any problems detected on an
1748
1987
  * application. </p>
1749
1988
  */
1750
1989
  OpsCenterEnabled?: boolean;
1751
1990
  /**
1991
+ * @public
1752
1992
  * <p> Indicates whether Application Insights can listen to CloudWatch events for the
1753
1993
  * application resources, such as <code>instance terminated</code>, <code>failed
1754
1994
  * deployment</code>, and others. </p>
1755
1995
  */
1756
1996
  CWEMonitorEnabled?: boolean;
1757
1997
  /**
1998
+ * @public
1758
1999
  * <p> The SNS topic provided to Application Insights that is associated to the created
1759
2000
  * opsItem. Allows you to receive notifications for updates to the opsItem.</p>
1760
2001
  */
1761
2002
  OpsItemSNSTopicArn?: string;
1762
2003
  /**
2004
+ * @public
1763
2005
  * <p> Disassociates the SNS topic from the opsItem created for detected problems.</p>
1764
2006
  */
1765
2007
  RemoveSNSTopic?: boolean;
1766
2008
  /**
2009
+ * @public
1767
2010
  * <p> Turns auto-configuration on or off. </p>
1768
2011
  */
1769
2012
  AutoConfigEnabled?: boolean;
@@ -1773,6 +2016,7 @@ export interface UpdateApplicationRequest {
1773
2016
  */
1774
2017
  export interface UpdateApplicationResponse {
1775
2018
  /**
2019
+ * @public
1776
2020
  * <p>Information about the application. </p>
1777
2021
  */
1778
2022
  ApplicationInfo?: ApplicationInfo;
@@ -1782,18 +2026,22 @@ export interface UpdateApplicationResponse {
1782
2026
  */
1783
2027
  export interface UpdateComponentRequest {
1784
2028
  /**
2029
+ * @public
1785
2030
  * <p>The name of the resource group.</p>
1786
2031
  */
1787
2032
  ResourceGroupName: string | undefined;
1788
2033
  /**
2034
+ * @public
1789
2035
  * <p>The name of the component.</p>
1790
2036
  */
1791
2037
  ComponentName: string | undefined;
1792
2038
  /**
2039
+ * @public
1793
2040
  * <p>The new name of the component.</p>
1794
2041
  */
1795
2042
  NewComponentName?: string;
1796
2043
  /**
2044
+ * @public
1797
2045
  * <p>The list of resource ARNs that belong to the component.</p>
1798
2046
  */
1799
2047
  ResourceList?: string[];
@@ -1808,22 +2056,27 @@ export interface UpdateComponentResponse {
1808
2056
  */
1809
2057
  export interface UpdateComponentConfigurationRequest {
1810
2058
  /**
2059
+ * @public
1811
2060
  * <p>The name of the resource group.</p>
1812
2061
  */
1813
2062
  ResourceGroupName: string | undefined;
1814
2063
  /**
2064
+ * @public
1815
2065
  * <p>The name of the component.</p>
1816
2066
  */
1817
2067
  ComponentName: string | undefined;
1818
2068
  /**
2069
+ * @public
1819
2070
  * <p>Indicates whether the application component is monitored.</p>
1820
2071
  */
1821
2072
  Monitor?: boolean;
1822
2073
  /**
2074
+ * @public
1823
2075
  * <p>The tier of the application component.</p>
1824
2076
  */
1825
2077
  Tier?: Tier | string;
1826
2078
  /**
2079
+ * @public
1827
2080
  * <p>The configuration settings of the component. The value is the escaped JSON of the
1828
2081
  * configuration. For more information about the JSON format, see <a href="https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html">Working with JSON</a>. You can send a request to
1829
2082
  * <code>DescribeComponentConfigurationRecommendation</code> to see the recommended
@@ -1832,6 +2085,7 @@ export interface UpdateComponentConfigurationRequest {
1832
2085
  */
1833
2086
  ComponentConfiguration?: string;
1834
2087
  /**
2088
+ * @public
1835
2089
  * <p> Automatically configures the component by applying the recommended configurations.
1836
2090
  * </p>
1837
2091
  */
@@ -1847,23 +2101,28 @@ export interface UpdateComponentConfigurationResponse {
1847
2101
  */
1848
2102
  export interface UpdateLogPatternRequest {
1849
2103
  /**
2104
+ * @public
1850
2105
  * <p>The name of the resource group.</p>
1851
2106
  */
1852
2107
  ResourceGroupName: string | undefined;
1853
2108
  /**
2109
+ * @public
1854
2110
  * <p>The name of the log pattern set.</p>
1855
2111
  */
1856
2112
  PatternSetName: string | undefined;
1857
2113
  /**
2114
+ * @public
1858
2115
  * <p>The name of the log pattern.</p>
1859
2116
  */
1860
2117
  PatternName: string | undefined;
1861
2118
  /**
2119
+ * @public
1862
2120
  * <p>The log pattern. The pattern must be DFA compatible. Patterns that utilize forward
1863
2121
  * lookahead or backreference constructions are not supported.</p>
1864
2122
  */
1865
2123
  Pattern?: string;
1866
2124
  /**
2125
+ * @public
1867
2126
  * <p>Rank of the log pattern. Must be a value between <code>1</code> and
1868
2127
  * <code>1,000,000</code>. The patterns are sorted by rank, so we recommend that you set
1869
2128
  * your highest priority patterns with the lowest rank. A pattern of rank <code>1</code> will
@@ -1882,10 +2141,12 @@ export interface UpdateLogPatternRequest {
1882
2141
  */
1883
2142
  export interface UpdateLogPatternResponse {
1884
2143
  /**
2144
+ * @public
1885
2145
  * <p>The name of the resource group.</p>
1886
2146
  */
1887
2147
  ResourceGroupName?: string;
1888
2148
  /**
2149
+ * @public
1889
2150
  * <p>The successfully created log pattern.</p>
1890
2151
  */
1891
2152
  LogPattern?: LogPattern;
@@ -1906,15 +2167,18 @@ export type UpdateStatus = (typeof UpdateStatus)[keyof typeof UpdateStatus];
1906
2167
  */
1907
2168
  export interface UpdateProblemRequest {
1908
2169
  /**
2170
+ * @public
1909
2171
  * <p>The ID of the problem.</p>
1910
2172
  */
1911
2173
  ProblemId: string | undefined;
1912
2174
  /**
2175
+ * @public
1913
2176
  * <p>The status of the problem. Arguments can be passed for only problems that show a status
1914
2177
  * of <code>RECOVERING</code>.</p>
1915
2178
  */
1916
2179
  UpdateStatus?: UpdateStatus | string;
1917
2180
  /**
2181
+ * @public
1918
2182
  * <p>The visibility of a problem. When you pass a value of <code>IGNORED</code>, the problem
1919
2183
  * is removed from the default view, and all notifications for the problem are suspended. When
1920
2184
  * <code>VISIBLE</code> is passed, the <code>IGNORED</code> action is reversed.</p>
@@ -1931,18 +2195,22 @@ export interface UpdateProblemResponse {
1931
2195
  */
1932
2196
  export interface UpdateWorkloadRequest {
1933
2197
  /**
2198
+ * @public
1934
2199
  * <p>The name of the resource group.</p>
1935
2200
  */
1936
2201
  ResourceGroupName: string | undefined;
1937
2202
  /**
2203
+ * @public
1938
2204
  * <p> The name of the component. </p>
1939
2205
  */
1940
2206
  ComponentName: string | undefined;
1941
2207
  /**
2208
+ * @public
1942
2209
  * <p>The ID of the workload.</p>
1943
2210
  */
1944
2211
  WorkloadId?: string;
1945
2212
  /**
2213
+ * @public
1946
2214
  * <p>The configuration settings of the workload. The value is the escaped JSON of the configuration.</p>
1947
2215
  */
1948
2216
  WorkloadConfiguration: WorkloadConfiguration | undefined;
@@ -1952,10 +2220,12 @@ export interface UpdateWorkloadRequest {
1952
2220
  */
1953
2221
  export interface UpdateWorkloadResponse {
1954
2222
  /**
2223
+ * @public
1955
2224
  * <p>The ID of the workload.</p>
1956
2225
  */
1957
2226
  WorkloadId?: string;
1958
2227
  /**
2228
+ * @public
1959
2229
  * <p>The configuration settings of the workload. The value is the escaped JSON of the configuration.</p>
1960
2230
  */
1961
2231
  WorkloadConfiguration?: WorkloadConfiguration;