@aws-sdk/client-compute-optimizer 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.
@@ -32,20 +32,24 @@ export type Status = (typeof Status)[keyof typeof Status];
32
32
  */
33
33
  export interface AccountEnrollmentStatus {
34
34
  /**
35
+ * @public
35
36
  * <p>The Amazon Web Services account ID.</p>
36
37
  */
37
38
  accountId?: string;
38
39
  /**
40
+ * @public
39
41
  * <p>The account enrollment status.</p>
40
42
  */
41
43
  status?: Status | string;
42
44
  /**
45
+ * @public
43
46
  * <p>The reason for the account enrollment status.</p>
44
47
  * <p>For example, an account might show a status of <code>Pending</code> because member
45
48
  * accounts of an organization require more time to be enrolled in the service.</p>
46
49
  */
47
50
  statusReason?: string;
48
51
  /**
52
+ * @public
49
53
  * <p>The Unix epoch timestamp, in seconds, of when the account enrollment status was last
50
54
  * updated.</p>
51
55
  */
@@ -69,20 +73,24 @@ export type AutoScalingConfiguration = (typeof AutoScalingConfiguration)[keyof t
69
73
  */
70
74
  export interface AutoScalingGroupConfiguration {
71
75
  /**
76
+ * @public
72
77
  * <p>The desired capacity, or number of instances, for the Auto Scaling group.</p>
73
78
  */
74
79
  desiredCapacity?: number;
75
80
  /**
81
+ * @public
76
82
  * <p>The minimum size, or minimum number of instances, for the Auto Scaling
77
83
  * group.</p>
78
84
  */
79
85
  minSize?: number;
80
86
  /**
87
+ * @public
81
88
  * <p>The maximum size, or maximum number of instances, for the Auto Scaling
82
89
  * group.</p>
83
90
  */
84
91
  maxSize?: number;
85
92
  /**
93
+ * @public
86
94
  * <p>The instance type for the Auto Scaling group.</p>
87
95
  */
88
96
  instanceType?: string;
@@ -146,6 +154,7 @@ export type ExternalMetricsSource = (typeof ExternalMetricsSource)[keyof typeof
146
154
  */
147
155
  export interface ExternalMetricsPreference {
148
156
  /**
157
+ * @public
149
158
  * <p> Contains the source options for external metrics preferences. </p>
150
159
  */
151
160
  source?: ExternalMetricsSource | string;
@@ -168,6 +177,7 @@ export type InferredWorkloadTypesPreference = (typeof InferredWorkloadTypesPrefe
168
177
  */
169
178
  export interface EffectiveRecommendationPreferences {
170
179
  /**
180
+ * @public
171
181
  * <p>Describes the CPU vendor and architecture for an instance or Auto Scaling group
172
182
  * recommendations.</p>
173
183
  * <p>For example, when you specify <code>AWS_ARM64</code> with:</p>
@@ -188,6 +198,7 @@ export interface EffectiveRecommendationPreferences {
188
198
  */
189
199
  cpuVendorArchitectures?: (CpuVendorArchitecture | string)[];
190
200
  /**
201
+ * @public
191
202
  * <p>Describes the activation status of the enhanced infrastructure metrics
192
203
  * preference.</p>
193
204
  * <p>A status of <code>Active</code> confirms that the preference is applied in the latest
@@ -199,6 +210,7 @@ export interface EffectiveRecommendationPreferences {
199
210
  */
200
211
  enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
201
212
  /**
213
+ * @public
202
214
  * <p>Describes the activation status of the inferred workload types preference.</p>
203
215
  * <p>A status of <code>Active</code> confirms that the preference is applied in the latest
204
216
  * recommendation refresh. A status of <code>Inactive</code> confirms that it's not yet
@@ -206,6 +218,7 @@ export interface EffectiveRecommendationPreferences {
206
218
  */
207
219
  inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
208
220
  /**
221
+ * @public
209
222
  * <p> An object that describes the external metrics recommendation preference. </p>
210
223
  * <p> If the preference is applied in the latest recommendation refresh, an object with a
211
224
  * valid <code>source</code> value appears in the response. If the preference isn't applied
@@ -306,6 +319,7 @@ export type MetricStatistic = (typeof MetricStatistic)[keyof typeof MetricStatis
306
319
  */
307
320
  export interface UtilizationMetric {
308
321
  /**
322
+ * @public
309
323
  * <p>The name of the utilization metric.</p>
310
324
  * <p>The following utilization metrics are available:</p>
311
325
  * <ul>
@@ -418,6 +432,7 @@ export interface UtilizationMetric {
418
432
  */
419
433
  name?: MetricName | string;
420
434
  /**
435
+ * @public
421
436
  * <p>The statistic of the utilization metric.</p>
422
437
  * <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
423
438
  * return utilization metrics using only the <code>Maximum</code> statistic, which is the
@@ -433,6 +448,7 @@ export interface UtilizationMetric {
433
448
  */
434
449
  statistic?: MetricStatistic | string;
435
450
  /**
451
+ * @public
436
452
  * <p>The value of the utilization metric.</p>
437
453
  */
438
454
  value?: number;
@@ -458,11 +474,13 @@ export type Currency = (typeof Currency)[keyof typeof Currency];
458
474
  */
459
475
  export interface EstimatedMonthlySavings {
460
476
  /**
477
+ * @public
461
478
  * <p>The currency of the estimated monthly
462
479
  * savings.</p>
463
480
  */
464
481
  currency?: Currency | string;
465
482
  /**
483
+ * @public
466
484
  * <p>The value of the estimated monthly savings.</p>
467
485
  */
468
486
  value?: number;
@@ -488,11 +506,13 @@ export interface EstimatedMonthlySavings {
488
506
  */
489
507
  export interface SavingsOpportunity {
490
508
  /**
509
+ * @public
491
510
  * <p>The estimated monthly savings possible as a percentage of monthly cost by adopting
492
511
  * Compute Optimizer recommendations for a given resource.</p>
493
512
  */
494
513
  savingsOpportunityPercentage?: number;
495
514
  /**
515
+ * @public
496
516
  * <p>An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given
497
517
  * resource. This is based on the On-Demand instance pricing..</p>
498
518
  */
@@ -504,10 +524,12 @@ export interface SavingsOpportunity {
504
524
  */
505
525
  export interface AutoScalingGroupRecommendationOption {
506
526
  /**
527
+ * @public
507
528
  * <p>An array of objects that describe an Auto Scaling group configuration.</p>
508
529
  */
509
530
  configuration?: AutoScalingGroupConfiguration;
510
531
  /**
532
+ * @public
511
533
  * <p>An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.</p>
512
534
  * <note>
513
535
  * <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected
@@ -519,6 +541,7 @@ export interface AutoScalingGroupRecommendationOption {
519
541
  */
520
542
  projectedUtilizationMetrics?: UtilizationMetric[];
521
543
  /**
544
+ * @public
522
545
  * <p>The performance risk of the Auto Scaling group configuration
523
546
  * recommendation.</p>
524
547
  * <p>Performance risk indicates the likelihood of the recommended instance type not meeting
@@ -537,17 +560,20 @@ export interface AutoScalingGroupRecommendationOption {
537
560
  */
538
561
  performanceRisk?: number;
539
562
  /**
563
+ * @public
540
564
  * <p>The rank of the Auto Scaling group recommendation option.</p>
541
565
  * <p>The top recommendation option is ranked as <code>1</code>.</p>
542
566
  */
543
567
  rank?: number;
544
568
  /**
569
+ * @public
545
570
  * <p>An object that describes the savings opportunity for the Auto Scaling group
546
571
  * recommendation option. Savings opportunity includes the estimated monthly savings amount
547
572
  * and percentage.</p>
548
573
  */
549
574
  savingsOpportunity?: SavingsOpportunity;
550
575
  /**
576
+ * @public
551
577
  * <p>The level of effort required to migrate from the current instance type to the
552
578
  * recommended instance type.</p>
553
579
  * <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
@@ -565,18 +591,22 @@ export interface AutoScalingGroupRecommendationOption {
565
591
  */
566
592
  export interface AutoScalingGroupRecommendation {
567
593
  /**
594
+ * @public
568
595
  * <p>The Amazon Web Services account ID of the Auto Scaling group.</p>
569
596
  */
570
597
  accountId?: string;
571
598
  /**
599
+ * @public
572
600
  * <p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>
573
601
  */
574
602
  autoScalingGroupArn?: string;
575
603
  /**
604
+ * @public
576
605
  * <p>The name of the Auto Scaling group.</p>
577
606
  */
578
607
  autoScalingGroupName?: string;
579
608
  /**
609
+ * @public
580
610
  * <p>The finding classification of the Auto Scaling group.</p>
581
611
  * <p>Findings for Auto Scaling groups include:</p>
582
612
  * <ul>
@@ -601,40 +631,48 @@ export interface AutoScalingGroupRecommendation {
601
631
  */
602
632
  finding?: Finding | string;
603
633
  /**
634
+ * @public
604
635
  * <p>An array of objects that describe the utilization metrics of the Auto Scaling
605
636
  * group.</p>
606
637
  */
607
638
  utilizationMetrics?: UtilizationMetric[];
608
639
  /**
640
+ * @public
609
641
  * <p>The number of days for which utilization metrics were analyzed for the Auto Scaling group.</p>
610
642
  */
611
643
  lookBackPeriodInDays?: number;
612
644
  /**
645
+ * @public
613
646
  * <p>An array of objects that describe the current configuration of the Auto Scaling
614
647
  * group.</p>
615
648
  */
616
649
  currentConfiguration?: AutoScalingGroupConfiguration;
617
650
  /**
651
+ * @public
618
652
  * <p>An array of objects that describe the recommendation options for the Auto Scaling
619
653
  * group.</p>
620
654
  */
621
655
  recommendationOptions?: AutoScalingGroupRecommendationOption[];
622
656
  /**
657
+ * @public
623
658
  * <p>The timestamp of when the Auto Scaling group recommendation was last
624
659
  * generated.</p>
625
660
  */
626
661
  lastRefreshTimestamp?: Date;
627
662
  /**
663
+ * @public
628
664
  * <p>The risk of the current Auto Scaling group not meeting the performance needs of
629
665
  * its workloads. The higher the risk, the more likely the current Auto Scaling group
630
666
  * configuration has insufficient capacity and cannot meet workload requirements.</p>
631
667
  */
632
668
  currentPerformanceRisk?: CurrentPerformanceRisk | string;
633
669
  /**
670
+ * @public
634
671
  * <p>An object that describes the effective recommendation preferences for the Auto Scaling group.</p>
635
672
  */
636
673
  effectiveRecommendationPreferences?: EffectiveRecommendationPreferences;
637
674
  /**
675
+ * @public
638
676
  * <p>The applications that might be running on the instances in the Auto Scaling group
639
677
  * as inferred by Compute Optimizer.</p>
640
678
  * <p>Compute Optimizer can infer if one of the following applications might be running on
@@ -752,6 +790,7 @@ export type ScopeName = (typeof ScopeName)[keyof typeof ScopeName];
752
790
  */
753
791
  export interface Scope {
754
792
  /**
793
+ * @public
755
794
  * <p>The name of the scope.</p>
756
795
  * <p>The following scopes are possible:</p>
757
796
  * <ul>
@@ -776,6 +815,7 @@ export interface Scope {
776
815
  */
777
816
  name?: ScopeName | string;
778
817
  /**
818
+ * @public
779
819
  * <p>The value of the scope.</p>
780
820
  * <p>If you specified the <code>name</code> of the scope as:</p>
781
821
  * <ul>
@@ -803,6 +843,7 @@ export interface Scope {
803
843
  */
804
844
  export interface DeleteRecommendationPreferencesRequest {
805
845
  /**
846
+ * @public
806
847
  * <p>The target resource type of the recommendation preference to delete.</p>
807
848
  * <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
808
849
  * that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
@@ -814,6 +855,7 @@ export interface DeleteRecommendationPreferencesRequest {
814
855
  */
815
856
  resourceType: ResourceType | string | undefined;
816
857
  /**
858
+ * @public
817
859
  * <p>An object that describes the scope of the recommendation preference to delete.</p>
818
860
  * <p>You can delete recommendation preferences that are created at the organization level
819
861
  * (for management accounts of an organization only), account level, and resource level.
@@ -823,6 +865,7 @@ export interface DeleteRecommendationPreferencesRequest {
823
865
  */
824
866
  scope?: Scope;
825
867
  /**
868
+ * @public
826
869
  * <p>The name of the recommendation preference to delete.</p>
827
870
  */
828
871
  recommendationPreferenceNames: (RecommendationPreferenceName | string)[] | undefined;
@@ -940,6 +983,7 @@ export type JobFilterName = (typeof JobFilterName)[keyof typeof JobFilterName];
940
983
  */
941
984
  export interface JobFilter {
942
985
  /**
986
+ * @public
943
987
  * <p>The name of the filter.</p>
944
988
  * <p>Specify <code>ResourceType</code> to return export jobs of a specific resource type
945
989
  * (for example, <code>Ec2Instance</code>).</p>
@@ -948,6 +992,7 @@ export interface JobFilter {
948
992
  */
949
993
  name?: JobFilterName | string;
950
994
  /**
995
+ * @public
951
996
  * <p>The value of the filter.</p>
952
997
  * <p>The valid values for this parameter are as follows, depending on what you specify for
953
998
  * the <code>name</code> parameter:</p>
@@ -972,6 +1017,7 @@ export interface JobFilter {
972
1017
  */
973
1018
  export interface DescribeRecommendationExportJobsRequest {
974
1019
  /**
1020
+ * @public
975
1021
  * <p>The identification numbers of the export jobs to return.</p>
976
1022
  * <p>An export job ID is returned when you create an export using the <a>ExportAutoScalingGroupRecommendations</a> or <a>ExportEC2InstanceRecommendations</a> actions.</p>
977
1023
  * <p>All export jobs created in the last seven days are returned if this parameter is
@@ -979,15 +1025,18 @@ export interface DescribeRecommendationExportJobsRequest {
979
1025
  */
980
1026
  jobIds?: string[];
981
1027
  /**
1028
+ * @public
982
1029
  * <p>An array of objects to specify a filter that returns a more specific list of export
983
1030
  * jobs.</p>
984
1031
  */
985
1032
  filters?: JobFilter[];
986
1033
  /**
1034
+ * @public
987
1035
  * <p>The token to advance to the next page of export jobs.</p>
988
1036
  */
989
1037
  nextToken?: string;
990
1038
  /**
1039
+ * @public
991
1040
  * <p>The maximum number of export jobs to return with a single request.</p>
992
1041
  * <p>To retrieve the remaining results, make another request with the returned
993
1042
  * <code>nextToken</code> value.</p>
@@ -1001,16 +1050,19 @@ export interface DescribeRecommendationExportJobsRequest {
1001
1050
  */
1002
1051
  export interface S3Destination {
1003
1052
  /**
1053
+ * @public
1004
1054
  * <p>The name of the Amazon S3 bucket used as the destination of an export
1005
1055
  * file.</p>
1006
1056
  */
1007
1057
  bucket?: string;
1008
1058
  /**
1059
+ * @public
1009
1060
  * <p>The Amazon S3 bucket key of an export file.</p>
1010
1061
  * <p>The key uniquely identifies the object, or export file, in the S3 bucket.</p>
1011
1062
  */
1012
1063
  key?: string;
1013
1064
  /**
1065
+ * @public
1014
1066
  * <p>The Amazon S3 bucket key of a metadata file.</p>
1015
1067
  * <p>The key uniquely identifies the object, or metadata file, in the S3 bucket.</p>
1016
1068
  */
@@ -1022,6 +1074,7 @@ export interface S3Destination {
1022
1074
  */
1023
1075
  export interface ExportDestination {
1024
1076
  /**
1077
+ * @public
1025
1078
  * <p>An object that describes the destination Amazon Simple Storage Service (Amazon S3)
1026
1079
  * bucket name and object keys of a recommendations export file, and its associated
1027
1080
  * metadata file.</p>
@@ -1052,30 +1105,37 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
1052
1105
  */
1053
1106
  export interface RecommendationExportJob {
1054
1107
  /**
1108
+ * @public
1055
1109
  * <p>The identification number of the export job.</p>
1056
1110
  */
1057
1111
  jobId?: string;
1058
1112
  /**
1113
+ * @public
1059
1114
  * <p>An object that describes the destination of the export file.</p>
1060
1115
  */
1061
1116
  destination?: ExportDestination;
1062
1117
  /**
1118
+ * @public
1063
1119
  * <p>The resource type of the exported recommendations.</p>
1064
1120
  */
1065
1121
  resourceType?: ResourceType | string;
1066
1122
  /**
1123
+ * @public
1067
1124
  * <p>The status of the export job.</p>
1068
1125
  */
1069
1126
  status?: JobStatus | string;
1070
1127
  /**
1128
+ * @public
1071
1129
  * <p>The timestamp of when the export job was created.</p>
1072
1130
  */
1073
1131
  creationTimestamp?: Date;
1074
1132
  /**
1133
+ * @public
1075
1134
  * <p>The timestamp of when the export job was last updated.</p>
1076
1135
  */
1077
1136
  lastUpdatedTimestamp?: Date;
1078
1137
  /**
1138
+ * @public
1079
1139
  * <p>The reason for an export job failure.</p>
1080
1140
  */
1081
1141
  failureReason?: string;
@@ -1085,10 +1145,12 @@ export interface RecommendationExportJob {
1085
1145
  */
1086
1146
  export interface DescribeRecommendationExportJobsResponse {
1087
1147
  /**
1148
+ * @public
1088
1149
  * <p>An array of objects that describe recommendation export jobs.</p>
1089
1150
  */
1090
1151
  recommendationExportJobs?: RecommendationExportJob[];
1091
1152
  /**
1153
+ * @public
1092
1154
  * <p>The token to use to advance to the next page of export jobs.</p>
1093
1155
  * <p>This value is null when there are no more pages of export jobs to return.</p>
1094
1156
  */
@@ -1193,6 +1255,7 @@ export type FilterName = (typeof FilterName)[keyof typeof FilterName];
1193
1255
  */
1194
1256
  export interface Filter {
1195
1257
  /**
1258
+ * @public
1196
1259
  * <p>The name of the filter.</p>
1197
1260
  * <p>Specify <code>Finding</code> to return recommendations with a specific finding
1198
1261
  * classification. For example, <code>Underprovisioned</code>.</p>
@@ -1216,6 +1279,7 @@ export interface Filter {
1216
1279
  */
1217
1280
  name?: FilterName | string;
1218
1281
  /**
1282
+ * @public
1219
1283
  * <p>The value of the filter.</p>
1220
1284
  * <p>The valid values for this parameter are as follows, depending on what you specify for
1221
1285
  * the <code>name</code> parameter and the resource type that you wish to filter results
@@ -1391,6 +1455,7 @@ export interface Filter {
1391
1455
  */
1392
1456
  export interface RecommendationPreferences {
1393
1457
  /**
1458
+ * @public
1394
1459
  * <p>Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.</p>
1395
1460
  * <p>For example, when you specify <code>AWS_ARM64</code> with:</p>
1396
1461
  * <ul>
@@ -1424,11 +1489,13 @@ export interface RecommendationPreferences {
1424
1489
  */
1425
1490
  export interface S3DestinationConfig {
1426
1491
  /**
1492
+ * @public
1427
1493
  * <p>The name of the Amazon S3 bucket to use as the destination for an export
1428
1494
  * job.</p>
1429
1495
  */
1430
1496
  bucket?: string;
1431
1497
  /**
1498
+ * @public
1432
1499
  * <p>The Amazon S3 bucket prefix for an export job.</p>
1433
1500
  */
1434
1501
  keyPrefix?: string;
@@ -1438,6 +1505,7 @@ export interface S3DestinationConfig {
1438
1505
  */
1439
1506
  export interface ExportAutoScalingGroupRecommendationsRequest {
1440
1507
  /**
1508
+ * @public
1441
1509
  * <p>The IDs of the Amazon Web Services accounts for which to export Auto Scaling group
1442
1510
  * recommendations.</p>
1443
1511
  * <p>If your account is the management account of an organization, use this parameter to
@@ -1450,16 +1518,19 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
1450
1518
  */
1451
1519
  accountIds?: string[];
1452
1520
  /**
1521
+ * @public
1453
1522
  * <p>An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.</p>
1454
1523
  */
1455
1524
  filters?: Filter[];
1456
1525
  /**
1526
+ * @public
1457
1527
  * <p>The recommendations data to include in the export file. For more information about the
1458
1528
  * fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
1459
1529
  * Guide</i>.</p>
1460
1530
  */
1461
1531
  fieldsToExport?: (ExportableAutoScalingGroupField | string)[];
1462
1532
  /**
1533
+ * @public
1463
1534
  * <p>An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket
1464
1535
  * name and key prefix for the export job.</p>
1465
1536
  * <p>You must create the destination Amazon S3 bucket for your recommendations
@@ -1472,11 +1543,13 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
1472
1543
  */
1473
1544
  s3DestinationConfig: S3DestinationConfig | undefined;
1474
1545
  /**
1546
+ * @public
1475
1547
  * <p>The format of the export file.</p>
1476
1548
  * <p>The only export file format currently supported is <code>Csv</code>.</p>
1477
1549
  */
1478
1550
  fileFormat?: FileFormat | string;
1479
1551
  /**
1552
+ * @public
1480
1553
  * <p>Indicates whether to include recommendations for resources in all member accounts of
1481
1554
  * the organization if your account is the management account of an organization.</p>
1482
1555
  * <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
@@ -1492,6 +1565,7 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
1492
1565
  */
1493
1566
  includeMemberAccounts?: boolean;
1494
1567
  /**
1568
+ * @public
1495
1569
  * <p>An object to specify the preferences for the Auto Scaling group recommendations
1496
1570
  * to export.</p>
1497
1571
  */
@@ -1502,12 +1576,14 @@ export interface ExportAutoScalingGroupRecommendationsRequest {
1502
1576
  */
1503
1577
  export interface ExportAutoScalingGroupRecommendationsResponse {
1504
1578
  /**
1579
+ * @public
1505
1580
  * <p>The identification number of the export job.</p>
1506
1581
  * <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
1507
1582
  * ID to view the status of an export job.</p>
1508
1583
  */
1509
1584
  jobId?: string;
1510
1585
  /**
1586
+ * @public
1511
1587
  * <p>An object that describes the destination Amazon S3 bucket of a recommendations
1512
1588
  * export file.</p>
1513
1589
  */
@@ -1586,6 +1662,7 @@ export type EBSFilterName = (typeof EBSFilterName)[keyof typeof EBSFilterName];
1586
1662
  */
1587
1663
  export interface EBSFilter {
1588
1664
  /**
1665
+ * @public
1589
1666
  * <p>The name of the filter.</p>
1590
1667
  * <p>Specify <code>Finding</code> to return recommendations with a specific finding
1591
1668
  * classification (for example, <code>NotOptimized</code>).</p>
@@ -1604,6 +1681,7 @@ export interface EBSFilter {
1604
1681
  */
1605
1682
  name?: EBSFilterName | string;
1606
1683
  /**
1684
+ * @public
1607
1685
  * <p>The value of the filter.</p>
1608
1686
  * <p>The valid values are <code>Optimized</code>, or <code>NotOptimized</code>.</p>
1609
1687
  */
@@ -1614,6 +1692,7 @@ export interface EBSFilter {
1614
1692
  */
1615
1693
  export interface ExportEBSVolumeRecommendationsRequest {
1616
1694
  /**
1695
+ * @public
1617
1696
  * <p>The IDs of the Amazon Web Services accounts for which to export Amazon EBS
1618
1697
  * volume recommendations.</p>
1619
1698
  * <p>If your account is the management account of an organization, use this parameter to
@@ -1626,16 +1705,19 @@ export interface ExportEBSVolumeRecommendationsRequest {
1626
1705
  */
1627
1706
  accountIds?: string[];
1628
1707
  /**
1708
+ * @public
1629
1709
  * <p>An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.</p>
1630
1710
  */
1631
1711
  filters?: EBSFilter[];
1632
1712
  /**
1713
+ * @public
1633
1714
  * <p>The recommendations data to include in the export file. For more information about the
1634
1715
  * fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
1635
1716
  * Guide</i>.</p>
1636
1717
  */
1637
1718
  fieldsToExport?: (ExportableVolumeField | string)[];
1638
1719
  /**
1720
+ * @public
1639
1721
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
1640
1722
  * key prefix for a recommendations export job.</p>
1641
1723
  * <p>You must create the destination Amazon S3 bucket for your recommendations
@@ -1648,11 +1730,13 @@ export interface ExportEBSVolumeRecommendationsRequest {
1648
1730
  */
1649
1731
  s3DestinationConfig: S3DestinationConfig | undefined;
1650
1732
  /**
1733
+ * @public
1651
1734
  * <p>The format of the export file.</p>
1652
1735
  * <p>The only export file format currently supported is <code>Csv</code>.</p>
1653
1736
  */
1654
1737
  fileFormat?: FileFormat | string;
1655
1738
  /**
1739
+ * @public
1656
1740
  * <p>Indicates whether to include recommendations for resources in all member accounts of
1657
1741
  * the organization if your account is the management account of an organization.</p>
1658
1742
  * <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
@@ -1673,12 +1757,14 @@ export interface ExportEBSVolumeRecommendationsRequest {
1673
1757
  */
1674
1758
  export interface ExportEBSVolumeRecommendationsResponse {
1675
1759
  /**
1760
+ * @public
1676
1761
  * <p>The identification number of the export job.</p>
1677
1762
  * <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
1678
1763
  * ID to view the status of an export job.</p>
1679
1764
  */
1680
1765
  jobId?: string;
1681
1766
  /**
1767
+ * @public
1682
1768
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
1683
1769
  * object keys of a recommendations export file, and its associated metadata file.</p>
1684
1770
  */
@@ -1756,6 +1842,7 @@ export type ExportableInstanceField = (typeof ExportableInstanceField)[keyof typ
1756
1842
  */
1757
1843
  export interface ExportEC2InstanceRecommendationsRequest {
1758
1844
  /**
1845
+ * @public
1759
1846
  * <p>The IDs of the Amazon Web Services accounts for which to export instance
1760
1847
  * recommendations.</p>
1761
1848
  * <p>If your account is the management account of an organization, use this parameter to
@@ -1768,17 +1855,20 @@ export interface ExportEC2InstanceRecommendationsRequest {
1768
1855
  */
1769
1856
  accountIds?: string[];
1770
1857
  /**
1858
+ * @public
1771
1859
  * <p>An array of objects to specify a filter that exports a more specific set of instance
1772
1860
  * recommendations.</p>
1773
1861
  */
1774
1862
  filters?: Filter[];
1775
1863
  /**
1864
+ * @public
1776
1865
  * <p>The recommendations data to include in the export file. For more information about the
1777
1866
  * fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
1778
1867
  * Guide</i>.</p>
1779
1868
  */
1780
1869
  fieldsToExport?: (ExportableInstanceField | string)[];
1781
1870
  /**
1871
+ * @public
1782
1872
  * <p>An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket
1783
1873
  * name and key prefix for the export job.</p>
1784
1874
  * <p>You must create the destination Amazon S3 bucket for your recommendations
@@ -1792,11 +1882,13 @@ export interface ExportEC2InstanceRecommendationsRequest {
1792
1882
  */
1793
1883
  s3DestinationConfig: S3DestinationConfig | undefined;
1794
1884
  /**
1885
+ * @public
1795
1886
  * <p>The format of the export file.</p>
1796
1887
  * <p>The only export file format currently supported is <code>Csv</code>.</p>
1797
1888
  */
1798
1889
  fileFormat?: FileFormat | string;
1799
1890
  /**
1891
+ * @public
1800
1892
  * <p>Indicates whether to include recommendations for resources in all member accounts of
1801
1893
  * the organization if your account is the management account of an organization.</p>
1802
1894
  * <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
@@ -1810,6 +1902,7 @@ export interface ExportEC2InstanceRecommendationsRequest {
1810
1902
  */
1811
1903
  includeMemberAccounts?: boolean;
1812
1904
  /**
1905
+ * @public
1813
1906
  * <p>An object to specify the preferences for the Amazon EC2 instance
1814
1907
  * recommendations to export.</p>
1815
1908
  */
@@ -1820,12 +1913,14 @@ export interface ExportEC2InstanceRecommendationsRequest {
1820
1913
  */
1821
1914
  export interface ExportEC2InstanceRecommendationsResponse {
1822
1915
  /**
1916
+ * @public
1823
1917
  * <p>The identification number of the export job.</p>
1824
1918
  * <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
1825
1919
  * ID to view the status of an export job.</p>
1826
1920
  */
1827
1921
  jobId?: string;
1828
1922
  /**
1923
+ * @public
1829
1924
  * <p>An object that describes the destination Amazon S3 bucket of a recommendations
1830
1925
  * export file.</p>
1831
1926
  */
@@ -1886,6 +1981,7 @@ export type ECSServiceRecommendationFilterName = (typeof ECSServiceRecommendatio
1886
1981
  */
1887
1982
  export interface ECSServiceRecommendationFilter {
1888
1983
  /**
1984
+ * @public
1889
1985
  * <p>
1890
1986
  * The name of the filter.
1891
1987
  * </p>
@@ -1910,6 +2006,7 @@ export interface ECSServiceRecommendationFilter {
1910
2006
  */
1911
2007
  name?: ECSServiceRecommendationFilterName | string;
1912
2008
  /**
2009
+ * @public
1913
2010
  * <p>
1914
2011
  * The value of the filter.
1915
2012
  * </p>
@@ -1933,6 +2030,7 @@ export interface ECSServiceRecommendationFilter {
1933
2030
  */
1934
2031
  export interface ExportECSServiceRecommendationsRequest {
1935
2032
  /**
2033
+ * @public
1936
2034
  * <p>
1937
2035
  * The Amazon Web Services account IDs for the export Amazon ECS service recommendations.
1938
2036
  * </p>
@@ -1947,6 +2045,7 @@ export interface ExportECSServiceRecommendationsRequest {
1947
2045
  */
1948
2046
  accountIds?: string[];
1949
2047
  /**
2048
+ * @public
1950
2049
  * <p>
1951
2050
  * An array of objects to specify a filter that exports a more specific set
1952
2051
  * of Amazon ECS service recommendations.
@@ -1954,12 +2053,14 @@ export interface ExportECSServiceRecommendationsRequest {
1954
2053
  */
1955
2054
  filters?: ECSServiceRecommendationFilter[];
1956
2055
  /**
2056
+ * @public
1957
2057
  * <p>The recommendations data to include in the export file. For more information about the
1958
2058
  * fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
1959
2059
  * Guide</i>.</p>
1960
2060
  */
1961
2061
  fieldsToExport?: (ExportableECSServiceField | string)[];
1962
2062
  /**
2063
+ * @public
1963
2064
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
1964
2065
  * key prefix for a recommendations export job.</p>
1965
2066
  * <p>You must create the destination Amazon S3 bucket for your recommendations
@@ -1972,6 +2073,7 @@ export interface ExportECSServiceRecommendationsRequest {
1972
2073
  */
1973
2074
  s3DestinationConfig: S3DestinationConfig | undefined;
1974
2075
  /**
2076
+ * @public
1975
2077
  * <p>
1976
2078
  * The format of the export file.
1977
2079
  * </p>
@@ -1979,6 +2081,7 @@ export interface ExportECSServiceRecommendationsRequest {
1979
2081
  */
1980
2082
  fileFormat?: FileFormat | string;
1981
2083
  /**
2084
+ * @public
1982
2085
  * <p>If your account is the management account or the delegated administrator of an organization,
1983
2086
  * this parameter indicates whether to include recommendations for resources in all member accounts of
1984
2087
  * the organization.</p>
@@ -1998,6 +2101,7 @@ export interface ExportECSServiceRecommendationsRequest {
1998
2101
  */
1999
2102
  export interface ExportECSServiceRecommendationsResponse {
2000
2103
  /**
2104
+ * @public
2001
2105
  * <p>
2002
2106
  * The identification number of the export job.
2003
2107
  * </p>
@@ -2007,6 +2111,7 @@ export interface ExportECSServiceRecommendationsResponse {
2007
2111
  */
2008
2112
  jobId?: string;
2009
2113
  /**
2114
+ * @public
2010
2115
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
2011
2116
  * object keys of a recommendations export file, and its associated metadata file.</p>
2012
2117
  */
@@ -2071,6 +2176,7 @@ export type LambdaFunctionRecommendationFilterName = (typeof LambdaFunctionRecom
2071
2176
  */
2072
2177
  export interface LambdaFunctionRecommendationFilter {
2073
2178
  /**
2179
+ * @public
2074
2180
  * <p>The name of the filter.</p>
2075
2181
  * <p>Specify <code>Finding</code> to return recommendations with a specific finding
2076
2182
  * classification (for example, <code>NotOptimized</code>).</p>
@@ -2091,6 +2197,7 @@ export interface LambdaFunctionRecommendationFilter {
2091
2197
  */
2092
2198
  name?: LambdaFunctionRecommendationFilterName | string;
2093
2199
  /**
2200
+ * @public
2094
2201
  * <p>The value of the filter.</p>
2095
2202
  * <p>The valid values for this parameter are as follows, depending on what you specify for
2096
2203
  * the <code>name</code> parameter:</p>
@@ -2115,6 +2222,7 @@ export interface LambdaFunctionRecommendationFilter {
2115
2222
  */
2116
2223
  export interface ExportLambdaFunctionRecommendationsRequest {
2117
2224
  /**
2225
+ * @public
2118
2226
  * <p>The IDs of the Amazon Web Services accounts for which to export Lambda
2119
2227
  * function recommendations.</p>
2120
2228
  * <p>If your account is the management account of an organization, use this parameter to
@@ -2127,16 +2235,19 @@ export interface ExportLambdaFunctionRecommendationsRequest {
2127
2235
  */
2128
2236
  accountIds?: string[];
2129
2237
  /**
2238
+ * @public
2130
2239
  * <p>An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.</p>
2131
2240
  */
2132
2241
  filters?: LambdaFunctionRecommendationFilter[];
2133
2242
  /**
2243
+ * @public
2134
2244
  * <p>The recommendations data to include in the export file. For more information about the
2135
2245
  * fields that can be exported, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files">Exported files</a> in the <i>Compute Optimizer User
2136
2246
  * Guide</i>.</p>
2137
2247
  */
2138
2248
  fieldsToExport?: (ExportableLambdaFunctionField | string)[];
2139
2249
  /**
2250
+ * @public
2140
2251
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
2141
2252
  * key prefix for a recommendations export job.</p>
2142
2253
  * <p>You must create the destination Amazon S3 bucket for your recommendations
@@ -2149,11 +2260,13 @@ export interface ExportLambdaFunctionRecommendationsRequest {
2149
2260
  */
2150
2261
  s3DestinationConfig: S3DestinationConfig | undefined;
2151
2262
  /**
2263
+ * @public
2152
2264
  * <p>The format of the export file.</p>
2153
2265
  * <p>The only export file format currently supported is <code>Csv</code>.</p>
2154
2266
  */
2155
2267
  fileFormat?: FileFormat | string;
2156
2268
  /**
2269
+ * @public
2157
2270
  * <p>Indicates whether to include recommendations for resources in all member accounts of
2158
2271
  * the organization if your account is the management account of an organization.</p>
2159
2272
  * <p>The member accounts must also be opted in to Compute Optimizer, and trusted access for
@@ -2174,12 +2287,14 @@ export interface ExportLambdaFunctionRecommendationsRequest {
2174
2287
  */
2175
2288
  export interface ExportLambdaFunctionRecommendationsResponse {
2176
2289
  /**
2290
+ * @public
2177
2291
  * <p>The identification number of the export job.</p>
2178
2292
  * <p>Use the <a>DescribeRecommendationExportJobs</a> action, and specify the job
2179
2293
  * ID to view the status of an export job.</p>
2180
2294
  */
2181
2295
  jobId?: string;
2182
2296
  /**
2297
+ * @public
2183
2298
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and
2184
2299
  * object keys of a recommendations export file, and its associated metadata file.</p>
2185
2300
  */
@@ -2190,6 +2305,7 @@ export interface ExportLambdaFunctionRecommendationsResponse {
2190
2305
  */
2191
2306
  export interface GetAutoScalingGroupRecommendationsRequest {
2192
2307
  /**
2308
+ * @public
2193
2309
  * <p>The ID of the Amazon Web Services account for which to return Auto Scaling group
2194
2310
  * recommendations.</p>
2195
2311
  * <p>If your account is the management account of an organization, use this parameter to
@@ -2199,16 +2315,19 @@ export interface GetAutoScalingGroupRecommendationsRequest {
2199
2315
  */
2200
2316
  accountIds?: string[];
2201
2317
  /**
2318
+ * @public
2202
2319
  * <p>The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return
2203
2320
  * recommendations.</p>
2204
2321
  */
2205
2322
  autoScalingGroupArns?: string[];
2206
2323
  /**
2324
+ * @public
2207
2325
  * <p>The token to advance to the next page of Auto Scaling group
2208
2326
  * recommendations.</p>
2209
2327
  */
2210
2328
  nextToken?: string;
2211
2329
  /**
2330
+ * @public
2212
2331
  * <p>The maximum number of Auto Scaling group recommendations to return with a single
2213
2332
  * request.</p>
2214
2333
  * <p>To retrieve the remaining results, make another request with the returned
@@ -2216,10 +2335,12 @@ export interface GetAutoScalingGroupRecommendationsRequest {
2216
2335
  */
2217
2336
  maxResults?: number;
2218
2337
  /**
2338
+ * @public
2219
2339
  * <p>An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.</p>
2220
2340
  */
2221
2341
  filters?: Filter[];
2222
2342
  /**
2343
+ * @public
2223
2344
  * <p>An object to specify the preferences for the Auto Scaling group recommendations
2224
2345
  * to return in the response.</p>
2225
2346
  */
@@ -2234,14 +2355,17 @@ export interface GetAutoScalingGroupRecommendationsRequest {
2234
2355
  */
2235
2356
  export interface GetRecommendationError {
2236
2357
  /**
2358
+ * @public
2237
2359
  * <p>The ID of the error.</p>
2238
2360
  */
2239
2361
  identifier?: string;
2240
2362
  /**
2363
+ * @public
2241
2364
  * <p>The error code.</p>
2242
2365
  */
2243
2366
  code?: string;
2244
2367
  /**
2368
+ * @public
2245
2369
  * <p>The message, or reason, for the error.</p>
2246
2370
  */
2247
2371
  message?: string;
@@ -2251,6 +2375,7 @@ export interface GetRecommendationError {
2251
2375
  */
2252
2376
  export interface GetAutoScalingGroupRecommendationsResponse {
2253
2377
  /**
2378
+ * @public
2254
2379
  * <p>The token to use to advance to the next page of Auto Scaling group
2255
2380
  * recommendations.</p>
2256
2381
  * <p>This value is null when there are no more pages of Auto Scaling group
@@ -2258,10 +2383,12 @@ export interface GetAutoScalingGroupRecommendationsResponse {
2258
2383
  */
2259
2384
  nextToken?: string;
2260
2385
  /**
2386
+ * @public
2261
2387
  * <p>An array of objects that describe Auto Scaling group recommendations.</p>
2262
2388
  */
2263
2389
  autoScalingGroupRecommendations?: AutoScalingGroupRecommendation[];
2264
2390
  /**
2391
+ * @public
2265
2392
  * <p>An array of objects that describe errors of the request.</p>
2266
2393
  * <p>For example, an error is returned if you request recommendations for an unsupported
2267
2394
  * Auto Scaling group.</p>
@@ -2273,26 +2400,31 @@ export interface GetAutoScalingGroupRecommendationsResponse {
2273
2400
  */
2274
2401
  export interface GetEBSVolumeRecommendationsRequest {
2275
2402
  /**
2403
+ * @public
2276
2404
  * <p>The Amazon Resource Name (ARN) of the volumes for which to return
2277
2405
  * recommendations.</p>
2278
2406
  */
2279
2407
  volumeArns?: string[];
2280
2408
  /**
2409
+ * @public
2281
2410
  * <p>The token to advance to the next page of volume recommendations.</p>
2282
2411
  */
2283
2412
  nextToken?: string;
2284
2413
  /**
2414
+ * @public
2285
2415
  * <p>The maximum number of volume recommendations to return with a single request.</p>
2286
2416
  * <p>To retrieve the remaining results, make another request with the returned
2287
2417
  * <code>nextToken</code> value.</p>
2288
2418
  */
2289
2419
  maxResults?: number;
2290
2420
  /**
2421
+ * @public
2291
2422
  * <p>An array of objects to specify a filter that returns a more specific list of volume
2292
2423
  * recommendations.</p>
2293
2424
  */
2294
2425
  filters?: EBSFilter[];
2295
2426
  /**
2427
+ * @public
2296
2428
  * <p>The ID of the Amazon Web Services account for which to return volume
2297
2429
  * recommendations.</p>
2298
2430
  * <p>If your account is the management account of an organization, use this parameter to
@@ -2308,6 +2440,7 @@ export interface GetEBSVolumeRecommendationsRequest {
2308
2440
  */
2309
2441
  export interface VolumeConfiguration {
2310
2442
  /**
2443
+ * @public
2311
2444
  * <p>The volume type.</p>
2312
2445
  * <p>This can be <code>gp2</code> for General Purpose SSD, <code>io1</code> or
2313
2446
  * <code>io2</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput Optimized
@@ -2316,26 +2449,32 @@ export interface VolumeConfiguration {
2316
2449
  */
2317
2450
  volumeType?: string;
2318
2451
  /**
2452
+ * @public
2319
2453
  * <p>The size of the volume, in GiB.</p>
2320
2454
  */
2321
2455
  volumeSize?: number;
2322
2456
  /**
2457
+ * @public
2323
2458
  * <p>The baseline IOPS of the volume.</p>
2324
2459
  */
2325
2460
  volumeBaselineIOPS?: number;
2326
2461
  /**
2462
+ * @public
2327
2463
  * <p>The burst IOPS of the volume.</p>
2328
2464
  */
2329
2465
  volumeBurstIOPS?: number;
2330
2466
  /**
2467
+ * @public
2331
2468
  * <p>The baseline throughput of the volume.</p>
2332
2469
  */
2333
2470
  volumeBaselineThroughput?: number;
2334
2471
  /**
2472
+ * @public
2335
2473
  * <p>The burst throughput of the volume.</p>
2336
2474
  */
2337
2475
  volumeBurstThroughput?: number;
2338
2476
  /**
2477
+ * @public
2339
2478
  * <p>
2340
2479
  * Contains the image used to boot the instance during launch.
2341
2480
  * </p>
@@ -2362,6 +2501,7 @@ export type EBSFinding = (typeof EBSFinding)[keyof typeof EBSFinding];
2362
2501
  */
2363
2502
  export interface Tag {
2364
2503
  /**
2504
+ * @public
2365
2505
  * <p>
2366
2506
  * One part of a key-value pair that makes up a tag. A key is a general
2367
2507
  * label that acts like a category for more specific tag values.
@@ -2369,6 +2509,7 @@ export interface Tag {
2369
2509
  */
2370
2510
  key?: string;
2371
2511
  /**
2512
+ * @public
2372
2513
  * <p>
2373
2514
  * One part of a key-value pair that make up a tag. A value acts as a descriptor
2374
2515
  * within a tag category (key). The value can be empty or null.
@@ -2400,6 +2541,7 @@ export type EBSMetricName = (typeof EBSMetricName)[keyof typeof EBSMetricName];
2400
2541
  */
2401
2542
  export interface EBSUtilizationMetric {
2402
2543
  /**
2544
+ * @public
2403
2545
  * <p>The name of the utilization metric.</p>
2404
2546
  * <p>The following utilization metrics are available:</p>
2405
2547
  * <ul>
@@ -2431,6 +2573,7 @@ export interface EBSUtilizationMetric {
2431
2573
  */
2432
2574
  name?: EBSMetricName | string;
2433
2575
  /**
2576
+ * @public
2434
2577
  * <p>The statistic of the utilization metric.</p>
2435
2578
  * <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
2436
2579
  * return utilization metrics using only the <code>Maximum</code> statistic, which is the
@@ -2446,6 +2589,7 @@ export interface EBSUtilizationMetric {
2446
2589
  */
2447
2590
  statistic?: MetricStatistic | string;
2448
2591
  /**
2592
+ * @public
2449
2593
  * <p>The value of the utilization metric.</p>
2450
2594
  */
2451
2595
  value?: number;
@@ -2457,10 +2601,12 @@ export interface EBSUtilizationMetric {
2457
2601
  */
2458
2602
  export interface VolumeRecommendationOption {
2459
2603
  /**
2604
+ * @public
2460
2605
  * <p>An array of objects that describe a volume configuration.</p>
2461
2606
  */
2462
2607
  configuration?: VolumeConfiguration;
2463
2608
  /**
2609
+ * @public
2464
2610
  * <p>The performance risk of the volume recommendation option.</p>
2465
2611
  * <p>Performance risk is the likelihood of the recommended volume type meeting the
2466
2612
  * performance requirement of your workload.</p>
@@ -2472,11 +2618,13 @@ export interface VolumeRecommendationOption {
2472
2618
  */
2473
2619
  performanceRisk?: number;
2474
2620
  /**
2621
+ * @public
2475
2622
  * <p>The rank of the volume recommendation option.</p>
2476
2623
  * <p>The top recommendation option is ranked as <code>1</code>.</p>
2477
2624
  */
2478
2625
  rank?: number;
2479
2626
  /**
2627
+ * @public
2480
2628
  * <p>An object that describes the savings opportunity for the EBS volume recommendation
2481
2629
  * option. Savings opportunity includes the estimated monthly savings amount and
2482
2630
  * percentage.</p>
@@ -2489,18 +2637,22 @@ export interface VolumeRecommendationOption {
2489
2637
  */
2490
2638
  export interface VolumeRecommendation {
2491
2639
  /**
2640
+ * @public
2492
2641
  * <p>The Amazon Resource Name (ARN) of the current volume.</p>
2493
2642
  */
2494
2643
  volumeArn?: string;
2495
2644
  /**
2645
+ * @public
2496
2646
  * <p>The Amazon Web Services account ID of the volume.</p>
2497
2647
  */
2498
2648
  accountId?: string;
2499
2649
  /**
2650
+ * @public
2500
2651
  * <p>An array of objects that describe the current configuration of the volume.</p>
2501
2652
  */
2502
2653
  currentConfiguration?: VolumeConfiguration;
2503
2654
  /**
2655
+ * @public
2504
2656
  * <p>The finding classification of the volume.</p>
2505
2657
  * <p>Findings for volumes include:</p>
2506
2658
  * <ul>
@@ -2526,28 +2678,34 @@ export interface VolumeRecommendation {
2526
2678
  */
2527
2679
  finding?: EBSFinding | string;
2528
2680
  /**
2681
+ * @public
2529
2682
  * <p>An array of objects that describe the utilization metrics of the volume.</p>
2530
2683
  */
2531
2684
  utilizationMetrics?: EBSUtilizationMetric[];
2532
2685
  /**
2686
+ * @public
2533
2687
  * <p>The number of days for which utilization metrics were analyzed for the volume.</p>
2534
2688
  */
2535
2689
  lookBackPeriodInDays?: number;
2536
2690
  /**
2691
+ * @public
2537
2692
  * <p>An array of objects that describe the recommendation options for the volume.</p>
2538
2693
  */
2539
2694
  volumeRecommendationOptions?: VolumeRecommendationOption[];
2540
2695
  /**
2696
+ * @public
2541
2697
  * <p>The timestamp of when the volume recommendation was last generated.</p>
2542
2698
  */
2543
2699
  lastRefreshTimestamp?: Date;
2544
2700
  /**
2701
+ * @public
2545
2702
  * <p>The risk of the current EBS volume not meeting the performance needs of its workloads.
2546
2703
  * The higher the risk, the more likely the current EBS volume doesn't have sufficient
2547
2704
  * capacity.</p>
2548
2705
  */
2549
2706
  currentPerformanceRisk?: CurrentPerformanceRisk | string;
2550
2707
  /**
2708
+ * @public
2551
2709
  * <p>
2552
2710
  * A list of tags assigned to your Amazon EBS volume recommendations.
2553
2711
  * </p>
@@ -2559,16 +2717,19 @@ export interface VolumeRecommendation {
2559
2717
  */
2560
2718
  export interface GetEBSVolumeRecommendationsResponse {
2561
2719
  /**
2720
+ * @public
2562
2721
  * <p>The token to use to advance to the next page of volume recommendations.</p>
2563
2722
  * <p>This value is null when there are no more pages of volume recommendations to
2564
2723
  * return.</p>
2565
2724
  */
2566
2725
  nextToken?: string;
2567
2726
  /**
2727
+ * @public
2568
2728
  * <p>An array of objects that describe volume recommendations.</p>
2569
2729
  */
2570
2730
  volumeRecommendations?: VolumeRecommendation[];
2571
2731
  /**
2732
+ * @public
2572
2733
  * <p>An array of objects that describe errors of the request.</p>
2573
2734
  * <p>For example, an error is returned if you request recommendations for an unsupported
2574
2735
  * volume.</p>
@@ -2580,26 +2741,31 @@ export interface GetEBSVolumeRecommendationsResponse {
2580
2741
  */
2581
2742
  export interface GetEC2InstanceRecommendationsRequest {
2582
2743
  /**
2744
+ * @public
2583
2745
  * <p>The Amazon Resource Name (ARN) of the instances for which to return
2584
2746
  * recommendations.</p>
2585
2747
  */
2586
2748
  instanceArns?: string[];
2587
2749
  /**
2750
+ * @public
2588
2751
  * <p>The token to advance to the next page of instance recommendations.</p>
2589
2752
  */
2590
2753
  nextToken?: string;
2591
2754
  /**
2755
+ * @public
2592
2756
  * <p>The maximum number of instance recommendations to return with a single request.</p>
2593
2757
  * <p>To retrieve the remaining results, make another request with the returned
2594
2758
  * <code>nextToken</code> value.</p>
2595
2759
  */
2596
2760
  maxResults?: number;
2597
2761
  /**
2762
+ * @public
2598
2763
  * <p>An array of objects to specify a filter that returns a more specific list of instance
2599
2764
  * recommendations.</p>
2600
2765
  */
2601
2766
  filters?: Filter[];
2602
2767
  /**
2768
+ * @public
2603
2769
  * <p>The ID of the Amazon Web Services account for which to return instance
2604
2770
  * recommendations.</p>
2605
2771
  * <p>If your account is the management account of an organization, use this parameter to
@@ -2608,6 +2774,7 @@ export interface GetEC2InstanceRecommendationsRequest {
2608
2774
  */
2609
2775
  accountIds?: string[];
2610
2776
  /**
2777
+ * @public
2611
2778
  * <p>An object to specify the preferences for the Amazon EC2 instance
2612
2779
  * recommendations to return in the response.</p>
2613
2780
  */
@@ -2641,12 +2808,14 @@ export type ExternalMetricStatusCode = (typeof ExternalMetricStatusCode)[keyof t
2641
2808
  */
2642
2809
  export interface ExternalMetricStatus {
2643
2810
  /**
2811
+ * @public
2644
2812
  * <p>
2645
2813
  * The status code for Compute Optimizer's integration with an external metrics provider.
2646
2814
  * </p>
2647
2815
  */
2648
2816
  statusCode?: ExternalMetricStatusCode | string;
2649
2817
  /**
2818
+ * @public
2650
2819
  * <p>
2651
2820
  * The reason for Compute Optimizer's integration status with your external metric provider.
2652
2821
  * </p>
@@ -2717,10 +2886,12 @@ export type PlatformDifference = (typeof PlatformDifference)[keyof typeof Platfo
2717
2886
  */
2718
2887
  export interface InstanceRecommendationOption {
2719
2888
  /**
2889
+ * @public
2720
2890
  * <p>The instance type of the instance recommendation.</p>
2721
2891
  */
2722
2892
  instanceType?: string;
2723
2893
  /**
2894
+ * @public
2724
2895
  * <p>An array of objects that describe the projected utilization metrics of the instance
2725
2896
  * recommendation option.</p>
2726
2897
  * <note>
@@ -2733,6 +2904,7 @@ export interface InstanceRecommendationOption {
2733
2904
  */
2734
2905
  projectedUtilizationMetrics?: UtilizationMetric[];
2735
2906
  /**
2907
+ * @public
2736
2908
  * <p>Describes the configuration differences between the current instance and the
2737
2909
  * recommended instance type. You should consider the configuration differences before
2738
2910
  * migrating your workloads from the current instance to the recommended instance type. The
@@ -2832,6 +3004,7 @@ export interface InstanceRecommendationOption {
2832
3004
  */
2833
3005
  platformDifferences?: (PlatformDifference | string)[];
2834
3006
  /**
3007
+ * @public
2835
3008
  * <p>The performance risk of the instance recommendation option.</p>
2836
3009
  * <p>Performance risk indicates the likelihood of the recommended instance type not meeting
2837
3010
  * the resource needs of your workload. Compute Optimizer calculates an individual
@@ -2849,17 +3022,20 @@ export interface InstanceRecommendationOption {
2849
3022
  */
2850
3023
  performanceRisk?: number;
2851
3024
  /**
3025
+ * @public
2852
3026
  * <p>The rank of the instance recommendation option.</p>
2853
3027
  * <p>The top recommendation option is ranked as <code>1</code>.</p>
2854
3028
  */
2855
3029
  rank?: number;
2856
3030
  /**
3031
+ * @public
2857
3032
  * <p>An object that describes the savings opportunity for the instance recommendation
2858
3033
  * option. Savings opportunity includes the estimated monthly savings amount and
2859
3034
  * percentage.</p>
2860
3035
  */
2861
3036
  savingsOpportunity?: SavingsOpportunity;
2862
3037
  /**
3038
+ * @public
2863
3039
  * <p>The level of effort required to migrate from the current instance type to the
2864
3040
  * recommended instance type.</p>
2865
3041
  * <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the
@@ -2893,10 +3069,12 @@ export type RecommendationSourceType = (typeof RecommendationSourceType)[keyof t
2893
3069
  */
2894
3070
  export interface RecommendationSource {
2895
3071
  /**
3072
+ * @public
2896
3073
  * <p>The Amazon Resource Name (ARN) of the recommendation source.</p>
2897
3074
  */
2898
3075
  recommendationSourceArn?: string;
2899
3076
  /**
3077
+ * @public
2900
3078
  * <p>The resource type of the recommendation source.</p>
2901
3079
  */
2902
3080
  recommendationSourceType?: RecommendationSourceType | string;
@@ -2907,22 +3085,27 @@ export interface RecommendationSource {
2907
3085
  */
2908
3086
  export interface InstanceRecommendation {
2909
3087
  /**
3088
+ * @public
2910
3089
  * <p>The Amazon Resource Name (ARN) of the current instance.</p>
2911
3090
  */
2912
3091
  instanceArn?: string;
2913
3092
  /**
3093
+ * @public
2914
3094
  * <p>The Amazon Web Services account ID of the instance.</p>
2915
3095
  */
2916
3096
  accountId?: string;
2917
3097
  /**
3098
+ * @public
2918
3099
  * <p>The name of the current instance.</p>
2919
3100
  */
2920
3101
  instanceName?: string;
2921
3102
  /**
3103
+ * @public
2922
3104
  * <p>The instance type of the current instance.</p>
2923
3105
  */
2924
3106
  currentInstanceType?: string;
2925
3107
  /**
3108
+ * @public
2926
3109
  * <p>The finding classification of the instance.</p>
2927
3110
  * <p>Findings for instances include:</p>
2928
3111
  * <ul>
@@ -2961,6 +3144,7 @@ export interface InstanceRecommendation {
2961
3144
  */
2962
3145
  finding?: Finding | string;
2963
3146
  /**
3147
+ * @public
2964
3148
  * <p>The reason for the finding classification of the instance.</p>
2965
3149
  * <p>Finding reason codes for instances include:</p>
2966
3150
  * <ul>
@@ -3159,38 +3343,46 @@ export interface InstanceRecommendation {
3159
3343
  */
3160
3344
  findingReasonCodes?: (InstanceRecommendationFindingReasonCode | string)[];
3161
3345
  /**
3346
+ * @public
3162
3347
  * <p>An array of objects that describe the utilization metrics of the instance.</p>
3163
3348
  */
3164
3349
  utilizationMetrics?: UtilizationMetric[];
3165
3350
  /**
3351
+ * @public
3166
3352
  * <p>The number of days for which utilization metrics were analyzed for the
3167
3353
  * instance.</p>
3168
3354
  */
3169
3355
  lookBackPeriodInDays?: number;
3170
3356
  /**
3357
+ * @public
3171
3358
  * <p>An array of objects that describe the recommendation options for the instance.</p>
3172
3359
  */
3173
3360
  recommendationOptions?: InstanceRecommendationOption[];
3174
3361
  /**
3362
+ * @public
3175
3363
  * <p>An array of objects that describe the source resource of the recommendation.</p>
3176
3364
  */
3177
3365
  recommendationSources?: RecommendationSource[];
3178
3366
  /**
3367
+ * @public
3179
3368
  * <p>The timestamp of when the instance recommendation was last generated.</p>
3180
3369
  */
3181
3370
  lastRefreshTimestamp?: Date;
3182
3371
  /**
3372
+ * @public
3183
3373
  * <p>The risk of the current instance not meeting the performance needs of its workloads.
3184
3374
  * The higher the risk, the more likely the current instance cannot meet the performance
3185
3375
  * requirements of its workload.</p>
3186
3376
  */
3187
3377
  currentPerformanceRisk?: CurrentPerformanceRisk | string;
3188
3378
  /**
3379
+ * @public
3189
3380
  * <p>An object that describes the effective recommendation preferences for the
3190
3381
  * instance.</p>
3191
3382
  */
3192
3383
  effectiveRecommendationPreferences?: EffectiveRecommendationPreferences;
3193
3384
  /**
3385
+ * @public
3194
3386
  * <p>The applications that might be running on the instance as inferred by Compute Optimizer.</p>
3195
3387
  * <p>Compute Optimizer can infer if one of the following applications might be running on
3196
3388
  * the instance:</p>
@@ -3244,18 +3436,21 @@ export interface InstanceRecommendation {
3244
3436
  */
3245
3437
  inferredWorkloadTypes?: (InferredWorkloadType | string)[];
3246
3438
  /**
3439
+ * @public
3247
3440
  * <p>
3248
3441
  * The state of the instance when the recommendation was generated.
3249
3442
  * </p>
3250
3443
  */
3251
3444
  instanceState?: InstanceState | string;
3252
3445
  /**
3446
+ * @public
3253
3447
  * <p>
3254
3448
  * A list of tags assigned to your Amazon EC2 instance recommendations.
3255
3449
  * </p>
3256
3450
  */
3257
3451
  tags?: Tag[];
3258
3452
  /**
3453
+ * @public
3259
3454
  * <p>
3260
3455
  * An object that describes Compute Optimizer's integration status with your external metrics provider.
3261
3456
  * </p>
@@ -3267,16 +3462,19 @@ export interface InstanceRecommendation {
3267
3462
  */
3268
3463
  export interface GetEC2InstanceRecommendationsResponse {
3269
3464
  /**
3465
+ * @public
3270
3466
  * <p>The token to use to advance to the next page of instance recommendations.</p>
3271
3467
  * <p>This value is null when there are no more pages of instance recommendations to
3272
3468
  * return.</p>
3273
3469
  */
3274
3470
  nextToken?: string;
3275
3471
  /**
3472
+ * @public
3276
3473
  * <p>An array of objects that describe instance recommendations.</p>
3277
3474
  */
3278
3475
  instanceRecommendations?: InstanceRecommendation[];
3279
3476
  /**
3477
+ * @public
3280
3478
  * <p>An array of objects that describe errors of the request.</p>
3281
3479
  * <p>For example, an error is returned if you request recommendations for an instance of an
3282
3480
  * unsupported instance family.</p>
@@ -3288,27 +3486,33 @@ export interface GetEC2InstanceRecommendationsResponse {
3288
3486
  */
3289
3487
  export interface GetEC2RecommendationProjectedMetricsRequest {
3290
3488
  /**
3489
+ * @public
3291
3490
  * <p>The Amazon Resource Name (ARN) of the instances for which to return recommendation
3292
3491
  * projected metrics.</p>
3293
3492
  */
3294
3493
  instanceArn: string | undefined;
3295
3494
  /**
3495
+ * @public
3296
3496
  * <p>The statistic of the projected metrics.</p>
3297
3497
  */
3298
3498
  stat: MetricStatistic | string | undefined;
3299
3499
  /**
3500
+ * @public
3300
3501
  * <p>The granularity, in seconds, of the projected metrics data points.</p>
3301
3502
  */
3302
3503
  period: number | undefined;
3303
3504
  /**
3505
+ * @public
3304
3506
  * <p>The timestamp of the first projected metrics data point to return.</p>
3305
3507
  */
3306
3508
  startTime: Date | undefined;
3307
3509
  /**
3510
+ * @public
3308
3511
  * <p>The timestamp of the last projected metrics data point to return.</p>
3309
3512
  */
3310
3513
  endTime: Date | undefined;
3311
3514
  /**
3515
+ * @public
3312
3516
  * <p>An object to specify the preferences for the Amazon EC2 recommendation
3313
3517
  * projected metrics to return in the response.</p>
3314
3518
  */
@@ -3331,6 +3535,7 @@ export interface GetEC2RecommendationProjectedMetricsRequest {
3331
3535
  */
3332
3536
  export interface ProjectedMetric {
3333
3537
  /**
3538
+ * @public
3334
3539
  * <p>The name of the projected utilization metric.</p>
3335
3540
  * <p>The following projected utilization metrics are returned:</p>
3336
3541
  * <ul>
@@ -3363,10 +3568,12 @@ export interface ProjectedMetric {
3363
3568
  */
3364
3569
  name?: MetricName | string;
3365
3570
  /**
3571
+ * @public
3366
3572
  * <p>The timestamps of the projected utilization metric.</p>
3367
3573
  */
3368
3574
  timestamps?: Date[];
3369
3575
  /**
3576
+ * @public
3370
3577
  * <p>The values of the projected utilization metrics.</p>
3371
3578
  */
3372
3579
  values?: number[];
@@ -3383,10 +3590,12 @@ export interface ProjectedMetric {
3383
3590
  */
3384
3591
  export interface RecommendedOptionProjectedMetric {
3385
3592
  /**
3593
+ * @public
3386
3594
  * <p>The recommended instance type.</p>
3387
3595
  */
3388
3596
  recommendedInstanceType?: string;
3389
3597
  /**
3598
+ * @public
3390
3599
  * <p>The rank of the recommendation option projected metric.</p>
3391
3600
  * <p>The top recommendation option is ranked as <code>1</code>.</p>
3392
3601
  * <p>The projected metric rank correlates to the recommendation option rank. For example,
@@ -3395,6 +3604,7 @@ export interface RecommendedOptionProjectedMetric {
3395
3604
  */
3396
3605
  rank?: number;
3397
3606
  /**
3607
+ * @public
3398
3608
  * <p>An array of objects that describe a projected utilization metric.</p>
3399
3609
  */
3400
3610
  projectedMetrics?: ProjectedMetric[];
@@ -3404,6 +3614,7 @@ export interface RecommendedOptionProjectedMetric {
3404
3614
  */
3405
3615
  export interface GetEC2RecommendationProjectedMetricsResponse {
3406
3616
  /**
3617
+ * @public
3407
3618
  * <p>An array of objects that describes projected metrics.</p>
3408
3619
  */
3409
3620
  recommendedOptionProjectedMetrics?: RecommendedOptionProjectedMetric[];
@@ -3413,6 +3624,7 @@ export interface GetEC2RecommendationProjectedMetricsResponse {
3413
3624
  */
3414
3625
  export interface GetECSServiceRecommendationProjectedMetricsRequest {
3415
3626
  /**
3627
+ * @public
3416
3628
  * <p>
3417
3629
  * The ARN that identifies the Amazon ECS service.
3418
3630
  * </p>
@@ -3425,24 +3637,28 @@ export interface GetECSServiceRecommendationProjectedMetricsRequest {
3425
3637
  */
3426
3638
  serviceArn: string | undefined;
3427
3639
  /**
3640
+ * @public
3428
3641
  * <p>
3429
3642
  * The statistic of the projected metrics.
3430
3643
  * </p>
3431
3644
  */
3432
3645
  stat: MetricStatistic | string | undefined;
3433
3646
  /**
3647
+ * @public
3434
3648
  * <p>
3435
3649
  * The granularity, in seconds, of the projected metrics data points.
3436
3650
  * </p>
3437
3651
  */
3438
3652
  period: number | undefined;
3439
3653
  /**
3654
+ * @public
3440
3655
  * <p>
3441
3656
  * The timestamp of the first projected metrics data point to return.
3442
3657
  * </p>
3443
3658
  */
3444
3659
  startTime: Date | undefined;
3445
3660
  /**
3661
+ * @public
3446
3662
  * <p>
3447
3663
  * The timestamp of the last projected metrics data point to return.
3448
3664
  * </p>
@@ -3471,6 +3687,7 @@ export type ECSServiceMetricName = (typeof ECSServiceMetricName)[keyof typeof EC
3471
3687
  */
3472
3688
  export interface ECSServiceProjectedMetric {
3473
3689
  /**
3690
+ * @public
3474
3691
  * <p>
3475
3692
  * The name of the projected metric.
3476
3693
  * </p>
@@ -3490,18 +3707,21 @@ export interface ECSServiceProjectedMetric {
3490
3707
  */
3491
3708
  name?: ECSServiceMetricName | string;
3492
3709
  /**
3710
+ * @public
3493
3711
  * <p>
3494
3712
  * The timestamps of the projected metric.
3495
3713
  * </p>
3496
3714
  */
3497
3715
  timestamps?: Date[];
3498
3716
  /**
3717
+ * @public
3499
3718
  * <p>
3500
3719
  * The upper bound values for the projected metric.
3501
3720
  * </p>
3502
3721
  */
3503
3722
  upperBoundValues?: number[];
3504
3723
  /**
3724
+ * @public
3505
3725
  * <p>
3506
3726
  * The lower bound values for the projected metric.
3507
3727
  * </p>
@@ -3518,18 +3738,21 @@ export interface ECSServiceProjectedMetric {
3518
3738
  */
3519
3739
  export interface ECSServiceRecommendedOptionProjectedMetric {
3520
3740
  /**
3741
+ * @public
3521
3742
  * <p>
3522
3743
  * The recommended CPU size for the Amazon ECS service.
3523
3744
  * </p>
3524
3745
  */
3525
3746
  recommendedCpuUnits?: number;
3526
3747
  /**
3748
+ * @public
3527
3749
  * <p>
3528
3750
  * The recommended memory size for the Amazon ECS service.
3529
3751
  * </p>
3530
3752
  */
3531
3753
  recommendedMemorySize?: number;
3532
3754
  /**
3755
+ * @public
3533
3756
  * <p>
3534
3757
  * An array of objects that describe the projected metric.
3535
3758
  * </p>
@@ -3541,6 +3764,7 @@ export interface ECSServiceRecommendedOptionProjectedMetric {
3541
3764
  */
3542
3765
  export interface GetECSServiceRecommendationProjectedMetricsResponse {
3543
3766
  /**
3767
+ * @public
3544
3768
  * <p>
3545
3769
  * An array of objects that describes the projected metrics.
3546
3770
  * </p>
@@ -3552,6 +3776,7 @@ export interface GetECSServiceRecommendationProjectedMetricsResponse {
3552
3776
  */
3553
3777
  export interface GetECSServiceRecommendationsRequest {
3554
3778
  /**
3779
+ * @public
3555
3780
  * <p>
3556
3781
  * The ARN that identifies the Amazon ECS service.
3557
3782
  * </p>
@@ -3564,12 +3789,14 @@ export interface GetECSServiceRecommendationsRequest {
3564
3789
  */
3565
3790
  serviceArns?: string[];
3566
3791
  /**
3792
+ * @public
3567
3793
  * <p>
3568
3794
  * The token to advance to the next page of Amazon ECS service recommendations.
3569
3795
  * </p>
3570
3796
  */
3571
3797
  nextToken?: string;
3572
3798
  /**
3799
+ * @public
3573
3800
  * <p>
3574
3801
  * The maximum number of Amazon ECS service recommendations to return with a single request.
3575
3802
  * </p>
@@ -3578,12 +3805,14 @@ export interface GetECSServiceRecommendationsRequest {
3578
3805
  */
3579
3806
  maxResults?: number;
3580
3807
  /**
3808
+ * @public
3581
3809
  * <p>
3582
3810
  * An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations.
3583
3811
  * </p>
3584
3812
  */
3585
3813
  filters?: ECSServiceRecommendationFilter[];
3586
3814
  /**
3815
+ * @public
3587
3816
  * <p>
3588
3817
  * Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs.
3589
3818
  * </p>
@@ -3602,12 +3831,14 @@ export interface GetECSServiceRecommendationsRequest {
3602
3831
  */
3603
3832
  export interface MemorySizeConfiguration {
3604
3833
  /**
3834
+ * @public
3605
3835
  * <p>
3606
3836
  * The amount of memory in the container.
3607
3837
  * </p>
3608
3838
  */
3609
3839
  memory?: number;
3610
3840
  /**
3841
+ * @public
3611
3842
  * <p>
3612
3843
  * The limit of memory reserve for the container.
3613
3844
  * </p>
@@ -3622,18 +3853,21 @@ export interface MemorySizeConfiguration {
3622
3853
  */
3623
3854
  export interface ContainerConfiguration {
3624
3855
  /**
3856
+ * @public
3625
3857
  * <p>
3626
3858
  * The name of the container.
3627
3859
  * </p>
3628
3860
  */
3629
3861
  containerName?: string;
3630
3862
  /**
3863
+ * @public
3631
3864
  * <p>
3632
3865
  * The memory size configurations for the container.
3633
3866
  * </p>
3634
3867
  */
3635
3868
  memorySizeConfiguration?: MemorySizeConfiguration;
3636
3869
  /**
3870
+ * @public
3637
3871
  * <p>
3638
3872
  * The number of CPU units reserved for the container.
3639
3873
  * </p>
@@ -3648,24 +3882,28 @@ export interface ContainerConfiguration {
3648
3882
  */
3649
3883
  export interface ServiceConfiguration {
3650
3884
  /**
3885
+ * @public
3651
3886
  * <p>
3652
3887
  * The amount of memory used by the tasks in the Amazon ECS service.
3653
3888
  * </p>
3654
3889
  */
3655
3890
  memory?: number;
3656
3891
  /**
3892
+ * @public
3657
3893
  * <p>
3658
3894
  * The number of CPU units used by the tasks in the Amazon ECS service.
3659
3895
  * </p>
3660
3896
  */
3661
3897
  cpu?: number;
3662
3898
  /**
3899
+ * @public
3663
3900
  * <p>
3664
3901
  * The container configurations within a task of an Amazon ECS service.
3665
3902
  * </p>
3666
3903
  */
3667
3904
  containerConfigurations?: ContainerConfiguration[];
3668
3905
  /**
3906
+ * @public
3669
3907
  * <p>
3670
3908
  * Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects
3671
3909
  * the generated recommendations. For example, if Auto Scaling is configured on a
@@ -3693,6 +3931,7 @@ export interface ServiceConfiguration {
3693
3931
  */
3694
3932
  autoScalingConfiguration?: AutoScalingConfiguration | string;
3695
3933
  /**
3934
+ * @public
3696
3935
  * <p>
3697
3936
  * The task definition ARN used by the tasks in the Amazon ECS service.
3698
3937
  * </p>
@@ -3746,18 +3985,21 @@ export type ECSServiceLaunchType = (typeof ECSServiceLaunchType)[keyof typeof EC
3746
3985
  */
3747
3986
  export interface ContainerRecommendation {
3748
3987
  /**
3988
+ * @public
3749
3989
  * <p>
3750
3990
  * The name of the container.
3751
3991
  * </p>
3752
3992
  */
3753
3993
  containerName?: string;
3754
3994
  /**
3995
+ * @public
3755
3996
  * <p>
3756
3997
  * The recommended memory size configurations for the container.
3757
3998
  * </p>
3758
3999
  */
3759
4000
  memorySizeConfiguration?: MemorySizeConfiguration;
3760
4001
  /**
4002
+ * @public
3761
4003
  * <p>
3762
4004
  * The recommended number of CPU units reserved for the container.
3763
4005
  * </p>
@@ -3786,6 +4028,7 @@ export type ECSServiceMetricStatistic = (typeof ECSServiceMetricStatistic)[keyof
3786
4028
  */
3787
4029
  export interface ECSServiceProjectedUtilizationMetric {
3788
4030
  /**
4031
+ * @public
3789
4032
  * <p>
3790
4033
  * The name of the projected utilization metric.
3791
4034
  * </p>
@@ -3805,6 +4048,7 @@ export interface ECSServiceProjectedUtilizationMetric {
3805
4048
  */
3806
4049
  name?: ECSServiceMetricName | string;
3807
4050
  /**
4051
+ * @public
3808
4052
  * <p>The statistic of the projected utilization metric.</p>
3809
4053
  * <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
3810
4054
  * return utilization metrics using only the <code>Maximum</code> statistic, which is the
@@ -3820,12 +4064,14 @@ export interface ECSServiceProjectedUtilizationMetric {
3820
4064
  */
3821
4065
  statistic?: ECSServiceMetricStatistic | string;
3822
4066
  /**
4067
+ * @public
3823
4068
  * <p>
3824
4069
  * The lower bound values for the projected utilization metrics.
3825
4070
  * </p>
3826
4071
  */
3827
4072
  lowerBoundValue?: number;
3828
4073
  /**
4074
+ * @public
3829
4075
  * <p>
3830
4076
  * The upper bound values for the projected utilization metrics.
3831
4077
  * </p>
@@ -3840,18 +4086,21 @@ export interface ECSServiceProjectedUtilizationMetric {
3840
4086
  */
3841
4087
  export interface ECSServiceRecommendationOption {
3842
4088
  /**
4089
+ * @public
3843
4090
  * <p>
3844
4091
  * The memory size of the Amazon ECS service recommendation option.
3845
4092
  * </p>
3846
4093
  */
3847
4094
  memory?: number;
3848
4095
  /**
4096
+ * @public
3849
4097
  * <p>
3850
4098
  * The CPU size of the Amazon ECS service recommendation option.
3851
4099
  * </p>
3852
4100
  */
3853
4101
  cpu?: number;
3854
4102
  /**
4103
+ * @public
3855
4104
  * <p>Describes the savings opportunity for recommendations of a given resource type or for
3856
4105
  * the recommendation option of an individual resource.</p>
3857
4106
  * <p>Savings opportunity represents the estimated monthly savings you can achieve by
@@ -3871,12 +4120,14 @@ export interface ECSServiceRecommendationOption {
3871
4120
  */
3872
4121
  savingsOpportunity?: SavingsOpportunity;
3873
4122
  /**
4123
+ * @public
3874
4124
  * <p>
3875
4125
  * An array of objects that describe the projected utilization metrics of the Amazon ECS service recommendation option.
3876
4126
  * </p>
3877
4127
  */
3878
4128
  projectedUtilizationMetrics?: ECSServiceProjectedUtilizationMetric[];
3879
4129
  /**
4130
+ * @public
3880
4131
  * <p>
3881
4132
  * The CPU and memory size recommendations for the containers within the task of your Amazon ECS service.
3882
4133
  * </p>
@@ -3893,6 +4144,7 @@ export interface ECSServiceRecommendationOption {
3893
4144
  */
3894
4145
  export interface ECSServiceUtilizationMetric {
3895
4146
  /**
4147
+ * @public
3896
4148
  * <p>
3897
4149
  * The name of the utilization metric.
3898
4150
  * </p>
@@ -3910,6 +4162,7 @@ export interface ECSServiceUtilizationMetric {
3910
4162
  */
3911
4163
  name?: ECSServiceMetricName | string;
3912
4164
  /**
4165
+ * @public
3913
4166
  * <p>The statistic of the utilization metric.</p>
3914
4167
  * <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
3915
4168
  * return utilization metrics using only the <code>Maximum</code> statistic, which is the
@@ -3925,6 +4178,7 @@ export interface ECSServiceUtilizationMetric {
3925
4178
  */
3926
4179
  statistic?: ECSServiceMetricStatistic | string;
3927
4180
  /**
4181
+ * @public
3928
4182
  * <p>
3929
4183
  * The value of the utilization metric.
3930
4184
  * </p>
@@ -3939,6 +4193,7 @@ export interface ECSServiceUtilizationMetric {
3939
4193
  */
3940
4194
  export interface ECSServiceRecommendation {
3941
4195
  /**
4196
+ * @public
3942
4197
  * <p>
3943
4198
  * The Amazon Resource Name (ARN) of the current Amazon ECS service.
3944
4199
  * </p>
@@ -3951,30 +4206,35 @@ export interface ECSServiceRecommendation {
3951
4206
  */
3952
4207
  serviceArn?: string;
3953
4208
  /**
4209
+ * @public
3954
4210
  * <p>
3955
4211
  * The Amazon Web Services account ID of the Amazon ECS service.
3956
4212
  * </p>
3957
4213
  */
3958
4214
  accountId?: string;
3959
4215
  /**
4216
+ * @public
3960
4217
  * <p>
3961
4218
  * The configuration of the current Amazon ECS service.
3962
4219
  * </p>
3963
4220
  */
3964
4221
  currentServiceConfiguration?: ServiceConfiguration;
3965
4222
  /**
4223
+ * @public
3966
4224
  * <p>
3967
4225
  * An array of objects that describe the utilization metrics of the Amazon ECS service.
3968
4226
  * </p>
3969
4227
  */
3970
4228
  utilizationMetrics?: ECSServiceUtilizationMetric[];
3971
4229
  /**
4230
+ * @public
3972
4231
  * <p>
3973
4232
  * The number of days the Amazon ECS service utilization metrics were analyzed.
3974
4233
  * </p>
3975
4234
  */
3976
4235
  lookbackPeriodInDays?: number;
3977
4236
  /**
4237
+ * @public
3978
4238
  * <p>
3979
4239
  * The launch type the Amazon ECS service is using.
3980
4240
  * </p>
@@ -3984,12 +4244,14 @@ export interface ECSServiceRecommendation {
3984
4244
  */
3985
4245
  launchType?: ECSServiceLaunchType | string;
3986
4246
  /**
4247
+ * @public
3987
4248
  * <p>
3988
4249
  * The timestamp of when the Amazon ECS service recommendation was last generated.
3989
4250
  * </p>
3990
4251
  */
3991
4252
  lastRefreshTimestamp?: Date;
3992
4253
  /**
4254
+ * @public
3993
4255
  * <p>
3994
4256
  * The finding classification of an Amazon ECS service.
3995
4257
  * </p>
@@ -4025,6 +4287,7 @@ export interface ECSServiceRecommendation {
4025
4287
  */
4026
4288
  finding?: ECSServiceRecommendationFinding | string;
4027
4289
  /**
4290
+ * @public
4028
4291
  * <p>
4029
4292
  * The reason for the finding classification of an Amazon ECS service.
4030
4293
  * </p>
@@ -4070,12 +4333,14 @@ export interface ECSServiceRecommendation {
4070
4333
  */
4071
4334
  findingReasonCodes?: (ECSServiceRecommendationFindingReasonCode | string)[];
4072
4335
  /**
4336
+ * @public
4073
4337
  * <p>
4074
4338
  * An array of objects that describe the recommendation options for the Amazon ECS service.
4075
4339
  * </p>
4076
4340
  */
4077
4341
  serviceRecommendationOptions?: ECSServiceRecommendationOption[];
4078
4342
  /**
4343
+ * @public
4079
4344
  * <p>
4080
4345
  * The risk of the current Amazon ECS service not meeting the performance needs of its workloads.
4081
4346
  * The higher the risk, the more likely the current service can't meet the performance
@@ -4084,6 +4349,7 @@ export interface ECSServiceRecommendation {
4084
4349
  */
4085
4350
  currentPerformanceRisk?: CurrentPerformanceRisk | string;
4086
4351
  /**
4352
+ * @public
4087
4353
  * <p>
4088
4354
  * A list of tags assigned to your Amazon ECS service recommendations.
4089
4355
  * </p>
@@ -4095,18 +4361,21 @@ export interface ECSServiceRecommendation {
4095
4361
  */
4096
4362
  export interface GetECSServiceRecommendationsResponse {
4097
4363
  /**
4364
+ * @public
4098
4365
  * <p>
4099
4366
  * The token to advance to the next page of Amazon ECS service recommendations.
4100
4367
  * </p>
4101
4368
  */
4102
4369
  nextToken?: string;
4103
4370
  /**
4371
+ * @public
4104
4372
  * <p>
4105
4373
  * An array of objects that describe the Amazon ECS service recommendations.
4106
4374
  * </p>
4107
4375
  */
4108
4376
  ecsServiceRecommendations?: ECSServiceRecommendation[];
4109
4377
  /**
4378
+ * @public
4110
4379
  * <p>
4111
4380
  * An array of objects that describe errors of the request.
4112
4381
  * </p>
@@ -4118,6 +4387,7 @@ export interface GetECSServiceRecommendationsResponse {
4118
4387
  */
4119
4388
  export interface GetEffectiveRecommendationPreferencesRequest {
4120
4389
  /**
4390
+ * @public
4121
4391
  * <p>The Amazon Resource Name (ARN) of the resource for which to confirm effective
4122
4392
  * recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are
4123
4393
  * currently supported.</p>
@@ -4129,6 +4399,7 @@ export interface GetEffectiveRecommendationPreferencesRequest {
4129
4399
  */
4130
4400
  export interface GetEffectiveRecommendationPreferencesResponse {
4131
4401
  /**
4402
+ * @public
4132
4403
  * <p>The status of the enhanced infrastructure metrics recommendation preference. Considers
4133
4404
  * all applicable preferences that you might have set at the resource, account, and
4134
4405
  * organization level.</p>
@@ -4144,6 +4415,7 @@ export interface GetEffectiveRecommendationPreferencesResponse {
4144
4415
  */
4145
4416
  enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
4146
4417
  /**
4418
+ * @public
4147
4419
  * <p>The provider of the external metrics recommendation preference. Considers all
4148
4420
  * applicable preferences that you might have set at the account and organization
4149
4421
  * level.</p>
@@ -4169,26 +4441,31 @@ export interface GetEnrollmentStatusRequest {
4169
4441
  */
4170
4442
  export interface GetEnrollmentStatusResponse {
4171
4443
  /**
4444
+ * @public
4172
4445
  * <p>The enrollment status of the account.</p>
4173
4446
  */
4174
4447
  status?: Status | string;
4175
4448
  /**
4449
+ * @public
4176
4450
  * <p>The reason for the enrollment status of the account.</p>
4177
4451
  * <p>For example, an account might show a status of <code>Pending</code> because member
4178
4452
  * accounts of an organization require more time to be enrolled in the service.</p>
4179
4453
  */
4180
4454
  statusReason?: string;
4181
4455
  /**
4456
+ * @public
4182
4457
  * <p>Confirms the enrollment status of member accounts of the organization, if the account
4183
4458
  * is a management account of an organization.</p>
4184
4459
  */
4185
4460
  memberAccountsEnrolled?: boolean;
4186
4461
  /**
4462
+ * @public
4187
4463
  * <p>The Unix epoch timestamp, in seconds, of when the account enrollment status was last
4188
4464
  * updated.</p>
4189
4465
  */
4190
4466
  lastUpdatedTimestamp?: Date;
4191
4467
  /**
4468
+ * @public
4192
4469
  * <p>The count of organization member accounts that are opted in to the service, if your
4193
4470
  * account is an organization management account.</p>
4194
4471
  */
@@ -4213,12 +4490,14 @@ export type EnrollmentFilterName = (typeof EnrollmentFilterName)[keyof typeof En
4213
4490
  */
4214
4491
  export interface EnrollmentFilter {
4215
4492
  /**
4493
+ * @public
4216
4494
  * <p>The name of the filter.</p>
4217
4495
  * <p>Specify <code>Status</code> to return accounts with a specific enrollment status (for
4218
4496
  * example, <code>Active</code>).</p>
4219
4497
  */
4220
4498
  name?: EnrollmentFilterName | string;
4221
4499
  /**
4500
+ * @public
4222
4501
  * <p>The value of the filter.</p>
4223
4502
  * <p>The valid values are <code>Active</code>, <code>Inactive</code>, <code>Pending</code>,
4224
4503
  * and <code>Failed</code>.</p>
@@ -4230,15 +4509,18 @@ export interface EnrollmentFilter {
4230
4509
  */
4231
4510
  export interface GetEnrollmentStatusesForOrganizationRequest {
4232
4511
  /**
4512
+ * @public
4233
4513
  * <p>An array of objects to specify a filter that returns a more specific list of account
4234
4514
  * enrollment statuses.</p>
4235
4515
  */
4236
4516
  filters?: EnrollmentFilter[];
4237
4517
  /**
4518
+ * @public
4238
4519
  * <p>The token to advance to the next page of account enrollment statuses.</p>
4239
4520
  */
4240
4521
  nextToken?: string;
4241
4522
  /**
4523
+ * @public
4242
4524
  * <p>The maximum number of account enrollment statuses to return with a single request. You
4243
4525
  * can specify up to 100 statuses to return with each request.</p>
4244
4526
  * <p>To retrieve the remaining results, make another request with the returned
@@ -4251,11 +4533,13 @@ export interface GetEnrollmentStatusesForOrganizationRequest {
4251
4533
  */
4252
4534
  export interface GetEnrollmentStatusesForOrganizationResponse {
4253
4535
  /**
4536
+ * @public
4254
4537
  * <p>An array of objects that describe the enrollment statuses of organization member
4255
4538
  * accounts.</p>
4256
4539
  */
4257
4540
  accountEnrollmentStatuses?: AccountEnrollmentStatus[];
4258
4541
  /**
4542
+ * @public
4259
4543
  * <p>The token to use to advance to the next page of account enrollment statuses.</p>
4260
4544
  * <p>This value is null when there are no more pages of account enrollment statuses to
4261
4545
  * return.</p>
@@ -4267,6 +4551,7 @@ export interface GetEnrollmentStatusesForOrganizationResponse {
4267
4551
  */
4268
4552
  export interface GetLambdaFunctionRecommendationsRequest {
4269
4553
  /**
4554
+ * @public
4270
4555
  * <p>The Amazon Resource Name (ARN) of the functions for which to return
4271
4556
  * recommendations.</p>
4272
4557
  * <p>You can specify a qualified or unqualified ARN. If you specify an unqualified ARN
@@ -4279,6 +4564,7 @@ export interface GetLambdaFunctionRecommendationsRequest {
4279
4564
  */
4280
4565
  functionArns?: string[];
4281
4566
  /**
4567
+ * @public
4282
4568
  * <p>The ID of the Amazon Web Services account for which to return function
4283
4569
  * recommendations.</p>
4284
4570
  * <p>If your account is the management account of an organization, use this parameter to
@@ -4287,15 +4573,18 @@ export interface GetLambdaFunctionRecommendationsRequest {
4287
4573
  */
4288
4574
  accountIds?: string[];
4289
4575
  /**
4576
+ * @public
4290
4577
  * <p>An array of objects to specify a filter that returns a more specific list of function
4291
4578
  * recommendations.</p>
4292
4579
  */
4293
4580
  filters?: LambdaFunctionRecommendationFilter[];
4294
4581
  /**
4582
+ * @public
4295
4583
  * <p>The token to advance to the next page of function recommendations.</p>
4296
4584
  */
4297
4585
  nextToken?: string;
4298
4586
  /**
4587
+ * @public
4299
4588
  * <p>The maximum number of function recommendations to return with a single request.</p>
4300
4589
  * <p>To retrieve the remaining results, make another request with the returned
4301
4590
  * <code>nextToken</code> value.</p>
@@ -4360,14 +4649,17 @@ export type LambdaFunctionMemoryMetricStatistic = (typeof LambdaFunctionMemoryMe
4360
4649
  */
4361
4650
  export interface LambdaFunctionMemoryProjectedMetric {
4362
4651
  /**
4652
+ * @public
4363
4653
  * <p>The name of the projected utilization metric.</p>
4364
4654
  */
4365
4655
  name?: LambdaFunctionMemoryMetricName | string;
4366
4656
  /**
4657
+ * @public
4367
4658
  * <p>The statistic of the projected utilization metric.</p>
4368
4659
  */
4369
4660
  statistic?: LambdaFunctionMemoryMetricStatistic | string;
4370
4661
  /**
4662
+ * @public
4371
4663
  * <p>The values of the projected utilization metrics.</p>
4372
4664
  */
4373
4665
  value?: number;
@@ -4378,20 +4670,24 @@ export interface LambdaFunctionMemoryProjectedMetric {
4378
4670
  */
4379
4671
  export interface LambdaFunctionMemoryRecommendationOption {
4380
4672
  /**
4673
+ * @public
4381
4674
  * <p>The rank of the function recommendation option.</p>
4382
4675
  * <p>The top recommendation option is ranked as <code>1</code>.</p>
4383
4676
  */
4384
4677
  rank?: number;
4385
4678
  /**
4679
+ * @public
4386
4680
  * <p>The memory size, in MB, of the function recommendation option.</p>
4387
4681
  */
4388
4682
  memorySize?: number;
4389
4683
  /**
4684
+ * @public
4390
4685
  * <p>An array of objects that describe the projected utilization metrics of the function
4391
4686
  * recommendation option.</p>
4392
4687
  */
4393
4688
  projectedUtilizationMetrics?: LambdaFunctionMemoryProjectedMetric[];
4394
4689
  /**
4690
+ * @public
4395
4691
  * <p>An object that describes the savings opportunity for the Lambda function
4396
4692
  * recommendation option. Savings opportunity includes the estimated monthly savings amount
4397
4693
  * and percentage.</p>
@@ -4428,6 +4724,7 @@ export type LambdaFunctionMetricStatistic = (typeof LambdaFunctionMetricStatisti
4428
4724
  */
4429
4725
  export interface LambdaFunctionUtilizationMetric {
4430
4726
  /**
4727
+ * @public
4431
4728
  * <p>The name of the utilization metric.</p>
4432
4729
  * <p>The following utilization metrics are available:</p>
4433
4730
  * <ul>
@@ -4444,6 +4741,7 @@ export interface LambdaFunctionUtilizationMetric {
4444
4741
  */
4445
4742
  name?: LambdaFunctionMetricName | string;
4446
4743
  /**
4744
+ * @public
4447
4745
  * <p>The statistic of the utilization metric.</p>
4448
4746
  * <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs
4449
4747
  * return utilization metrics using only the <code>Maximum</code> statistic, which is the
@@ -4459,6 +4757,7 @@ export interface LambdaFunctionUtilizationMetric {
4459
4757
  */
4460
4758
  statistic?: LambdaFunctionMetricStatistic | string;
4461
4759
  /**
4760
+ * @public
4462
4761
  * <p>The value of the utilization metric.</p>
4463
4762
  */
4464
4763
  value?: number;
@@ -4469,39 +4768,48 @@ export interface LambdaFunctionUtilizationMetric {
4469
4768
  */
4470
4769
  export interface LambdaFunctionRecommendation {
4471
4770
  /**
4771
+ * @public
4472
4772
  * <p>The Amazon Resource Name (ARN) of the current function.</p>
4473
4773
  */
4474
4774
  functionArn?: string;
4475
4775
  /**
4776
+ * @public
4476
4777
  * <p>The version number of the current function.</p>
4477
4778
  */
4478
4779
  functionVersion?: string;
4479
4780
  /**
4781
+ * @public
4480
4782
  * <p>The Amazon Web Services account ID of the function.</p>
4481
4783
  */
4482
4784
  accountId?: string;
4483
4785
  /**
4786
+ * @public
4484
4787
  * <p>The amount of memory, in MB, that's allocated to the current function.</p>
4485
4788
  */
4486
4789
  currentMemorySize?: number;
4487
4790
  /**
4791
+ * @public
4488
4792
  * <p>The number of times your function code was applied during the look-back period.</p>
4489
4793
  */
4490
4794
  numberOfInvocations?: number;
4491
4795
  /**
4796
+ * @public
4492
4797
  * <p>An array of objects that describe the utilization metrics of the function.</p>
4493
4798
  */
4494
4799
  utilizationMetrics?: LambdaFunctionUtilizationMetric[];
4495
4800
  /**
4801
+ * @public
4496
4802
  * <p>The number of days for which utilization metrics were analyzed for the
4497
4803
  * function.</p>
4498
4804
  */
4499
4805
  lookbackPeriodInDays?: number;
4500
4806
  /**
4807
+ * @public
4501
4808
  * <p>The timestamp of when the function recommendation was last generated.</p>
4502
4809
  */
4503
4810
  lastRefreshTimestamp?: Date;
4504
4811
  /**
4812
+ * @public
4505
4813
  * <p>The finding classification of the function.</p>
4506
4814
  * <p>Findings for functions include:</p>
4507
4815
  * <ul>
@@ -4548,6 +4856,7 @@ export interface LambdaFunctionRecommendation {
4548
4856
  */
4549
4857
  finding?: LambdaFunctionRecommendationFinding | string;
4550
4858
  /**
4859
+ * @public
4551
4860
  * <p>The reason for the finding classification of the function.</p>
4552
4861
  * <note>
4553
4862
  * <p>Functions that have a finding classification of <code>Optimized</code> don't have
@@ -4600,17 +4909,20 @@ export interface LambdaFunctionRecommendation {
4600
4909
  */
4601
4910
  findingReasonCodes?: (LambdaFunctionRecommendationFindingReasonCode | string)[];
4602
4911
  /**
4912
+ * @public
4603
4913
  * <p>An array of objects that describe the memory configuration recommendation options for
4604
4914
  * the function.</p>
4605
4915
  */
4606
4916
  memorySizeRecommendationOptions?: LambdaFunctionMemoryRecommendationOption[];
4607
4917
  /**
4918
+ * @public
4608
4919
  * <p>The risk of the current Lambda function not meeting the performance needs
4609
4920
  * of its workloads. The higher the risk, the more likely the current Lambda
4610
4921
  * function requires more memory.</p>
4611
4922
  */
4612
4923
  currentPerformanceRisk?: CurrentPerformanceRisk | string;
4613
4924
  /**
4925
+ * @public
4614
4926
  * <p>
4615
4927
  * A list of tags assigned to your Lambda function recommendations.
4616
4928
  * </p>
@@ -4622,12 +4934,14 @@ export interface LambdaFunctionRecommendation {
4622
4934
  */
4623
4935
  export interface GetLambdaFunctionRecommendationsResponse {
4624
4936
  /**
4937
+ * @public
4625
4938
  * <p>The token to use to advance to the next page of function recommendations.</p>
4626
4939
  * <p>This value is null when there are no more pages of function recommendations to
4627
4940
  * return.</p>
4628
4941
  */
4629
4942
  nextToken?: string;
4630
4943
  /**
4944
+ * @public
4631
4945
  * <p>An array of objects that describe function recommendations.</p>
4632
4946
  */
4633
4947
  lambdaFunctionRecommendations?: LambdaFunctionRecommendation[];
@@ -4637,6 +4951,7 @@ export interface GetLambdaFunctionRecommendationsResponse {
4637
4951
  */
4638
4952
  export interface GetRecommendationPreferencesRequest {
4639
4953
  /**
4954
+ * @public
4640
4955
  * <p>The target resource type of the recommendation preference for which to return
4641
4956
  * preferences.</p>
4642
4957
  * <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
@@ -4649,6 +4964,7 @@ export interface GetRecommendationPreferencesRequest {
4649
4964
  */
4650
4965
  resourceType: ResourceType | string | undefined;
4651
4966
  /**
4967
+ * @public
4652
4968
  * <p>An object that describes the scope of the recommendation preference to return.</p>
4653
4969
  * <p>You can return recommendation preferences that are created at the organization level
4654
4970
  * (for management accounts of an organization only), account level, and resource level.
@@ -4658,10 +4974,12 @@ export interface GetRecommendationPreferencesRequest {
4658
4974
  */
4659
4975
  scope?: Scope;
4660
4976
  /**
4977
+ * @public
4661
4978
  * <p>The token to advance to the next page of recommendation preferences.</p>
4662
4979
  */
4663
4980
  nextToken?: string;
4664
4981
  /**
4982
+ * @public
4665
4983
  * <p>The maximum number of recommendation preferences to return with a single
4666
4984
  * request.</p>
4667
4985
  * <p>To retrieve the remaining results, make another request with the returned
@@ -4675,6 +4993,7 @@ export interface GetRecommendationPreferencesRequest {
4675
4993
  */
4676
4994
  export interface RecommendationPreferencesDetail {
4677
4995
  /**
4996
+ * @public
4678
4997
  * <p>An object that describes the scope of the recommendation preference.</p>
4679
4998
  * <p>Recommendation preferences can be created at the organization level (for management
4680
4999
  * accounts of an organization only), account level, and resource level. For more
@@ -4684,6 +5003,7 @@ export interface RecommendationPreferencesDetail {
4684
5003
  */
4685
5004
  scope?: Scope;
4686
5005
  /**
5006
+ * @public
4687
5007
  * <p>The target resource type of the recommendation preference to create.</p>
4688
5008
  * <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
4689
5009
  * that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
@@ -4691,6 +5011,7 @@ export interface RecommendationPreferencesDetail {
4691
5011
  */
4692
5012
  resourceType?: ResourceType | string;
4693
5013
  /**
5014
+ * @public
4694
5015
  * <p>The status of the enhanced infrastructure metrics recommendation preference.</p>
4695
5016
  * <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms
4696
5017
  * that the preference is applied to the recommendations, and a status of
@@ -4702,6 +5023,7 @@ export interface RecommendationPreferencesDetail {
4702
5023
  */
4703
5024
  enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
4704
5025
  /**
5026
+ * @public
4705
5027
  * <p>The status of the inferred workload types recommendation preference.</p>
4706
5028
  * <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms
4707
5029
  * that the preference is applied to the recommendations, and a status of
@@ -4710,6 +5032,7 @@ export interface RecommendationPreferencesDetail {
4710
5032
  */
4711
5033
  inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
4712
5034
  /**
5035
+ * @public
4713
5036
  * <p> An object that describes the external metrics recommendation preference. </p>
4714
5037
  * <p> If the preference is applied in the latest recommendation refresh, an object with a
4715
5038
  * valid <code>source</code> value appears in the response. If the preference isn't applied
@@ -4722,12 +5045,14 @@ export interface RecommendationPreferencesDetail {
4722
5045
  */
4723
5046
  export interface GetRecommendationPreferencesResponse {
4724
5047
  /**
5048
+ * @public
4725
5049
  * <p>The token to use to advance to the next page of recommendation preferences.</p>
4726
5050
  * <p>This value is null when there are no more pages of recommendation preferences to
4727
5051
  * return.</p>
4728
5052
  */
4729
5053
  nextToken?: string;
4730
5054
  /**
5055
+ * @public
4731
5056
  * <p>An array of objects that describe recommendation preferences.</p>
4732
5057
  */
4733
5058
  recommendationPreferencesDetails?: RecommendationPreferencesDetail[];
@@ -4737,6 +5062,7 @@ export interface GetRecommendationPreferencesResponse {
4737
5062
  */
4738
5063
  export interface GetRecommendationSummariesRequest {
4739
5064
  /**
5065
+ * @public
4740
5066
  * <p>The ID of the Amazon Web Services account for which to return recommendation
4741
5067
  * summaries.</p>
4742
5068
  * <p>If your account is the management account of an organization, use this parameter to
@@ -4745,10 +5071,12 @@ export interface GetRecommendationSummariesRequest {
4745
5071
  */
4746
5072
  accountIds?: string[];
4747
5073
  /**
5074
+ * @public
4748
5075
  * <p>The token to advance to the next page of recommendation summaries.</p>
4749
5076
  */
4750
5077
  nextToken?: string;
4751
5078
  /**
5079
+ * @public
4752
5080
  * <p>The maximum number of recommendation summaries to return with a single request.</p>
4753
5081
  * <p>To retrieve the remaining results, make another request with the returned
4754
5082
  * <code>nextToken</code> value.</p>
@@ -4764,18 +5092,22 @@ export interface GetRecommendationSummariesRequest {
4764
5092
  */
4765
5093
  export interface CurrentPerformanceRiskRatings {
4766
5094
  /**
5095
+ * @public
4767
5096
  * <p>A count of the applicable resource types with a high performance risk rating.</p>
4768
5097
  */
4769
5098
  high?: number;
4770
5099
  /**
5100
+ * @public
4771
5101
  * <p>A count of the applicable resource types with a medium performance risk rating.</p>
4772
5102
  */
4773
5103
  medium?: number;
4774
5104
  /**
5105
+ * @public
4775
5106
  * <p>A count of the applicable resource types with a low performance risk rating.</p>
4776
5107
  */
4777
5108
  low?: number;
4778
5109
  /**
5110
+ * @public
4779
5111
  * <p>A count of the applicable resource types with a very low performance risk
4780
5112
  * rating.</p>
4781
5113
  */
@@ -4792,6 +5124,7 @@ export interface CurrentPerformanceRiskRatings {
4792
5124
  */
4793
5125
  export interface InferredWorkloadSaving {
4794
5126
  /**
5127
+ * @public
4795
5128
  * <p>The applications that might be running on the instance as inferred by Compute Optimizer.</p>
4796
5129
  * <p>Compute Optimizer can infer if one of the following applications might be running on
4797
5130
  * the instance:</p>
@@ -4845,6 +5178,7 @@ export interface InferredWorkloadSaving {
4845
5178
  */
4846
5179
  inferredWorkloadTypes?: (InferredWorkloadType | string)[];
4847
5180
  /**
5181
+ * @public
4848
5182
  * <p>An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given
4849
5183
  * resource. This is based on the On-Demand instance pricing.</p>
4850
5184
  */
@@ -4868,10 +5202,12 @@ export type FindingReasonCode = (typeof FindingReasonCode)[keyof typeof FindingR
4868
5202
  */
4869
5203
  export interface ReasonCodeSummary {
4870
5204
  /**
5205
+ * @public
4871
5206
  * <p>The name of the finding reason code.</p>
4872
5207
  */
4873
5208
  name?: FindingReasonCode | string;
4874
5209
  /**
5210
+ * @public
4875
5211
  * <p>The value of the finding reason code summary.</p>
4876
5212
  */
4877
5213
  value?: number;
@@ -4882,14 +5218,17 @@ export interface ReasonCodeSummary {
4882
5218
  */
4883
5219
  export interface Summary {
4884
5220
  /**
5221
+ * @public
4885
5222
  * <p>The finding classification of the recommendation.</p>
4886
5223
  */
4887
5224
  name?: Finding | string;
4888
5225
  /**
5226
+ * @public
4889
5227
  * <p>The value of the recommendation summary.</p>
4890
5228
  */
4891
5229
  value?: number;
4892
5230
  /**
5231
+ * @public
4893
5232
  * <p>An array of objects that summarize a finding reason code.</p>
4894
5233
  */
4895
5234
  reasonCodeSummaries?: ReasonCodeSummary[];
@@ -4900,28 +5239,34 @@ export interface Summary {
4900
5239
  */
4901
5240
  export interface RecommendationSummary {
4902
5241
  /**
5242
+ * @public
4903
5243
  * <p>An array of objects that describe a recommendation summary.</p>
4904
5244
  */
4905
5245
  summaries?: Summary[];
4906
5246
  /**
5247
+ * @public
4907
5248
  * <p>The resource type that the recommendation summary applies to.</p>
4908
5249
  */
4909
5250
  recommendationResourceType?: RecommendationSourceType | string;
4910
5251
  /**
5252
+ * @public
4911
5253
  * <p>The Amazon Web Services account ID of the recommendation summary.</p>
4912
5254
  */
4913
5255
  accountId?: string;
4914
5256
  /**
5257
+ * @public
4915
5258
  * <p>An object that describes the savings opportunity for a given resource type. Savings
4916
5259
  * opportunity includes the estimated monthly savings amount and percentage.</p>
4917
5260
  */
4918
5261
  savingsOpportunity?: SavingsOpportunity;
4919
5262
  /**
5263
+ * @public
4920
5264
  * <p>An object that describes the performance risk ratings for a given resource
4921
5265
  * type.</p>
4922
5266
  */
4923
5267
  currentPerformanceRiskRatings?: CurrentPerformanceRiskRatings;
4924
5268
  /**
5269
+ * @public
4925
5270
  * <p>
4926
5271
  * An array of objects that describes the estimated monthly saving amounts for the instances running on the specified
4927
5272
  * <code>inferredWorkloadTypes</code>. The array contains the top three savings opportunites for the instances running
@@ -4935,12 +5280,14 @@ export interface RecommendationSummary {
4935
5280
  */
4936
5281
  export interface GetRecommendationSummariesResponse {
4937
5282
  /**
5283
+ * @public
4938
5284
  * <p>The token to use to advance to the next page of recommendation summaries.</p>
4939
5285
  * <p>This value is null when there are no more pages of recommendation summaries to
4940
5286
  * return.</p>
4941
5287
  */
4942
5288
  nextToken?: string;
4943
5289
  /**
5290
+ * @public
4944
5291
  * <p>An array of objects that summarize a recommendation.</p>
4945
5292
  */
4946
5293
  recommendationSummaries?: RecommendationSummary[];
@@ -4950,6 +5297,7 @@ export interface GetRecommendationSummariesResponse {
4950
5297
  */
4951
5298
  export interface PutRecommendationPreferencesRequest {
4952
5299
  /**
5300
+ * @public
4953
5301
  * <p>The target resource type of the recommendation preference to create.</p>
4954
5302
  * <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances
4955
5303
  * that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option
@@ -4961,6 +5309,7 @@ export interface PutRecommendationPreferencesRequest {
4961
5309
  */
4962
5310
  resourceType: ResourceType | string | undefined;
4963
5311
  /**
5312
+ * @public
4964
5313
  * <p>An object that describes the scope of the recommendation preference to create.</p>
4965
5314
  * <p>You can create recommendation preferences at the organization level (for management
4966
5315
  * accounts of an organization only), account level, and resource level. For more
@@ -4980,6 +5329,7 @@ export interface PutRecommendationPreferencesRequest {
4980
5329
  */
4981
5330
  scope?: Scope;
4982
5331
  /**
5332
+ * @public
4983
5333
  * <p>The status of the enhanced infrastructure metrics recommendation preference to create
4984
5334
  * or update.</p>
4985
5335
  * <p>Specify the <code>Active</code> status to activate the preference, or specify
@@ -4990,6 +5340,7 @@ export interface PutRecommendationPreferencesRequest {
4990
5340
  */
4991
5341
  enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string;
4992
5342
  /**
5343
+ * @public
4993
5344
  * <p>The status of the inferred workload types recommendation preference to create or
4994
5345
  * update.</p>
4995
5346
  * <note>
@@ -5003,6 +5354,7 @@ export interface PutRecommendationPreferencesRequest {
5003
5354
  */
5004
5355
  inferredWorkloadTypes?: InferredWorkloadTypesPreference | string;
5005
5356
  /**
5357
+ * @public
5006
5358
  * <p>The provider of the external metrics recommendation preference to create or
5007
5359
  * update.</p>
5008
5360
  * <p>Specify a valid provider in the <code>source</code> field to activate the preference.
@@ -5025,6 +5377,7 @@ export interface PutRecommendationPreferencesResponse {
5025
5377
  */
5026
5378
  export interface UpdateEnrollmentStatusRequest {
5027
5379
  /**
5380
+ * @public
5028
5381
  * <p>The new enrollment status of the account.</p>
5029
5382
  * <p>The following status options are available:</p>
5030
5383
  * <ul>
@@ -5050,6 +5403,7 @@ export interface UpdateEnrollmentStatusRequest {
5050
5403
  */
5051
5404
  status: Status | string | undefined;
5052
5405
  /**
5406
+ * @public
5053
5407
  * <p>Indicates whether to enroll member accounts of the organization if the account is the
5054
5408
  * management account of an organization.</p>
5055
5409
  */
@@ -5060,10 +5414,12 @@ export interface UpdateEnrollmentStatusRequest {
5060
5414
  */
5061
5415
  export interface UpdateEnrollmentStatusResponse {
5062
5416
  /**
5417
+ * @public
5063
5418
  * <p>The enrollment status of the account.</p>
5064
5419
  */
5065
5420
  status?: Status | string;
5066
5421
  /**
5422
+ * @public
5067
5423
  * <p>The reason for the enrollment status of the account. For example, an account might
5068
5424
  * show a status of <code>Pending</code> because member accounts of an organization require
5069
5425
  * more time to be enrolled in the service.</p>