@aws-sdk/client-migrationhubstrategy 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -54,6 +54,7 @@ export type AnalysisStatusUnion = AnalysisStatusUnion.RuntimeAnalysisStatusMembe
54
54
  */
55
55
  export declare namespace AnalysisStatusUnion {
56
56
  /**
57
+ * @public
57
58
  * <p>The status of the analysis.</p>
58
59
  */
59
60
  interface RuntimeAnalysisStatusMember {
@@ -62,6 +63,7 @@ export declare namespace AnalysisStatusUnion {
62
63
  $unknown?: never;
63
64
  }
64
65
  /**
66
+ * @public
65
67
  * <p>The status of the source code or database analysis.</p>
66
68
  */
67
69
  interface SrcCodeOrDbAnalysisStatusMember {
@@ -69,6 +71,9 @@ export declare namespace AnalysisStatusUnion {
69
71
  srcCodeOrDbAnalysisStatus: SrcCodeOrDbAnalysisStatus | string;
70
72
  $unknown?: never;
71
73
  }
74
+ /**
75
+ * @public
76
+ */
72
77
  interface $UnknownMember {
73
78
  runtimeAnalysisStatus?: never;
74
79
  srcCodeOrDbAnalysisStatus?: never;
@@ -146,6 +151,7 @@ export type AnalyzerNameUnion = AnalyzerNameUnion.BinaryAnalyzerNameMember | Ana
146
151
  */
147
152
  export declare namespace AnalyzerNameUnion {
148
153
  /**
154
+ * @public
149
155
  * <p>The binary analyzer names.</p>
150
156
  */
151
157
  interface BinaryAnalyzerNameMember {
@@ -155,6 +161,7 @@ export declare namespace AnalyzerNameUnion {
155
161
  $unknown?: never;
156
162
  }
157
163
  /**
164
+ * @public
158
165
  * <p>The assessment analyzer names.</p>
159
166
  */
160
167
  interface RunTimeAnalyzerNameMember {
@@ -164,6 +171,7 @@ export declare namespace AnalyzerNameUnion {
164
171
  $unknown?: never;
165
172
  }
166
173
  /**
174
+ * @public
167
175
  * <p>The source code analyzer names.</p>
168
176
  */
169
177
  interface SourceCodeAnalyzerNameMember {
@@ -172,6 +180,9 @@ export declare namespace AnalyzerNameUnion {
172
180
  sourceCodeAnalyzerName: SourceCodeAnalyzerName | string;
173
181
  $unknown?: never;
174
182
  }
183
+ /**
184
+ * @public
185
+ */
175
186
  interface $UnknownMember {
176
187
  binaryAnalyzerName?: never;
177
188
  runTimeAnalyzerName?: never;
@@ -192,10 +203,12 @@ export declare namespace AnalyzerNameUnion {
192
203
  */
193
204
  export interface S3Object {
194
205
  /**
206
+ * @public
195
207
  * <p> The S3 bucket name. </p>
196
208
  */
197
209
  s3Bucket?: string;
198
210
  /**
211
+ * @public
199
212
  * <p> The Amazon S3 key name. </p>
200
213
  */
201
214
  s3key?: string;
@@ -219,18 +232,22 @@ export type AntipatternReportStatus = (typeof AntipatternReportStatus)[keyof typ
219
232
  */
220
233
  export interface AntipatternReportResult {
221
234
  /**
235
+ * @public
222
236
  * <p>The analyzer name.</p>
223
237
  */
224
238
  analyzerName?: AnalyzerNameUnion;
225
239
  /**
240
+ * @public
226
241
  * <p> Contains the S3 bucket name and the Amazon S3 key name. </p>
227
242
  */
228
243
  antiPatternReportS3Object?: S3Object;
229
244
  /**
245
+ * @public
230
246
  * <p>The status of the anti-pattern report generation.</p>
231
247
  */
232
248
  antipatternReportStatus?: AntipatternReportStatus | string;
233
249
  /**
250
+ * @public
234
251
  * <p>The status message for the anti-pattern.</p>
235
252
  */
236
253
  antipatternReportStatusMessage?: string;
@@ -254,10 +271,12 @@ export type Severity = (typeof Severity)[keyof typeof Severity];
254
271
  */
255
272
  export interface AntipatternSeveritySummary {
256
273
  /**
274
+ * @public
257
275
  * <p> Contains the severity of anti-patterns. </p>
258
276
  */
259
277
  severity?: Severity | string;
260
278
  /**
279
+ * @public
261
280
  * <p> Contains the count of anti-patterns. </p>
262
281
  */
263
282
  count?: number;
@@ -333,6 +352,7 @@ export type AppUnitErrorCategory = (typeof AppUnitErrorCategory)[keyof typeof Ap
333
352
  */
334
353
  export interface AppUnitError {
335
354
  /**
355
+ * @public
336
356
  * <p>The category of the error.</p>
337
357
  */
338
358
  appUnitErrorCategory?: AppUnitErrorCategory | string;
@@ -343,6 +363,7 @@ export interface AppUnitError {
343
363
  */
344
364
  export interface DatabaseConfigDetail {
345
365
  /**
366
+ * @public
346
367
  * <p> AWS Secrets Manager key that holds the credentials that you use to connect to a database.
347
368
  * </p>
348
369
  */
@@ -428,14 +449,17 @@ export type TransformationToolName = (typeof TransformationToolName)[keyof typeo
428
449
  */
429
450
  export interface TransformationTool {
430
451
  /**
452
+ * @public
431
453
  * <p> Name of the tool. </p>
432
454
  */
433
455
  name?: TransformationToolName | string;
434
456
  /**
457
+ * @public
435
458
  * <p> Description of the tool. </p>
436
459
  */
437
460
  description?: string;
438
461
  /**
462
+ * @public
439
463
  * <p> URL for installing the tool. </p>
440
464
  */
441
465
  tranformationToolInstallationLink?: string;
@@ -446,14 +470,17 @@ export interface TransformationTool {
446
470
  */
447
471
  export interface RecommendationSet {
448
472
  /**
473
+ * @public
449
474
  * <p> The target destination for the recommendation set. </p>
450
475
  */
451
476
  transformationTool?: TransformationTool;
452
477
  /**
478
+ * @public
453
479
  * <p> The recommended target destination. </p>
454
480
  */
455
481
  targetDestination?: TargetDestination | string;
456
482
  /**
483
+ * @public
457
484
  * <p> The recommended strategy. </p>
458
485
  */
459
486
  strategy?: Strategy | string;
@@ -477,18 +504,22 @@ export type ResourceSubType = (typeof ResourceSubType)[keyof typeof ResourceSubT
477
504
  */
478
505
  export interface Result {
479
506
  /**
507
+ * @public
480
508
  * <p>The error in server analysis.</p>
481
509
  */
482
510
  analysisType?: AnalysisType | string;
483
511
  /**
512
+ * @public
484
513
  * <p>The error in server analysis.</p>
485
514
  */
486
515
  analysisStatus?: AnalysisStatusUnion;
487
516
  /**
517
+ * @public
488
518
  * <p>The error in server analysis.</p>
489
519
  */
490
520
  statusMessage?: string;
491
521
  /**
522
+ * @public
492
523
  * <p>The error in server analysis.</p>
493
524
  */
494
525
  antipatternReportResultList?: AntipatternReportResult[];
@@ -500,18 +531,22 @@ export interface Result {
500
531
  */
501
532
  export interface SourceCodeRepository {
502
533
  /**
534
+ * @public
503
535
  * <p> The repository name for the source code. </p>
504
536
  */
505
537
  repository?: string;
506
538
  /**
539
+ * @public
507
540
  * <p> The branch of the source code. </p>
508
541
  */
509
542
  branch?: string;
510
543
  /**
544
+ * @public
511
545
  * <p> The type of repository to use for the source code. </p>
512
546
  */
513
547
  versionControlType?: string;
514
548
  /**
549
+ * @public
515
550
  * <p>The name of the project.</p>
516
551
  */
517
552
  projectName?: string;
@@ -522,97 +557,120 @@ export interface SourceCodeRepository {
522
557
  */
523
558
  export interface ApplicationComponentDetail {
524
559
  /**
560
+ * @public
525
561
  * <p> The ID of the application component. </p>
526
562
  */
527
563
  id?: string;
528
564
  /**
565
+ * @public
529
566
  * <p> The name of application component. </p>
530
567
  */
531
568
  name?: string;
532
569
  /**
570
+ * @public
533
571
  * <p> The top recommendation set for the application component. </p>
534
572
  */
535
573
  recommendationSet?: RecommendationSet;
536
574
  /**
575
+ * @public
537
576
  * <p> The status of analysis, if the application component has source code or an associated
538
577
  * database. </p>
539
578
  */
540
579
  analysisStatus?: SrcCodeOrDbAnalysisStatus | string;
541
580
  /**
581
+ * @public
542
582
  * <p> A detailed description of the analysis status and any failure message. </p>
543
583
  */
544
584
  statusMessage?: string;
545
585
  /**
586
+ * @public
546
587
  * <p> A list of anti-pattern severity summaries. </p>
547
588
  */
548
589
  listAntipatternSeveritySummary?: AntipatternSeveritySummary[];
549
590
  /**
591
+ * @public
550
592
  * <p> Configuration details for the database associated with the application component. </p>
551
593
  */
552
594
  databaseConfigDetail?: DatabaseConfigDetail;
553
595
  /**
596
+ * @public
554
597
  * <p> Details about the source code repository associated with the application component.
555
598
  * </p>
556
599
  */
557
600
  sourceCodeRepositories?: SourceCodeRepository[];
558
601
  /**
602
+ * @public
559
603
  * <p> The type of application component. </p>
560
604
  */
561
605
  appType?: AppType | string;
562
606
  /**
607
+ * @public
563
608
  * <p> The application component subtype.</p>
564
609
  */
565
610
  resourceSubType?: ResourceSubType | string;
566
611
  /**
612
+ * @public
567
613
  * <p> Indicates whether the application component has been included for server recommendation
568
614
  * or not. </p>
569
615
  */
570
616
  inclusionStatus?: InclusionStatus | string;
571
617
  /**
618
+ * @public
572
619
  * <p> The S3 bucket name and the Amazon S3 key name for the anti-pattern report. </p>
573
620
  */
574
621
  antipatternReportS3Object?: S3Object;
575
622
  /**
623
+ * @public
576
624
  * <p> The status of the anti-pattern report generation.</p>
577
625
  */
578
626
  antipatternReportStatus?: AntipatternReportStatus | string;
579
627
  /**
628
+ * @public
580
629
  * <p> The status message for the anti-pattern. </p>
581
630
  */
582
631
  antipatternReportStatusMessage?: string;
583
632
  /**
633
+ * @public
584
634
  * <p> OS version. </p>
585
635
  */
586
636
  osVersion?: string;
587
637
  /**
638
+ * @public
588
639
  * <p> OS driver. </p>
589
640
  */
590
641
  osDriver?: string;
591
642
  /**
643
+ * @public
592
644
  * <p> The timestamp of when the application component was assessed. </p>
593
645
  */
594
646
  lastAnalyzedTimestamp?: Date;
595
647
  /**
648
+ * @public
596
649
  * <p> The ID of the server that the application component is running on. </p>
597
650
  */
598
651
  associatedServerId?: string;
599
652
  /**
653
+ * @public
600
654
  * <p> Set to true if the application component is running on multiple servers.</p>
601
655
  */
602
656
  moreServerAssociationExists?: boolean;
603
657
  /**
658
+ * @public
604
659
  * <p>The status of the application unit.</p>
605
660
  */
606
661
  runtimeStatus?: RuntimeAnalysisStatus | string;
607
662
  /**
663
+ * @public
608
664
  * <p>The status message for the application unit.</p>
609
665
  */
610
666
  runtimeStatusMessage?: string;
611
667
  /**
668
+ * @public
612
669
  * <p>The error in the analysis of the source code or database.</p>
613
670
  */
614
671
  appUnitError?: AppUnitError;
615
672
  /**
673
+ * @public
616
674
  * <p>A list of the analysis results.</p>
617
675
  */
618
676
  resultList?: Result[];
@@ -623,10 +681,12 @@ export interface ApplicationComponentDetail {
623
681
  */
624
682
  export interface ApplicationComponentStatusSummary {
625
683
  /**
684
+ * @public
626
685
  * <p>The status of database analysis.</p>
627
686
  */
628
687
  srcCodeOrDbAnalysisStatus?: SrcCodeOrDbAnalysisStatus | string;
629
688
  /**
689
+ * @public
630
690
  * <p>The number of application components successfully analyzed, partially successful or failed
631
691
  * analysis.</p>
632
692
  */
@@ -653,14 +713,17 @@ export type StrategyRecommendation = (typeof StrategyRecommendation)[keyof typeo
653
713
  */
654
714
  export interface ApplicationComponentStrategy {
655
715
  /**
716
+ * @public
656
717
  * <p> Strategy recommendation for the application component. </p>
657
718
  */
658
719
  recommendation?: RecommendationSet;
659
720
  /**
721
+ * @public
660
722
  * <p> The recommendation status of a strategy for an application component. </p>
661
723
  */
662
724
  status?: StrategyRecommendation | string;
663
725
  /**
726
+ * @public
664
727
  * <p> Set to true if the recommendation is set as preferred. </p>
665
728
  */
666
729
  isPreferred?: boolean;
@@ -671,10 +734,12 @@ export interface ApplicationComponentStrategy {
671
734
  */
672
735
  export interface ApplicationComponentSummary {
673
736
  /**
737
+ * @public
674
738
  * <p> Contains the name of application types. </p>
675
739
  */
676
740
  appType?: AppType | string;
677
741
  /**
742
+ * @public
678
743
  * <p> Contains the count of application type. </p>
679
744
  */
680
745
  count?: number;
@@ -711,6 +776,7 @@ export type AwsManagedTargetDestination = (typeof AwsManagedTargetDestination)[k
711
776
  */
712
777
  export interface AwsManagedResources {
713
778
  /**
779
+ * @public
714
780
  * <p> The choice of application destination that you specify. </p>
715
781
  */
716
782
  targetDestination: (AwsManagedTargetDestination | string)[] | undefined;
@@ -737,6 +803,7 @@ export type NoPreferenceTargetDestination = (typeof NoPreferenceTargetDestinatio
737
803
  */
738
804
  export interface NoManagementPreference {
739
805
  /**
806
+ * @public
740
807
  * <p> The choice of application destination that you specify. </p>
741
808
  */
742
809
  targetDestination: (NoPreferenceTargetDestination | string)[] | undefined;
@@ -761,6 +828,7 @@ export type SelfManageTargetDestination = (typeof SelfManageTargetDestination)[k
761
828
  */
762
829
  export interface SelfManageResources {
763
830
  /**
831
+ * @public
764
832
  * <p> Self-managed resources target destination. </p>
765
833
  */
766
834
  targetDestination: (SelfManageTargetDestination | string)[] | undefined;
@@ -775,6 +843,7 @@ export type ManagementPreference = ManagementPreference.AwsManagedResourcesMembe
775
843
  */
776
844
  export declare namespace ManagementPreference {
777
845
  /**
846
+ * @public
778
847
  * <p> Indicates interest in solutions that are managed by AWS. </p>
779
848
  */
780
849
  interface AwsManagedResourcesMember {
@@ -784,6 +853,7 @@ export declare namespace ManagementPreference {
784
853
  $unknown?: never;
785
854
  }
786
855
  /**
856
+ * @public
787
857
  * <p> Indicates interest in managing your own resources on AWS. </p>
788
858
  */
789
859
  interface SelfManageResourcesMember {
@@ -793,6 +863,7 @@ export declare namespace ManagementPreference {
793
863
  $unknown?: never;
794
864
  }
795
865
  /**
866
+ * @public
796
867
  * <p> No specific preference. </p>
797
868
  */
798
869
  interface NoPreferenceMember {
@@ -801,6 +872,9 @@ export declare namespace ManagementPreference {
801
872
  noPreference: NoManagementPreference;
802
873
  $unknown?: never;
803
874
  }
875
+ /**
876
+ * @public
877
+ */
804
878
  interface $UnknownMember {
805
879
  awsManagedResources?: never;
806
880
  selfManageResources?: never;
@@ -821,6 +895,7 @@ export declare namespace ManagementPreference {
821
895
  */
822
896
  export interface ApplicationPreferences {
823
897
  /**
898
+ * @public
824
899
  * <p> Application preferences that you specify to prefer managed environment. </p>
825
900
  */
826
901
  managementPreference?: ManagementPreference;
@@ -845,10 +920,12 @@ export type AssessmentStatus = (typeof AssessmentStatus)[keyof typeof Assessment
845
920
  */
846
921
  export interface StrategySummary {
847
922
  /**
923
+ * @public
848
924
  * <p> The name of recommended strategy. </p>
849
925
  */
850
926
  strategy?: Strategy | string;
851
927
  /**
928
+ * @public
852
929
  * <p> The count of recommendations per strategy. </p>
853
930
  */
854
931
  count?: number;
@@ -876,10 +953,12 @@ export type RunTimeAssessmentStatus = (typeof RunTimeAssessmentStatus)[keyof typ
876
953
  */
877
954
  export interface ServerStatusSummary {
878
955
  /**
956
+ * @public
879
957
  * <p>The status of the run time.</p>
880
958
  */
881
959
  runTimeAssessmentStatus?: RunTimeAssessmentStatus | string;
882
960
  /**
961
+ * @public
883
962
  * <p>The number of servers successfully analyzed, partially successful or failed
884
963
  * analysis.</p>
885
964
  */
@@ -906,10 +985,12 @@ export type ServerOsType = (typeof ServerOsType)[keyof typeof ServerOsType];
906
985
  */
907
986
  export interface ServerSummary {
908
987
  /**
988
+ * @public
909
989
  * <p> Type of operating system for the servers. </p>
910
990
  */
911
991
  ServerOsType?: ServerOsType | string;
912
992
  /**
993
+ * @public
913
994
  * <p> Number of servers. </p>
914
995
  */
915
996
  count?: number;
@@ -920,46 +1001,57 @@ export interface ServerSummary {
920
1001
  */
921
1002
  export interface AssessmentSummary {
922
1003
  /**
1004
+ * @public
923
1005
  * <p> List of ServerStrategySummary. </p>
924
1006
  */
925
1007
  listServerStrategySummary?: StrategySummary[];
926
1008
  /**
1009
+ * @public
927
1010
  * <p> List of ApplicationComponentStrategySummary. </p>
928
1011
  */
929
1012
  listApplicationComponentStrategySummary?: StrategySummary[];
930
1013
  /**
1014
+ * @public
931
1015
  * <p> List of AntipatternSeveritySummary. </p>
932
1016
  */
933
1017
  listAntipatternSeveritySummary?: AntipatternSeveritySummary[];
934
1018
  /**
1019
+ * @public
935
1020
  * <p> List of ApplicationComponentSummary. </p>
936
1021
  */
937
1022
  listApplicationComponentSummary?: ApplicationComponentSummary[];
938
1023
  /**
1024
+ * @public
939
1025
  * <p> List of ServerSummary. </p>
940
1026
  */
941
1027
  listServerSummary?: ServerSummary[];
942
1028
  /**
1029
+ * @public
943
1030
  * <p> The Amazon S3 object containing the anti-pattern report. </p>
944
1031
  */
945
1032
  antipatternReportS3Object?: S3Object;
946
1033
  /**
1034
+ * @public
947
1035
  * <p> The status of the anti-pattern report. </p>
948
1036
  */
949
1037
  antipatternReportStatus?: AntipatternReportStatus | string;
950
1038
  /**
1039
+ * @public
951
1040
  * <p> The status message of the anti-pattern report. </p>
952
1041
  */
953
1042
  antipatternReportStatusMessage?: string;
954
1043
  /**
1044
+ * @public
955
1045
  * <p> The time the assessment was performed. </p>
956
1046
  */
957
1047
  lastAnalyzedTimestamp?: Date;
958
1048
  /**
1049
+ * @public
959
1050
  * <p>List of status summaries of the analyzed application components.</p>
960
1051
  */
961
1052
  listApplicationComponentStatusSummary?: ApplicationComponentStatusSummary[];
962
1053
  /**
1054
+ * @public
963
1055
  * <p>List of status summaries of the analyzed servers.</p>
964
1056
  */
965
1057
  listServerStatusSummary?: ServerStatusSummary[];
@@ -984,14 +1076,17 @@ export type Condition = (typeof Condition)[keyof typeof Condition];
984
1076
  */
985
1077
  export interface AssessmentTarget {
986
1078
  /**
1079
+ * @public
987
1080
  * <p>Condition of an assessment.</p>
988
1081
  */
989
1082
  condition: Condition | string | undefined;
990
1083
  /**
1084
+ * @public
991
1085
  * <p>Name of an assessment.</p>
992
1086
  */
993
1087
  name: string | undefined;
994
1088
  /**
1089
+ * @public
995
1090
  * <p>Values of an assessment.</p>
996
1091
  */
997
1092
  values: string[] | undefined;
@@ -1002,10 +1097,12 @@ export interface AssessmentTarget {
1002
1097
  */
1003
1098
  export interface AssociatedApplication {
1004
1099
  /**
1100
+ * @public
1005
1101
  * <p> Name of the application as defined in Application Discovery Service. </p>
1006
1102
  */
1007
1103
  name?: string;
1008
1104
  /**
1105
+ * @public
1009
1106
  * <p> ID of the application as defined in Application Discovery Service. </p>
1010
1107
  */
1011
1108
  id?: string;
@@ -1028,6 +1125,7 @@ export type AuthType = (typeof AuthType)[keyof typeof AuthType];
1028
1125
  */
1029
1126
  export interface GetApplicationComponentDetailsRequest {
1030
1127
  /**
1128
+ * @public
1031
1129
  * <p> The ID of the application component. The ID is unique within an AWS account.</p>
1032
1130
  */
1033
1131
  applicationComponentId: string | undefined;
@@ -1037,19 +1135,23 @@ export interface GetApplicationComponentDetailsRequest {
1037
1135
  */
1038
1136
  export interface GetApplicationComponentDetailsResponse {
1039
1137
  /**
1138
+ * @public
1040
1139
  * <p> Detailed information about an application component. </p>
1041
1140
  */
1042
1141
  applicationComponentDetail?: ApplicationComponentDetail;
1043
1142
  /**
1143
+ * @public
1044
1144
  * <p> The associated application group as defined in AWS Application Discovery Service. </p>
1045
1145
  */
1046
1146
  associatedApplications?: AssociatedApplication[];
1047
1147
  /**
1148
+ * @public
1048
1149
  * <p> Set to true if the application component belongs to more than one application group.
1049
1150
  * </p>
1050
1151
  */
1051
1152
  moreApplicationResource?: boolean;
1052
1153
  /**
1154
+ * @public
1053
1155
  * <p> A list of the IDs of the servers on which the application component is running. </p>
1054
1156
  */
1055
1157
  associatedServerIds?: string[];
@@ -1095,6 +1197,7 @@ export declare class ThrottlingException extends __BaseException {
1095
1197
  */
1096
1198
  export interface GetApplicationComponentStrategiesRequest {
1097
1199
  /**
1200
+ * @public
1098
1201
  * <p> The ID of the application component. The ID is unique within an AWS account.</p>
1099
1202
  */
1100
1203
  applicationComponentId: string | undefined;
@@ -1104,6 +1207,7 @@ export interface GetApplicationComponentStrategiesRequest {
1104
1207
  */
1105
1208
  export interface GetApplicationComponentStrategiesResponse {
1106
1209
  /**
1210
+ * @public
1107
1211
  * <p> A list of application component strategy recommendations. </p>
1108
1212
  */
1109
1213
  applicationComponentStrategies?: ApplicationComponentStrategy[];
@@ -1113,6 +1217,7 @@ export interface GetApplicationComponentStrategiesResponse {
1113
1217
  */
1114
1218
  export interface GetAssessmentRequest {
1115
1219
  /**
1220
+ * @public
1116
1221
  * <p> The <code>assessmentid</code> returned by <a>StartAssessment</a>.</p>
1117
1222
  */
1118
1223
  id: string | undefined;
@@ -1123,34 +1228,42 @@ export interface GetAssessmentRequest {
1123
1228
  */
1124
1229
  export interface DataCollectionDetails {
1125
1230
  /**
1231
+ * @public
1126
1232
  * <p> The status of the assessment. </p>
1127
1233
  */
1128
1234
  status?: AssessmentStatus | string;
1129
1235
  /**
1236
+ * @public
1130
1237
  * <p> The total number of servers in the assessment. </p>
1131
1238
  */
1132
1239
  servers?: number;
1133
1240
  /**
1241
+ * @public
1134
1242
  * <p> The number of failed servers in the assessment. </p>
1135
1243
  */
1136
1244
  failed?: number;
1137
1245
  /**
1246
+ * @public
1138
1247
  * <p> The number of successful servers in the assessment. </p>
1139
1248
  */
1140
1249
  success?: number;
1141
1250
  /**
1251
+ * @public
1142
1252
  * <p> The number of servers with the assessment status <code>IN_PROGESS</code>. </p>
1143
1253
  */
1144
1254
  inProgress?: number;
1145
1255
  /**
1256
+ * @public
1146
1257
  * <p> The start time of assessment. </p>
1147
1258
  */
1148
1259
  startTime?: Date;
1149
1260
  /**
1261
+ * @public
1150
1262
  * <p> The time the assessment completes. </p>
1151
1263
  */
1152
1264
  completionTime?: Date;
1153
1265
  /**
1266
+ * @public
1154
1267
  * <p>The status message of the assessment.</p>
1155
1268
  */
1156
1269
  statusMessage?: string;
@@ -1160,14 +1273,17 @@ export interface DataCollectionDetails {
1160
1273
  */
1161
1274
  export interface GetAssessmentResponse {
1162
1275
  /**
1276
+ * @public
1163
1277
  * <p> The ID for the specific assessment task. </p>
1164
1278
  */
1165
1279
  id?: string;
1166
1280
  /**
1281
+ * @public
1167
1282
  * <p> Detailed information about the assessment. </p>
1168
1283
  */
1169
1284
  dataCollectionDetails?: DataCollectionDetails;
1170
1285
  /**
1286
+ * @public
1171
1287
  * <p>List of criteria for assessment.</p>
1172
1288
  */
1173
1289
  assessmentTargets?: AssessmentTarget[];
@@ -1177,6 +1293,7 @@ export interface GetAssessmentResponse {
1177
1293
  */
1178
1294
  export interface GetImportFileTaskRequest {
1179
1295
  /**
1296
+ * @public
1180
1297
  * <p> The ID of the import file task. This ID is returned in the response of <a>StartImportFileTask</a>. </p>
1181
1298
  */
1182
1299
  id: string | undefined;
@@ -1204,47 +1321,58 @@ export type ImportFileTaskStatus = (typeof ImportFileTaskStatus)[keyof typeof Im
1204
1321
  */
1205
1322
  export interface GetImportFileTaskResponse {
1206
1323
  /**
1324
+ * @public
1207
1325
  * <p> The import file task <code>id</code> returned in the response of <a>StartImportFileTask</a>. </p>
1208
1326
  */
1209
1327
  id?: string;
1210
1328
  /**
1329
+ * @public
1211
1330
  * <p> Status of import file task. </p>
1212
1331
  */
1213
1332
  status?: ImportFileTaskStatus | string;
1214
1333
  /**
1334
+ * @public
1215
1335
  * <p> Start time of the import task. </p>
1216
1336
  */
1217
1337
  startTime?: Date;
1218
1338
  /**
1339
+ * @public
1219
1340
  * <p> The S3 bucket where import file is located. </p>
1220
1341
  */
1221
1342
  inputS3Bucket?: string;
1222
1343
  /**
1344
+ * @public
1223
1345
  * <p> The Amazon S3 key name of the import file. </p>
1224
1346
  */
1225
1347
  inputS3Key?: string;
1226
1348
  /**
1349
+ * @public
1227
1350
  * <p> The S3 bucket name for status report of import task. </p>
1228
1351
  */
1229
1352
  statusReportS3Bucket?: string;
1230
1353
  /**
1354
+ * @public
1231
1355
  * <p> The Amazon S3 key name for status report of import task. The report contains details about
1232
1356
  * whether each record imported successfully or why it did not.</p>
1233
1357
  */
1234
1358
  statusReportS3Key?: string;
1235
1359
  /**
1360
+ * @public
1236
1361
  * <p> The time that the import task completed. </p>
1237
1362
  */
1238
1363
  completionTime?: Date;
1239
1364
  /**
1365
+ * @public
1240
1366
  * <p> The number of records successfully imported. </p>
1241
1367
  */
1242
1368
  numberOfRecordsSuccess?: number;
1243
1369
  /**
1370
+ * @public
1244
1371
  * <p> The number of records that failed to be imported. </p>
1245
1372
  */
1246
1373
  numberOfRecordsFailed?: number;
1247
1374
  /**
1375
+ * @public
1248
1376
  * <p> The name of the import task given in <a>StartImportFileTask</a>. </p>
1249
1377
  */
1250
1378
  importName?: string;
@@ -1283,6 +1411,7 @@ export interface GetLatestAssessmentIdRequest {
1283
1411
  */
1284
1412
  export interface GetLatestAssessmentIdResponse {
1285
1413
  /**
1414
+ * @public
1286
1415
  * <p>The latest ID for the specific assessment task.</p>
1287
1416
  */
1288
1417
  id?: string;
@@ -1331,6 +1460,7 @@ export type HeterogeneousTargetDatabaseEngine = (typeof HeterogeneousTargetDatab
1331
1460
  */
1332
1461
  export interface Heterogeneous {
1333
1462
  /**
1463
+ * @public
1334
1464
  * <p> The target database engine for heterogeneous database migration preference. </p>
1335
1465
  */
1336
1466
  targetDatabaseEngine: (HeterogeneousTargetDatabaseEngine | string)[] | undefined;
@@ -1352,6 +1482,7 @@ export type HomogeneousTargetDatabaseEngine = (typeof HomogeneousTargetDatabaseE
1352
1482
  */
1353
1483
  export interface Homogeneous {
1354
1484
  /**
1485
+ * @public
1355
1486
  * <p> The target database engine for homogeneous database migration preferences. </p>
1356
1487
  */
1357
1488
  targetDatabaseEngine?: (HomogeneousTargetDatabaseEngine | string)[];
@@ -1383,6 +1514,7 @@ export type TargetDatabaseEngine = (typeof TargetDatabaseEngine)[keyof typeof Ta
1383
1514
  */
1384
1515
  export interface NoDatabaseMigrationPreference {
1385
1516
  /**
1517
+ * @public
1386
1518
  * <p> The target database engine for database migration preference that you specify. </p>
1387
1519
  */
1388
1520
  targetDatabaseEngine: (TargetDatabaseEngine | string)[] | undefined;
@@ -1397,6 +1529,7 @@ export type DatabaseMigrationPreference = DatabaseMigrationPreference.Heterogene
1397
1529
  */
1398
1530
  export declare namespace DatabaseMigrationPreference {
1399
1531
  /**
1532
+ * @public
1400
1533
  * <p> Indicates whether you are interested in moving from one type of database to another. For
1401
1534
  * example, from SQL Server to Amazon Aurora MySQL-Compatible Edition. </p>
1402
1535
  */
@@ -1407,6 +1540,7 @@ export declare namespace DatabaseMigrationPreference {
1407
1540
  $unknown?: never;
1408
1541
  }
1409
1542
  /**
1543
+ * @public
1410
1544
  * <p> Indicates whether you are interested in moving to the same type of database into AWS.
1411
1545
  * For example, from SQL Server in your environment to SQL Server on AWS. </p>
1412
1546
  */
@@ -1417,6 +1551,7 @@ export declare namespace DatabaseMigrationPreference {
1417
1551
  $unknown?: never;
1418
1552
  }
1419
1553
  /**
1554
+ * @public
1420
1555
  * <p> Indicated that you do not prefer heterogeneous or homogeneous. </p>
1421
1556
  */
1422
1557
  interface NoPreferenceMember {
@@ -1425,6 +1560,9 @@ export declare namespace DatabaseMigrationPreference {
1425
1560
  noPreference: NoDatabaseMigrationPreference;
1426
1561
  $unknown?: never;
1427
1562
  }
1563
+ /**
1564
+ * @public
1565
+ */
1428
1566
  interface $UnknownMember {
1429
1567
  heterogeneous?: never;
1430
1568
  homogeneous?: never;
@@ -1445,11 +1583,13 @@ export declare namespace DatabaseMigrationPreference {
1445
1583
  */
1446
1584
  export interface DatabasePreferences {
1447
1585
  /**
1586
+ * @public
1448
1587
  * <p> Specifies whether you're interested in self-managed databases or databases managed by
1449
1588
  * AWS. </p>
1450
1589
  */
1451
1590
  databaseManagementPreference?: DatabaseManagementPreference | string;
1452
1591
  /**
1592
+ * @public
1453
1593
  * <p> Specifies your preferred migration path. </p>
1454
1594
  */
1455
1595
  databaseMigrationPreference?: DatabaseMigrationPreference;
@@ -1460,19 +1600,23 @@ export interface DatabasePreferences {
1460
1600
  */
1461
1601
  export interface BusinessGoals {
1462
1602
  /**
1603
+ * @public
1463
1604
  * <p> Business goal to achieve migration at a fast pace. </p>
1464
1605
  */
1465
1606
  speedOfMigration?: number;
1466
1607
  /**
1608
+ * @public
1467
1609
  * <p> Business goal to reduce the operational overhead on the team by moving into managed
1468
1610
  * services. </p>
1469
1611
  */
1470
1612
  reduceOperationalOverheadWithManagedServices?: number;
1471
1613
  /**
1614
+ * @public
1472
1615
  * <p> Business goal to modernize infrastructure by moving to cloud native technologies. </p>
1473
1616
  */
1474
1617
  modernizeInfrastructureWithCloudNativeTechnologies?: number;
1475
1618
  /**
1619
+ * @public
1476
1620
  * <p> Business goal to reduce license costs. </p>
1477
1621
  */
1478
1622
  licenseCostReduction?: number;
@@ -1483,6 +1627,7 @@ export interface BusinessGoals {
1483
1627
  */
1484
1628
  export interface PrioritizeBusinessGoals {
1485
1629
  /**
1630
+ * @public
1486
1631
  * <p> Rank of business goals based on priority. </p>
1487
1632
  */
1488
1633
  businessGoals?: BusinessGoals;
@@ -1492,18 +1637,22 @@ export interface PrioritizeBusinessGoals {
1492
1637
  */
1493
1638
  export interface GetPortfolioPreferencesResponse {
1494
1639
  /**
1640
+ * @public
1495
1641
  * <p> The rank of business goals based on priority. </p>
1496
1642
  */
1497
1643
  prioritizeBusinessGoals?: PrioritizeBusinessGoals;
1498
1644
  /**
1645
+ * @public
1499
1646
  * <p> The transformation preferences for non-database applications. </p>
1500
1647
  */
1501
1648
  applicationPreferences?: ApplicationPreferences;
1502
1649
  /**
1650
+ * @public
1503
1651
  * <p> The transformation preferences for database applications. </p>
1504
1652
  */
1505
1653
  databasePreferences?: DatabasePreferences;
1506
1654
  /**
1655
+ * @public
1507
1656
  * <p>The classification for application component types.</p>
1508
1657
  */
1509
1658
  applicationMode?: ApplicationMode | string;
@@ -1518,6 +1667,7 @@ export interface GetPortfolioSummaryRequest {
1518
1667
  */
1519
1668
  export interface GetPortfolioSummaryResponse {
1520
1669
  /**
1670
+ * @public
1521
1671
  * <p> An assessment summary for the portfolio including the number of servers to rehost and the
1522
1672
  * overall number of anti-patterns. </p>
1523
1673
  */
@@ -1528,6 +1678,7 @@ export interface GetPortfolioSummaryResponse {
1528
1678
  */
1529
1679
  export interface GetRecommendationReportDetailsRequest {
1530
1680
  /**
1681
+ * @public
1531
1682
  * <p> The recommendation report generation task <code>id</code> returned by <a>StartRecommendationReportGeneration</a>. </p>
1532
1683
  */
1533
1684
  id: string | undefined;
@@ -1551,26 +1702,32 @@ export type RecommendationReportStatus = (typeof RecommendationReportStatus)[key
1551
1702
  */
1552
1703
  export interface RecommendationReportDetails {
1553
1704
  /**
1705
+ * @public
1554
1706
  * <p> The status of the recommendation report generation task. </p>
1555
1707
  */
1556
1708
  status?: RecommendationReportStatus | string;
1557
1709
  /**
1710
+ * @public
1558
1711
  * <p> The status message for recommendation report generation. </p>
1559
1712
  */
1560
1713
  statusMessage?: string;
1561
1714
  /**
1715
+ * @public
1562
1716
  * <p> The time that the recommendation report generation task starts. </p>
1563
1717
  */
1564
1718
  startTime?: Date;
1565
1719
  /**
1720
+ * @public
1566
1721
  * <p> The time that the recommendation report generation task completes. </p>
1567
1722
  */
1568
1723
  completionTime?: Date;
1569
1724
  /**
1725
+ * @public
1570
1726
  * <p> The S3 bucket where the report file is located. </p>
1571
1727
  */
1572
1728
  s3Bucket?: string;
1573
1729
  /**
1730
+ * @public
1574
1731
  * <p> The Amazon S3 key name of the report file. </p>
1575
1732
  */
1576
1733
  s3Keys?: string[];
@@ -1580,10 +1737,12 @@ export interface RecommendationReportDetails {
1580
1737
  */
1581
1738
  export interface GetRecommendationReportDetailsResponse {
1582
1739
  /**
1740
+ * @public
1583
1741
  * <p> The ID of the recommendation report generation task. See the response of <a>StartRecommendationReportGeneration</a>. </p>
1584
1742
  */
1585
1743
  id?: string;
1586
1744
  /**
1745
+ * @public
1587
1746
  * <p> Detailed information about the recommendation report. </p>
1588
1747
  */
1589
1748
  recommendationReportDetails?: RecommendationReportDetails;
@@ -1593,16 +1752,19 @@ export interface GetRecommendationReportDetailsResponse {
1593
1752
  */
1594
1753
  export interface GetServerDetailsRequest {
1595
1754
  /**
1755
+ * @public
1596
1756
  * <p> The ID of the server. </p>
1597
1757
  */
1598
1758
  serverId: string | undefined;
1599
1759
  /**
1760
+ * @public
1600
1761
  * <p> The token from a previous call that you use to retrieve the next set of results. For example,
1601
1762
  * if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along
1602
1763
  * with a token. You then use the returned token to retrieve the next set of 10. </p>
1603
1764
  */
1604
1765
  nextToken?: string;
1605
1766
  /**
1767
+ * @public
1606
1768
  * <p> The maximum number of items to include in the response. The maximum value is 100. </p>
1607
1769
  */
1608
1770
  maxResults?: number;
@@ -1628,6 +1790,7 @@ export type ServerErrorCategory = (typeof ServerErrorCategory)[keyof typeof Serv
1628
1790
  */
1629
1791
  export interface ServerError {
1630
1792
  /**
1793
+ * @public
1631
1794
  * <p>The error category of server analysis.</p>
1632
1795
  */
1633
1796
  serverErrorCategory?: ServerErrorCategory | string;
@@ -1638,19 +1801,23 @@ export interface ServerError {
1638
1801
  */
1639
1802
  export interface NetworkInfo {
1640
1803
  /**
1804
+ * @public
1641
1805
  * <p> Information about the name of the interface of the server for which the assessment was
1642
1806
  * run. </p>
1643
1807
  */
1644
1808
  interfaceName: string | undefined;
1645
1809
  /**
1810
+ * @public
1646
1811
  * <p> Information about the IP address of the server for which the assessment was run. </p>
1647
1812
  */
1648
1813
  ipAddress: string | undefined;
1649
1814
  /**
1815
+ * @public
1650
1816
  * <p> Information about the MAC address of the server for which the assessment was run. </p>
1651
1817
  */
1652
1818
  macAddress: string | undefined;
1653
1819
  /**
1820
+ * @public
1654
1821
  * <p> Information about the subnet mask of the server for which the assessment was run. </p>
1655
1822
  */
1656
1823
  netMask: string | undefined;
@@ -1673,10 +1840,12 @@ export type OSType = (typeof OSType)[keyof typeof OSType];
1673
1840
  */
1674
1841
  export interface OSInfo {
1675
1842
  /**
1843
+ * @public
1676
1844
  * <p> Information about the type of operating system. </p>
1677
1845
  */
1678
1846
  type?: OSType | string;
1679
1847
  /**
1848
+ * @public
1680
1849
  * <p> Information about the version of operating system. </p>
1681
1850
  */
1682
1851
  version?: string;
@@ -1687,18 +1856,22 @@ export interface OSInfo {
1687
1856
  */
1688
1857
  export interface SystemInfo {
1689
1858
  /**
1859
+ * @public
1690
1860
  * <p> Operating system corresponding to a server. </p>
1691
1861
  */
1692
1862
  osInfo?: OSInfo;
1693
1863
  /**
1864
+ * @public
1694
1865
  * <p> File system type for the server. </p>
1695
1866
  */
1696
1867
  fileSystemType?: string;
1697
1868
  /**
1869
+ * @public
1698
1870
  * <p> Networking information related to a server. </p>
1699
1871
  */
1700
1872
  networkInfoList?: NetworkInfo[];
1701
1873
  /**
1874
+ * @public
1702
1875
  * <p> CPU architecture type for the server. </p>
1703
1876
  */
1704
1877
  cpuArchitecture?: string;
@@ -1709,59 +1882,73 @@ export interface SystemInfo {
1709
1882
  */
1710
1883
  export interface ServerDetail {
1711
1884
  /**
1885
+ * @public
1712
1886
  * <p> The server ID. </p>
1713
1887
  */
1714
1888
  id?: string;
1715
1889
  /**
1890
+ * @public
1716
1891
  * <p> The name of the server. </p>
1717
1892
  */
1718
1893
  name?: string;
1719
1894
  /**
1895
+ * @public
1720
1896
  * <p> A set of recommendations. </p>
1721
1897
  */
1722
1898
  recommendationSet?: RecommendationSet;
1723
1899
  /**
1900
+ * @public
1724
1901
  * <p> The status of assessment for the server. </p>
1725
1902
  */
1726
1903
  dataCollectionStatus?: RunTimeAssessmentStatus | string;
1727
1904
  /**
1905
+ * @public
1728
1906
  * <p> A message about the status of data collection, which contains detailed descriptions of
1729
1907
  * any error messages. </p>
1730
1908
  */
1731
1909
  statusMessage?: string;
1732
1910
  /**
1911
+ * @public
1733
1912
  * <p> A list of anti-pattern severity summaries. </p>
1734
1913
  */
1735
1914
  listAntipatternSeveritySummary?: AntipatternSeveritySummary[];
1736
1915
  /**
1916
+ * @public
1737
1917
  * <p> System information about the server. </p>
1738
1918
  */
1739
1919
  systemInfo?: SystemInfo;
1740
1920
  /**
1921
+ * @public
1741
1922
  * <p> A list of strategy summaries. </p>
1742
1923
  */
1743
1924
  applicationComponentStrategySummary?: StrategySummary[];
1744
1925
  /**
1926
+ * @public
1745
1927
  * <p> The S3 bucket name and Amazon S3 key name for anti-pattern report. </p>
1746
1928
  */
1747
1929
  antipatternReportS3Object?: S3Object;
1748
1930
  /**
1931
+ * @public
1749
1932
  * <p> The status of the anti-pattern report generation. </p>
1750
1933
  */
1751
1934
  antipatternReportStatus?: AntipatternReportStatus | string;
1752
1935
  /**
1936
+ * @public
1753
1937
  * <p> A message about the status of the anti-pattern report generation. </p>
1754
1938
  */
1755
1939
  antipatternReportStatusMessage?: string;
1756
1940
  /**
1941
+ * @public
1757
1942
  * <p> The type of server. </p>
1758
1943
  */
1759
1944
  serverType?: string;
1760
1945
  /**
1946
+ * @public
1761
1947
  * <p> The timestamp of when the server was assessed. </p>
1762
1948
  */
1763
1949
  lastAnalyzedTimestamp?: Date;
1764
1950
  /**
1951
+ * @public
1765
1952
  * <p>The error in server analysis.</p>
1766
1953
  */
1767
1954
  serverError?: ServerError;
@@ -1771,14 +1958,17 @@ export interface ServerDetail {
1771
1958
  */
1772
1959
  export interface GetServerDetailsResponse {
1773
1960
  /**
1961
+ * @public
1774
1962
  * <p> The token you use to retrieve the next set of results, or null if there are no more results. </p>
1775
1963
  */
1776
1964
  nextToken?: string;
1777
1965
  /**
1966
+ * @public
1778
1967
  * <p> Detailed information about the server. </p>
1779
1968
  */
1780
1969
  serverDetail?: ServerDetail;
1781
1970
  /**
1971
+ * @public
1782
1972
  * <p> The associated application group the server belongs to, as defined in AWS Application Discovery Service.
1783
1973
  * </p>
1784
1974
  */
@@ -1789,6 +1979,7 @@ export interface GetServerDetailsResponse {
1789
1979
  */
1790
1980
  export interface GetServerStrategiesRequest {
1791
1981
  /**
1982
+ * @public
1792
1983
  * <p> The ID of the server. </p>
1793
1984
  */
1794
1985
  serverId: string | undefined;
@@ -1799,19 +1990,23 @@ export interface GetServerStrategiesRequest {
1799
1990
  */
1800
1991
  export interface ServerStrategy {
1801
1992
  /**
1993
+ * @public
1802
1994
  * <p> Strategy recommendation for the server. </p>
1803
1995
  */
1804
1996
  recommendation?: RecommendationSet;
1805
1997
  /**
1998
+ * @public
1806
1999
  * <p> The recommendation status of the strategy for the server. </p>
1807
2000
  */
1808
2001
  status?: StrategyRecommendation | string;
1809
2002
  /**
2003
+ * @public
1810
2004
  * <p> The number of application components with this strategy recommendation running on the
1811
2005
  * server. </p>
1812
2006
  */
1813
2007
  numberOfApplicationComponents?: number;
1814
2008
  /**
2009
+ * @public
1815
2010
  * <p> Set to true if the recommendation is set as preferred. </p>
1816
2011
  */
1817
2012
  isPreferred?: boolean;
@@ -1821,6 +2016,7 @@ export interface ServerStrategy {
1821
2016
  */
1822
2017
  export interface GetServerStrategiesResponse {
1823
2018
  /**
2019
+ * @public
1824
2020
  * <p> A list of strategy recommendations for the server. </p>
1825
2021
  */
1826
2022
  serverStrategies?: ServerStrategy[];
@@ -1843,10 +2039,12 @@ export type GroupName = (typeof GroupName)[keyof typeof GroupName];
1843
2039
  */
1844
2040
  export interface Group {
1845
2041
  /**
2042
+ * @public
1846
2043
  * <p> The key of the specific import group. </p>
1847
2044
  */
1848
2045
  name?: GroupName | string;
1849
2046
  /**
2047
+ * @public
1850
2048
  * <p> The value of the specific import group. </p>
1851
2049
  */
1852
2050
  value?: string;
@@ -1868,10 +2066,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
1868
2066
  */
1869
2067
  export interface ListApplicationComponentsRequest {
1870
2068
  /**
2069
+ * @public
1871
2070
  * <p> Criteria for filtering the list of application components. </p>
1872
2071
  */
1873
2072
  applicationComponentCriteria?: ApplicationComponentCriteria | string;
1874
2073
  /**
2074
+ * @public
1875
2075
  * <p> Specify the value based on the application component criteria type. For example, if
1876
2076
  * <code>applicationComponentCriteria</code> is set to <code>SERVER_ID</code> and
1877
2077
  * <code>filterValue</code> is set to <code>server1</code>, then <a>ListApplicationComponents</a> returns all the application components running on
@@ -1879,21 +2079,25 @@ export interface ListApplicationComponentsRequest {
1879
2079
  */
1880
2080
  filterValue?: string;
1881
2081
  /**
2082
+ * @public
1882
2083
  * <p> Specifies whether to sort by ascending (<code>ASC</code>) or descending
1883
2084
  * (<code>DESC</code>) order. </p>
1884
2085
  */
1885
2086
  sort?: SortOrder | string;
1886
2087
  /**
2088
+ * @public
1887
2089
  * <p> The group ID specified in to filter on. </p>
1888
2090
  */
1889
2091
  groupIdFilter?: Group[];
1890
2092
  /**
2093
+ * @public
1891
2094
  * <p> The token from a previous call that you use to retrieve the next set of results. For example,
1892
2095
  * if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along
1893
2096
  * with a token. You then use the returned token to retrieve the next set of 10. </p>
1894
2097
  */
1895
2098
  nextToken?: string;
1896
2099
  /**
2100
+ * @public
1897
2101
  * <p> The maximum number of items to include in the response. The maximum value is 100. </p>
1898
2102
  */
1899
2103
  maxResults?: number;
@@ -1903,11 +2107,13 @@ export interface ListApplicationComponentsRequest {
1903
2107
  */
1904
2108
  export interface ListApplicationComponentsResponse {
1905
2109
  /**
2110
+ * @public
1906
2111
  * <p> The list of application components with detailed information about each component.
1907
2112
  * </p>
1908
2113
  */
1909
2114
  applicationComponentInfos?: ApplicationComponentDetail[];
1910
2115
  /**
2116
+ * @public
1911
2117
  * <p> The token you use to retrieve the next set of results, or null if there are no more results. </p>
1912
2118
  */
1913
2119
  nextToken?: string;
@@ -1929,12 +2135,14 @@ export declare class ServiceLinkedRoleLockClientException extends __BaseExceptio
1929
2135
  */
1930
2136
  export interface ListCollectorsRequest {
1931
2137
  /**
2138
+ * @public
1932
2139
  * <p> The token from a previous call that you use to retrieve the next set of results. For example,
1933
2140
  * if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along
1934
2141
  * with a token. You then use the returned token to retrieve the next set of 10. </p>
1935
2142
  */
1936
2143
  nextToken?: string;
1937
2144
  /**
2145
+ * @public
1938
2146
  * <p> The maximum number of items to include in the response. The maximum value is 100. </p>
1939
2147
  */
1940
2148
  maxResults?: number;
@@ -1957,14 +2165,17 @@ export type CollectorHealth = (typeof CollectorHealth)[keyof typeof CollectorHea
1957
2165
  */
1958
2166
  export interface IPAddressBasedRemoteInfo {
1959
2167
  /**
2168
+ * @public
1960
2169
  * <p>The time stamp of the configuration.</p>
1961
2170
  */
1962
2171
  ipAddressConfigurationTimeStamp?: string;
1963
2172
  /**
2173
+ * @public
1964
2174
  * <p>The type of authorization.</p>
1965
2175
  */
1966
2176
  authType?: AuthType | string;
1967
2177
  /**
2178
+ * @public
1968
2179
  * <p>The type of the operating system.</p>
1969
2180
  */
1970
2181
  osType?: OSType | string;
@@ -1986,10 +2197,12 @@ export type PipelineType = (typeof PipelineType)[keyof typeof PipelineType];
1986
2197
  */
1987
2198
  export interface PipelineInfo {
1988
2199
  /**
2200
+ * @public
1989
2201
  * <p>The type of pipeline.</p>
1990
2202
  */
1991
2203
  pipelineType?: PipelineType | string;
1992
2204
  /**
2205
+ * @public
1993
2206
  * <p>The time when the pipeline info was configured.</p>
1994
2207
  */
1995
2208
  pipelineConfigurationTimeStamp?: string;
@@ -2000,6 +2213,7 @@ export interface PipelineInfo {
2000
2213
  */
2001
2214
  export interface RemoteSourceCodeAnalysisServerInfo {
2002
2215
  /**
2216
+ * @public
2003
2217
  * <p>The time when the remote source code server was configured.</p>
2004
2218
  */
2005
2219
  remoteSourceCodeAnalysisServerConfigurationTimestamp?: string;
@@ -2010,10 +2224,12 @@ export interface RemoteSourceCodeAnalysisServerInfo {
2010
2224
  */
2011
2225
  export interface VcenterBasedRemoteInfo {
2012
2226
  /**
2227
+ * @public
2013
2228
  * <p>The time when the remote server based on vCenter was last configured.</p>
2014
2229
  */
2015
2230
  vcenterConfigurationTimeStamp?: string;
2016
2231
  /**
2232
+ * @public
2017
2233
  * <p>The type of the operating system.</p>
2018
2234
  */
2019
2235
  osType?: OSType | string;
@@ -2037,10 +2253,12 @@ export type VersionControlType = (typeof VersionControlType)[keyof typeof Versio
2037
2253
  */
2038
2254
  export interface VersionControlInfo {
2039
2255
  /**
2256
+ * @public
2040
2257
  * <p>The type of version control.</p>
2041
2258
  */
2042
2259
  versionControlType?: VersionControlType | string;
2043
2260
  /**
2261
+ * @public
2044
2262
  * <p>The time when the version control system was last configured.</p>
2045
2263
  */
2046
2264
  versionControlConfigurationTimeStamp?: string;
@@ -2051,22 +2269,27 @@ export interface VersionControlInfo {
2051
2269
  */
2052
2270
  export interface ConfigurationSummary {
2053
2271
  /**
2272
+ * @public
2054
2273
  * <p>The list of vCenter configurations.</p>
2055
2274
  */
2056
2275
  vcenterBasedRemoteInfoList?: VcenterBasedRemoteInfo[];
2057
2276
  /**
2277
+ * @public
2058
2278
  * <p>IP address based configurations.</p>
2059
2279
  */
2060
2280
  ipAddressBasedRemoteInfoList?: IPAddressBasedRemoteInfo[];
2061
2281
  /**
2282
+ * @public
2062
2283
  * <p>The list of the version control configurations.</p>
2063
2284
  */
2064
2285
  versionControlInfoList?: VersionControlInfo[];
2065
2286
  /**
2287
+ * @public
2066
2288
  * <p>The list of pipeline info configurations.</p>
2067
2289
  */
2068
2290
  pipelineInfoList?: PipelineInfo[];
2069
2291
  /**
2292
+ * @public
2070
2293
  * <p>Info about the remote server source code configuration.</p>
2071
2294
  */
2072
2295
  remoteSourceCodeAnalysisServerInfo?: RemoteSourceCodeAnalysisServerInfo;
@@ -2077,35 +2300,43 @@ export interface ConfigurationSummary {
2077
2300
  */
2078
2301
  export interface Collector {
2079
2302
  /**
2303
+ * @public
2080
2304
  * <p> The ID of the collector. </p>
2081
2305
  */
2082
2306
  collectorId?: string;
2083
2307
  /**
2308
+ * @public
2084
2309
  * <p> IP address of the server that is hosting the collector. </p>
2085
2310
  */
2086
2311
  ipAddress?: string;
2087
2312
  /**
2313
+ * @public
2088
2314
  * <p> Hostname of the server that is hosting the collector. </p>
2089
2315
  */
2090
2316
  hostName?: string;
2091
2317
  /**
2318
+ * @public
2092
2319
  * <p> Indicates the health of a collector. </p>
2093
2320
  */
2094
2321
  collectorHealth?: CollectorHealth | string;
2095
2322
  /**
2323
+ * @public
2096
2324
  * <p> Current version of the collector that is running in the environment that you specify.
2097
2325
  * </p>
2098
2326
  */
2099
2327
  collectorVersion?: string;
2100
2328
  /**
2329
+ * @public
2101
2330
  * <p> Time when the collector registered with the service. </p>
2102
2331
  */
2103
2332
  registeredTimeStamp?: string;
2104
2333
  /**
2334
+ * @public
2105
2335
  * <p> Time when the collector last pinged the service. </p>
2106
2336
  */
2107
2337
  lastActivityTimeStamp?: string;
2108
2338
  /**
2339
+ * @public
2109
2340
  * <p>Summary of the collector configuration.</p>
2110
2341
  */
2111
2342
  configurationSummary?: ConfigurationSummary;
@@ -2115,10 +2346,12 @@ export interface Collector {
2115
2346
  */
2116
2347
  export interface ListCollectorsResponse {
2117
2348
  /**
2349
+ * @public
2118
2350
  * <p> The list of all the installed collectors. </p>
2119
2351
  */
2120
2352
  Collectors?: Collector[];
2121
2353
  /**
2354
+ * @public
2122
2355
  * <p> The token you use to retrieve the next set of results, or null if there are no more results. </p>
2123
2356
  */
2124
2357
  nextToken?: string;
@@ -2128,12 +2361,14 @@ export interface ListCollectorsResponse {
2128
2361
  */
2129
2362
  export interface ListImportFileTaskRequest {
2130
2363
  /**
2364
+ * @public
2131
2365
  * <p> The token from a previous call that you use to retrieve the next set of results. For example,
2132
2366
  * if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along
2133
2367
  * with a token. You then use the returned token to retrieve the next set of 10. </p>
2134
2368
  */
2135
2369
  nextToken?: string;
2136
2370
  /**
2371
+ * @public
2137
2372
  * <p> The total number of items to return. The maximum value is 100. </p>
2138
2373
  */
2139
2374
  maxResults?: number;
@@ -2144,47 +2379,58 @@ export interface ListImportFileTaskRequest {
2144
2379
  */
2145
2380
  export interface ImportFileTaskInformation {
2146
2381
  /**
2382
+ * @public
2147
2383
  * <p> The ID of the import file task. </p>
2148
2384
  */
2149
2385
  id?: string;
2150
2386
  /**
2387
+ * @public
2151
2388
  * <p> Status of import file task. </p>
2152
2389
  */
2153
2390
  status?: ImportFileTaskStatus | string;
2154
2391
  /**
2392
+ * @public
2155
2393
  * <p> Start time of the import task. </p>
2156
2394
  */
2157
2395
  startTime?: Date;
2158
2396
  /**
2397
+ * @public
2159
2398
  * <p> The S3 bucket where the import file is located. </p>
2160
2399
  */
2161
2400
  inputS3Bucket?: string;
2162
2401
  /**
2402
+ * @public
2163
2403
  * <p> The Amazon S3 key name of the import file. </p>
2164
2404
  */
2165
2405
  inputS3Key?: string;
2166
2406
  /**
2407
+ * @public
2167
2408
  * <p> The S3 bucket name for status report of import task. </p>
2168
2409
  */
2169
2410
  statusReportS3Bucket?: string;
2170
2411
  /**
2412
+ * @public
2171
2413
  * <p> The Amazon S3 key name for status report of import task. The report contains details about
2172
2414
  * whether each record imported successfully or why it did not. </p>
2173
2415
  */
2174
2416
  statusReportS3Key?: string;
2175
2417
  /**
2418
+ * @public
2176
2419
  * <p> The time that the import task completes. </p>
2177
2420
  */
2178
2421
  completionTime?: Date;
2179
2422
  /**
2423
+ * @public
2180
2424
  * <p> The number of records successfully imported. </p>
2181
2425
  */
2182
2426
  numberOfRecordsSuccess?: number;
2183
2427
  /**
2428
+ * @public
2184
2429
  * <p> The number of records that failed to be imported. </p>
2185
2430
  */
2186
2431
  numberOfRecordsFailed?: number;
2187
2432
  /**
2433
+ * @public
2188
2434
  * <p> The name of the import task given in <code>StartImportFileTask</code>. </p>
2189
2435
  */
2190
2436
  importName?: string;
@@ -2194,10 +2440,12 @@ export interface ImportFileTaskInformation {
2194
2440
  */
2195
2441
  export interface ListImportFileTaskResponse {
2196
2442
  /**
2443
+ * @public
2197
2444
  * <p> Lists information about the files you import.</p>
2198
2445
  */
2199
2446
  taskInfos?: ImportFileTaskInformation[];
2200
2447
  /**
2448
+ * @public
2201
2449
  * <p> The token you use to retrieve the next set of results, or null if there are no more results. </p>
2202
2450
  */
2203
2451
  nextToken?: string;
@@ -2224,10 +2472,12 @@ export type ServerCriteria = (typeof ServerCriteria)[keyof typeof ServerCriteria
2224
2472
  */
2225
2473
  export interface ListServersRequest {
2226
2474
  /**
2475
+ * @public
2227
2476
  * <p> Criteria for filtering servers. </p>
2228
2477
  */
2229
2478
  serverCriteria?: ServerCriteria | string;
2230
2479
  /**
2480
+ * @public
2231
2481
  * <p> Specifies the filter value, which is based on the type of server criteria. For example,
2232
2482
  * if <code>serverCriteria</code> is <code>OS_NAME</code>, and the <code>filterValue</code> is
2233
2483
  * equal to <code>WindowsServer</code>, then <code>ListServers</code> returns all of the servers
@@ -2235,21 +2485,25 @@ export interface ListServersRequest {
2235
2485
  */
2236
2486
  filterValue?: string;
2237
2487
  /**
2488
+ * @public
2238
2489
  * <p> Specifies whether to sort by ascending (<code>ASC</code>) or descending
2239
2490
  * (<code>DESC</code>) order. </p>
2240
2491
  */
2241
2492
  sort?: SortOrder | string;
2242
2493
  /**
2494
+ * @public
2243
2495
  * <p> Specifies the group ID to filter on. </p>
2244
2496
  */
2245
2497
  groupIdFilter?: Group[];
2246
2498
  /**
2499
+ * @public
2247
2500
  * <p> The token from a previous call that you use to retrieve the next set of results. For example,
2248
2501
  * if a previous call to this action returned 100 items, but you set <code>maxResults</code> to 10. You'll receive a set of 10 results along
2249
2502
  * with a token. You then use the returned token to retrieve the next set of 10. </p>
2250
2503
  */
2251
2504
  nextToken?: string;
2252
2505
  /**
2506
+ * @public
2253
2507
  * <p> The maximum number of items to include in the response. The maximum value is 100. </p>
2254
2508
  */
2255
2509
  maxResults?: number;
@@ -2259,10 +2513,12 @@ export interface ListServersRequest {
2259
2513
  */
2260
2514
  export interface ListServersResponse {
2261
2515
  /**
2516
+ * @public
2262
2517
  * <p> The list of servers with detailed information about each server. </p>
2263
2518
  */
2264
2519
  serverInfos?: ServerDetail[];
2265
2520
  /**
2521
+ * @public
2266
2522
  * <p> The token you use to retrieve the next set of results, or null if there are no more results. </p>
2267
2523
  */
2268
2524
  nextToken?: string;
@@ -2285,18 +2541,22 @@ export declare class ConflictException extends __BaseException {
2285
2541
  */
2286
2542
  export interface PutPortfolioPreferencesRequest {
2287
2543
  /**
2544
+ * @public
2288
2545
  * <p> The rank of the business goals based on priority. </p>
2289
2546
  */
2290
2547
  prioritizeBusinessGoals?: PrioritizeBusinessGoals;
2291
2548
  /**
2549
+ * @public
2292
2550
  * <p> The transformation preferences for non-database applications. </p>
2293
2551
  */
2294
2552
  applicationPreferences?: ApplicationPreferences;
2295
2553
  /**
2554
+ * @public
2296
2555
  * <p> The transformation preferences for database applications. </p>
2297
2556
  */
2298
2557
  databasePreferences?: DatabasePreferences;
2299
2558
  /**
2559
+ * @public
2300
2560
  * <p>The classification for application component types.</p>
2301
2561
  */
2302
2562
  applicationMode?: ApplicationMode | string;
@@ -2324,16 +2584,19 @@ export declare class ServiceQuotaExceededException extends __BaseException {
2324
2584
  */
2325
2585
  export interface StartAssessmentRequest {
2326
2586
  /**
2587
+ * @public
2327
2588
  * <p> The S3 bucket used by the collectors to send analysis data to the service. The bucket
2328
2589
  * name must begin with <code>migrationhub-strategy-</code>. </p>
2329
2590
  */
2330
2591
  s3bucketForAnalysisData?: string;
2331
2592
  /**
2593
+ * @public
2332
2594
  * <p> The S3 bucket where all the reports generated by the service are stored. The bucket name
2333
2595
  * must begin with <code>migrationhub-strategy-</code>. </p>
2334
2596
  */
2335
2597
  s3bucketForReportData?: string;
2336
2598
  /**
2599
+ * @public
2337
2600
  * <p>List of criteria for assessment.</p>
2338
2601
  */
2339
2602
  assessmentTargets?: AssessmentTarget[];
@@ -2343,6 +2606,7 @@ export interface StartAssessmentRequest {
2343
2606
  */
2344
2607
  export interface StartAssessmentResponse {
2345
2608
  /**
2609
+ * @public
2346
2610
  * <p> The ID of the assessment. </p>
2347
2611
  */
2348
2612
  assessmentId?: string;
@@ -2365,29 +2629,35 @@ export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType
2365
2629
  */
2366
2630
  export interface StartImportFileTaskRequest {
2367
2631
  /**
2632
+ * @public
2368
2633
  * <p> A descriptive name for the request. </p>
2369
2634
  */
2370
2635
  name: string | undefined;
2371
2636
  /**
2637
+ * @public
2372
2638
  * <p> The S3 bucket where the import file is located. The bucket name is required to begin with
2373
2639
  * <code>migrationhub-strategy-</code>.</p>
2374
2640
  */
2375
2641
  S3Bucket: string | undefined;
2376
2642
  /**
2643
+ * @public
2377
2644
  * <p> The Amazon S3 key name of the import file. </p>
2378
2645
  */
2379
2646
  s3key: string | undefined;
2380
2647
  /**
2648
+ * @public
2381
2649
  * <p>Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that
2382
2650
  * the servers specified in the import file are available in AWS Application Discovery Service. </p>
2383
2651
  */
2384
2652
  dataSourceType?: DataSourceType | string;
2385
2653
  /**
2654
+ * @public
2386
2655
  * <p>Groups the resources in the import file together with a unique name. This ID can be as
2387
2656
  * filter in <code>ListApplicationComponents</code> and <code>ListServers</code>. </p>
2388
2657
  */
2389
2658
  groupId?: Group[];
2390
2659
  /**
2660
+ * @public
2391
2661
  * <p> The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to
2392
2662
  * begin with migrationhub-strategy-. </p>
2393
2663
  */
@@ -2398,6 +2668,7 @@ export interface StartImportFileTaskRequest {
2398
2668
  */
2399
2669
  export interface StartImportFileTaskResponse {
2400
2670
  /**
2671
+ * @public
2401
2672
  * <p> The ID for a specific import task. The ID is unique within an AWS account. </p>
2402
2673
  */
2403
2674
  id?: string;
@@ -2419,11 +2690,13 @@ export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
2419
2690
  */
2420
2691
  export interface StartRecommendationReportGenerationRequest {
2421
2692
  /**
2693
+ * @public
2422
2694
  * <p> The output format for the recommendation report file. The default format is Microsoft
2423
2695
  * Excel. </p>
2424
2696
  */
2425
2697
  outputFormat?: OutputFormat | string;
2426
2698
  /**
2699
+ * @public
2427
2700
  * <p> Groups the resources in the recommendation report with a unique name. </p>
2428
2701
  */
2429
2702
  groupIdFilter?: Group[];
@@ -2433,6 +2706,7 @@ export interface StartRecommendationReportGenerationRequest {
2433
2706
  */
2434
2707
  export interface StartRecommendationReportGenerationResponse {
2435
2708
  /**
2709
+ * @public
2436
2710
  * <p> The ID of the recommendation report generation task. </p>
2437
2711
  */
2438
2712
  id?: string;
@@ -2442,6 +2716,7 @@ export interface StartRecommendationReportGenerationResponse {
2442
2716
  */
2443
2717
  export interface StopAssessmentRequest {
2444
2718
  /**
2719
+ * @public
2445
2720
  * <p> The <code>assessmentId</code> returned by <a>StartAssessment</a>. </p>
2446
2721
  */
2447
2722
  assessmentId: string | undefined;
@@ -2471,18 +2746,22 @@ export type VersionControl = (typeof VersionControl)[keyof typeof VersionControl
2471
2746
  */
2472
2747
  export interface SourceCode {
2473
2748
  /**
2749
+ * @public
2474
2750
  * <p> The type of repository to use for the source code. </p>
2475
2751
  */
2476
2752
  versionControl?: VersionControl | string;
2477
2753
  /**
2754
+ * @public
2478
2755
  * <p> The branch of the source code. </p>
2479
2756
  */
2480
2757
  sourceVersion?: string;
2481
2758
  /**
2759
+ * @public
2482
2760
  * <p> The repository name for the source code. </p>
2483
2761
  */
2484
2762
  location?: string;
2485
2763
  /**
2764
+ * @public
2486
2765
  * <p>The name of the project.</p>
2487
2766
  */
2488
2767
  projectName?: string;
@@ -2494,20 +2773,24 @@ export interface SourceCode {
2494
2773
  */
2495
2774
  export interface StrategyOption {
2496
2775
  /**
2776
+ * @public
2497
2777
  * <p> Type of transformation. For example, Rehost, Replatform, and so on. </p>
2498
2778
  */
2499
2779
  strategy?: Strategy | string;
2500
2780
  /**
2781
+ * @public
2501
2782
  * <p> The name of the tool that can be used to transform an application component using this
2502
2783
  * strategy. </p>
2503
2784
  */
2504
2785
  toolName?: TransformationToolName | string;
2505
2786
  /**
2787
+ * @public
2506
2788
  * <p> Destination information about where the application component can migrate to. For
2507
2789
  * example, <code>EC2</code>, <code>ECS</code>, and so on. </p>
2508
2790
  */
2509
2791
  targetDestination?: TargetDestination | string;
2510
2792
  /**
2793
+ * @public
2511
2794
  * <p> Indicates if a specific strategy is preferred for the application component. </p>
2512
2795
  */
2513
2796
  isPreferred?: boolean;
@@ -2517,33 +2800,40 @@ export interface StrategyOption {
2517
2800
  */
2518
2801
  export interface UpdateApplicationComponentConfigRequest {
2519
2802
  /**
2803
+ * @public
2520
2804
  * <p> The ID of the application component. The ID is unique within an AWS account. </p>
2521
2805
  */
2522
2806
  applicationComponentId: string | undefined;
2523
2807
  /**
2808
+ * @public
2524
2809
  * <p> Indicates whether the application component has been included for server recommendation
2525
2810
  * or not. </p>
2526
2811
  */
2527
2812
  inclusionStatus?: InclusionStatus | string;
2528
2813
  /**
2814
+ * @public
2529
2815
  * <p> The preferred strategy options for the application component. Use values from the <a>GetApplicationComponentStrategies</a> response. </p>
2530
2816
  */
2531
2817
  strategyOption?: StrategyOption;
2532
2818
  /**
2819
+ * @public
2533
2820
  * <p> The list of source code configurations to update for the application component. </p>
2534
2821
  */
2535
2822
  sourceCodeList?: SourceCode[];
2536
2823
  /**
2824
+ * @public
2537
2825
  * <p> Database credentials. </p>
2538
2826
  */
2539
2827
  secretsManagerKey?: string;
2540
2828
  /**
2829
+ * @public
2541
2830
  * <p>Update the configuration request of an application component. If it is set to true, the
2542
2831
  * source code and/or database credentials are updated. If it is set to false, the source code
2543
2832
  * and/or database credentials are updated and an analysis is initiated.</p>
2544
2833
  */
2545
2834
  configureOnly?: boolean;
2546
2835
  /**
2836
+ * @public
2547
2837
  * <p>The type of known component.</p>
2548
2838
  */
2549
2839
  appType?: AppType | string;
@@ -2558,10 +2848,12 @@ export interface UpdateApplicationComponentConfigResponse {
2558
2848
  */
2559
2849
  export interface UpdateServerConfigRequest {
2560
2850
  /**
2851
+ * @public
2561
2852
  * <p> The ID of the server. </p>
2562
2853
  */
2563
2854
  serverId: string | undefined;
2564
2855
  /**
2856
+ * @public
2565
2857
  * <p> The preferred strategy options for the application component. See the response from <a>GetServerStrategies</a>.</p>
2566
2858
  */
2567
2859
  strategyOption?: StrategyOption;