@aws-sdk/client-cost-explorer 3.379.1 → 3.385.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.
@@ -18,10 +18,12 @@ export type AccountScope = (typeof AccountScope)[keyof typeof AccountScope];
18
18
  */
19
19
  export interface AnomalyScore {
20
20
  /**
21
+ * @public
21
22
  * <p>The maximum score that's observed during the <code>AnomalyDateInterval</code>. </p>
22
23
  */
23
24
  MaxScore: number | undefined;
24
25
  /**
26
+ * @public
25
27
  * <p>The last observed score. </p>
26
28
  */
27
29
  CurrentScore: number | undefined;
@@ -45,25 +47,30 @@ export type AnomalyFeedbackType = (typeof AnomalyFeedbackType)[keyof typeof Anom
45
47
  */
46
48
  export interface Impact {
47
49
  /**
50
+ * @public
48
51
  * <p>The maximum dollar value that's observed for an anomaly.</p>
49
52
  */
50
53
  MaxImpact: number | undefined;
51
54
  /**
55
+ * @public
52
56
  * <p>The cumulative dollar difference between the total actual spend and total expected
53
57
  * spend. It is calculated as <code>TotalActualSpend - TotalExpectedSpend</code>.</p>
54
58
  */
55
59
  TotalImpact?: number;
56
60
  /**
61
+ * @public
57
62
  * <p>The cumulative dollar amount that was actually spent during the anomaly.</p>
58
63
  */
59
64
  TotalActualSpend?: number;
60
65
  /**
66
+ * @public
61
67
  * <p>The cumulative dollar amount that was expected to be spent during the anomaly. It is
62
68
  * calculated using advanced machine learning models to determine the typical spending
63
69
  * pattern based on historical data for a customer.</p>
64
70
  */
65
71
  TotalExpectedSpend?: number;
66
72
  /**
73
+ * @public
67
74
  * <p>The cumulative percentage difference between the total actual spend and total expected
68
75
  * spend. It is calculated as <code>(TotalImpact / TotalExpectedSpend) * 100</code>. When
69
76
  * <code>TotalExpectedSpend</code> is zero, this field is omitted. Expected spend can
@@ -79,22 +86,27 @@ export interface Impact {
79
86
  */
80
87
  export interface RootCause {
81
88
  /**
89
+ * @public
82
90
  * <p>The Amazon Web Service name that's associated with the cost anomaly. </p>
83
91
  */
84
92
  Service?: string;
85
93
  /**
94
+ * @public
86
95
  * <p>The Amazon Web Services Region that's associated with the cost anomaly. </p>
87
96
  */
88
97
  Region?: string;
89
98
  /**
99
+ * @public
90
100
  * <p>The member account value that's associated with the cost anomaly. </p>
91
101
  */
92
102
  LinkedAccount?: string;
93
103
  /**
104
+ * @public
94
105
  * <p>The <code>UsageType</code> value that's associated with the cost anomaly. </p>
95
106
  */
96
107
  UsageType?: string;
97
108
  /**
109
+ * @public
98
110
  * <p>The member account name value that's associated with the cost anomaly.</p>
99
111
  */
100
112
  LinkedAccountName?: string;
@@ -106,40 +118,49 @@ export interface RootCause {
106
118
  */
107
119
  export interface Anomaly {
108
120
  /**
121
+ * @public
109
122
  * <p>The unique identifier for the anomaly. </p>
110
123
  */
111
124
  AnomalyId: string | undefined;
112
125
  /**
126
+ * @public
113
127
  * <p>The first day the anomaly is detected. </p>
114
128
  */
115
129
  AnomalyStartDate?: string;
116
130
  /**
131
+ * @public
117
132
  * <p>The last day the anomaly is detected. </p>
118
133
  */
119
134
  AnomalyEndDate?: string;
120
135
  /**
136
+ * @public
121
137
  * <p>The dimension for the anomaly (for example, an Amazon Web Service in a service
122
138
  * monitor). </p>
123
139
  */
124
140
  DimensionValue?: string;
125
141
  /**
142
+ * @public
126
143
  * <p>The list of identified root causes for the anomaly. </p>
127
144
  */
128
145
  RootCauses?: RootCause[];
129
146
  /**
147
+ * @public
130
148
  * <p>The latest and maximum score for the anomaly. </p>
131
149
  */
132
150
  AnomalyScore: AnomalyScore | undefined;
133
151
  /**
152
+ * @public
134
153
  * <p>The dollar impact for the anomaly. </p>
135
154
  */
136
155
  Impact: Impact | undefined;
137
156
  /**
157
+ * @public
138
158
  * <p>The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.
139
159
  * </p>
140
160
  */
141
161
  MonitorArn: string | undefined;
142
162
  /**
163
+ * @public
143
164
  * <p>The feedback value. </p>
144
165
  */
145
166
  Feedback?: AnomalyFeedbackType | string;
@@ -150,10 +171,12 @@ export interface Anomaly {
150
171
  */
151
172
  export interface AnomalyDateInterval {
152
173
  /**
174
+ * @public
153
175
  * <p>The first date an anomaly was observed. </p>
154
176
  */
155
177
  StartDate: string | undefined;
156
178
  /**
179
+ * @public
157
180
  * <p>The last date an anomaly was observed. </p>
158
181
  */
159
182
  EndDate?: string;
@@ -200,14 +223,17 @@ export type MatchOption = (typeof MatchOption)[keyof typeof MatchOption];
200
223
  */
201
224
  export interface CostCategoryValues {
202
225
  /**
226
+ * @public
203
227
  * <p>The unique name of the Cost Category.</p>
204
228
  */
205
229
  Key?: string;
206
230
  /**
231
+ * @public
207
232
  * <p>The specific value of the Cost Category.</p>
208
233
  */
209
234
  Values?: string[];
210
235
  /**
236
+ * @public
211
237
  * <p>The match options that you can use to filter your results. MatchOptions is only
212
238
  * applicable for actions related to cost category. The default values for
213
239
  * <code>MatchOptions</code> is <code>EQUALS</code> and <code>CASE_SENSITIVE</code>.
@@ -266,6 +292,7 @@ export type Dimension = (typeof Dimension)[keyof typeof Dimension];
266
292
  */
267
293
  export interface DimensionValues {
268
294
  /**
295
+ * @public
269
296
  * <p>The names of the metadata types that you can use to filter and group your results. For
270
297
  * example, <code>AZ</code> returns a list of Availability Zones.</p>
271
298
  * <p>Not all dimensions are supported in each API. Refer to the documentation for each
@@ -279,11 +306,13 @@ export interface DimensionValues {
279
306
  */
280
307
  Key?: Dimension | string;
281
308
  /**
309
+ * @public
282
310
  * <p>The metadata values that you can use to filter and group your results. You can use
283
311
  * <code>GetDimensionValues</code> to find specific values.</p>
284
312
  */
285
313
  Values?: string[];
286
314
  /**
315
+ * @public
287
316
  * <p>The match options that you can use to filter your results.</p>
288
317
  * <p>
289
318
  * <code>MatchOptions</code> is only applicable for actions related to Cost Category and
@@ -307,14 +336,17 @@ export interface DimensionValues {
307
336
  */
308
337
  export interface TagValues {
309
338
  /**
339
+ * @public
310
340
  * <p>The key for the tag.</p>
311
341
  */
312
342
  Key?: string;
313
343
  /**
344
+ * @public
314
345
  * <p>The specific value of the tag.</p>
315
346
  */
316
347
  Values?: string[];
317
348
  /**
349
+ * @public
318
350
  * <p>The match options that you can use to filter your results. <code>MatchOptions</code>
319
351
  * is only applicable for actions related to Cost Category. The default values for
320
352
  * <code>MatchOptions</code> are <code>EQUALS</code> and
@@ -377,15 +409,18 @@ export type SubscriberType = (typeof SubscriberType)[keyof typeof SubscriberType
377
409
  */
378
410
  export interface Subscriber {
379
411
  /**
412
+ * @public
380
413
  * <p>The email address or SNS Amazon Resource Name (ARN). This depends on the
381
414
  * <code>Type</code>. </p>
382
415
  */
383
416
  Address?: string;
384
417
  /**
418
+ * @public
385
419
  * <p>The notification delivery channel. </p>
386
420
  */
387
421
  Type?: SubscriberType | string;
388
422
  /**
423
+ * @public
389
424
  * <p>Indicates if the subscriber accepts the notifications. </p>
390
425
  */
391
426
  Status?: SubscriberStatus | string;
@@ -406,10 +441,12 @@ export interface Subscriber {
406
441
  */
407
442
  export interface ResourceTag {
408
443
  /**
444
+ * @public
409
445
  * <p>The key that's associated with the tag. </p>
410
446
  */
411
447
  Key: string | undefined;
412
448
  /**
449
+ * @public
413
450
  * <p>The value that's associated with the tag. </p>
414
451
  */
415
452
  Value: string | undefined;
@@ -419,6 +456,7 @@ export interface ResourceTag {
419
456
  */
420
457
  export interface CreateAnomalyMonitorResponse {
421
458
  /**
459
+ * @public
422
460
  * <p>The unique identifier of your newly created cost anomaly detection monitor.</p>
423
461
  */
424
462
  MonitorArn: string | undefined;
@@ -441,6 +479,7 @@ export declare class LimitExceededException extends __BaseException {
441
479
  */
442
480
  export interface CreateAnomalySubscriptionResponse {
443
481
  /**
482
+ * @public
444
483
  * <p>The unique identifier of your newly created cost anomaly subscription. </p>
445
484
  */
446
485
  SubscriptionArn: string | undefined;
@@ -483,6 +522,7 @@ export type CostCategoryInheritedValueDimensionName = (typeof CostCategoryInheri
483
522
  */
484
523
  export interface CostCategoryInheritedValueDimension {
485
524
  /**
525
+ * @public
486
526
  * <p>The name of the dimension that's used to group costs.</p>
487
527
  * <p>If you specify <code>LINKED_ACCOUNT_NAME</code>, the cost category value is based on
488
528
  * account name. If you specify <code>TAG</code>, the cost category value is based on the
@@ -490,6 +530,7 @@ export interface CostCategoryInheritedValueDimension {
490
530
  */
491
531
  DimensionName?: CostCategoryInheritedValueDimensionName | string;
492
532
  /**
533
+ * @public
493
534
  * <p>The key to extract cost category values.</p>
494
535
  */
495
536
  DimensionKey?: string;
@@ -547,10 +588,12 @@ export type CostCategorySplitChargeRuleParameterType = (typeof CostCategorySplit
547
588
  */
548
589
  export interface CostCategorySplitChargeRuleParameter {
549
590
  /**
591
+ * @public
550
592
  * <p>The parameter type. </p>
551
593
  */
552
594
  Type: CostCategorySplitChargeRuleParameterType | string | undefined;
553
595
  /**
596
+ * @public
554
597
  * <p>The parameter values. </p>
555
598
  */
556
599
  Values: string[] | undefined;
@@ -562,17 +605,20 @@ export interface CostCategorySplitChargeRuleParameter {
562
605
  */
563
606
  export interface CostCategorySplitChargeRule {
564
607
  /**
608
+ * @public
565
609
  * <p>The Cost Category value that you want to split. That value can't be used as a source
566
610
  * or a target in other split charge rules. To indicate uncategorized costs, you can use an
567
611
  * empty string as the source.</p>
568
612
  */
569
613
  Source: string | undefined;
570
614
  /**
615
+ * @public
571
616
  * <p>The Cost Category values that you want to split costs across. These values can't be
572
617
  * used as a source in other split charge rules. </p>
573
618
  */
574
619
  Targets: string[] | undefined;
575
620
  /**
621
+ * @public
576
622
  * <p>The method that's used to define how to split your source costs across your targets. </p>
577
623
  * <p>
578
624
  * <code>Proportional</code> - Allocates charges across your targets based on the
@@ -584,6 +630,7 @@ export interface CostCategorySplitChargeRule {
584
630
  */
585
631
  Method: CostCategorySplitChargeMethod | string | undefined;
586
632
  /**
633
+ * @public
587
634
  * <p>The parameters for a split charge method. This is only required for the
588
635
  * <code>FIXED</code> method. </p>
589
636
  */
@@ -594,10 +641,12 @@ export interface CostCategorySplitChargeRule {
594
641
  */
595
642
  export interface CreateCostCategoryDefinitionResponse {
596
643
  /**
644
+ * @public
597
645
  * <p>The unique identifier for your newly created Cost Category. </p>
598
646
  */
599
647
  CostCategoryArn?: string;
600
648
  /**
649
+ * @public
601
650
  * <p>The Cost Category's effective start date. It can only be a billing start date (first day of the month).</p>
602
651
  */
603
652
  EffectiveStart?: string;
@@ -621,6 +670,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
621
670
  */
622
671
  export interface DeleteAnomalyMonitorRequest {
623
672
  /**
673
+ * @public
624
674
  * <p>The unique identifier of the cost anomaly monitor that you want to delete. </p>
625
675
  */
626
676
  MonitorArn: string | undefined;
@@ -635,6 +685,7 @@ export interface DeleteAnomalyMonitorResponse {
635
685
  */
636
686
  export interface DeleteAnomalySubscriptionRequest {
637
687
  /**
688
+ * @public
638
689
  * <p>The unique identifier of the cost anomaly subscription that you want to delete. </p>
639
690
  */
640
691
  SubscriptionArn: string | undefined;
@@ -662,6 +713,7 @@ export declare class UnknownSubscriptionException extends __BaseException {
662
713
  */
663
714
  export interface DeleteCostCategoryDefinitionRequest {
664
715
  /**
716
+ * @public
665
717
  * <p>The unique identifier for your Cost Category. </p>
666
718
  */
667
719
  CostCategoryArn: string | undefined;
@@ -671,10 +723,12 @@ export interface DeleteCostCategoryDefinitionRequest {
671
723
  */
672
724
  export interface DeleteCostCategoryDefinitionResponse {
673
725
  /**
726
+ * @public
674
727
  * <p>The unique identifier for your Cost Category. </p>
675
728
  */
676
729
  CostCategoryArn?: string;
677
730
  /**
731
+ * @public
678
732
  * <p>The effective end date of the Cost Category as a result of deleting it. No costs after
679
733
  * this date is categorized by the deleted Cost Category. </p>
680
734
  */
@@ -699,10 +753,12 @@ export declare class ResourceNotFoundException extends __BaseException {
699
753
  */
700
754
  export interface DescribeCostCategoryDefinitionRequest {
701
755
  /**
756
+ * @public
702
757
  * <p>The unique identifier for your Cost Category. </p>
703
758
  */
704
759
  CostCategoryArn: string | undefined;
705
760
  /**
761
+ * @public
706
762
  * <p>The date when the Cost Category was effective. </p>
707
763
  */
708
764
  EffectiveOn?: string;
@@ -737,10 +793,12 @@ export type CostCategoryStatus = (typeof CostCategoryStatus)[keyof typeof CostCa
737
793
  */
738
794
  export interface CostCategoryProcessingStatus {
739
795
  /**
796
+ * @public
740
797
  * <p>The Cost Management product name of the applied status. </p>
741
798
  */
742
799
  Component?: CostCategoryStatusComponent | string;
743
800
  /**
801
+ * @public
744
802
  * <p>The process status for a specific cost category. </p>
745
803
  */
746
804
  Status?: CostCategoryStatus | string;
@@ -767,14 +825,17 @@ export type NumericOperator = (typeof NumericOperator)[keyof typeof NumericOpera
767
825
  */
768
826
  export interface TotalImpactFilter {
769
827
  /**
828
+ * @public
770
829
  * <p>The comparing value that's used in the filter. </p>
771
830
  */
772
831
  NumericOperator: NumericOperator | string | undefined;
773
832
  /**
833
+ * @public
774
834
  * <p>The lower bound dollar value that's used in the filter. </p>
775
835
  */
776
836
  StartValue: number | undefined;
777
837
  /**
838
+ * @public
778
839
  * <p>The upper bound dollar value that's used in the filter. </p>
779
840
  */
780
841
  EndValue?: number;
@@ -784,31 +845,37 @@ export interface TotalImpactFilter {
784
845
  */
785
846
  export interface GetAnomaliesRequest {
786
847
  /**
848
+ * @public
787
849
  * <p>Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon
788
850
  * Resource Name (ARN). </p>
789
851
  */
790
852
  MonitorArn?: string;
791
853
  /**
854
+ * @public
792
855
  * <p>Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object
793
856
  * will have an <code>AnomalyEndDate</code> in the specified time range. </p>
794
857
  */
795
858
  DateInterval: AnomalyDateInterval | undefined;
796
859
  /**
860
+ * @public
797
861
  * <p>Filters anomaly results by the feedback field on the anomaly object. </p>
798
862
  */
799
863
  Feedback?: AnomalyFeedbackType | string;
800
864
  /**
865
+ * @public
801
866
  * <p>Filters anomaly results by the total impact field on the anomaly object. For example, you
802
867
  * can filter anomalies <code>GREATER_THAN 200.00</code> to retrieve anomalies, with an estimated
803
868
  * dollar impact greater than 200. </p>
804
869
  */
805
870
  TotalImpact?: TotalImpactFilter;
806
871
  /**
872
+ * @public
807
873
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
808
874
  * the response from a previous call has more results than the maximum page size. </p>
809
875
  */
810
876
  NextPageToken?: string;
811
877
  /**
878
+ * @public
812
879
  * <p>The number of entries a paginated response contains. </p>
813
880
  */
814
881
  MaxResults?: number;
@@ -818,10 +885,12 @@ export interface GetAnomaliesRequest {
818
885
  */
819
886
  export interface GetAnomaliesResponse {
820
887
  /**
888
+ * @public
821
889
  * <p>A list of cost anomalies. </p>
822
890
  */
823
891
  Anomalies: Anomaly[] | undefined;
824
892
  /**
893
+ * @public
825
894
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
826
895
  * the response from a previous call has more results than the maximum page size. </p>
827
896
  */
@@ -845,15 +914,18 @@ export declare class InvalidNextTokenException extends __BaseException {
845
914
  */
846
915
  export interface GetAnomalyMonitorsRequest {
847
916
  /**
917
+ * @public
848
918
  * <p>A list of cost anomaly monitor ARNs. </p>
849
919
  */
850
920
  MonitorArnList?: string[];
851
921
  /**
922
+ * @public
852
923
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
853
924
  * the response from a previous call has more results than the maximum page size. </p>
854
925
  */
855
926
  NextPageToken?: string;
856
927
  /**
928
+ * @public
857
929
  * <p>The number of entries that a paginated response contains. </p>
858
930
  */
859
931
  MaxResults?: number;
@@ -863,19 +935,23 @@ export interface GetAnomalyMonitorsRequest {
863
935
  */
864
936
  export interface GetAnomalySubscriptionsRequest {
865
937
  /**
938
+ * @public
866
939
  * <p>A list of cost anomaly subscription ARNs. </p>
867
940
  */
868
941
  SubscriptionArnList?: string[];
869
942
  /**
943
+ * @public
870
944
  * <p>Cost anomaly monitor ARNs. </p>
871
945
  */
872
946
  MonitorArn?: string;
873
947
  /**
948
+ * @public
874
949
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
875
950
  * the response from a previous call has more results than the maximum page size. </p>
876
951
  */
877
952
  NextPageToken?: string;
878
953
  /**
954
+ * @public
879
955
  * <p>The number of entries a paginated response contains. </p>
880
956
  */
881
957
  MaxResults?: number;
@@ -939,10 +1015,12 @@ export type GroupDefinitionType = (typeof GroupDefinitionType)[keyof typeof Grou
939
1015
  */
940
1016
  export interface GroupDefinition {
941
1017
  /**
1018
+ * @public
942
1019
  * <p>The string that represents the type of group.</p>
943
1020
  */
944
1021
  Type?: GroupDefinitionType | string;
945
1022
  /**
1023
+ * @public
946
1024
  * <p>The string that represents a key for a specified group.</p>
947
1025
  */
948
1026
  Key?: string;
@@ -953,6 +1031,7 @@ export interface GroupDefinition {
953
1031
  */
954
1032
  export interface DateInterval {
955
1033
  /**
1034
+ * @public
956
1035
  * <p>The beginning of the time period. The start date is inclusive. For example, if
957
1036
  * <code>start</code> is <code>2017-01-01</code>, Amazon Web Services retrieves cost and
958
1037
  * usage data starting at <code>2017-01-01</code> up to the end date. The start date must
@@ -960,6 +1039,7 @@ export interface DateInterval {
960
1039
  */
961
1040
  Start: string | undefined;
962
1041
  /**
1042
+ * @public
963
1043
  * <p>The end of the time period. The end date is exclusive. For example, if
964
1044
  * <code>end</code> is <code>2017-05-01</code>, Amazon Web Services retrieves cost and
965
1045
  * usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>
@@ -973,10 +1053,12 @@ export interface DateInterval {
973
1053
  */
974
1054
  export interface DimensionValuesWithAttributes {
975
1055
  /**
1056
+ * @public
976
1057
  * <p>The value of a dimension with a specific attribute.</p>
977
1058
  */
978
1059
  Value?: string;
979
1060
  /**
1061
+ * @public
980
1062
  * <p>The attribute that applies to a specific <code>Dimension</code>.</p>
981
1063
  */
982
1064
  Attributes?: Record<string, string>;
@@ -987,10 +1069,12 @@ export interface DimensionValuesWithAttributes {
987
1069
  */
988
1070
  export interface MetricValue {
989
1071
  /**
1072
+ * @public
990
1073
  * <p>The actual number that represents the metric.</p>
991
1074
  */
992
1075
  Amount?: string;
993
1076
  /**
1077
+ * @public
994
1078
  * <p>The unit that the metric is given in.</p>
995
1079
  */
996
1080
  Unit?: string;
@@ -1001,10 +1085,12 @@ export interface MetricValue {
1001
1085
  */
1002
1086
  export interface Group {
1003
1087
  /**
1088
+ * @public
1004
1089
  * <p>The keys that are included in this group.</p>
1005
1090
  */
1006
1091
  Keys?: string[];
1007
1092
  /**
1093
+ * @public
1008
1094
  * <p>The metrics that are included in this group.</p>
1009
1095
  */
1010
1096
  Metrics?: Record<string, MetricValue>;
@@ -1015,18 +1101,22 @@ export interface Group {
1015
1101
  */
1016
1102
  export interface ResultByTime {
1017
1103
  /**
1104
+ * @public
1018
1105
  * <p>The time period that the result covers.</p>
1019
1106
  */
1020
1107
  TimePeriod?: DateInterval;
1021
1108
  /**
1109
+ * @public
1022
1110
  * <p>The total amount of cost or usage accrued during the time period.</p>
1023
1111
  */
1024
1112
  Total?: Record<string, MetricValue>;
1025
1113
  /**
1114
+ * @public
1026
1115
  * <p>The groups that this time period includes.</p>
1027
1116
  */
1028
1117
  Groups?: Group[];
1029
1118
  /**
1119
+ * @public
1030
1120
  * <p>Determines whether the result is estimated.</p>
1031
1121
  */
1032
1122
  Estimated?: boolean;
@@ -1036,20 +1126,24 @@ export interface ResultByTime {
1036
1126
  */
1037
1127
  export interface GetCostAndUsageResponse {
1038
1128
  /**
1129
+ * @public
1039
1130
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
1040
1131
  * when the response from a previous call has more results than the maximum page size.</p>
1041
1132
  */
1042
1133
  NextPageToken?: string;
1043
1134
  /**
1135
+ * @public
1044
1136
  * <p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code>
1045
1137
  * parameters in the request.</p>
1046
1138
  */
1047
1139
  GroupDefinitions?: GroupDefinition[];
1048
1140
  /**
1141
+ * @public
1049
1142
  * <p>The time period that's covered by the results in the response.</p>
1050
1143
  */
1051
1144
  ResultsByTime?: ResultByTime[];
1052
1145
  /**
1146
+ * @public
1053
1147
  * <p>The attributes that apply to a specific dimension value. For example, if the value is a
1054
1148
  * linked account, the attribute is that account name.</p>
1055
1149
  */
@@ -1074,20 +1168,24 @@ export declare class RequestChangedException extends __BaseException {
1074
1168
  */
1075
1169
  export interface GetCostAndUsageWithResourcesResponse {
1076
1170
  /**
1171
+ * @public
1077
1172
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
1078
1173
  * when the response from a previous call has more results than the maximum page size.</p>
1079
1174
  */
1080
1175
  NextPageToken?: string;
1081
1176
  /**
1177
+ * @public
1082
1178
  * <p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code>
1083
1179
  * parameters in the request.</p>
1084
1180
  */
1085
1181
  GroupDefinitions?: GroupDefinition[];
1086
1182
  /**
1183
+ * @public
1087
1184
  * <p>The time period that's covered by the results in the response.</p>
1088
1185
  */
1089
1186
  ResultsByTime?: ResultByTime[];
1090
1187
  /**
1188
+ * @public
1091
1189
  * <p>The attributes that apply to a specific dimension value. For example, if the value is a
1092
1190
  * linked account, the attribute is that account name.</p>
1093
1191
  */
@@ -1111,10 +1209,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
1111
1209
  */
1112
1210
  export interface SortDefinition {
1113
1211
  /**
1212
+ * @public
1114
1213
  * <p>The key that's used to sort the data.</p>
1115
1214
  */
1116
1215
  Key: string | undefined;
1117
1216
  /**
1217
+ * @public
1118
1218
  * <p>The order that's used to sort the data.</p>
1119
1219
  */
1120
1220
  SortOrder?: SortOrder | string;
@@ -1124,25 +1224,30 @@ export interface SortDefinition {
1124
1224
  */
1125
1225
  export interface GetCostCategoriesResponse {
1126
1226
  /**
1227
+ * @public
1127
1228
  * <p>If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of
1128
1229
  * objects, provide the marker from the prior call in your next request.</p>
1129
1230
  */
1130
1231
  NextPageToken?: string;
1131
1232
  /**
1233
+ * @public
1132
1234
  * <p>The names of the Cost Categories.</p>
1133
1235
  */
1134
1236
  CostCategoryNames?: string[];
1135
1237
  /**
1238
+ * @public
1136
1239
  * <p>The Cost Category values.</p>
1137
1240
  * <p>If the <code>CostCategoryName</code> key isn't specified in the request, the
1138
1241
  * <code>CostCategoryValues</code> fields aren't returned. </p>
1139
1242
  */
1140
1243
  CostCategoryValues?: string[];
1141
1244
  /**
1245
+ * @public
1142
1246
  * <p>The number of objects that are returned.</p>
1143
1247
  */
1144
1248
  ReturnSize: number | undefined;
1145
1249
  /**
1250
+ * @public
1146
1251
  * <p>The total number of objects.</p>
1147
1252
  */
1148
1253
  TotalSize: number | undefined;
@@ -1170,18 +1275,22 @@ export type Metric = (typeof Metric)[keyof typeof Metric];
1170
1275
  */
1171
1276
  export interface ForecastResult {
1172
1277
  /**
1278
+ * @public
1173
1279
  * <p>The period of time that the forecast covers.</p>
1174
1280
  */
1175
1281
  TimePeriod?: DateInterval;
1176
1282
  /**
1283
+ * @public
1177
1284
  * <p>The mean value of the forecast.</p>
1178
1285
  */
1179
1286
  MeanValue?: string;
1180
1287
  /**
1288
+ * @public
1181
1289
  * <p>The lower limit for the prediction interval. </p>
1182
1290
  */
1183
1291
  PredictionIntervalLowerBound?: string;
1184
1292
  /**
1293
+ * @public
1185
1294
  * <p>The upper limit for the prediction interval. </p>
1186
1295
  */
1187
1296
  PredictionIntervalUpperBound?: string;
@@ -1191,10 +1300,12 @@ export interface ForecastResult {
1191
1300
  */
1192
1301
  export interface GetCostForecastResponse {
1193
1302
  /**
1303
+ * @public
1194
1304
  * <p>How much you are forecasted to spend over the forecast period, in <code>USD</code>.</p>
1195
1305
  */
1196
1306
  Total?: MetricValue;
1197
1307
  /**
1308
+ * @public
1198
1309
  * <p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a list
1199
1310
  * of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>
1200
1311
  */
@@ -1218,6 +1329,7 @@ export type Context = (typeof Context)[keyof typeof Context];
1218
1329
  */
1219
1330
  export interface GetDimensionValuesResponse {
1220
1331
  /**
1332
+ * @public
1221
1333
  * <p>The filters that you used to filter your request. Some dimensions are available only
1222
1334
  * for a specific context.</p>
1223
1335
  * <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following
@@ -1351,14 +1463,17 @@ export interface GetDimensionValuesResponse {
1351
1463
  */
1352
1464
  DimensionValues: DimensionValuesWithAttributes[] | undefined;
1353
1465
  /**
1466
+ * @public
1354
1467
  * <p>The number of results that Amazon Web Services returned at one time.</p>
1355
1468
  */
1356
1469
  ReturnSize: number | undefined;
1357
1470
  /**
1471
+ * @public
1358
1472
  * <p>The total number of search results.</p>
1359
1473
  */
1360
1474
  TotalSize: number | undefined;
1361
1475
  /**
1476
+ * @public
1362
1477
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
1363
1478
  * when the response from a previous call has more results than the maximum page size.</p>
1364
1479
  */
@@ -1370,6 +1485,7 @@ export interface GetDimensionValuesResponse {
1370
1485
  */
1371
1486
  export interface CoverageCost {
1372
1487
  /**
1488
+ * @public
1373
1489
  * <p>How much an On-Demand Instance costs.</p>
1374
1490
  */
1375
1491
  OnDemandCost?: string;
@@ -1380,18 +1496,22 @@ export interface CoverageCost {
1380
1496
  */
1381
1497
  export interface CoverageHours {
1382
1498
  /**
1499
+ * @public
1383
1500
  * <p>The number of instance running hours that On-Demand Instances covered.</p>
1384
1501
  */
1385
1502
  OnDemandHours?: string;
1386
1503
  /**
1504
+ * @public
1387
1505
  * <p>The number of instance running hours that reservations covered.</p>
1388
1506
  */
1389
1507
  ReservedHours?: string;
1390
1508
  /**
1509
+ * @public
1391
1510
  * <p>The total instance usage, in hours.</p>
1392
1511
  */
1393
1512
  TotalRunningHours?: string;
1394
1513
  /**
1514
+ * @public
1395
1515
  * <p>The percentage of instance hours that a reservation covered.</p>
1396
1516
  */
1397
1517
  CoverageHoursPercentage?: string;
@@ -1411,19 +1531,23 @@ export interface CoverageHours {
1411
1531
  */
1412
1532
  export interface CoverageNormalizedUnits {
1413
1533
  /**
1534
+ * @public
1414
1535
  * <p>The number of normalized units that are covered by On-Demand Instances instead of a
1415
1536
  * reservation.</p>
1416
1537
  */
1417
1538
  OnDemandNormalizedUnits?: string;
1418
1539
  /**
1540
+ * @public
1419
1541
  * <p>The number of normalized units that a reservation covers.</p>
1420
1542
  */
1421
1543
  ReservedNormalizedUnits?: string;
1422
1544
  /**
1545
+ * @public
1423
1546
  * <p>The total number of normalized units that you used.</p>
1424
1547
  */
1425
1548
  TotalRunningNormalizedUnits?: string;
1426
1549
  /**
1550
+ * @public
1427
1551
  * <p>The percentage of your used instance normalized units that a reservation
1428
1552
  * covers.</p>
1429
1553
  */
@@ -1435,14 +1559,17 @@ export interface CoverageNormalizedUnits {
1435
1559
  */
1436
1560
  export interface Coverage {
1437
1561
  /**
1562
+ * @public
1438
1563
  * <p>The amount of instance usage that the reservation covered, in hours.</p>
1439
1564
  */
1440
1565
  CoverageHours?: CoverageHours;
1441
1566
  /**
1567
+ * @public
1442
1568
  * <p>The amount of instance usage that the reservation covered, in normalized units.</p>
1443
1569
  */
1444
1570
  CoverageNormalizedUnits?: CoverageNormalizedUnits;
1445
1571
  /**
1572
+ * @public
1446
1573
  * <p>The amount of cost that the reservation covered.</p>
1447
1574
  */
1448
1575
  CoverageCost?: CoverageCost;
@@ -1453,10 +1580,12 @@ export interface Coverage {
1453
1580
  */
1454
1581
  export interface ReservationCoverageGroup {
1455
1582
  /**
1583
+ * @public
1456
1584
  * <p>The attributes for this group of reservations.</p>
1457
1585
  */
1458
1586
  Attributes?: Record<string, string>;
1459
1587
  /**
1588
+ * @public
1460
1589
  * <p>How much instance usage this group of reservations covered.</p>
1461
1590
  */
1462
1591
  Coverage?: Coverage;
@@ -1467,14 +1596,17 @@ export interface ReservationCoverageGroup {
1467
1596
  */
1468
1597
  export interface CoverageByTime {
1469
1598
  /**
1599
+ * @public
1470
1600
  * <p>The period that this coverage was used over.</p>
1471
1601
  */
1472
1602
  TimePeriod?: DateInterval;
1473
1603
  /**
1604
+ * @public
1474
1605
  * <p>The groups of instances that the reservation covered.</p>
1475
1606
  */
1476
1607
  Groups?: ReservationCoverageGroup[];
1477
1608
  /**
1609
+ * @public
1478
1610
  * <p>The total reservation coverage, in hours.</p>
1479
1611
  */
1480
1612
  Total?: Coverage;
@@ -1484,14 +1616,17 @@ export interface CoverageByTime {
1484
1616
  */
1485
1617
  export interface GetReservationCoverageResponse {
1486
1618
  /**
1619
+ * @public
1487
1620
  * <p>The amount of time that your reservations covered.</p>
1488
1621
  */
1489
1622
  CoveragesByTime: CoverageByTime[] | undefined;
1490
1623
  /**
1624
+ * @public
1491
1625
  * <p>The total amount of instance usage that a reservation covered.</p>
1492
1626
  */
1493
1627
  Total?: Coverage;
1494
1628
  /**
1629
+ * @public
1495
1630
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
1496
1631
  * when the response from a previous call has more results than the maximum page size.</p>
1497
1632
  */
@@ -1545,6 +1680,7 @@ export type OfferingClass = (typeof OfferingClass)[keyof typeof OfferingClass];
1545
1680
  */
1546
1681
  export interface EC2Specification {
1547
1682
  /**
1683
+ * @public
1548
1684
  * <p>Indicates whether you want a recommendation for standard or convertible
1549
1685
  * reservations.</p>
1550
1686
  */
@@ -1556,6 +1692,7 @@ export interface EC2Specification {
1556
1692
  */
1557
1693
  export interface ServiceSpecification {
1558
1694
  /**
1695
+ * @public
1559
1696
  * <p>The Amazon EC2 hardware specifications that you want Amazon Web Services to provide
1560
1697
  * recommendations for.</p>
1561
1698
  */
@@ -1579,10 +1716,12 @@ export type TermInYears = (typeof TermInYears)[keyof typeof TermInYears];
1579
1716
  */
1580
1717
  export interface ReservationPurchaseRecommendationMetadata {
1581
1718
  /**
1719
+ * @public
1582
1720
  * <p>The ID for this specific recommendation.</p>
1583
1721
  */
1584
1722
  RecommendationId?: string;
1585
1723
  /**
1724
+ * @public
1586
1725
  * <p>The timestamp for when Amazon Web Services made this recommendation.</p>
1587
1726
  */
1588
1727
  GenerationTimestamp?: string;
@@ -1594,35 +1733,43 @@ export interface ReservationPurchaseRecommendationMetadata {
1594
1733
  */
1595
1734
  export interface EC2InstanceDetails {
1596
1735
  /**
1736
+ * @public
1597
1737
  * <p>The instance family of the recommended reservation.</p>
1598
1738
  */
1599
1739
  Family?: string;
1600
1740
  /**
1741
+ * @public
1601
1742
  * <p>The type of instance that Amazon Web Services recommends.</p>
1602
1743
  */
1603
1744
  InstanceType?: string;
1604
1745
  /**
1746
+ * @public
1605
1747
  * <p>The Amazon Web Services Region of the recommended reservation.</p>
1606
1748
  */
1607
1749
  Region?: string;
1608
1750
  /**
1751
+ * @public
1609
1752
  * <p>The Availability Zone of the recommended reservation.</p>
1610
1753
  */
1611
1754
  AvailabilityZone?: string;
1612
1755
  /**
1756
+ * @public
1613
1757
  * <p>The platform of the recommended reservation. The platform is the specific combination
1614
1758
  * of operating system, license model, and software on an instance.</p>
1615
1759
  */
1616
1760
  Platform?: string;
1617
1761
  /**
1762
+ * @public
1618
1763
  * <p>Determines whether the recommended reservation is dedicated or shared.</p>
1619
1764
  */
1620
1765
  Tenancy?: string;
1621
1766
  /**
1767
+ * @public
1622
1768
  * <p>Determines whether the recommendation is for a current-generation instance. </p>
1623
1769
  */
1624
1770
  CurrentGeneration?: boolean;
1625
1771
  /**
1772
+ * @public
1626
1773
  * <p>Determines whether the recommended reservation is size flexible.</p>
1627
1774
  */
1628
1775
  SizeFlexEligible?: boolean;
@@ -1634,26 +1781,32 @@ export interface EC2InstanceDetails {
1634
1781
  */
1635
1782
  export interface ElastiCacheInstanceDetails {
1636
1783
  /**
1784
+ * @public
1637
1785
  * <p>The instance family of the recommended reservation.</p>
1638
1786
  */
1639
1787
  Family?: string;
1640
1788
  /**
1789
+ * @public
1641
1790
  * <p>The type of node that Amazon Web Services recommends.</p>
1642
1791
  */
1643
1792
  NodeType?: string;
1644
1793
  /**
1794
+ * @public
1645
1795
  * <p>The Amazon Web Services Region of the recommended reservation.</p>
1646
1796
  */
1647
1797
  Region?: string;
1648
1798
  /**
1799
+ * @public
1649
1800
  * <p>The description of the recommended reservation.</p>
1650
1801
  */
1651
1802
  ProductDescription?: string;
1652
1803
  /**
1804
+ * @public
1653
1805
  * <p>Determines whether the recommendation is for a current generation instance.</p>
1654
1806
  */
1655
1807
  CurrentGeneration?: boolean;
1656
1808
  /**
1809
+ * @public
1657
1810
  * <p>Determines whether the recommended reservation is size flexible.</p>
1658
1811
  */
1659
1812
  SizeFlexEligible?: boolean;
@@ -1665,22 +1818,27 @@ export interface ElastiCacheInstanceDetails {
1665
1818
  */
1666
1819
  export interface ESInstanceDetails {
1667
1820
  /**
1821
+ * @public
1668
1822
  * <p>The class of instance that Amazon Web Services recommends.</p>
1669
1823
  */
1670
1824
  InstanceClass?: string;
1671
1825
  /**
1826
+ * @public
1672
1827
  * <p>The size of instance that Amazon Web Services recommends.</p>
1673
1828
  */
1674
1829
  InstanceSize?: string;
1675
1830
  /**
1831
+ * @public
1676
1832
  * <p>The Amazon Web Services Region of the recommended reservation.</p>
1677
1833
  */
1678
1834
  Region?: string;
1679
1835
  /**
1836
+ * @public
1680
1837
  * <p>Determines whether the recommendation is for a current-generation instance.</p>
1681
1838
  */
1682
1839
  CurrentGeneration?: boolean;
1683
1840
  /**
1841
+ * @public
1684
1842
  * <p>Determines whether the recommended reservation is size flexible.</p>
1685
1843
  */
1686
1844
  SizeFlexEligible?: boolean;
@@ -1692,39 +1850,48 @@ export interface ESInstanceDetails {
1692
1850
  */
1693
1851
  export interface RDSInstanceDetails {
1694
1852
  /**
1853
+ * @public
1695
1854
  * <p>The instance family of the recommended reservation.</p>
1696
1855
  */
1697
1856
  Family?: string;
1698
1857
  /**
1858
+ * @public
1699
1859
  * <p>The type of instance that Amazon Web Services recommends.</p>
1700
1860
  */
1701
1861
  InstanceType?: string;
1702
1862
  /**
1863
+ * @public
1703
1864
  * <p>The Amazon Web Services Region of the recommended reservation.</p>
1704
1865
  */
1705
1866
  Region?: string;
1706
1867
  /**
1868
+ * @public
1707
1869
  * <p>The database engine that the recommended reservation supports.</p>
1708
1870
  */
1709
1871
  DatabaseEngine?: string;
1710
1872
  /**
1873
+ * @public
1711
1874
  * <p>The database edition that the recommended reservation supports.</p>
1712
1875
  */
1713
1876
  DatabaseEdition?: string;
1714
1877
  /**
1878
+ * @public
1715
1879
  * <p>Determines whether the recommendation is for a reservation in a single Availability
1716
1880
  * Zone or a reservation with a backup in a second Availability Zone.</p>
1717
1881
  */
1718
1882
  DeploymentOption?: string;
1719
1883
  /**
1884
+ * @public
1720
1885
  * <p>The license model that the recommended reservation supports.</p>
1721
1886
  */
1722
1887
  LicenseModel?: string;
1723
1888
  /**
1889
+ * @public
1724
1890
  * <p>Determines whether the recommendation is for a current-generation instance. </p>
1725
1891
  */
1726
1892
  CurrentGeneration?: boolean;
1727
1893
  /**
1894
+ * @public
1728
1895
  * <p>Determines whether the recommended reservation is size flexible.</p>
1729
1896
  */
1730
1897
  SizeFlexEligible?: boolean;
@@ -1736,22 +1903,27 @@ export interface RDSInstanceDetails {
1736
1903
  */
1737
1904
  export interface RedshiftInstanceDetails {
1738
1905
  /**
1906
+ * @public
1739
1907
  * <p>The instance family of the recommended reservation.</p>
1740
1908
  */
1741
1909
  Family?: string;
1742
1910
  /**
1911
+ * @public
1743
1912
  * <p>The type of node that Amazon Web Services recommends.</p>
1744
1913
  */
1745
1914
  NodeType?: string;
1746
1915
  /**
1916
+ * @public
1747
1917
  * <p>The Amazon Web Services Region of the recommended reservation.</p>
1748
1918
  */
1749
1919
  Region?: string;
1750
1920
  /**
1921
+ * @public
1751
1922
  * <p>Determines whether the recommendation is for a current-generation instance.</p>
1752
1923
  */
1753
1924
  CurrentGeneration?: boolean;
1754
1925
  /**
1926
+ * @public
1755
1927
  * <p>Determines whether the recommended reservation is size flexible.</p>
1756
1928
  */
1757
1929
  SizeFlexEligible?: boolean;
@@ -1763,23 +1935,28 @@ export interface RedshiftInstanceDetails {
1763
1935
  */
1764
1936
  export interface InstanceDetails {
1765
1937
  /**
1938
+ * @public
1766
1939
  * <p>The Amazon EC2 instances that Amazon Web Services recommends that you purchase.</p>
1767
1940
  */
1768
1941
  EC2InstanceDetails?: EC2InstanceDetails;
1769
1942
  /**
1943
+ * @public
1770
1944
  * <p>The Amazon RDS instances that Amazon Web Services recommends that you purchase.</p>
1771
1945
  */
1772
1946
  RDSInstanceDetails?: RDSInstanceDetails;
1773
1947
  /**
1948
+ * @public
1774
1949
  * <p>The Amazon Redshift instances that Amazon Web Services recommends that you
1775
1950
  * purchase.</p>
1776
1951
  */
1777
1952
  RedshiftInstanceDetails?: RedshiftInstanceDetails;
1778
1953
  /**
1954
+ * @public
1779
1955
  * <p>The ElastiCache instances that Amazon Web Services recommends that you purchase.</p>
1780
1956
  */
1781
1957
  ElastiCacheInstanceDetails?: ElastiCacheInstanceDetails;
1782
1958
  /**
1959
+ * @public
1783
1960
  * <p>The Amazon OpenSearch Service instances that Amazon Web Services recommends that you
1784
1961
  * purchase.</p>
1785
1962
  */
@@ -1791,99 +1968,118 @@ export interface InstanceDetails {
1791
1968
  */
1792
1969
  export interface ReservationPurchaseRecommendationDetail {
1793
1970
  /**
1971
+ * @public
1794
1972
  * <p>The account that this Reserved Instance (RI) recommendation is for.</p>
1795
1973
  */
1796
1974
  AccountId?: string;
1797
1975
  /**
1976
+ * @public
1798
1977
  * <p>Details about the instances that Amazon Web Services recommends that you
1799
1978
  * purchase.</p>
1800
1979
  */
1801
1980
  InstanceDetails?: InstanceDetails;
1802
1981
  /**
1982
+ * @public
1803
1983
  * <p>The number of instances that Amazon Web Services recommends that you purchase.</p>
1804
1984
  */
1805
1985
  RecommendedNumberOfInstancesToPurchase?: string;
1806
1986
  /**
1987
+ * @public
1807
1988
  * <p>The number of normalized units that Amazon Web Services recommends that you
1808
1989
  * purchase.</p>
1809
1990
  */
1810
1991
  RecommendedNormalizedUnitsToPurchase?: string;
1811
1992
  /**
1993
+ * @public
1812
1994
  * <p>The minimum number of instances that you used in an hour during the historical period.
1813
1995
  * Amazon Web Services uses this to calculate your recommended reservation
1814
1996
  * purchases.</p>
1815
1997
  */
1816
1998
  MinimumNumberOfInstancesUsedPerHour?: string;
1817
1999
  /**
2000
+ * @public
1818
2001
  * <p>The minimum number of normalized units that you used in an hour during the historical
1819
2002
  * period. Amazon Web Services uses this to calculate your recommended reservation
1820
2003
  * purchases.</p>
1821
2004
  */
1822
2005
  MinimumNormalizedUnitsUsedPerHour?: string;
1823
2006
  /**
2007
+ * @public
1824
2008
  * <p>The maximum number of instances that you used in an hour during the historical period.
1825
2009
  * Amazon Web Services uses this to calculate your recommended reservation
1826
2010
  * purchases.</p>
1827
2011
  */
1828
2012
  MaximumNumberOfInstancesUsedPerHour?: string;
1829
2013
  /**
2014
+ * @public
1830
2015
  * <p>The maximum number of normalized units that you used in an hour during the historical
1831
2016
  * period. Amazon Web Services uses this to calculate your recommended reservation
1832
2017
  * purchases.</p>
1833
2018
  */
1834
2019
  MaximumNormalizedUnitsUsedPerHour?: string;
1835
2020
  /**
2021
+ * @public
1836
2022
  * <p>The average number of instances that you used in an hour during the historical period.
1837
2023
  * Amazon Web Services uses this to calculate your recommended reservation
1838
2024
  * purchases.</p>
1839
2025
  */
1840
2026
  AverageNumberOfInstancesUsedPerHour?: string;
1841
2027
  /**
2028
+ * @public
1842
2029
  * <p>The average number of normalized units that you used in an hour during the historical
1843
2030
  * period. Amazon Web Services uses this to calculate your recommended reservation
1844
2031
  * purchases.</p>
1845
2032
  */
1846
2033
  AverageNormalizedUnitsUsedPerHour?: string;
1847
2034
  /**
2035
+ * @public
1848
2036
  * <p>The average utilization of your instances. Amazon Web Services uses this to calculate
1849
2037
  * your recommended reservation purchases.</p>
1850
2038
  */
1851
2039
  AverageUtilization?: string;
1852
2040
  /**
2041
+ * @public
1853
2042
  * <p>How long Amazon Web Services estimates that it takes for this instance to start saving
1854
2043
  * you money, in months.</p>
1855
2044
  */
1856
2045
  EstimatedBreakEvenInMonths?: string;
1857
2046
  /**
2047
+ * @public
1858
2048
  * <p>The currency code that Amazon Web Services used to calculate the costs for this
1859
2049
  * instance.</p>
1860
2050
  */
1861
2051
  CurrencyCode?: string;
1862
2052
  /**
2053
+ * @public
1863
2054
  * <p>How much Amazon Web Services estimates that this specific recommendation might save you
1864
2055
  * in a month.</p>
1865
2056
  */
1866
2057
  EstimatedMonthlySavingsAmount?: string;
1867
2058
  /**
2059
+ * @public
1868
2060
  * <p>How much Amazon Web Services estimates that this specific recommendation might save you
1869
2061
  * in a month, as a percentage of your overall costs.</p>
1870
2062
  */
1871
2063
  EstimatedMonthlySavingsPercentage?: string;
1872
2064
  /**
2065
+ * @public
1873
2066
  * <p>How much Amazon Web Services estimates that you spend on On-Demand Instances in a
1874
2067
  * month.</p>
1875
2068
  */
1876
2069
  EstimatedMonthlyOnDemandCost?: string;
1877
2070
  /**
2071
+ * @public
1878
2072
  * <p>How much Amazon Web Services estimates that you might spend for all usage during the
1879
2073
  * specified historical period if you had a reservation.</p>
1880
2074
  */
1881
2075
  EstimatedReservationCostForLookbackPeriod?: string;
1882
2076
  /**
2077
+ * @public
1883
2078
  * <p>How much purchasing this instance costs you upfront.</p>
1884
2079
  */
1885
2080
  UpfrontCost?: string;
1886
2081
  /**
2082
+ * @public
1887
2083
  * <p>How much purchasing this instance costs you on a monthly basis.</p>
1888
2084
  */
1889
2085
  RecurringStandardMonthlyCost?: string;
@@ -1896,16 +2092,19 @@ export interface ReservationPurchaseRecommendationDetail {
1896
2092
  */
1897
2093
  export interface ReservationPurchaseRecommendationSummary {
1898
2094
  /**
2095
+ * @public
1899
2096
  * <p>The total amount that Amazon Web Services estimates that this recommendation could save
1900
2097
  * you in a month.</p>
1901
2098
  */
1902
2099
  TotalEstimatedMonthlySavingsAmount?: string;
1903
2100
  /**
2101
+ * @public
1904
2102
  * <p>The total amount that Amazon Web Services estimates that this recommendation could save
1905
2103
  * you in a month, as a percentage of your costs.</p>
1906
2104
  */
1907
2105
  TotalEstimatedMonthlySavingsPercentage?: string;
1908
2106
  /**
2107
+ * @public
1909
2108
  * <p>The currency code used for this recommendation.</p>
1910
2109
  */
1911
2110
  CurrencyCode?: string;
@@ -1916,34 +2115,41 @@ export interface ReservationPurchaseRecommendationSummary {
1916
2115
  */
1917
2116
  export interface ReservationPurchaseRecommendation {
1918
2117
  /**
2118
+ * @public
1919
2119
  * <p>The account scope that Amazon Web Services recommends that you purchase this instance
1920
2120
  * for. For example, you can purchase this reservation for an entire organization in
1921
2121
  * Amazon Web Services Organizations.</p>
1922
2122
  */
1923
2123
  AccountScope?: AccountScope | string;
1924
2124
  /**
2125
+ * @public
1925
2126
  * <p>How many days of previous usage that Amazon Web Services considers when making this
1926
2127
  * recommendation.</p>
1927
2128
  */
1928
2129
  LookbackPeriodInDays?: LookbackPeriodInDays | string;
1929
2130
  /**
2131
+ * @public
1930
2132
  * <p>The term of the reservation that you want recommendations for, in years.</p>
1931
2133
  */
1932
2134
  TermInYears?: TermInYears | string;
1933
2135
  /**
2136
+ * @public
1934
2137
  * <p>The payment option for the reservation (for example, <code>AllUpfront</code> or
1935
2138
  * <code>NoUpfront</code>).</p>
1936
2139
  */
1937
2140
  PaymentOption?: PaymentOption | string;
1938
2141
  /**
2142
+ * @public
1939
2143
  * <p>Hardware specifications for the service that you want recommendations for.</p>
1940
2144
  */
1941
2145
  ServiceSpecification?: ServiceSpecification;
1942
2146
  /**
2147
+ * @public
1943
2148
  * <p>Details about the recommended purchases.</p>
1944
2149
  */
1945
2150
  RecommendationDetails?: ReservationPurchaseRecommendationDetail[];
1946
2151
  /**
2152
+ * @public
1947
2153
  * <p>A summary about the recommended purchase.</p>
1948
2154
  */
1949
2155
  RecommendationSummary?: ReservationPurchaseRecommendationSummary;
@@ -1953,15 +2159,18 @@ export interface ReservationPurchaseRecommendation {
1953
2159
  */
1954
2160
  export interface GetReservationPurchaseRecommendationResponse {
1955
2161
  /**
2162
+ * @public
1956
2163
  * <p>Information about this specific recommendation call, such as the time stamp for when
1957
2164
  * Cost Explorer generated this recommendation.</p>
1958
2165
  */
1959
2166
  Metadata?: ReservationPurchaseRecommendationMetadata;
1960
2167
  /**
2168
+ * @public
1961
2169
  * <p>Recommendations for reservations to purchase.</p>
1962
2170
  */
1963
2171
  Recommendations?: ReservationPurchaseRecommendation[];
1964
2172
  /**
2173
+ * @public
1965
2174
  * <p>The pagination token for the next set of retrievable results.</p>
1966
2175
  */
1967
2176
  NextPageToken?: string;
@@ -1972,82 +2181,99 @@ export interface GetReservationPurchaseRecommendationResponse {
1972
2181
  */
1973
2182
  export interface ReservationAggregates {
1974
2183
  /**
2184
+ * @public
1975
2185
  * <p>The percentage of reservation time that you used.</p>
1976
2186
  */
1977
2187
  UtilizationPercentage?: string;
1978
2188
  /**
2189
+ * @public
1979
2190
  * <p>The percentage of Amazon EC2 reservation time that you used. It's converted to
1980
2191
  * normalized units. Normalized units are available only for Amazon EC2 usage after
1981
2192
  * November 11, 2017.</p>
1982
2193
  */
1983
2194
  UtilizationPercentageInUnits?: string;
1984
2195
  /**
2196
+ * @public
1985
2197
  * <p>How many reservation hours that you purchased.</p>
1986
2198
  */
1987
2199
  PurchasedHours?: string;
1988
2200
  /**
2201
+ * @public
1989
2202
  * <p>The number of Amazon EC2 reservation hours that you purchased. It's converted to
1990
2203
  * normalized units. Normalized units are available only for Amazon EC2 usage after
1991
2204
  * November 11, 2017.</p>
1992
2205
  */
1993
2206
  PurchasedUnits?: string;
1994
2207
  /**
2208
+ * @public
1995
2209
  * <p>The total number of reservation hours that you used.</p>
1996
2210
  */
1997
2211
  TotalActualHours?: string;
1998
2212
  /**
2213
+ * @public
1999
2214
  * <p>The total number of Amazon EC2 reservation hours that you used. It's converted to
2000
2215
  * normalized units. Normalized units are available only for Amazon EC2 usage after
2001
2216
  * November 11, 2017.</p>
2002
2217
  */
2003
2218
  TotalActualUnits?: string;
2004
2219
  /**
2220
+ * @public
2005
2221
  * <p>The number of reservation hours that you didn't use.</p>
2006
2222
  */
2007
2223
  UnusedHours?: string;
2008
2224
  /**
2225
+ * @public
2009
2226
  * <p>The number of Amazon EC2 reservation hours that you didn't use. It's converted to
2010
2227
  * normalized units. Normalized units are available only for Amazon EC2 usage after
2011
2228
  * November 11, 2017.</p>
2012
2229
  */
2013
2230
  UnusedUnits?: string;
2014
2231
  /**
2232
+ * @public
2015
2233
  * <p>How much your reservation costs if charged On-Demand rates.</p>
2016
2234
  */
2017
2235
  OnDemandCostOfRIHoursUsed?: string;
2018
2236
  /**
2237
+ * @public
2019
2238
  * <p>How much you saved due to purchasing and utilizing reservation. Amazon Web Services
2020
2239
  * calculates this by subtracting <code>TotalAmortizedFee</code> from
2021
2240
  * <code>OnDemandCostOfRIHoursUsed</code>.</p>
2022
2241
  */
2023
2242
  NetRISavings?: string;
2024
2243
  /**
2244
+ * @public
2025
2245
  * <p>How much you might save if you use your entire reservation.</p>
2026
2246
  */
2027
2247
  TotalPotentialRISavings?: string;
2028
2248
  /**
2249
+ * @public
2029
2250
  * <p>The upfront cost of your reservation. It's amortized over the reservation
2030
2251
  * period.</p>
2031
2252
  */
2032
2253
  AmortizedUpfrontFee?: string;
2033
2254
  /**
2255
+ * @public
2034
2256
  * <p>The monthly cost of your reservation. It's amortized over the reservation
2035
2257
  * period.</p>
2036
2258
  */
2037
2259
  AmortizedRecurringFee?: string;
2038
2260
  /**
2261
+ * @public
2039
2262
  * <p>The total cost of your reservation. It's amortized over the reservation period.</p>
2040
2263
  */
2041
2264
  TotalAmortizedFee?: string;
2042
2265
  /**
2266
+ * @public
2043
2267
  * <p>The cost of unused hours for your reservation.</p>
2044
2268
  */
2045
2269
  RICostForUnusedHours?: string;
2046
2270
  /**
2271
+ * @public
2047
2272
  * <p>The realized savings because of purchasing and using a reservation.</p>
2048
2273
  */
2049
2274
  RealizedSavings?: string;
2050
2275
  /**
2276
+ * @public
2051
2277
  * <p>The unrealized savings because of purchasing and using a reservation.</p>
2052
2278
  */
2053
2279
  UnrealizedSavings?: string;
@@ -2058,18 +2284,22 @@ export interface ReservationAggregates {
2058
2284
  */
2059
2285
  export interface ReservationUtilizationGroup {
2060
2286
  /**
2287
+ * @public
2061
2288
  * <p>The key for a specific reservation attribute.</p>
2062
2289
  */
2063
2290
  Key?: string;
2064
2291
  /**
2292
+ * @public
2065
2293
  * <p>The value of a specific reservation attribute.</p>
2066
2294
  */
2067
2295
  Value?: string;
2068
2296
  /**
2297
+ * @public
2069
2298
  * <p>The attributes for this group of reservations.</p>
2070
2299
  */
2071
2300
  Attributes?: Record<string, string>;
2072
2301
  /**
2302
+ * @public
2073
2303
  * <p>How much you used this group of reservations.</p>
2074
2304
  */
2075
2305
  Utilization?: ReservationAggregates;
@@ -2080,14 +2310,17 @@ export interface ReservationUtilizationGroup {
2080
2310
  */
2081
2311
  export interface UtilizationByTime {
2082
2312
  /**
2313
+ * @public
2083
2314
  * <p>The period of time that this utilization was used for.</p>
2084
2315
  */
2085
2316
  TimePeriod?: DateInterval;
2086
2317
  /**
2318
+ * @public
2087
2319
  * <p>The groups that this utilization result uses.</p>
2088
2320
  */
2089
2321
  Groups?: ReservationUtilizationGroup[];
2090
2322
  /**
2323
+ * @public
2091
2324
  * <p>The total number of reservation hours that were used.</p>
2092
2325
  */
2093
2326
  Total?: ReservationAggregates;
@@ -2097,14 +2330,17 @@ export interface UtilizationByTime {
2097
2330
  */
2098
2331
  export interface GetReservationUtilizationResponse {
2099
2332
  /**
2333
+ * @public
2100
2334
  * <p>The amount of time that you used your Reserved Instances (RIs).</p>
2101
2335
  */
2102
2336
  UtilizationsByTime: UtilizationByTime[] | undefined;
2103
2337
  /**
2338
+ * @public
2104
2339
  * <p>The total amount of time that you used your Reserved Instances (RIs).</p>
2105
2340
  */
2106
2341
  Total?: ReservationAggregates;
2107
2342
  /**
2343
+ * @public
2108
2344
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
2109
2345
  * when the response from a previous call has more results than the maximum page size.</p>
2110
2346
  */
@@ -2133,12 +2369,14 @@ export type RecommendationTarget = (typeof RecommendationTarget)[keyof typeof Re
2133
2369
  */
2134
2370
  export interface RightsizingRecommendationConfiguration {
2135
2371
  /**
2372
+ * @public
2136
2373
  * <p>The option to see recommendations within the same instance family or recommendations
2137
2374
  * for instances across other families. The default value is
2138
2375
  * <code>SAME_INSTANCE_FAMILY</code>. </p>
2139
2376
  */
2140
2377
  RecommendationTarget: RecommendationTarget | string | undefined;
2141
2378
  /**
2379
+ * @public
2142
2380
  * <p>The option to consider RI or Savings Plans discount benefits in your savings
2143
2381
  * calculation. The default value is <code>TRUE</code>. </p>
2144
2382
  */
@@ -2150,19 +2388,23 @@ export interface RightsizingRecommendationConfiguration {
2150
2388
  */
2151
2389
  export interface RightsizingRecommendationMetadata {
2152
2390
  /**
2391
+ * @public
2153
2392
  * <p>The ID for this specific recommendation.</p>
2154
2393
  */
2155
2394
  RecommendationId?: string;
2156
2395
  /**
2396
+ * @public
2157
2397
  * <p>The timestamp for when Amazon Web Services made this recommendation.</p>
2158
2398
  */
2159
2399
  GenerationTimestamp?: string;
2160
2400
  /**
2401
+ * @public
2161
2402
  * <p>The number of days of previous usage that Amazon Web Services considers when making
2162
2403
  * this recommendation.</p>
2163
2404
  */
2164
2405
  LookbackPeriodInDays?: LookbackPeriodInDays | string;
2165
2406
  /**
2407
+ * @public
2166
2408
  * <p>Additional metadata that might be applicable to the recommendation.</p>
2167
2409
  */
2168
2410
  AdditionalMetadata?: string;
@@ -2173,40 +2415,49 @@ export interface RightsizingRecommendationMetadata {
2173
2415
  */
2174
2416
  export interface EC2ResourceDetails {
2175
2417
  /**
2418
+ * @public
2176
2419
  * <p>The hourly public On-Demand rate for the instance type.</p>
2177
2420
  */
2178
2421
  HourlyOnDemandRate?: string;
2179
2422
  /**
2423
+ * @public
2180
2424
  * <p>The type of Amazon Web Services instance.</p>
2181
2425
  */
2182
2426
  InstanceType?: string;
2183
2427
  /**
2428
+ * @public
2184
2429
  * <p>The platform of the Amazon Web Services instance. The platform is the specific
2185
2430
  * combination of operating system, license model, and software on an instance.</p>
2186
2431
  */
2187
2432
  Platform?: string;
2188
2433
  /**
2434
+ * @public
2189
2435
  * <p>The Amazon Web Services Region of the instance.</p>
2190
2436
  */
2191
2437
  Region?: string;
2192
2438
  /**
2439
+ * @public
2193
2440
  * <p>The SKU of the product.</p>
2194
2441
  */
2195
2442
  Sku?: string;
2196
2443
  /**
2444
+ * @public
2197
2445
  * <p>The memory capacity of the Amazon Web Services instance.</p>
2198
2446
  */
2199
2447
  Memory?: string;
2200
2448
  /**
2449
+ * @public
2201
2450
  * <p>The network performance capacity of the Amazon Web Services instance.</p>
2202
2451
  */
2203
2452
  NetworkPerformance?: string;
2204
2453
  /**
2454
+ * @public
2205
2455
  * <p>The disk storage of the Amazon Web Services instance. This doesn't include EBS
2206
2456
  * storage.</p>
2207
2457
  */
2208
2458
  Storage?: string;
2209
2459
  /**
2460
+ * @public
2210
2461
  * <p>The number of VCPU cores in the Amazon Web Services instance type.</p>
2211
2462
  */
2212
2463
  Vcpu?: string;
@@ -2217,6 +2468,7 @@ export interface EC2ResourceDetails {
2217
2468
  */
2218
2469
  export interface ResourceDetails {
2219
2470
  /**
2471
+ * @public
2220
2472
  * <p>Details for the Amazon EC2 resource.</p>
2221
2473
  */
2222
2474
  EC2ResourceDetails?: EC2ResourceDetails;
@@ -2228,18 +2480,22 @@ export interface ResourceDetails {
2228
2480
  */
2229
2481
  export interface DiskResourceUtilization {
2230
2482
  /**
2483
+ * @public
2231
2484
  * <p>The maximum number of read operations per second. </p>
2232
2485
  */
2233
2486
  DiskReadOpsPerSecond?: string;
2234
2487
  /**
2488
+ * @public
2235
2489
  * <p>The maximum number of write operations per second. </p>
2236
2490
  */
2237
2491
  DiskWriteOpsPerSecond?: string;
2238
2492
  /**
2493
+ * @public
2239
2494
  * <p>The maximum read throughput operations per second. </p>
2240
2495
  */
2241
2496
  DiskReadBytesPerSecond?: string;
2242
2497
  /**
2498
+ * @public
2243
2499
  * <p>The maximum write throughput operations per second. </p>
2244
2500
  */
2245
2501
  DiskWriteBytesPerSecond?: string;
@@ -2251,18 +2507,22 @@ export interface DiskResourceUtilization {
2251
2507
  */
2252
2508
  export interface EBSResourceUtilization {
2253
2509
  /**
2510
+ * @public
2254
2511
  * <p>The maximum number of read operations per second. </p>
2255
2512
  */
2256
2513
  EbsReadOpsPerSecond?: string;
2257
2514
  /**
2515
+ * @public
2258
2516
  * <p>The maximum number of write operations per second. </p>
2259
2517
  */
2260
2518
  EbsWriteOpsPerSecond?: string;
2261
2519
  /**
2520
+ * @public
2262
2521
  * <p>The maximum size of read operations per second </p>
2263
2522
  */
2264
2523
  EbsReadBytesPerSecond?: string;
2265
2524
  /**
2525
+ * @public
2266
2526
  * <p>The maximum size of write operations per second. </p>
2267
2527
  */
2268
2528
  EbsWriteBytesPerSecond?: string;
@@ -2274,19 +2534,23 @@ export interface EBSResourceUtilization {
2274
2534
  */
2275
2535
  export interface NetworkResourceUtilization {
2276
2536
  /**
2537
+ * @public
2277
2538
  * <p>The network inbound throughput utilization measured in Bytes per second (Bps). </p>
2278
2539
  */
2279
2540
  NetworkInBytesPerSecond?: string;
2280
2541
  /**
2542
+ * @public
2281
2543
  * <p>The network outbound throughput utilization measured in Bytes per second (Bps).
2282
2544
  * </p>
2283
2545
  */
2284
2546
  NetworkOutBytesPerSecond?: string;
2285
2547
  /**
2548
+ * @public
2286
2549
  * <p>The network inbound packets that are measured in packets per second. </p>
2287
2550
  */
2288
2551
  NetworkPacketsInPerSecond?: string;
2289
2552
  /**
2553
+ * @public
2290
2554
  * <p>The network outbound packets that are measured in packets per second. </p>
2291
2555
  */
2292
2556
  NetworkPacketsOutPerSecond?: string;
@@ -2297,29 +2561,35 @@ export interface NetworkResourceUtilization {
2297
2561
  */
2298
2562
  export interface EC2ResourceUtilization {
2299
2563
  /**
2564
+ * @public
2300
2565
  * <p>The maximum observed or expected CPU utilization of the instance.</p>
2301
2566
  */
2302
2567
  MaxCpuUtilizationPercentage?: string;
2303
2568
  /**
2569
+ * @public
2304
2570
  * <p>The maximum observed or expected memory utilization of the instance.</p>
2305
2571
  */
2306
2572
  MaxMemoryUtilizationPercentage?: string;
2307
2573
  /**
2574
+ * @public
2308
2575
  * <p>The maximum observed or expected storage utilization of the instance. This doesn't
2309
2576
  * include EBS storage.</p>
2310
2577
  */
2311
2578
  MaxStorageUtilizationPercentage?: string;
2312
2579
  /**
2580
+ * @public
2313
2581
  * <p>The EBS field that contains a list of EBS metrics that are associated with the current
2314
2582
  * instance. </p>
2315
2583
  */
2316
2584
  EBSResourceUtilization?: EBSResourceUtilization;
2317
2585
  /**
2586
+ * @public
2318
2587
  * <p>The field that contains a list of disk (local storage) metrics that are associated
2319
2588
  * with the current instance. </p>
2320
2589
  */
2321
2590
  DiskResourceUtilization?: DiskResourceUtilization;
2322
2591
  /**
2592
+ * @public
2323
2593
  * <p>The network field that contains a list of network metrics that are associated with the
2324
2594
  * current instance. </p>
2325
2595
  */
@@ -2331,6 +2601,7 @@ export interface EC2ResourceUtilization {
2331
2601
  */
2332
2602
  export interface ResourceUtilization {
2333
2603
  /**
2604
+ * @public
2334
2605
  * <p>The utilization of current Amazon EC2 instance. </p>
2335
2606
  */
2336
2607
  EC2ResourceUtilization?: EC2ResourceUtilization;
@@ -2341,48 +2612,59 @@ export interface ResourceUtilization {
2341
2612
  */
2342
2613
  export interface CurrentInstance {
2343
2614
  /**
2615
+ * @public
2344
2616
  * <p>Resource ID of the current instance.</p>
2345
2617
  */
2346
2618
  ResourceId?: string;
2347
2619
  /**
2620
+ * @public
2348
2621
  * <p>The name that you given an instance. This field shows as blank if you haven't given
2349
2622
  * the instance a name.</p>
2350
2623
  */
2351
2624
  InstanceName?: string;
2352
2625
  /**
2626
+ * @public
2353
2627
  * <p>Cost allocation resource tags that are applied to the instance.</p>
2354
2628
  */
2355
2629
  Tags?: TagValues[];
2356
2630
  /**
2631
+ * @public
2357
2632
  * <p>Details about the resource and utilization.</p>
2358
2633
  */
2359
2634
  ResourceDetails?: ResourceDetails;
2360
2635
  /**
2636
+ * @public
2361
2637
  * <p>Utilization information of the current instance during the lookback period.</p>
2362
2638
  */
2363
2639
  ResourceUtilization?: ResourceUtilization;
2364
2640
  /**
2641
+ * @public
2365
2642
  * <p>The number of hours during the lookback period that's covered by reservations.</p>
2366
2643
  */
2367
2644
  ReservationCoveredHoursInLookbackPeriod?: string;
2368
2645
  /**
2646
+ * @public
2369
2647
  * <p>The number of hours during the lookback period that's covered by Savings Plans.</p>
2370
2648
  */
2371
2649
  SavingsPlansCoveredHoursInLookbackPeriod?: string;
2372
2650
  /**
2651
+ * @public
2373
2652
  * <p>The number of hours during the lookback period that's billed at On-Demand
2374
2653
  * rates.</p>
2375
2654
  */
2376
2655
  OnDemandHoursInLookbackPeriod?: string;
2377
2656
  /**
2657
+ * @public
2378
2658
  * <p>The total number of hours that the instance ran during the lookback period.</p>
2379
2659
  */
2380
2660
  TotalRunningHoursInLookbackPeriod?: string;
2381
2661
  /**
2662
+ * @public
2382
2663
  * <p>The current On-Demand cost of operating this instance on a monthly basis.</p>
2383
2664
  */
2384
2665
  MonthlyCost?: string;
2385
2666
  /**
2667
+ * @public
2386
2668
  * <p>The currency code that Amazon Web Services used to calculate the costs for this
2387
2669
  * instance.</p>
2388
2670
  */
@@ -2435,32 +2717,39 @@ export type PlatformDifference = (typeof PlatformDifference)[keyof typeof Platfo
2435
2717
  */
2436
2718
  export interface TargetInstance {
2437
2719
  /**
2720
+ * @public
2438
2721
  * <p>The expected cost to operate this instance type on a monthly basis.</p>
2439
2722
  */
2440
2723
  EstimatedMonthlyCost?: string;
2441
2724
  /**
2725
+ * @public
2442
2726
  * <p>The estimated savings that result from modification, on a monthly basis.</p>
2443
2727
  */
2444
2728
  EstimatedMonthlySavings?: string;
2445
2729
  /**
2730
+ * @public
2446
2731
  * <p>The currency code that Amazon Web Services used to calculate the costs for this
2447
2732
  * instance.</p>
2448
2733
  */
2449
2734
  CurrencyCode?: string;
2450
2735
  /**
2736
+ * @public
2451
2737
  * <p>Determines whether this recommendation is the defaulted Amazon Web Services
2452
2738
  * recommendation.</p>
2453
2739
  */
2454
2740
  DefaultTargetInstance?: boolean;
2455
2741
  /**
2742
+ * @public
2456
2743
  * <p>Details on the target instance type. </p>
2457
2744
  */
2458
2745
  ResourceDetails?: ResourceDetails;
2459
2746
  /**
2747
+ * @public
2460
2748
  * <p>The expected utilization metrics for target instance type.</p>
2461
2749
  */
2462
2750
  ExpectedResourceUtilization?: ResourceUtilization;
2463
2751
  /**
2752
+ * @public
2464
2753
  * <p>Explains the actions that you might need to take to successfully migrate your
2465
2754
  * workloads from the current instance type to the recommended instance type. </p>
2466
2755
  */
@@ -2472,6 +2761,7 @@ export interface TargetInstance {
2472
2761
  */
2473
2762
  export interface ModifyRecommendationDetail {
2474
2763
  /**
2764
+ * @public
2475
2765
  * <p>Determines whether this instance type is the Amazon Web Services default
2476
2766
  * recommendation.</p>
2477
2767
  */
@@ -2495,10 +2785,12 @@ export type RightsizingType = (typeof RightsizingType)[keyof typeof RightsizingT
2495
2785
  */
2496
2786
  export interface TerminateRecommendationDetail {
2497
2787
  /**
2788
+ * @public
2498
2789
  * <p>The estimated savings that result from modification, on a monthly basis.</p>
2499
2790
  */
2500
2791
  EstimatedMonthlySavings?: string;
2501
2792
  /**
2793
+ * @public
2502
2794
  * <p>The currency code that Amazon Web Services used to calculate the costs for this
2503
2795
  * instance.</p>
2504
2796
  */
@@ -2510,27 +2802,33 @@ export interface TerminateRecommendationDetail {
2510
2802
  */
2511
2803
  export interface RightsizingRecommendation {
2512
2804
  /**
2805
+ * @public
2513
2806
  * <p>The account that this recommendation is for.</p>
2514
2807
  */
2515
2808
  AccountId?: string;
2516
2809
  /**
2810
+ * @public
2517
2811
  * <p>Context
2518
2812
  * regarding the current instance.</p>
2519
2813
  */
2520
2814
  CurrentInstance?: CurrentInstance;
2521
2815
  /**
2816
+ * @public
2522
2817
  * <p>A recommendation to either terminate or modify the resource.</p>
2523
2818
  */
2524
2819
  RightsizingType?: RightsizingType | string;
2525
2820
  /**
2821
+ * @public
2526
2822
  * <p>The details for the modification recommendations. </p>
2527
2823
  */
2528
2824
  ModifyRecommendationDetail?: ModifyRecommendationDetail;
2529
2825
  /**
2826
+ * @public
2530
2827
  * <p>The details for termination recommendations.</p>
2531
2828
  */
2532
2829
  TerminateRecommendationDetail?: TerminateRecommendationDetail;
2533
2830
  /**
2831
+ * @public
2534
2832
  * <p>The list of possible reasons why the recommendation is generated, such as under- or
2535
2833
  * over-utilization of specific metrics (for example, CPU, Memory, Network). </p>
2536
2834
  */
@@ -2542,18 +2840,22 @@ export interface RightsizingRecommendation {
2542
2840
  */
2543
2841
  export interface RightsizingRecommendationSummary {
2544
2842
  /**
2843
+ * @public
2545
2844
  * <p>The total number of instance recommendations.</p>
2546
2845
  */
2547
2846
  TotalRecommendationCount?: string;
2548
2847
  /**
2848
+ * @public
2549
2849
  * <p>The estimated total savings resulting from modifications, on a monthly basis.</p>
2550
2850
  */
2551
2851
  EstimatedTotalMonthlySavingsAmount?: string;
2552
2852
  /**
2853
+ * @public
2553
2854
  * <p>The currency code that Amazon Web Services used to calculate the savings.</p>
2554
2855
  */
2555
2856
  SavingsCurrencyCode?: string;
2556
2857
  /**
2858
+ * @public
2557
2859
  * <p> The savings percentage based on the recommended modifications. It's relative to the
2558
2860
  * total On-Demand costs that are associated with these instances.</p>
2559
2861
  */
@@ -2564,22 +2866,27 @@ export interface RightsizingRecommendationSummary {
2564
2866
  */
2565
2867
  export interface GetRightsizingRecommendationResponse {
2566
2868
  /**
2869
+ * @public
2567
2870
  * <p>Information regarding this specific recommendation set.</p>
2568
2871
  */
2569
2872
  Metadata?: RightsizingRecommendationMetadata;
2570
2873
  /**
2874
+ * @public
2571
2875
  * <p>Summary of this recommendation set.</p>
2572
2876
  */
2573
2877
  Summary?: RightsizingRecommendationSummary;
2574
2878
  /**
2879
+ * @public
2575
2880
  * <p>Recommendations to rightsize resources.</p>
2576
2881
  */
2577
2882
  RightsizingRecommendations?: RightsizingRecommendation[];
2578
2883
  /**
2884
+ * @public
2579
2885
  * <p>The token to retrieve the next set of results.</p>
2580
2886
  */
2581
2887
  NextPageToken?: string;
2582
2888
  /**
2889
+ * @public
2583
2890
  * <p>You can use Configuration to customize recommendations across two attributes. You can
2584
2891
  * choose to view recommendations for instances within the same instance families or across
2585
2892
  * different instance families. You can also choose to view your estimated savings that are
@@ -2593,6 +2900,7 @@ export interface GetRightsizingRecommendationResponse {
2593
2900
  */
2594
2901
  export interface GetSavingsPlanPurchaseRecommendationDetailsRequest {
2595
2902
  /**
2903
+ * @public
2596
2904
  * <p>The ID that is associated with the Savings Plan recommendation.</p>
2597
2905
  */
2598
2906
  RecommendationDetailId: string | undefined;
@@ -2604,24 +2912,29 @@ export interface GetSavingsPlanPurchaseRecommendationDetailsRequest {
2604
2912
  */
2605
2913
  export interface RecommendationDetailHourlyMetrics {
2606
2914
  /**
2915
+ * @public
2607
2916
  * <p>The period of time that you want the usage and costs for.</p>
2608
2917
  */
2609
2918
  StartTime?: string;
2610
2919
  /**
2920
+ * @public
2611
2921
  * <p>The remaining On-Demand cost estimated to not be covered by the recommended Savings
2612
2922
  * Plan, over the length of the lookback period.</p>
2613
2923
  */
2614
2924
  EstimatedOnDemandCost?: string;
2615
2925
  /**
2926
+ * @public
2616
2927
  * <p>The current amount of Savings Plans eligible usage that the Savings Plan
2617
2928
  * covered.</p>
2618
2929
  */
2619
2930
  CurrentCoverage?: string;
2620
2931
  /**
2932
+ * @public
2621
2933
  * <p>The estimated coverage amount based on the recommended Savings Plan.</p>
2622
2934
  */
2623
2935
  EstimatedCoverage?: string;
2624
2936
  /**
2937
+ * @public
2625
2938
  * <p>The estimated utilization for the recommended Savings Plan.</p>
2626
2939
  */
2627
2940
  EstimatedNewCommitmentUtilization?: string;
@@ -2645,6 +2958,7 @@ export type SupportedSavingsPlansType = (typeof SupportedSavingsPlansType)[keyof
2645
2958
  */
2646
2959
  export interface RecommendationDetailData {
2647
2960
  /**
2961
+ * @public
2648
2962
  * <p>The account scope that you want your recommendations for. Amazon Web Services
2649
2963
  * calculates recommendations including the management account and member accounts if the
2650
2964
  * value is set to PAYER. If the value is LINKED, recommendations are calculated for
@@ -2652,127 +2966,155 @@ export interface RecommendationDetailData {
2652
2966
  */
2653
2967
  AccountScope?: AccountScope | string;
2654
2968
  /**
2969
+ * @public
2655
2970
  * <p>How many days of previous usage that Amazon Web Services considers when making this
2656
2971
  * recommendation.</p>
2657
2972
  */
2658
2973
  LookbackPeriodInDays?: LookbackPeriodInDays | string;
2659
2974
  /**
2975
+ * @public
2660
2976
  * <p>The requested Savings Plan recommendation type.</p>
2661
2977
  */
2662
2978
  SavingsPlansType?: SupportedSavingsPlansType | string;
2663
2979
  /**
2980
+ * @public
2664
2981
  * <p>The term of the commitment in years.</p>
2665
2982
  */
2666
2983
  TermInYears?: TermInYears | string;
2667
2984
  /**
2985
+ * @public
2668
2986
  * <p>The payment option for the commitment (for example, All Upfront or No Upfront).</p>
2669
2987
  */
2670
2988
  PaymentOption?: PaymentOption | string;
2671
2989
  /**
2990
+ * @public
2672
2991
  * <p>The AccountID that the recommendation is generated for.</p>
2673
2992
  */
2674
2993
  AccountId?: string;
2675
2994
  /**
2995
+ * @public
2676
2996
  * <p>The currency code that Amazon Web Services used to generate the recommendation and
2677
2997
  * present potential savings.</p>
2678
2998
  */
2679
2999
  CurrencyCode?: string;
2680
3000
  /**
3001
+ * @public
2681
3002
  * <p>The instance family of the recommended Savings Plan.</p>
2682
3003
  */
2683
3004
  InstanceFamily?: string;
2684
3005
  /**
3006
+ * @public
2685
3007
  * <p>The region the recommendation is generated for.</p>
2686
3008
  */
2687
3009
  Region?: string;
2688
3010
  /**
3011
+ * @public
2689
3012
  * <p>The unique ID that's used to distinguish Savings Plans from one another.</p>
2690
3013
  */
2691
3014
  OfferingId?: string;
2692
3015
  /**
3016
+ * @public
2693
3017
  * <p>The period of time that you want the usage and costs for.</p>
2694
3018
  */
2695
3019
  GenerationTimestamp?: string;
2696
3020
  /**
3021
+ * @public
2697
3022
  * <p>The period of time that you want the usage and costs for.</p>
2698
3023
  */
2699
3024
  LatestUsageTimestamp?: string;
2700
3025
  /**
3026
+ * @public
2701
3027
  * <p>The average value of hourly On-Demand spend over the lookback period of the applicable
2702
3028
  * usage type.</p>
2703
3029
  */
2704
3030
  CurrentAverageHourlyOnDemandSpend?: string;
2705
3031
  /**
3032
+ * @public
2706
3033
  * <p>The highest value of hourly On-Demand spend over the lookback period of the applicable
2707
3034
  * usage type.</p>
2708
3035
  */
2709
3036
  CurrentMaximumHourlyOnDemandSpend?: string;
2710
3037
  /**
3038
+ * @public
2711
3039
  * <p>The lowest value of hourly On-Demand spend over the lookback period of the applicable
2712
3040
  * usage type.</p>
2713
3041
  */
2714
3042
  CurrentMinimumHourlyOnDemandSpend?: string;
2715
3043
  /**
3044
+ * @public
2716
3045
  * <p>The estimated utilization of the recommended Savings Plan.</p>
2717
3046
  */
2718
3047
  EstimatedAverageUtilization?: string;
2719
3048
  /**
3049
+ * @public
2720
3050
  * <p>The estimated monthly savings amount based on the recommended Savings Plan.</p>
2721
3051
  */
2722
3052
  EstimatedMonthlySavingsAmount?: string;
2723
3053
  /**
3054
+ * @public
2724
3055
  * <p>The remaining On-Demand cost estimated to not be covered by the recommended Savings
2725
3056
  * Plan, over the length of the lookback period.</p>
2726
3057
  */
2727
3058
  EstimatedOnDemandCost?: string;
2728
3059
  /**
3060
+ * @public
2729
3061
  * <p>The estimated On-Demand costs you expect with no additional commitment, based on your
2730
3062
  * usage of the selected time period and the Savings Plan you own.</p>
2731
3063
  */
2732
3064
  EstimatedOnDemandCostWithCurrentCommitment?: string;
2733
3065
  /**
3066
+ * @public
2734
3067
  * <p>The estimated return on investment that's based on the recommended Savings Plan that
2735
3068
  * you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.</p>
2736
3069
  */
2737
3070
  EstimatedROI?: string;
2738
3071
  /**
3072
+ * @public
2739
3073
  * <p>The cost of the recommended Savings Plan over the length of the lookback
2740
3074
  * period.</p>
2741
3075
  */
2742
3076
  EstimatedSPCost?: string;
2743
3077
  /**
3078
+ * @public
2744
3079
  * <p>The estimated savings amount that's based on the recommended Savings Plan over the
2745
3080
  * length of the lookback period.</p>
2746
3081
  */
2747
3082
  EstimatedSavingsAmount?: string;
2748
3083
  /**
3084
+ * @public
2749
3085
  * <p>The estimated savings percentage relative to the total cost of applicable On-Demand
2750
3086
  * usage over the lookback period.</p>
2751
3087
  */
2752
3088
  EstimatedSavingsPercentage?: string;
2753
3089
  /**
3090
+ * @public
2754
3091
  * <p>The existing hourly commitment for the Savings Plan type.</p>
2755
3092
  */
2756
3093
  ExistingHourlyCommitment?: string;
2757
3094
  /**
3095
+ * @public
2758
3096
  * <p>The recommended hourly commitment level for the Savings Plan type and the
2759
3097
  * configuration that's based on the usage during the lookback period.</p>
2760
3098
  */
2761
3099
  HourlyCommitmentToPurchase?: string;
2762
3100
  /**
3101
+ * @public
2763
3102
  * <p>The upfront cost of the recommended Savings Plan, based on the selected payment
2764
3103
  * option.</p>
2765
3104
  */
2766
3105
  UpfrontCost?: string;
2767
3106
  /**
3107
+ * @public
2768
3108
  * <p>The average value of hourly coverage over the lookback period.</p>
2769
3109
  */
2770
3110
  CurrentAverageCoverage?: string;
2771
3111
  /**
3112
+ * @public
2772
3113
  * <p>The estimated coverage of the recommended Savings Plan.</p>
2773
3114
  */
2774
3115
  EstimatedAverageCoverage?: string;
2775
3116
  /**
3117
+ * @public
2776
3118
  * <p>The related hourly cost, coverage, and utilization metrics over the lookback
2777
3119
  * period.</p>
2778
3120
  */
@@ -2783,10 +3125,12 @@ export interface RecommendationDetailData {
2783
3125
  */
2784
3126
  export interface GetSavingsPlanPurchaseRecommendationDetailsResponse {
2785
3127
  /**
3128
+ * @public
2786
3129
  * <p>The ID that is associated with the Savings Plan recommendation.</p>
2787
3130
  */
2788
3131
  RecommendationDetailId?: string;
2789
3132
  /**
3133
+ * @public
2790
3134
  * <p>Contains detailed information about a specific Savings Plan recommendation.</p>
2791
3135
  */
2792
3136
  RecommendationDetailData?: RecommendationDetailData;
@@ -2798,19 +3142,23 @@ export interface GetSavingsPlanPurchaseRecommendationDetailsResponse {
2798
3142
  */
2799
3143
  export interface SavingsPlansCoverageData {
2800
3144
  /**
3145
+ * @public
2801
3146
  * <p>The amount of your Amazon Web Services usage that's covered by a Savings Plans.</p>
2802
3147
  */
2803
3148
  SpendCoveredBySavingsPlans?: string;
2804
3149
  /**
3150
+ * @public
2805
3151
  * <p>The cost of your Amazon Web Services usage at the public On-Demand rate.</p>
2806
3152
  */
2807
3153
  OnDemandCost?: string;
2808
3154
  /**
3155
+ * @public
2809
3156
  * <p>The total cost of your Amazon Web Services usage, regardless of your purchase
2810
3157
  * option.</p>
2811
3158
  */
2812
3159
  TotalCost?: string;
2813
3160
  /**
3161
+ * @public
2814
3162
  * <p>The percentage of your existing Savings Plans covered usage, divided by all of your
2815
3163
  * eligible Savings Plans usage in an account (or set of accounts).</p>
2816
3164
  */
@@ -2823,14 +3171,17 @@ export interface SavingsPlansCoverageData {
2823
3171
  */
2824
3172
  export interface SavingsPlansCoverage {
2825
3173
  /**
3174
+ * @public
2826
3175
  * <p>The attribute that applies to a specific <code>Dimension</code>.</p>
2827
3176
  */
2828
3177
  Attributes?: Record<string, string>;
2829
3178
  /**
3179
+ * @public
2830
3180
  * <p>The amount of Savings Plans eligible usage that the Savings Plans covered.</p>
2831
3181
  */
2832
3182
  Coverage?: SavingsPlansCoverageData;
2833
3183
  /**
3184
+ * @public
2834
3185
  * <p>The time period of the request. </p>
2835
3186
  */
2836
3187
  TimePeriod?: DateInterval;
@@ -2840,10 +3191,12 @@ export interface SavingsPlansCoverage {
2840
3191
  */
2841
3192
  export interface GetSavingsPlansCoverageResponse {
2842
3193
  /**
3194
+ * @public
2843
3195
  * <p>The amount of spend that your Savings Plans covered.</p>
2844
3196
  */
2845
3197
  SavingsPlansCoverages: SavingsPlansCoverage[] | undefined;
2846
3198
  /**
3199
+ * @public
2847
3200
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
2848
3201
  * the response from a previous call has more results than the maximum page size.</p>
2849
3202
  */
@@ -2855,14 +3208,17 @@ export interface GetSavingsPlansCoverageResponse {
2855
3208
  */
2856
3209
  export interface SavingsPlansPurchaseRecommendationMetadata {
2857
3210
  /**
3211
+ * @public
2858
3212
  * <p>The unique identifier for the recommendation set.</p>
2859
3213
  */
2860
3214
  RecommendationId?: string;
2861
3215
  /**
3216
+ * @public
2862
3217
  * <p>The timestamp that shows when the recommendations were generated.</p>
2863
3218
  */
2864
3219
  GenerationTimestamp?: string;
2865
3220
  /**
3221
+ * @public
2866
3222
  * <p>Additional metadata that might be applicable to the recommendation.</p>
2867
3223
  */
2868
3224
  AdditionalMetadata?: string;
@@ -2873,14 +3229,17 @@ export interface SavingsPlansPurchaseRecommendationMetadata {
2873
3229
  */
2874
3230
  export interface SavingsPlansDetails {
2875
3231
  /**
3232
+ * @public
2876
3233
  * <p>A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.</p>
2877
3234
  */
2878
3235
  Region?: string;
2879
3236
  /**
3237
+ * @public
2880
3238
  * <p>A group of instance types that Savings Plans applies to.</p>
2881
3239
  */
2882
3240
  InstanceFamily?: string;
2883
3241
  /**
3242
+ * @public
2884
3243
  * <p>The unique ID that's used to distinguish Savings Plans from one another.</p>
2885
3244
  */
2886
3245
  OfferingId?: string;
@@ -2891,83 +3250,100 @@ export interface SavingsPlansDetails {
2891
3250
  */
2892
3251
  export interface SavingsPlansPurchaseRecommendationDetail {
2893
3252
  /**
3253
+ * @public
2894
3254
  * <p>Details for your recommended Savings Plans.</p>
2895
3255
  */
2896
3256
  SavingsPlansDetails?: SavingsPlansDetails;
2897
3257
  /**
3258
+ * @public
2898
3259
  * <p>The <code>AccountID</code> the recommendation is generated for.</p>
2899
3260
  */
2900
3261
  AccountId?: string;
2901
3262
  /**
3263
+ * @public
2902
3264
  * <p>The upfront cost of the recommended Savings Plans, based on the selected payment
2903
3265
  * option.</p>
2904
3266
  */
2905
3267
  UpfrontCost?: string;
2906
3268
  /**
3269
+ * @public
2907
3270
  * <p>The estimated return on investment that's based on the recommended Savings Plans that
2908
3271
  * you purchased. This is calculated as <code>estimatedSavingsAmount</code>/
2909
3272
  * <code>estimatedSPCost</code>*100.</p>
2910
3273
  */
2911
3274
  EstimatedROI?: string;
2912
3275
  /**
3276
+ * @public
2913
3277
  * <p>The currency code that Amazon Web Services used to generate the recommendations and
2914
3278
  * present potential savings.</p>
2915
3279
  */
2916
3280
  CurrencyCode?: string;
2917
3281
  /**
3282
+ * @public
2918
3283
  * <p>The cost of the recommended Savings Plans over the length of the lookback
2919
3284
  * period.</p>
2920
3285
  */
2921
3286
  EstimatedSPCost?: string;
2922
3287
  /**
3288
+ * @public
2923
3289
  * <p>The remaining On-Demand cost estimated to not be covered by the recommended Savings
2924
3290
  * Plans, over the length of the lookback period.</p>
2925
3291
  */
2926
3292
  EstimatedOnDemandCost?: string;
2927
3293
  /**
3294
+ * @public
2928
3295
  * <p> The estimated On-Demand costs you expect with no additional commitment, based on your
2929
3296
  * usage of the selected time period and the Savings Plans you own. </p>
2930
3297
  */
2931
3298
  EstimatedOnDemandCostWithCurrentCommitment?: string;
2932
3299
  /**
3300
+ * @public
2933
3301
  * <p>The estimated savings amount that's based on the recommended Savings Plans over the
2934
3302
  * length of the lookback period.</p>
2935
3303
  */
2936
3304
  EstimatedSavingsAmount?: string;
2937
3305
  /**
3306
+ * @public
2938
3307
  * <p>The estimated savings percentage relative to the total cost of applicable On-Demand
2939
3308
  * usage over the lookback period.</p>
2940
3309
  */
2941
3310
  EstimatedSavingsPercentage?: string;
2942
3311
  /**
3312
+ * @public
2943
3313
  * <p>The recommended hourly commitment level for the Savings Plans type and the
2944
3314
  * configuration that's based on the usage during the lookback period.</p>
2945
3315
  */
2946
3316
  HourlyCommitmentToPurchase?: string;
2947
3317
  /**
3318
+ * @public
2948
3319
  * <p>The estimated utilization of the recommended Savings Plans.</p>
2949
3320
  */
2950
3321
  EstimatedAverageUtilization?: string;
2951
3322
  /**
3323
+ * @public
2952
3324
  * <p>The estimated monthly savings amount based on the recommended Savings Plans.</p>
2953
3325
  */
2954
3326
  EstimatedMonthlySavingsAmount?: string;
2955
3327
  /**
3328
+ * @public
2956
3329
  * <p>The lowest value of hourly On-Demand spend over the lookback period of the applicable
2957
3330
  * usage type.</p>
2958
3331
  */
2959
3332
  CurrentMinimumHourlyOnDemandSpend?: string;
2960
3333
  /**
3334
+ * @public
2961
3335
  * <p>The highest value of hourly On-Demand spend over the lookback period of the applicable
2962
3336
  * usage type.</p>
2963
3337
  */
2964
3338
  CurrentMaximumHourlyOnDemandSpend?: string;
2965
3339
  /**
3340
+ * @public
2966
3341
  * <p>The average value of hourly On-Demand spend over the lookback period of the applicable
2967
3342
  * usage type.</p>
2968
3343
  */
2969
3344
  CurrentAverageHourlyOnDemandSpend?: string;
2970
3345
  /**
3346
+ * @public
2971
3347
  * <p>Contains detailed information about a specific Savings Plan recommendation.</p>
2972
3348
  */
2973
3349
  RecommendationDetailId?: string;
@@ -2978,57 +3354,68 @@ export interface SavingsPlansPurchaseRecommendationDetail {
2978
3354
  */
2979
3355
  export interface SavingsPlansPurchaseRecommendationSummary {
2980
3356
  /**
3357
+ * @public
2981
3358
  * <p>The estimated return on investment that's based on the recommended Savings Plans and
2982
3359
  * estimated savings.</p>
2983
3360
  */
2984
3361
  EstimatedROI?: string;
2985
3362
  /**
3363
+ * @public
2986
3364
  * <p>The currency code that Amazon Web Services used to generate the recommendations and
2987
3365
  * present potential savings.</p>
2988
3366
  */
2989
3367
  CurrencyCode?: string;
2990
3368
  /**
3369
+ * @public
2991
3370
  * <p>The estimated total cost of the usage after purchasing the recommended Savings Plans.
2992
3371
  * This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand
2993
3372
  * usage.</p>
2994
3373
  */
2995
3374
  EstimatedTotalCost?: string;
2996
3375
  /**
3376
+ * @public
2997
3377
  * <p>The current total on demand spend of the applicable usage types over the lookback
2998
3378
  * period.</p>
2999
3379
  */
3000
3380
  CurrentOnDemandSpend?: string;
3001
3381
  /**
3382
+ * @public
3002
3383
  * <p>The estimated total savings over the lookback period, based on the purchase of the
3003
3384
  * recommended Savings Plans.</p>
3004
3385
  */
3005
3386
  EstimatedSavingsAmount?: string;
3006
3387
  /**
3388
+ * @public
3007
3389
  * <p>The aggregate number of Savings Plans recommendations that exist for your
3008
3390
  * account.</p>
3009
3391
  */
3010
3392
  TotalRecommendationCount?: string;
3011
3393
  /**
3394
+ * @public
3012
3395
  * <p>The recommended Savings Plans cost on a daily (24 hourly) basis.</p>
3013
3396
  */
3014
3397
  DailyCommitmentToPurchase?: string;
3015
3398
  /**
3399
+ * @public
3016
3400
  * <p>The recommended hourly commitment that's based on the recommendation
3017
3401
  * parameters.</p>
3018
3402
  */
3019
3403
  HourlyCommitmentToPurchase?: string;
3020
3404
  /**
3405
+ * @public
3021
3406
  * <p>The estimated savings relative to the total cost of On-Demand usage, over the lookback
3022
3407
  * period. This is calculated as <code>estimatedSavingsAmount</code>/
3023
3408
  * <code>CurrentOnDemandSpend</code>*100.</p>
3024
3409
  */
3025
3410
  EstimatedSavingsPercentage?: string;
3026
3411
  /**
3412
+ * @public
3027
3413
  * <p>The estimated monthly savings amount that's based on the recommended Savings Plans
3028
3414
  * purchase.</p>
3029
3415
  */
3030
3416
  EstimatedMonthlySavingsAmount?: string;
3031
3417
  /**
3418
+ * @public
3032
3419
  * <p>The estimated On-Demand costs you expect with no additional commitment. It's based on
3033
3420
  * your usage of the selected time period and the Savings Plans you own. </p>
3034
3421
  */
@@ -3041,6 +3428,7 @@ export interface SavingsPlansPurchaseRecommendationSummary {
3041
3428
  */
3042
3429
  export interface SavingsPlansPurchaseRecommendation {
3043
3430
  /**
3431
+ * @public
3044
3432
  * <p>The account scope that you want your recommendations for. Amazon Web Services
3045
3433
  * calculates recommendations that include the management account and member accounts if
3046
3434
  * the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>,
@@ -3048,28 +3436,34 @@ export interface SavingsPlansPurchaseRecommendation {
3048
3436
  */
3049
3437
  AccountScope?: AccountScope | string;
3050
3438
  /**
3439
+ * @public
3051
3440
  * <p>The requested Savings Plans recommendation type.</p>
3052
3441
  */
3053
3442
  SavingsPlansType?: SupportedSavingsPlansType | string;
3054
3443
  /**
3444
+ * @public
3055
3445
  * <p>The Savings Plans recommendation term in years. It's used to generate the
3056
3446
  * recommendation.</p>
3057
3447
  */
3058
3448
  TermInYears?: TermInYears | string;
3059
3449
  /**
3450
+ * @public
3060
3451
  * <p>The payment option that's used to generate the recommendation.</p>
3061
3452
  */
3062
3453
  PaymentOption?: PaymentOption | string;
3063
3454
  /**
3455
+ * @public
3064
3456
  * <p>The lookback period in days that's used to generate the recommendation.</p>
3065
3457
  */
3066
3458
  LookbackPeriodInDays?: LookbackPeriodInDays | string;
3067
3459
  /**
3460
+ * @public
3068
3461
  * <p>Details for the Savings Plans that we recommend that you purchase to cover existing
3069
3462
  * Savings Plans eligible workloads.</p>
3070
3463
  */
3071
3464
  SavingsPlansPurchaseRecommendationDetails?: SavingsPlansPurchaseRecommendationDetail[];
3072
3465
  /**
3466
+ * @public
3073
3467
  * <p>Summary metrics for your Savings Plans Recommendations. </p>
3074
3468
  */
3075
3469
  SavingsPlansPurchaseRecommendationSummary?: SavingsPlansPurchaseRecommendationSummary;
@@ -3079,15 +3473,18 @@ export interface SavingsPlansPurchaseRecommendation {
3079
3473
  */
3080
3474
  export interface GetSavingsPlansPurchaseRecommendationResponse {
3081
3475
  /**
3476
+ * @public
3082
3477
  * <p>Information that regards this specific recommendation set.</p>
3083
3478
  */
3084
3479
  Metadata?: SavingsPlansPurchaseRecommendationMetadata;
3085
3480
  /**
3481
+ * @public
3086
3482
  * <p>Contains your request parameters, Savings Plan Recommendations Summary, and
3087
3483
  * Details.</p>
3088
3484
  */
3089
3485
  SavingsPlansPurchaseRecommendation?: SavingsPlansPurchaseRecommendation;
3090
3486
  /**
3487
+ * @public
3091
3488
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
3092
3489
  * when the response from a previous call has more results than the maximum page size.</p>
3093
3490
  */
@@ -3100,16 +3497,19 @@ export interface GetSavingsPlansPurchaseRecommendationResponse {
3100
3497
  */
3101
3498
  export interface SavingsPlansAmortizedCommitment {
3102
3499
  /**
3500
+ * @public
3103
3501
  * <p>The amortized amount of your Savings Plans commitment that was purchased with either a
3104
3502
  * <code>Partial</code> or a <code>NoUpfront</code>.</p>
3105
3503
  */
3106
3504
  AmortizedRecurringCommitment?: string;
3107
3505
  /**
3506
+ * @public
3108
3507
  * <p>The amortized amount of your Savings Plans commitment that was purchased with an
3109
3508
  * <code>Upfront</code> or <code>PartialUpfront</code> Savings Plans.</p>
3110
3509
  */
3111
3510
  AmortizedUpfrontCommitment?: string;
3112
3511
  /**
3512
+ * @public
3113
3513
  * <p>The total amortized amount of your Savings Plans commitment, regardless of your
3114
3514
  * Savings Plans purchase method. </p>
3115
3515
  */
@@ -3122,11 +3522,13 @@ export interface SavingsPlansAmortizedCommitment {
3122
3522
  */
3123
3523
  export interface SavingsPlansSavings {
3124
3524
  /**
3525
+ * @public
3125
3526
  * <p>The savings amount that you're accumulating for the usage that's covered by a Savings
3126
3527
  * Plans, when compared to the On-Demand equivalent of the same usage.</p>
3127
3528
  */
3128
3529
  NetSavings?: string;
3129
3530
  /**
3531
+ * @public
3130
3532
  * <p>How much the amount that the usage would have cost if it was accrued at the On-Demand
3131
3533
  * rate.</p>
3132
3534
  */
@@ -3138,21 +3540,25 @@ export interface SavingsPlansSavings {
3138
3540
  */
3139
3541
  export interface SavingsPlansUtilization {
3140
3542
  /**
3543
+ * @public
3141
3544
  * <p>The total amount of Savings Plans commitment that's been purchased in an account (or
3142
3545
  * set of accounts).</p>
3143
3546
  */
3144
3547
  TotalCommitment?: string;
3145
3548
  /**
3549
+ * @public
3146
3550
  * <p>The amount of your Savings Plans commitment that was consumed from Savings Plans
3147
3551
  * eligible usage in a specific period.</p>
3148
3552
  */
3149
3553
  UsedCommitment?: string;
3150
3554
  /**
3555
+ * @public
3151
3556
  * <p>The amount of your Savings Plans commitment that wasn't consumed from Savings Plans
3152
3557
  * eligible usage in a specific period.</p>
3153
3558
  */
3154
3559
  UnusedCommitment?: string;
3155
3560
  /**
3561
+ * @public
3156
3562
  * <p>The amount of <code>UsedCommitment</code> divided by the <code>TotalCommitment</code>
3157
3563
  * for your Savings Plans.</p>
3158
3564
  */
@@ -3164,21 +3570,25 @@ export interface SavingsPlansUtilization {
3164
3570
  */
3165
3571
  export interface SavingsPlansUtilizationByTime {
3166
3572
  /**
3573
+ * @public
3167
3574
  * <p>The time period of the request. </p>
3168
3575
  */
3169
3576
  TimePeriod: DateInterval | undefined;
3170
3577
  /**
3578
+ * @public
3171
3579
  * <p>A ratio of your effectiveness of using existing Savings Plans to apply to workloads
3172
3580
  * that are Savings Plans eligible.</p>
3173
3581
  */
3174
3582
  Utilization: SavingsPlansUtilization | undefined;
3175
3583
  /**
3584
+ * @public
3176
3585
  * <p>The amount that's saved by using existing Savings Plans. Savings returns both net
3177
3586
  * savings from Savings Plans and also the <code>onDemandCostEquivalent</code> of the
3178
3587
  * Savings Plans when considering the utilization rate.</p>
3179
3588
  */
3180
3589
  Savings?: SavingsPlansSavings;
3181
3590
  /**
3591
+ * @public
3182
3592
  * <p>The total amortized commitment for a Savings Plans. This includes the sum of the
3183
3593
  * upfront and recurring Savings Plans fees.</p>
3184
3594
  */
@@ -3190,17 +3600,20 @@ export interface SavingsPlansUtilizationByTime {
3190
3600
  */
3191
3601
  export interface SavingsPlansUtilizationAggregates {
3192
3602
  /**
3603
+ * @public
3193
3604
  * <p>A ratio of your effectiveness of using existing Savings Plans to apply to workloads
3194
3605
  * that are Savings Plans eligible.</p>
3195
3606
  */
3196
3607
  Utilization: SavingsPlansUtilization | undefined;
3197
3608
  /**
3609
+ * @public
3198
3610
  * <p>The amount that's saved by using existing Savings Plans. Savings returns both net
3199
3611
  * savings from Savings Plans and also the <code>onDemandCostEquivalent</code> of the
3200
3612
  * Savings Plans when considering the utilization rate.</p>
3201
3613
  */
3202
3614
  Savings?: SavingsPlansSavings;
3203
3615
  /**
3616
+ * @public
3204
3617
  * <p>The total amortized commitment for a Savings Plans. This includes the sum of the
3205
3618
  * upfront and recurring Savings Plans fees.</p>
3206
3619
  */
@@ -3211,11 +3624,13 @@ export interface SavingsPlansUtilizationAggregates {
3211
3624
  */
3212
3625
  export interface GetSavingsPlansUtilizationResponse {
3213
3626
  /**
3627
+ * @public
3214
3628
  * <p>The amount of cost/commitment that you used your Savings Plans. You can use it to specify
3215
3629
  * date ranges.</p>
3216
3630
  */
3217
3631
  SavingsPlansUtilizationsByTime?: SavingsPlansUtilizationByTime[];
3218
3632
  /**
3633
+ * @public
3219
3634
  * <p>The total amount of cost/commitment that you used your Savings Plans, regardless of date
3220
3635
  * ranges.</p>
3221
3636
  */
@@ -3243,25 +3658,30 @@ export type SavingsPlansDataType = (typeof SavingsPlansDataType)[keyof typeof Sa
3243
3658
  */
3244
3659
  export interface SavingsPlansUtilizationDetail {
3245
3660
  /**
3661
+ * @public
3246
3662
  * <p>The unique Amazon Resource Name (ARN) for a particular Savings Plan.</p>
3247
3663
  */
3248
3664
  SavingsPlanArn?: string;
3249
3665
  /**
3666
+ * @public
3250
3667
  * <p>The attribute that applies to a specific <code>Dimension</code>.</p>
3251
3668
  */
3252
3669
  Attributes?: Record<string, string>;
3253
3670
  /**
3671
+ * @public
3254
3672
  * <p>A ratio of your effectiveness of using existing Savings Plans to apply to workloads
3255
3673
  * that are Savings Plans eligible.</p>
3256
3674
  */
3257
3675
  Utilization?: SavingsPlansUtilization;
3258
3676
  /**
3677
+ * @public
3259
3678
  * <p>The amount saved by using existing Savings Plans. Savings returns both net savings
3260
3679
  * from savings plans and also the <code>onDemandCostEquivalent</code> of the Savings Plans
3261
3680
  * when considering the utilization rate.</p>
3262
3681
  */
3263
3682
  Savings?: SavingsPlansSavings;
3264
3683
  /**
3684
+ * @public
3265
3685
  * <p>The total amortized commitment for a Savings Plans. Includes the sum of the upfront
3266
3686
  * and recurring Savings Plans fees.</p>
3267
3687
  */
@@ -3272,19 +3692,23 @@ export interface SavingsPlansUtilizationDetail {
3272
3692
  */
3273
3693
  export interface GetSavingsPlansUtilizationDetailsResponse {
3274
3694
  /**
3695
+ * @public
3275
3696
  * <p>Retrieves a single daily or monthly Savings Plans utilization rate and details for your
3276
3697
  * account.</p>
3277
3698
  */
3278
3699
  SavingsPlansUtilizationDetails: SavingsPlansUtilizationDetail[] | undefined;
3279
3700
  /**
3701
+ * @public
3280
3702
  * <p>The total Savings Plans utilization, regardless of time period.</p>
3281
3703
  */
3282
3704
  Total?: SavingsPlansUtilizationAggregates;
3283
3705
  /**
3706
+ * @public
3284
3707
  * <p>The time period of the request. </p>
3285
3708
  */
3286
3709
  TimePeriod: DateInterval | undefined;
3287
3710
  /**
3711
+ * @public
3288
3712
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
3289
3713
  * the response from a previous call has more results than the maximum page size.</p>
3290
3714
  */
@@ -3295,19 +3719,23 @@ export interface GetSavingsPlansUtilizationDetailsResponse {
3295
3719
  */
3296
3720
  export interface GetTagsResponse {
3297
3721
  /**
3722
+ * @public
3298
3723
  * <p>The token for the next set of retrievable results. Amazon Web Services provides the token
3299
3724
  * when the response from a previous call has more results than the maximum page size.</p>
3300
3725
  */
3301
3726
  NextPageToken?: string;
3302
3727
  /**
3728
+ * @public
3303
3729
  * <p>The tags that match your request.</p>
3304
3730
  */
3305
3731
  Tags: string[] | undefined;
3306
3732
  /**
3733
+ * @public
3307
3734
  * <p>The number of query results that Amazon Web Services returns at a time.</p>
3308
3735
  */
3309
3736
  ReturnSize: number | undefined;
3310
3737
  /**
3738
+ * @public
3311
3739
  * <p>The total number of query results.</p>
3312
3740
  */
3313
3741
  TotalSize: number | undefined;
@@ -3317,10 +3745,12 @@ export interface GetTagsResponse {
3317
3745
  */
3318
3746
  export interface GetUsageForecastResponse {
3319
3747
  /**
3748
+ * @public
3320
3749
  * <p>How much you're forecasted to use over the forecast period.</p>
3321
3750
  */
3322
3751
  Total?: MetricValue;
3323
3752
  /**
3753
+ * @public
3324
3754
  * <p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a
3325
3755
  * list of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>
3326
3756
  */
@@ -3370,14 +3800,17 @@ export type CostAllocationTagType = (typeof CostAllocationTagType)[keyof typeof
3370
3800
  */
3371
3801
  export interface ListCostAllocationTagsRequest {
3372
3802
  /**
3803
+ * @public
3373
3804
  * <p>The status of cost allocation tag keys that are returned for this request. </p>
3374
3805
  */
3375
3806
  Status?: CostAllocationTagStatus | string;
3376
3807
  /**
3808
+ * @public
3377
3809
  * <p>The list of cost allocation tag keys that are returned for this request. </p>
3378
3810
  */
3379
3811
  TagKeys?: string[];
3380
3812
  /**
3813
+ * @public
3381
3814
  * <p>The type of <code>CostAllocationTag</code> object that are returned for this request. The
3382
3815
  * <code>AWSGenerated</code> type tags are tags that Amazon Web Services defines and applies to
3383
3816
  * support Amazon Web Services resources for cost allocation purposes. The
@@ -3386,11 +3819,13 @@ export interface ListCostAllocationTagsRequest {
3386
3819
  */
3387
3820
  Type?: CostAllocationTagType | string;
3388
3821
  /**
3822
+ * @public
3389
3823
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
3390
3824
  * the response from a previous call has more results than the maximum page size. </p>
3391
3825
  */
3392
3826
  NextToken?: string;
3393
3827
  /**
3828
+ * @public
3394
3829
  * <p>The maximum number of objects that are returned for this request. By default, the request
3395
3830
  * returns 100 results. </p>
3396
3831
  */
@@ -3403,10 +3838,12 @@ export interface ListCostAllocationTagsRequest {
3403
3838
  */
3404
3839
  export interface CostAllocationTag {
3405
3840
  /**
3841
+ * @public
3406
3842
  * <p>The key for the cost allocation tag. </p>
3407
3843
  */
3408
3844
  TagKey: string | undefined;
3409
3845
  /**
3846
+ * @public
3410
3847
  * <p>The type of cost allocation tag. You can use <code>AWSGenerated</code> or
3411
3848
  * <code>UserDefined</code> type tags. <code>AWSGenerated</code> type tags are tags
3412
3849
  * that Amazon Web Services defines and applies to support Amazon Web Services resources for
@@ -3415,6 +3852,7 @@ export interface CostAllocationTag {
3415
3852
  */
3416
3853
  Type: CostAllocationTagType | string | undefined;
3417
3854
  /**
3855
+ * @public
3418
3856
  * <p>The status of a cost allocation tag. </p>
3419
3857
  */
3420
3858
  Status: CostAllocationTagStatus | string | undefined;
@@ -3424,10 +3862,12 @@ export interface CostAllocationTag {
3424
3862
  */
3425
3863
  export interface ListCostAllocationTagsResponse {
3426
3864
  /**
3865
+ * @public
3427
3866
  * <p>A list of cost allocation tags that includes the detailed metadata for each one. </p>
3428
3867
  */
3429
3868
  CostAllocationTags?: CostAllocationTag[];
3430
3869
  /**
3870
+ * @public
3431
3871
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
3432
3872
  * the response from a previous call has more results than the maximum page size. </p>
3433
3873
  */
@@ -3438,15 +3878,18 @@ export interface ListCostAllocationTagsResponse {
3438
3878
  */
3439
3879
  export interface ListCostCategoryDefinitionsRequest {
3440
3880
  /**
3881
+ * @public
3441
3882
  * <p>The date when the Cost Category was effective. </p>
3442
3883
  */
3443
3884
  EffectiveOn?: string;
3444
3885
  /**
3886
+ * @public
3445
3887
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
3446
3888
  * when the response from a previous call has more results than the maximum page size. </p>
3447
3889
  */
3448
3890
  NextToken?: string;
3449
3891
  /**
3892
+ * @public
3450
3893
  * <p>The number of entries a paginated response contains. </p>
3451
3894
  */
3452
3895
  MaxResults?: number;
@@ -3460,35 +3903,43 @@ export interface ListCostCategoryDefinitionsRequest {
3460
3903
  */
3461
3904
  export interface CostCategoryReference {
3462
3905
  /**
3906
+ * @public
3463
3907
  * <p>The unique identifier for your Cost Category. </p>
3464
3908
  */
3465
3909
  CostCategoryArn?: string;
3466
3910
  /**
3911
+ * @public
3467
3912
  * <p>The unique name of the Cost Category.</p>
3468
3913
  */
3469
3914
  Name?: string;
3470
3915
  /**
3916
+ * @public
3471
3917
  * <p>The Cost Category's effective start date.</p>
3472
3918
  */
3473
3919
  EffectiveStart?: string;
3474
3920
  /**
3921
+ * @public
3475
3922
  * <p>The Cost Category's effective end date.</p>
3476
3923
  */
3477
3924
  EffectiveEnd?: string;
3478
3925
  /**
3926
+ * @public
3479
3927
  * <p>The number of rules that are associated with a specific Cost Category. </p>
3480
3928
  */
3481
3929
  NumberOfRules?: number;
3482
3930
  /**
3931
+ * @public
3483
3932
  * <p>The list of processing statuses for Cost Management products for a specific cost
3484
3933
  * category. </p>
3485
3934
  */
3486
3935
  ProcessingStatus?: CostCategoryProcessingStatus[];
3487
3936
  /**
3937
+ * @public
3488
3938
  * <p>A list of unique cost category values in a specific cost category. </p>
3489
3939
  */
3490
3940
  Values?: string[];
3491
3941
  /**
3942
+ * @public
3492
3943
  * <p>The
3493
3944
  * default value for the cost category.</p>
3494
3945
  */
@@ -3499,11 +3950,13 @@ export interface CostCategoryReference {
3499
3950
  */
3500
3951
  export interface ListCostCategoryDefinitionsResponse {
3501
3952
  /**
3953
+ * @public
3502
3954
  * <p>A reference to a Cost Category that contains enough information to identify the Cost
3503
3955
  * Category. </p>
3504
3956
  */
3505
3957
  CostCategoryReferences?: CostCategoryReference[];
3506
3958
  /**
3959
+ * @public
3507
3960
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
3508
3961
  * the response from a previous call has more results than the maximum page size. </p>
3509
3962
  */
@@ -3527,18 +3980,22 @@ export type GenerationStatus = (typeof GenerationStatus)[keyof typeof Generation
3527
3980
  */
3528
3981
  export interface ListSavingsPlansPurchaseRecommendationGenerationRequest {
3529
3982
  /**
3983
+ * @public
3530
3984
  * <p>The status of the recommendation generation.</p>
3531
3985
  */
3532
3986
  GenerationStatus?: GenerationStatus | string;
3533
3987
  /**
3988
+ * @public
3534
3989
  * <p>The IDs for each specific recommendation.</p>
3535
3990
  */
3536
3991
  RecommendationIds?: string[];
3537
3992
  /**
3993
+ * @public
3538
3994
  * <p>The number of recommendations that you want returned in a single response object.</p>
3539
3995
  */
3540
3996
  PageSize?: number;
3541
3997
  /**
3998
+ * @public
3542
3999
  * <p>The token to retrieve the next set of results.</p>
3543
4000
  */
3544
4001
  NextPageToken?: string;
@@ -3549,23 +4006,28 @@ export interface ListSavingsPlansPurchaseRecommendationGenerationRequest {
3549
4006
  */
3550
4007
  export interface GenerationSummary {
3551
4008
  /**
4009
+ * @public
3552
4010
  * <p>Indicates the ID for this specific recommendation.</p>
3553
4011
  */
3554
4012
  RecommendationId?: string;
3555
4013
  /**
4014
+ * @public
3556
4015
  * <p>Indicates whether the recommendation generation succeeded, is processing, or
3557
4016
  * failed.</p>
3558
4017
  */
3559
4018
  GenerationStatus?: GenerationStatus | string;
3560
4019
  /**
4020
+ * @public
3561
4021
  * <p>Indicates the start time of the recommendation generation.</p>
3562
4022
  */
3563
4023
  GenerationStartedTime?: string;
3564
4024
  /**
4025
+ * @public
3565
4026
  * <p>Indicates the completion time of the recommendation generation.</p>
3566
4027
  */
3567
4028
  GenerationCompletionTime?: string;
3568
4029
  /**
4030
+ * @public
3569
4031
  * <p>Indicates the estimated time for when the recommendation generation will
3570
4032
  * complete.</p>
3571
4033
  */
@@ -3576,10 +4038,12 @@ export interface GenerationSummary {
3576
4038
  */
3577
4039
  export interface ListSavingsPlansPurchaseRecommendationGenerationResponse {
3578
4040
  /**
4041
+ * @public
3579
4042
  * <p>The list of historical recommendation generations.</p>
3580
4043
  */
3581
4044
  GenerationSummaryList?: GenerationSummary[];
3582
4045
  /**
4046
+ * @public
3583
4047
  * <p>The token to retrieve the next set of results.</p>
3584
4048
  */
3585
4049
  NextPageToken?: string;
@@ -3589,6 +4053,7 @@ export interface ListSavingsPlansPurchaseRecommendationGenerationResponse {
3589
4053
  */
3590
4054
  export interface ListTagsForResourceRequest {
3591
4055
  /**
4056
+ * @public
3592
4057
  * <p>The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see
3593
4058
  * <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html">ResourceTag</a>.</p>
3594
4059
  */
@@ -3599,6 +4064,7 @@ export interface ListTagsForResourceRequest {
3599
4064
  */
3600
4065
  export interface ListTagsForResourceResponse {
3601
4066
  /**
4067
+ * @public
3602
4068
  * <p>A list of tag key value pairs that are associated with the resource. </p>
3603
4069
  */
3604
4070
  ResourceTags?: ResourceTag[];
@@ -3608,10 +4074,12 @@ export interface ListTagsForResourceResponse {
3608
4074
  */
3609
4075
  export interface ProvideAnomalyFeedbackRequest {
3610
4076
  /**
4077
+ * @public
3611
4078
  * <p>A cost anomaly ID. </p>
3612
4079
  */
3613
4080
  AnomalyId: string | undefined;
3614
4081
  /**
4082
+ * @public
3615
4083
  * <p>Describes whether the cost anomaly was a planned activity or you considered it an anomaly.
3616
4084
  * </p>
3617
4085
  */
@@ -3622,6 +4090,7 @@ export interface ProvideAnomalyFeedbackRequest {
3622
4090
  */
3623
4091
  export interface ProvideAnomalyFeedbackResponse {
3624
4092
  /**
4093
+ * @public
3625
4094
  * <p>The ID of the modified cost anomaly. </p>
3626
4095
  */
3627
4096
  AnomalyId: string | undefined;
@@ -3649,14 +4118,17 @@ export interface StartSavingsPlansPurchaseRecommendationGenerationRequest {
3649
4118
  */
3650
4119
  export interface StartSavingsPlansPurchaseRecommendationGenerationResponse {
3651
4120
  /**
4121
+ * @public
3652
4122
  * <p>The ID for this specific recommendation.</p>
3653
4123
  */
3654
4124
  RecommendationId?: string;
3655
4125
  /**
4126
+ * @public
3656
4127
  * <p>The start time of the recommendation generation.</p>
3657
4128
  */
3658
4129
  GenerationStartedTime?: string;
3659
4130
  /**
4131
+ * @public
3660
4132
  * <p>The estimated time for when the recommendation generation will complete.</p>
3661
4133
  */
3662
4134
  EstimatedCompletionTime?: string;
@@ -3666,12 +4138,14 @@ export interface StartSavingsPlansPurchaseRecommendationGenerationResponse {
3666
4138
  */
3667
4139
  export interface TagResourceRequest {
3668
4140
  /**
4141
+ * @public
3669
4142
  * <p>The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see
3670
4143
  * <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html">ResourceTag</a>.
3671
4144
  * </p>
3672
4145
  */
3673
4146
  ResourceArn: string | undefined;
3674
4147
  /**
4148
+ * @public
3675
4149
  * <p> A list of tag key-value pairs to be added to the resource.</p>
3676
4150
  * <p>Each tag consists of a key and a value, and each key must be unique for the resource. The
3677
4151
  * following restrictions apply to resource tags:</p>
@@ -3730,12 +4204,14 @@ export declare class TooManyTagsException extends __BaseException {
3730
4204
  */
3731
4205
  export interface UntagResourceRequest {
3732
4206
  /**
4207
+ * @public
3733
4208
  * <p>The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see
3734
4209
  * <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html">ResourceTag</a>.
3735
4210
  * </p>
3736
4211
  */
3737
4212
  ResourceArn: string | undefined;
3738
4213
  /**
4214
+ * @public
3739
4215
  * <p>A list of tag keys associated with tags that need to be removed from the resource. If you
3740
4216
  * specify a tag key that doesn't exist, it's ignored. Although the maximum number of array
3741
4217
  * members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
@@ -3753,10 +4229,12 @@ export interface UntagResourceResponse {
3753
4229
  */
3754
4230
  export interface UpdateAnomalyMonitorRequest {
3755
4231
  /**
4232
+ * @public
3756
4233
  * <p>Cost anomaly monitor Amazon Resource Names (ARNs). </p>
3757
4234
  */
3758
4235
  MonitorArn: string | undefined;
3759
4236
  /**
4237
+ * @public
3760
4238
  * <p>The new name for the cost anomaly monitor. </p>
3761
4239
  */
3762
4240
  MonitorName?: string;
@@ -3766,6 +4244,7 @@ export interface UpdateAnomalyMonitorRequest {
3766
4244
  */
3767
4245
  export interface UpdateAnomalyMonitorResponse {
3768
4246
  /**
4247
+ * @public
3769
4248
  * <p>A cost anomaly monitor ARN. </p>
3770
4249
  */
3771
4250
  MonitorArn: string | undefined;
@@ -3775,6 +4254,7 @@ export interface UpdateAnomalyMonitorResponse {
3775
4254
  */
3776
4255
  export interface UpdateAnomalySubscriptionResponse {
3777
4256
  /**
4257
+ * @public
3778
4258
  * <p>A cost anomaly subscription ARN. </p>
3779
4259
  */
3780
4260
  SubscriptionArn: string | undefined;
@@ -3786,10 +4266,12 @@ export interface UpdateAnomalySubscriptionResponse {
3786
4266
  */
3787
4267
  export interface CostAllocationTagStatusEntry {
3788
4268
  /**
4269
+ * @public
3789
4270
  * <p>The key for the cost allocation tag. </p>
3790
4271
  */
3791
4272
  TagKey: string | undefined;
3792
4273
  /**
4274
+ * @public
3793
4275
  * <p>The status of a cost allocation tag. </p>
3794
4276
  */
3795
4277
  Status: CostAllocationTagStatus | string | undefined;
@@ -3799,6 +4281,7 @@ export interface CostAllocationTagStatusEntry {
3799
4281
  */
3800
4282
  export interface UpdateCostAllocationTagsStatusRequest {
3801
4283
  /**
4284
+ * @public
3802
4285
  * <p>The list of <code>CostAllocationTagStatusEntry</code> objects that are used to update cost
3803
4286
  * allocation tags status for this request. </p>
3804
4287
  */
@@ -3811,14 +4294,17 @@ export interface UpdateCostAllocationTagsStatusRequest {
3811
4294
  */
3812
4295
  export interface UpdateCostAllocationTagsStatusError {
3813
4296
  /**
4297
+ * @public
3814
4298
  * <p>The key for the cost allocation tag. </p>
3815
4299
  */
3816
4300
  TagKey?: string;
3817
4301
  /**
4302
+ * @public
3818
4303
  * <p>An error code representing why the action failed on this entry. </p>
3819
4304
  */
3820
4305
  Code?: string;
3821
4306
  /**
4307
+ * @public
3822
4308
  * <p>A message explaining why the action failed on this entry. </p>
3823
4309
  */
3824
4310
  Message?: string;
@@ -3828,6 +4314,7 @@ export interface UpdateCostAllocationTagsStatusError {
3828
4314
  */
3829
4315
  export interface UpdateCostAllocationTagsStatusResponse {
3830
4316
  /**
4317
+ * @public
3831
4318
  * <p>A list of <code>UpdateCostAllocationTagsStatusError</code> objects with error details
3832
4319
  * about each cost allocation tag that can't be updated. If there's no failure, an empty array
3833
4320
  * returns. </p>
@@ -3839,10 +4326,12 @@ export interface UpdateCostAllocationTagsStatusResponse {
3839
4326
  */
3840
4327
  export interface UpdateCostCategoryDefinitionResponse {
3841
4328
  /**
4329
+ * @public
3842
4330
  * <p>The unique identifier for your Cost Category. </p>
3843
4331
  */
3844
4332
  CostCategoryArn?: string;
3845
4333
  /**
4334
+ * @public
3846
4335
  * <p>The Cost Category's effective start date. It can only be a billing start date (first day of the month).</p>
3847
4336
  */
3848
4337
  EffectiveStart?: string;
@@ -3974,26 +4463,32 @@ export interface UpdateCostCategoryDefinitionResponse {
3974
4463
  */
3975
4464
  export interface Expression {
3976
4465
  /**
4466
+ * @public
3977
4467
  * <p>Return results that match either <code>Dimension</code> object.</p>
3978
4468
  */
3979
4469
  Or?: Expression[];
3980
4470
  /**
4471
+ * @public
3981
4472
  * <p>Return results that match both <code>Dimension</code> objects.</p>
3982
4473
  */
3983
4474
  And?: Expression[];
3984
4475
  /**
4476
+ * @public
3985
4477
  * <p>Return results that don't match a <code>Dimension</code> object.</p>
3986
4478
  */
3987
4479
  Not?: Expression;
3988
4480
  /**
4481
+ * @public
3989
4482
  * <p>The specific <code>Dimension</code> to use for <code>Expression</code>.</p>
3990
4483
  */
3991
4484
  Dimensions?: DimensionValues;
3992
4485
  /**
4486
+ * @public
3993
4487
  * <p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>
3994
4488
  */
3995
4489
  Tags?: TagValues;
3996
4490
  /**
4491
+ * @public
3997
4492
  * <p>The filter that's based on <code>CostCategory</code> values.</p>
3998
4493
  */
3999
4494
  CostCategories?: CostCategoryValues;
@@ -4006,34 +4501,42 @@ export interface Expression {
4006
4501
  */
4007
4502
  export interface AnomalyMonitor {
4008
4503
  /**
4504
+ * @public
4009
4505
  * <p>The Amazon Resource Name (ARN) value. </p>
4010
4506
  */
4011
4507
  MonitorArn?: string;
4012
4508
  /**
4509
+ * @public
4013
4510
  * <p>The name of the monitor. </p>
4014
4511
  */
4015
4512
  MonitorName: string | undefined;
4016
4513
  /**
4514
+ * @public
4017
4515
  * <p>The date when the monitor was created. </p>
4018
4516
  */
4019
4517
  CreationDate?: string;
4020
4518
  /**
4519
+ * @public
4021
4520
  * <p>The date when the monitor was last updated. </p>
4022
4521
  */
4023
4522
  LastUpdatedDate?: string;
4024
4523
  /**
4524
+ * @public
4025
4525
  * <p>The date when the monitor last evaluated for anomalies. </p>
4026
4526
  */
4027
4527
  LastEvaluatedDate?: string;
4028
4528
  /**
4529
+ * @public
4029
4530
  * <p>The possible type values. </p>
4030
4531
  */
4031
4532
  MonitorType: MonitorType | string | undefined;
4032
4533
  /**
4534
+ * @public
4033
4535
  * <p>The dimensions to evaluate. </p>
4034
4536
  */
4035
4537
  MonitorDimension?: MonitorDimension | string;
4036
4538
  /**
4539
+ * @public
4037
4540
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
4038
4541
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
4039
4542
  * documentation for each specific API to see what is supported.</p>
@@ -4159,6 +4662,7 @@ export interface AnomalyMonitor {
4159
4662
  */
4160
4663
  MonitorSpecification?: Expression;
4161
4664
  /**
4665
+ * @public
4162
4666
  * <p>The value for evaluated dimensions. </p>
4163
4667
  */
4164
4668
  DimensionalValueCount?: number;
@@ -4183,22 +4687,27 @@ export interface AnomalyMonitor {
4183
4687
  */
4184
4688
  export interface AnomalySubscription {
4185
4689
  /**
4690
+ * @public
4186
4691
  * <p>The <code>AnomalySubscription</code> Amazon Resource Name (ARN). </p>
4187
4692
  */
4188
4693
  SubscriptionArn?: string;
4189
4694
  /**
4695
+ * @public
4190
4696
  * <p>Your unique account identifier. </p>
4191
4697
  */
4192
4698
  AccountId?: string;
4193
4699
  /**
4700
+ * @public
4194
4701
  * <p>A list of cost anomaly monitors. </p>
4195
4702
  */
4196
4703
  MonitorArnList: string[] | undefined;
4197
4704
  /**
4705
+ * @public
4198
4706
  * <p>A list of subscribers to notify. </p>
4199
4707
  */
4200
4708
  Subscribers: Subscriber[] | undefined;
4201
4709
  /**
4710
+ * @public
4202
4711
  * @deprecated
4203
4712
  *
4204
4713
  * <p>(deprecated)</p>
@@ -4213,6 +4722,7 @@ export interface AnomalySubscription {
4213
4722
  */
4214
4723
  Threshold?: number;
4215
4724
  /**
4725
+ * @public
4216
4726
  * <p>The frequency that anomaly notifications are sent. Notifications are sent either over
4217
4727
  * email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more
4218
4728
  * information, see <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html">Creating an Amazon SNS topic for
@@ -4220,10 +4730,12 @@ export interface AnomalySubscription {
4220
4730
  */
4221
4731
  Frequency: AnomalySubscriptionFrequency | string | undefined;
4222
4732
  /**
4733
+ * @public
4223
4734
  * <p>The name for the subscription. </p>
4224
4735
  */
4225
4736
  SubscriptionName: string | undefined;
4226
4737
  /**
4738
+ * @public
4227
4739
  * <p>An <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html">Expression</a>
4228
4740
  * object used to specify the anomalies that you want to generate alerts for. This supports
4229
4741
  * dimensions and nested expressions. The supported dimensions are
@@ -4278,11 +4790,13 @@ export interface AnomalySubscription {
4278
4790
  */
4279
4791
  export interface CostCategoryRule {
4280
4792
  /**
4793
+ * @public
4281
4794
  * <p>The
4282
4795
  * default value for the cost category.</p>
4283
4796
  */
4284
4797
  Value?: string;
4285
4798
  /**
4799
+ * @public
4286
4800
  * <p>An <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html">Expression</a>
4287
4801
  * object used to categorize costs. This supports dimensions, tags, and nested expressions.
4288
4802
  * Currently the only dimensions supported are <code>LINKED_ACCOUNT</code>,
@@ -4297,11 +4811,13 @@ export interface CostCategoryRule {
4297
4811
  */
4298
4812
  Rule?: Expression;
4299
4813
  /**
4814
+ * @public
4300
4815
  * <p>The value the line item is categorized as if the line item contains the matched
4301
4816
  * dimension.</p>
4302
4817
  */
4303
4818
  InheritedValue?: CostCategoryInheritedValueDimension;
4304
4819
  /**
4820
+ * @public
4305
4821
  * <p>You can define the <code>CostCategoryRule</code> rule type as either
4306
4822
  * <code>REGULAR</code> or <code>INHERITED_VALUE</code>. The
4307
4823
  * <code>INHERITED_VALUE</code> rule type adds the flexibility to define a rule that
@@ -4318,6 +4834,7 @@ export interface CostCategoryRule {
4318
4834
  */
4319
4835
  export interface GetCostAndUsageRequest {
4320
4836
  /**
4837
+ * @public
4321
4838
  * <p>Sets the start date and end date for retrieving Amazon Web Services costs. The start
4322
4839
  * date is inclusive, but the end date is exclusive. For example, if <code>start</code> is
4323
4840
  * <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and
@@ -4326,6 +4843,7 @@ export interface GetCostAndUsageRequest {
4326
4843
  */
4327
4844
  TimePeriod: DateInterval | undefined;
4328
4845
  /**
4846
+ * @public
4329
4847
  * <p>Sets the Amazon Web Services cost granularity to <code>MONTHLY</code> or
4330
4848
  * <code>DAILY</code>, or <code>HOURLY</code>. If <code>Granularity</code> isn't set, the
4331
4849
  * response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or
@@ -4333,6 +4851,7 @@ export interface GetCostAndUsageRequest {
4333
4851
  */
4334
4852
  Granularity: Granularity | string | undefined;
4335
4853
  /**
4854
+ * @public
4336
4855
  * <p>Filters Amazon Web Services costs by different dimensions. For example, you can specify
4337
4856
  * <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated
4338
4857
  * with that account's usage of that service. You can nest <code>Expression</code> objects to
@@ -4346,6 +4865,7 @@ export interface GetCostAndUsageRequest {
4346
4865
  */
4347
4866
  Filter?: Expression;
4348
4867
  /**
4868
+ * @public
4349
4869
  * <p>Which metrics are returned in the query. For more information about blended and
4350
4870
  * unblended rates, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/">Why does the "blended" annotation
4351
4871
  * appear on some line items in my bill?</a>. </p>
@@ -4366,6 +4886,7 @@ export interface GetCostAndUsageRequest {
4366
4886
  */
4367
4887
  Metrics: string[] | undefined;
4368
4888
  /**
4889
+ * @public
4369
4890
  * <p>You can group Amazon Web Services costs using up to two different groups, either
4370
4891
  * dimensions, tag keys, cost categories, or any two group by types.</p>
4371
4892
  * <p>Valid values for the <code>DIMENSION</code> type are <code>AZ</code>,
@@ -4378,6 +4899,7 @@ export interface GetCostAndUsageRequest {
4378
4899
  */
4379
4900
  GroupBy?: GroupDefinition[];
4380
4901
  /**
4902
+ * @public
4381
4903
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
4382
4904
  * when the response from a previous call has more results than the maximum page size.</p>
4383
4905
  */
@@ -4388,6 +4910,7 @@ export interface GetCostAndUsageRequest {
4388
4910
  */
4389
4911
  export interface GetCostAndUsageWithResourcesRequest {
4390
4912
  /**
4913
+ * @public
4391
4914
  * <p>Sets the start and end dates for retrieving Amazon Web Services costs. The range must
4392
4915
  * be within the last 14 days (the start date cannot be earlier than 14 days ago). The start date
4393
4916
  * is inclusive, but the end date is exclusive. For example, if <code>start</code> is
@@ -4397,6 +4920,7 @@ export interface GetCostAndUsageWithResourcesRequest {
4397
4920
  */
4398
4921
  TimePeriod: DateInterval | undefined;
4399
4922
  /**
4923
+ * @public
4400
4924
  * <p>Sets the Amazon Web Services cost granularity to <code>MONTHLY</code>,
4401
4925
  * <code>DAILY</code>, or <code>HOURLY</code>. If <code>Granularity</code> isn't set, the
4402
4926
  * response object doesn't include the <code>Granularity</code>, <code>MONTHLY</code>,
@@ -4404,6 +4928,7 @@ export interface GetCostAndUsageWithResourcesRequest {
4404
4928
  */
4405
4929
  Granularity: Granularity | string | undefined;
4406
4930
  /**
4931
+ * @public
4407
4932
  * <p>Filters Amazon Web Services costs by different dimensions. For example, you can specify
4408
4933
  * <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated
4409
4934
  * with that account's usage of that service. You can nest <code>Expression</code> objects to
@@ -4420,6 +4945,7 @@ export interface GetCostAndUsageWithResourcesRequest {
4420
4945
  */
4421
4946
  Filter: Expression | undefined;
4422
4947
  /**
4948
+ * @public
4423
4949
  * <p>Which metrics are returned in the query. For more information about blended and
4424
4950
  * unblended rates, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/">Why does the "blended" annotation
4425
4951
  * appear on some line items in my bill?</a>. </p>
@@ -4441,11 +4967,13 @@ export interface GetCostAndUsageWithResourcesRequest {
4441
4967
  */
4442
4968
  Metrics?: string[];
4443
4969
  /**
4970
+ * @public
4444
4971
  * <p>You can group Amazon Web Services costs using up to two different groups:
4445
4972
  * <code>DIMENSION</code>, <code>TAG</code>, <code>COST_CATEGORY</code>.</p>
4446
4973
  */
4447
4974
  GroupBy?: GroupDefinition[];
4448
4975
  /**
4976
+ * @public
4449
4977
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
4450
4978
  * when the response from a previous call has more results than the maximum page size.</p>
4451
4979
  */
@@ -4456,6 +4984,7 @@ export interface GetCostAndUsageWithResourcesRequest {
4456
4984
  */
4457
4985
  export interface GetCostCategoriesRequest {
4458
4986
  /**
4987
+ * @public
4459
4988
  * <p>The value that you want to search the filter values for.</p>
4460
4989
  * <p>If you don't specify a <code>CostCategoryName</code>, <code>SearchString</code> is used to
4461
4990
  * filter Cost Category names that match the <code>SearchString</code> pattern. If you specify a
@@ -4464,14 +4993,17 @@ export interface GetCostCategoriesRequest {
4464
4993
  */
4465
4994
  SearchString?: string;
4466
4995
  /**
4996
+ * @public
4467
4997
  * <p>The time period of the request. </p>
4468
4998
  */
4469
4999
  TimePeriod: DateInterval | undefined;
4470
5000
  /**
5001
+ * @public
4471
5002
  * <p>The unique name of the Cost Category.</p>
4472
5003
  */
4473
5004
  CostCategoryName?: string;
4474
5005
  /**
5006
+ * @public
4475
5007
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
4476
5008
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
4477
5009
  * documentation for each specific API to see what is supported.</p>
@@ -4597,6 +5129,7 @@ export interface GetCostCategoriesRequest {
4597
5129
  */
4598
5130
  Filter?: Expression;
4599
5131
  /**
5132
+ * @public
4600
5133
  * <p>The value that you sort the data by.</p>
4601
5134
  * <p>The key represents the cost and usage metrics. The following values are supported:</p>
4602
5135
  * <ul>
@@ -4643,6 +5176,7 @@ export interface GetCostCategoriesRequest {
4643
5176
  */
4644
5177
  SortBy?: SortDefinition[];
4645
5178
  /**
5179
+ * @public
4646
5180
  * <p>This field is only used when the <code>SortBy</code> value is provided in the
4647
5181
  * request.</p>
4648
5182
  * <p>The maximum number of objects that are returned for this request. If
@@ -4652,6 +5186,7 @@ export interface GetCostCategoriesRequest {
4652
5186
  */
4653
5187
  MaxResults?: number;
4654
5188
  /**
5189
+ * @public
4655
5190
  * <p>If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of
4656
5191
  * objects, provide the NextPageToken from the previous call in your next request.</p>
4657
5192
  */
@@ -4662,11 +5197,13 @@ export interface GetCostCategoriesRequest {
4662
5197
  */
4663
5198
  export interface GetCostForecastRequest {
4664
5199
  /**
5200
+ * @public
4665
5201
  * <p>The period of time that you want the forecast to cover. The start date must be equal to or
4666
5202
  * no later than the current date to avoid a validation error.</p>
4667
5203
  */
4668
5204
  TimePeriod: DateInterval | undefined;
4669
5205
  /**
5206
+ * @public
4670
5207
  * <p>Which metric Cost Explorer uses to create your forecast. For more information about
4671
5208
  * blended and unblended rates, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/">Why does the "blended" annotation
4672
5209
  * appear on some line items in my bill?</a>. </p>
@@ -4691,6 +5228,7 @@ export interface GetCostForecastRequest {
4691
5228
  */
4692
5229
  Metric: Metric | string | undefined;
4693
5230
  /**
5231
+ * @public
4694
5232
  * <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code>
4695
5233
  * forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>
4696
5234
  * <p>The <code>GetCostForecast</code> operation supports only <code>DAILY</code> and
@@ -4698,6 +5236,7 @@ export interface GetCostForecastRequest {
4698
5236
  */
4699
5237
  Granularity: Granularity | string | undefined;
4700
5238
  /**
5239
+ * @public
4701
5240
  * <p>The filters that you want to use to filter your forecast. The
4702
5241
  * <code>GetCostForecast</code> API supports filtering by the following dimensions:</p>
4703
5242
  * <ul>
@@ -4820,6 +5359,7 @@ export interface GetCostForecastRequest {
4820
5359
  */
4821
5360
  Filter?: Expression;
4822
5361
  /**
5362
+ * @public
4823
5363
  * <p>Cost Explorer always returns the mean forecast as a single point. You can request a
4824
5364
  * prediction interval around the mean by specifying a confidence level. The higher the
4825
5365
  * confidence level, the more confident Cost Explorer is about the actual value falling in the
@@ -4832,10 +5372,12 @@ export interface GetCostForecastRequest {
4832
5372
  */
4833
5373
  export interface GetDimensionValuesRequest {
4834
5374
  /**
5375
+ * @public
4835
5376
  * <p>The value that you want to search the filter values for.</p>
4836
5377
  */
4837
5378
  SearchString?: string;
4838
5379
  /**
5380
+ * @public
4839
5381
  * <p>The start date and end date for retrieving the dimension values. The start date is
4840
5382
  * inclusive, but the end date is exclusive. For example, if <code>start</code> is
4841
5383
  * <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and
@@ -4844,12 +5386,14 @@ export interface GetDimensionValuesRequest {
4844
5386
  */
4845
5387
  TimePeriod: DateInterval | undefined;
4846
5388
  /**
5389
+ * @public
4847
5390
  * <p>The name of the dimension. Each <code>Dimension</code> is available for a different
4848
5391
  * <code>Context</code>. For more information, see <code>Context</code>.
4849
5392
  * <code>LINK_ACCOUNT_NAME</code> and <code>SERVICE_CODE</code> can only be used in <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html">CostCategoryRule</a>. </p>
4850
5393
  */
4851
5394
  Dimension: Dimension | string | undefined;
4852
5395
  /**
5396
+ * @public
4853
5397
  * <p>The context for the call to <code>GetDimensionValues</code>. This can be
4854
5398
  * <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is
4855
5399
  * <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the
@@ -5030,6 +5574,7 @@ export interface GetDimensionValuesRequest {
5030
5574
  */
5031
5575
  Context?: Context | string;
5032
5576
  /**
5577
+ * @public
5033
5578
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
5034
5579
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
5035
5580
  * documentation for each specific API to see what is supported.</p>
@@ -5155,6 +5700,7 @@ export interface GetDimensionValuesRequest {
5155
5700
  */
5156
5701
  Filter?: Expression;
5157
5702
  /**
5703
+ * @public
5158
5704
  * <p>The value that you want to sort the data by.</p>
5159
5705
  * <p>The key represents cost and usage metrics. The following values are supported:</p>
5160
5706
  * <ul>
@@ -5202,6 +5748,7 @@ export interface GetDimensionValuesRequest {
5202
5748
  */
5203
5749
  SortBy?: SortDefinition[];
5204
5750
  /**
5751
+ * @public
5205
5752
  * <p>This field is only used when SortBy is provided in the request. The maximum number of
5206
5753
  * objects that are returned for this request. If MaxResults isn't specified with SortBy, the
5207
5754
  * request returns 1000 results as the default value for this parameter.</p>
@@ -5209,6 +5756,7 @@ export interface GetDimensionValuesRequest {
5209
5756
  */
5210
5757
  MaxResults?: number;
5211
5758
  /**
5759
+ * @public
5212
5760
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
5213
5761
  * when the response from a previous call has more results than the maximum page size.</p>
5214
5762
  */
@@ -5221,6 +5769,7 @@ export interface GetDimensionValuesRequest {
5221
5769
  */
5222
5770
  export interface GetReservationCoverageRequest {
5223
5771
  /**
5772
+ * @public
5224
5773
  * <p>The start and end dates of the period that you want to retrieve data about reservation
5225
5774
  * coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the
5226
5775
  * current month. The start date is inclusive, but the end date is exclusive. For example, if
@@ -5231,6 +5780,7 @@ export interface GetReservationCoverageRequest {
5231
5780
  */
5232
5781
  TimePeriod: DateInterval | undefined;
5233
5782
  /**
5783
+ * @public
5234
5784
  * <p>You can group the data by the following attributes:</p>
5235
5785
  * <ul>
5236
5786
  * <li>
@@ -5270,6 +5820,7 @@ export interface GetReservationCoverageRequest {
5270
5820
  */
5271
5821
  GroupBy?: GroupDefinition[];
5272
5822
  /**
5823
+ * @public
5273
5824
  * <p>The granularity of the Amazon Web Services cost data for the reservation. Valid values
5274
5825
  * are <code>MONTHLY</code> and <code>DAILY</code>.</p>
5275
5826
  * <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If
@@ -5280,6 +5831,7 @@ export interface GetReservationCoverageRequest {
5280
5831
  */
5281
5832
  Granularity?: Granularity | string;
5282
5833
  /**
5834
+ * @public
5283
5835
  * <p>Filters utilization data by dimensions. You can filter by the following
5284
5836
  * dimensions:</p>
5285
5837
  * <ul>
@@ -5331,17 +5883,20 @@ export interface GetReservationCoverageRequest {
5331
5883
  */
5332
5884
  Filter?: Expression;
5333
5885
  /**
5886
+ * @public
5334
5887
  * <p>The measurement that you want your reservation coverage reported in.</p>
5335
5888
  * <p>Valid values are <code>Hour</code>, <code>Unit</code>, and <code>Cost</code>. You can use
5336
5889
  * multiple values in a request.</p>
5337
5890
  */
5338
5891
  Metrics?: string[];
5339
5892
  /**
5893
+ * @public
5340
5894
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
5341
5895
  * when the response from a previous call has more results than the maximum page size.</p>
5342
5896
  */
5343
5897
  NextPageToken?: string;
5344
5898
  /**
5899
+ * @public
5345
5900
  * <p>The value by which you want to sort the data.</p>
5346
5901
  * <p>The following values are supported for <code>Key</code>:</p>
5347
5902
  * <ul>
@@ -5401,6 +5956,7 @@ export interface GetReservationCoverageRequest {
5401
5956
  */
5402
5957
  SortBy?: SortDefinition;
5403
5958
  /**
5959
+ * @public
5404
5960
  * <p>The maximum number of objects that you returned for this request. If more objects are
5405
5961
  * available, in the response, Amazon Web Services provides a NextPageToken value that you can use
5406
5962
  * in a subsequent call to get the next batch of objects.</p>
@@ -5412,14 +5968,17 @@ export interface GetReservationCoverageRequest {
5412
5968
  */
5413
5969
  export interface GetReservationPurchaseRecommendationRequest {
5414
5970
  /**
5971
+ * @public
5415
5972
  * <p>The account ID that's associated with the recommendation. </p>
5416
5973
  */
5417
5974
  AccountId?: string;
5418
5975
  /**
5976
+ * @public
5419
5977
  * <p>The specific service that you want recommendations for.</p>
5420
5978
  */
5421
5979
  Service: string | undefined;
5422
5980
  /**
5981
+ * @public
5423
5982
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
5424
5983
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
5425
5984
  * documentation for each specific API to see what is supported.</p>
@@ -5545,6 +6104,7 @@ export interface GetReservationPurchaseRecommendationRequest {
5545
6104
  */
5546
6105
  Filter?: Expression;
5547
6106
  /**
6107
+ * @public
5548
6108
  * <p>The account scope that you want your recommendations for. Amazon Web Services
5549
6109
  * calculates recommendations including the management account and member accounts if the value
5550
6110
  * is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are
@@ -5552,29 +6112,35 @@ export interface GetReservationPurchaseRecommendationRequest {
5552
6112
  */
5553
6113
  AccountScope?: AccountScope | string;
5554
6114
  /**
6115
+ * @public
5555
6116
  * <p>The number of previous days that you want Amazon Web Services to consider when it
5556
6117
  * calculates your recommendations.</p>
5557
6118
  */
5558
6119
  LookbackPeriodInDays?: LookbackPeriodInDays | string;
5559
6120
  /**
6121
+ * @public
5560
6122
  * <p>The reservation term that you want recommendations for.</p>
5561
6123
  */
5562
6124
  TermInYears?: TermInYears | string;
5563
6125
  /**
6126
+ * @public
5564
6127
  * <p>The reservation purchase option that you want recommendations for.</p>
5565
6128
  */
5566
6129
  PaymentOption?: PaymentOption | string;
5567
6130
  /**
6131
+ * @public
5568
6132
  * <p>The hardware specifications for the service instances that you want recommendations
5569
6133
  * for, such as standard or convertible Amazon EC2 instances.</p>
5570
6134
  */
5571
6135
  ServiceSpecification?: ServiceSpecification;
5572
6136
  /**
6137
+ * @public
5573
6138
  * <p>The number of recommendations that you want returned in a single response
5574
6139
  * object.</p>
5575
6140
  */
5576
6141
  PageSize?: number;
5577
6142
  /**
6143
+ * @public
5578
6144
  * <p>The pagination token that indicates the next set of results that you want to
5579
6145
  * retrieve.</p>
5580
6146
  */
@@ -5585,6 +6151,7 @@ export interface GetReservationPurchaseRecommendationRequest {
5585
6151
  */
5586
6152
  export interface GetReservationUtilizationRequest {
5587
6153
  /**
6154
+ * @public
5588
6155
  * <p>Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The
5589
6156
  * start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is
5590
6157
  * <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and
@@ -5593,10 +6160,12 @@ export interface GetReservationUtilizationRequest {
5593
6160
  */
5594
6161
  TimePeriod: DateInterval | undefined;
5595
6162
  /**
6163
+ * @public
5596
6164
  * <p>Groups only by <code>SUBSCRIPTION_ID</code>. Metadata is included.</p>
5597
6165
  */
5598
6166
  GroupBy?: GroupDefinition[];
5599
6167
  /**
6168
+ * @public
5600
6169
  * <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If
5601
6170
  * <code>Granularity</code> isn't set, the response object doesn't include
5602
6171
  * <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both
@@ -5607,6 +6176,7 @@ export interface GetReservationUtilizationRequest {
5607
6176
  */
5608
6177
  Granularity?: Granularity | string;
5609
6178
  /**
6179
+ * @public
5610
6180
  * <p>Filters utilization data by dimensions. You can filter by the following
5611
6181
  * dimensions:</p>
5612
6182
  * <ul>
@@ -5652,6 +6222,7 @@ export interface GetReservationUtilizationRequest {
5652
6222
  */
5653
6223
  Filter?: Expression;
5654
6224
  /**
6225
+ * @public
5655
6226
  * <p>The value that you want to sort the data by.</p>
5656
6227
  * <p>The following values are supported for <code>Key</code>:</p>
5657
6228
  * <ul>
@@ -5746,11 +6317,13 @@ export interface GetReservationUtilizationRequest {
5746
6317
  */
5747
6318
  SortBy?: SortDefinition;
5748
6319
  /**
6320
+ * @public
5749
6321
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
5750
6322
  * when the response from a previous call has more results than the maximum page size.</p>
5751
6323
  */
5752
6324
  NextPageToken?: string;
5753
6325
  /**
6326
+ * @public
5754
6327
  * <p>The maximum number of objects that you returned for this request. If more objects are
5755
6328
  * available, in the response, Amazon Web Services provides a NextPageToken value that you can use
5756
6329
  * in a subsequent call to get the next batch of objects.</p>
@@ -5762,6 +6335,7 @@ export interface GetReservationUtilizationRequest {
5762
6335
  */
5763
6336
  export interface GetRightsizingRecommendationRequest {
5764
6337
  /**
6338
+ * @public
5765
6339
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
5766
6340
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
5767
6341
  * documentation for each specific API to see what is supported.</p>
@@ -5887,6 +6461,7 @@ export interface GetRightsizingRecommendationRequest {
5887
6461
  */
5888
6462
  Filter?: Expression;
5889
6463
  /**
6464
+ * @public
5890
6465
  * <p>You can use Configuration to customize recommendations across two attributes. You can
5891
6466
  * choose to view recommendations for instances within the same instance families or across
5892
6467
  * different instance families. You can also choose to view your estimated savings that are
@@ -5895,15 +6470,18 @@ export interface GetRightsizingRecommendationRequest {
5895
6470
  */
5896
6471
  Configuration?: RightsizingRecommendationConfiguration;
5897
6472
  /**
6473
+ * @public
5898
6474
  * <p>The specific service that you want recommendations for. The only valid value for
5899
6475
  * <code>GetRightsizingRecommendation</code> is "<code>AmazonEC2</code>".</p>
5900
6476
  */
5901
6477
  Service: string | undefined;
5902
6478
  /**
6479
+ * @public
5903
6480
  * <p>The number of recommendations that you want returned in a single response object.</p>
5904
6481
  */
5905
6482
  PageSize?: number;
5906
6483
  /**
6484
+ * @public
5907
6485
  * <p>The pagination token that indicates the next set of results that you want to
5908
6486
  * retrieve.</p>
5909
6487
  */
@@ -5914,17 +6492,20 @@ export interface GetRightsizingRecommendationRequest {
5914
6492
  */
5915
6493
  export interface GetSavingsPlansCoverageRequest {
5916
6494
  /**
6495
+ * @public
5917
6496
  * <p>The time period that you want the usage and costs for. The <code>Start</code> date must be
5918
6497
  * within 13 months. The <code>End</code> date must be after the <code>Start</code> date, and
5919
6498
  * before the current date. Future dates can't be used as an <code>End</code> date.</p>
5920
6499
  */
5921
6500
  TimePeriod: DateInterval | undefined;
5922
6501
  /**
6502
+ * @public
5923
6503
  * <p>You can group the data using the attributes <code>INSTANCE_FAMILY</code>,
5924
6504
  * <code>REGION</code>, or <code>SERVICE</code>.</p>
5925
6505
  */
5926
6506
  GroupBy?: GroupDefinition[];
5927
6507
  /**
6508
+ * @public
5928
6509
  * <p>The granularity of the Amazon Web Services cost data for your Savings Plans.
5929
6510
  * <code>Granularity</code> can't be set if <code>GroupBy</code> is set.</p>
5930
6511
  * <p>The <code>GetSavingsPlansCoverage</code> operation supports only <code>DAILY</code> and
@@ -5932,6 +6513,7 @@ export interface GetSavingsPlansCoverageRequest {
5932
6513
  */
5933
6514
  Granularity?: Granularity | string;
5934
6515
  /**
6516
+ * @public
5935
6517
  * <p>Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans
5936
6518
  * usage with the following dimensions:</p>
5937
6519
  * <ul>
@@ -5964,21 +6546,25 @@ export interface GetSavingsPlansCoverageRequest {
5964
6546
  */
5965
6547
  Filter?: Expression;
5966
6548
  /**
6549
+ * @public
5967
6550
  * <p>The measurement that you want your Savings Plans coverage reported in. The only valid
5968
6551
  * value is <code>SpendCoveredBySavingsPlans</code>.</p>
5969
6552
  */
5970
6553
  Metrics?: string[];
5971
6554
  /**
6555
+ * @public
5972
6556
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
5973
6557
  * the response from a previous call has more results than the maximum page size.</p>
5974
6558
  */
5975
6559
  NextToken?: string;
5976
6560
  /**
6561
+ * @public
5977
6562
  * <p>The number of items to be returned in a response. The default is <code>20</code>, with a
5978
6563
  * minimum value of <code>1</code>.</p>
5979
6564
  */
5980
6565
  MaxResults?: number;
5981
6566
  /**
6567
+ * @public
5982
6568
  * <p>The value that you want to sort the data by.</p>
5983
6569
  * <p>The following values are supported for <code>Key</code>:</p>
5984
6570
  * <ul>
@@ -6028,18 +6614,22 @@ export interface GetSavingsPlansCoverageRequest {
6028
6614
  */
6029
6615
  export interface GetSavingsPlansPurchaseRecommendationRequest {
6030
6616
  /**
6617
+ * @public
6031
6618
  * <p>The Savings Plans recommendation type that's requested.</p>
6032
6619
  */
6033
6620
  SavingsPlansType: SupportedSavingsPlansType | string | undefined;
6034
6621
  /**
6622
+ * @public
6035
6623
  * <p>The savings plan recommendation term that's used to generate these recommendations.</p>
6036
6624
  */
6037
6625
  TermInYears: TermInYears | string | undefined;
6038
6626
  /**
6627
+ * @public
6039
6628
  * <p>The payment option that's used to generate these recommendations.</p>
6040
6629
  */
6041
6630
  PaymentOption: PaymentOption | string | undefined;
6042
6631
  /**
6632
+ * @public
6043
6633
  * <p>The account scope that you want your recommendations for. Amazon Web Services calculates
6044
6634
  * recommendations including the management account and member accounts if the value is set to
6045
6635
  * <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for
@@ -6047,19 +6637,23 @@ export interface GetSavingsPlansPurchaseRecommendationRequest {
6047
6637
  */
6048
6638
  AccountScope?: AccountScope | string;
6049
6639
  /**
6640
+ * @public
6050
6641
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
6051
6642
  * the response from a previous call has more results than the maximum page size.</p>
6052
6643
  */
6053
6644
  NextPageToken?: string;
6054
6645
  /**
6646
+ * @public
6055
6647
  * <p>The number of recommendations that you want returned in a single response object.</p>
6056
6648
  */
6057
6649
  PageSize?: number;
6058
6650
  /**
6651
+ * @public
6059
6652
  * <p>The lookback period that's used to generate the recommendation.</p>
6060
6653
  */
6061
6654
  LookbackPeriodInDays: LookbackPeriodInDays | string | undefined;
6062
6655
  /**
6656
+ * @public
6063
6657
  * <p>You can filter your recommendations by Account ID with the <code>LINKED_ACCOUNT</code>
6064
6658
  * dimension. To filter your recommendations by Account ID, specify <code>Key</code> as
6065
6659
  * <code>LINKED_ACCOUNT</code> and <code>Value</code> as the comma-separated Acount ID(s) that
@@ -6078,12 +6672,14 @@ export interface GetSavingsPlansPurchaseRecommendationRequest {
6078
6672
  */
6079
6673
  export interface GetSavingsPlansUtilizationDetailsRequest {
6080
6674
  /**
6675
+ * @public
6081
6676
  * <p>The time period that you want the usage and costs for. The <code>Start</code> date must be
6082
6677
  * within 13 months. The <code>End</code> date must be after the <code>Start</code> date, and
6083
6678
  * before the current date. Future dates can't be used as an <code>End</code> date.</p>
6084
6679
  */
6085
6680
  TimePeriod: DateInterval | undefined;
6086
6681
  /**
6682
+ * @public
6087
6683
  * <p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You
6088
6684
  * can filter data with the following dimensions:</p>
6089
6685
  * <ul>
@@ -6119,20 +6715,24 @@ export interface GetSavingsPlansUtilizationDetailsRequest {
6119
6715
  */
6120
6716
  Filter?: Expression;
6121
6717
  /**
6718
+ * @public
6122
6719
  * <p>The data type.</p>
6123
6720
  */
6124
6721
  DataType?: (SavingsPlansDataType | string)[];
6125
6722
  /**
6723
+ * @public
6126
6724
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
6127
6725
  * the response from a previous call has more results than the maximum page size.</p>
6128
6726
  */
6129
6727
  NextToken?: string;
6130
6728
  /**
6729
+ * @public
6131
6730
  * <p>The number of items to be returned in a response. The default is <code>20</code>, with a
6132
6731
  * minimum value of <code>1</code>.</p>
6133
6732
  */
6134
6733
  MaxResults?: number;
6135
6734
  /**
6735
+ * @public
6136
6736
  * <p>The value that you want to sort the data by.</p>
6137
6737
  * <p>The following values are supported for <code>Key</code>:</p>
6138
6738
  * <ul>
@@ -6182,12 +6782,14 @@ export interface GetSavingsPlansUtilizationDetailsRequest {
6182
6782
  */
6183
6783
  export interface GetSavingsPlansUtilizationRequest {
6184
6784
  /**
6785
+ * @public
6185
6786
  * <p>The time period that you want the usage and costs for. The <code>Start</code> date must be
6186
6787
  * within 13 months. The <code>End</code> date must be after the <code>Start</code> date, and
6187
6788
  * before the current date. Future dates can't be used as an <code>End</code> date.</p>
6188
6789
  */
6189
6790
  TimePeriod: DateInterval | undefined;
6190
6791
  /**
6792
+ * @public
6191
6793
  * <p>The granularity of the Amazon Web Services utillization data for your Savings
6192
6794
  * Plans.</p>
6193
6795
  * <p>The <code>GetSavingsPlansUtilization</code> operation supports only <code>DAILY</code> and
@@ -6195,6 +6797,7 @@ export interface GetSavingsPlansUtilizationRequest {
6195
6797
  */
6196
6798
  Granularity?: Granularity | string;
6197
6799
  /**
6800
+ * @public
6198
6801
  * <p>Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You
6199
6802
  * can filter data with the following dimensions:</p>
6200
6803
  * <ul>
@@ -6235,6 +6838,7 @@ export interface GetSavingsPlansUtilizationRequest {
6235
6838
  */
6236
6839
  Filter?: Expression;
6237
6840
  /**
6841
+ * @public
6238
6842
  * <p>The value that you want to sort the data by.</p>
6239
6843
  * <p>The following values are supported for <code>Key</code>:</p>
6240
6844
  * <ul>
@@ -6274,10 +6878,12 @@ export interface GetSavingsPlansUtilizationRequest {
6274
6878
  */
6275
6879
  export interface GetTagsRequest {
6276
6880
  /**
6881
+ * @public
6277
6882
  * <p>The value that you want to search for.</p>
6278
6883
  */
6279
6884
  SearchString?: string;
6280
6885
  /**
6886
+ * @public
6281
6887
  * <p>The start and end dates for retrieving the dimension values. The start date is
6282
6888
  * inclusive, but the end date is exclusive. For example, if <code>start</code> is
6283
6889
  * <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and
@@ -6286,10 +6892,12 @@ export interface GetTagsRequest {
6286
6892
  */
6287
6893
  TimePeriod: DateInterval | undefined;
6288
6894
  /**
6895
+ * @public
6289
6896
  * <p>The key of the tag that you want to return values for.</p>
6290
6897
  */
6291
6898
  TagKey?: string;
6292
6899
  /**
6900
+ * @public
6293
6901
  * <p>Use <code>Expression</code> to filter in various Cost Explorer APIs.</p>
6294
6902
  * <p>Not all <code>Expression</code> types are supported in each API. Refer to the
6295
6903
  * documentation for each specific API to see what is supported.</p>
@@ -6415,6 +7023,7 @@ export interface GetTagsRequest {
6415
7023
  */
6416
7024
  Filter?: Expression;
6417
7025
  /**
7026
+ * @public
6418
7027
  * <p>The value that you want to sort the data by.</p>
6419
7028
  * <p>The key represents cost and usage metrics. The following values are supported:</p>
6420
7029
  * <ul>
@@ -6461,6 +7070,7 @@ export interface GetTagsRequest {
6461
7070
  */
6462
7071
  SortBy?: SortDefinition[];
6463
7072
  /**
7073
+ * @public
6464
7074
  * <p>This field is only used when SortBy is provided in the request. The maximum number of
6465
7075
  * objects that are returned for this request. If MaxResults isn't specified with SortBy, the
6466
7076
  * request returns 1000 results as the default value for this parameter.</p>
@@ -6468,6 +7078,7 @@ export interface GetTagsRequest {
6468
7078
  */
6469
7079
  MaxResults?: number;
6470
7080
  /**
7081
+ * @public
6471
7082
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token
6472
7083
  * when the response from a previous call has more results than the maximum page size.</p>
6473
7084
  */
@@ -6478,6 +7089,7 @@ export interface GetTagsRequest {
6478
7089
  */
6479
7090
  export interface GetUsageForecastRequest {
6480
7091
  /**
7092
+ * @public
6481
7093
  * <p>The start and end dates of the period that you want to retrieve usage forecast for. The
6482
7094
  * start date is included in the period, but the end date isn't included in the period. For
6483
7095
  * example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is
@@ -6488,6 +7100,7 @@ export interface GetUsageForecastRequest {
6488
7100
  */
6489
7101
  TimePeriod: DateInterval | undefined;
6490
7102
  /**
7103
+ * @public
6491
7104
  * <p>Which metric Cost Explorer uses to create your forecast.</p>
6492
7105
  * <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
6493
7106
  * <ul>
@@ -6501,6 +7114,7 @@ export interface GetUsageForecastRequest {
6501
7114
  */
6502
7115
  Metric: Metric | string | undefined;
6503
7116
  /**
7117
+ * @public
6504
7118
  * <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code>
6505
7119
  * forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>
6506
7120
  * <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and
@@ -6508,6 +7122,7 @@ export interface GetUsageForecastRequest {
6508
7122
  */
6509
7123
  Granularity: Granularity | string | undefined;
6510
7124
  /**
7125
+ * @public
6511
7126
  * <p>The filters that you want to use to filter your forecast. The
6512
7127
  * <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
6513
7128
  * <ul>
@@ -6630,6 +7245,7 @@ export interface GetUsageForecastRequest {
6630
7245
  */
6631
7246
  Filter?: Expression;
6632
7247
  /**
7248
+ * @public
6633
7249
  * <p>Amazon Web Services Cost Explorer always returns the mean forecast as a single point.
6634
7250
  * You can request a prediction interval around the mean by specifying a confidence level. The
6635
7251
  * higher the confidence level, the more confident Cost Explorer is about the actual value
@@ -6643,10 +7259,12 @@ export interface GetUsageForecastRequest {
6643
7259
  */
6644
7260
  export interface UpdateAnomalySubscriptionRequest {
6645
7261
  /**
7262
+ * @public
6646
7263
  * <p>A cost anomaly subscription Amazon Resource Name (ARN). </p>
6647
7264
  */
6648
7265
  SubscriptionArn: string | undefined;
6649
7266
  /**
7267
+ * @public
6650
7268
  * @deprecated
6651
7269
  *
6652
7270
  * <p>(deprecated)</p>
@@ -6657,22 +7275,27 @@ export interface UpdateAnomalySubscriptionRequest {
6657
7275
  */
6658
7276
  Threshold?: number;
6659
7277
  /**
7278
+ * @public
6660
7279
  * <p>The update to the frequency value that subscribers receive notifications. </p>
6661
7280
  */
6662
7281
  Frequency?: AnomalySubscriptionFrequency | string;
6663
7282
  /**
7283
+ * @public
6664
7284
  * <p>A list of cost anomaly monitor ARNs. </p>
6665
7285
  */
6666
7286
  MonitorArnList?: string[];
6667
7287
  /**
7288
+ * @public
6668
7289
  * <p>The update to the subscriber list. </p>
6669
7290
  */
6670
7291
  Subscribers?: Subscriber[];
6671
7292
  /**
7293
+ * @public
6672
7294
  * <p>The new name of the subscription. </p>
6673
7295
  */
6674
7296
  SubscriptionName?: string;
6675
7297
  /**
7298
+ * @public
6676
7299
  * <p>The update to the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html">Expression</a> object
6677
7300
  * used to specify the anomalies that you want to generate alerts for. This supports dimensions
6678
7301
  * and nested expressions. The supported dimensions are
@@ -6719,10 +7342,12 @@ export interface UpdateAnomalySubscriptionRequest {
6719
7342
  */
6720
7343
  export interface CreateAnomalyMonitorRequest {
6721
7344
  /**
7345
+ * @public
6722
7346
  * <p>The cost anomaly detection monitor object that you want to create.</p>
6723
7347
  */
6724
7348
  AnomalyMonitor: AnomalyMonitor | undefined;
6725
7349
  /**
7350
+ * @public
6726
7351
  * <p>An optional list of tags to associate with the specified <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html">
6727
7352
  * <code>AnomalyMonitor</code>
6728
7353
  * </a>. You can use resource tags to control access to your
@@ -6764,10 +7389,12 @@ export interface CreateAnomalyMonitorRequest {
6764
7389
  */
6765
7390
  export interface CreateAnomalySubscriptionRequest {
6766
7391
  /**
7392
+ * @public
6767
7393
  * <p>The cost anomaly subscription object that you want to create. </p>
6768
7394
  */
6769
7395
  AnomalySubscription: AnomalySubscription | undefined;
6770
7396
  /**
7397
+ * @public
6771
7398
  * <p>An optional list of tags to associate with the specified <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html">
6772
7399
  * <code>AnomalySubscription</code>
6773
7400
  * </a>. You can use resource tags to control access to
@@ -6811,42 +7438,51 @@ export interface CreateAnomalySubscriptionRequest {
6811
7438
  */
6812
7439
  export interface CostCategory {
6813
7440
  /**
7441
+ * @public
6814
7442
  * <p>The unique identifier for your Cost Category. </p>
6815
7443
  */
6816
7444
  CostCategoryArn: string | undefined;
6817
7445
  /**
7446
+ * @public
6818
7447
  * <p>The effective start date of your Cost Category.</p>
6819
7448
  */
6820
7449
  EffectiveStart: string | undefined;
6821
7450
  /**
7451
+ * @public
6822
7452
  * <p>The effective end date of your Cost Category.</p>
6823
7453
  */
6824
7454
  EffectiveEnd?: string;
6825
7455
  /**
7456
+ * @public
6826
7457
  * <p>The unique name of the Cost Category.</p>
6827
7458
  */
6828
7459
  Name: string | undefined;
6829
7460
  /**
7461
+ * @public
6830
7462
  * <p>The rule schema version in this particular Cost Category.</p>
6831
7463
  */
6832
7464
  RuleVersion: CostCategoryRuleVersion | string | undefined;
6833
7465
  /**
7466
+ * @public
6834
7467
  * <p>The rules are processed in order. If there are multiple rules that match the line
6835
7468
  * item, then the first rule to match is used to determine that Cost Category value.
6836
7469
  * </p>
6837
7470
  */
6838
7471
  Rules: CostCategoryRule[] | undefined;
6839
7472
  /**
7473
+ * @public
6840
7474
  * <p> The split charge rules that are used to allocate your charges between your Cost
6841
7475
  * Category values. </p>
6842
7476
  */
6843
7477
  SplitChargeRules?: CostCategorySplitChargeRule[];
6844
7478
  /**
7479
+ * @public
6845
7480
  * <p>The list of processing statuses for Cost Management products for a specific cost
6846
7481
  * category. </p>
6847
7482
  */
6848
7483
  ProcessingStatus?: CostCategoryProcessingStatus[];
6849
7484
  /**
7485
+ * @public
6850
7486
  * <p>The
6851
7487
  * default value for the cost category.</p>
6852
7488
  */
@@ -6857,32 +7493,39 @@ export interface CostCategory {
6857
7493
  */
6858
7494
  export interface CreateCostCategoryDefinitionRequest {
6859
7495
  /**
7496
+ * @public
6860
7497
  * <p>The unique name of the Cost Category.</p>
6861
7498
  */
6862
7499
  Name: string | undefined;
6863
7500
  /**
7501
+ * @public
6864
7502
  * <p>The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.</p>
6865
7503
  */
6866
7504
  EffectiveStart?: string;
6867
7505
  /**
7506
+ * @public
6868
7507
  * <p>The rule schema version in this particular Cost Category.</p>
6869
7508
  */
6870
7509
  RuleVersion: CostCategoryRuleVersion | string | undefined;
6871
7510
  /**
7511
+ * @public
6872
7512
  * <p>The Cost Category rules used to categorize costs. For more information, see <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html">CostCategoryRule</a>.</p>
6873
7513
  */
6874
7514
  Rules: CostCategoryRule[] | undefined;
6875
7515
  /**
7516
+ * @public
6876
7517
  * <p>The
6877
7518
  * default value for the cost category.</p>
6878
7519
  */
6879
7520
  DefaultValue?: string;
6880
7521
  /**
7522
+ * @public
6881
7523
  * <p> The split charge rules used to allocate your charges between your Cost Category values.
6882
7524
  * </p>
6883
7525
  */
6884
7526
  SplitChargeRules?: CostCategorySplitChargeRule[];
6885
7527
  /**
7528
+ * @public
6886
7529
  * <p>An optional list of tags to associate with the specified <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html">
6887
7530
  * <code>CostCategory</code>
6888
7531
  * </a>. You can use resource tags to control access to your
@@ -6924,11 +7567,13 @@ export interface CreateCostCategoryDefinitionRequest {
6924
7567
  */
6925
7568
  export interface GetAnomalyMonitorsResponse {
6926
7569
  /**
7570
+ * @public
6927
7571
  * <p>A list of cost anomaly monitors that includes the detailed metadata for each monitor.
6928
7572
  * </p>
6929
7573
  */
6930
7574
  AnomalyMonitors: AnomalyMonitor[] | undefined;
6931
7575
  /**
7576
+ * @public
6932
7577
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
6933
7578
  * the response from a previous call has more results than the maximum page size. </p>
6934
7579
  */
@@ -6939,11 +7584,13 @@ export interface GetAnomalyMonitorsResponse {
6939
7584
  */
6940
7585
  export interface GetAnomalySubscriptionsResponse {
6941
7586
  /**
7587
+ * @public
6942
7588
  * <p>A list of cost anomaly subscriptions that includes the detailed metadata for each one.
6943
7589
  * </p>
6944
7590
  */
6945
7591
  AnomalySubscriptions: AnomalySubscription[] | undefined;
6946
7592
  /**
7593
+ * @public
6947
7594
  * <p>The token to retrieve the next set of results. Amazon Web Services provides the token when
6948
7595
  * the response from a previous call has more results than the maximum page size. </p>
6949
7596
  */
@@ -6954,29 +7601,35 @@ export interface GetAnomalySubscriptionsResponse {
6954
7601
  */
6955
7602
  export interface UpdateCostCategoryDefinitionRequest {
6956
7603
  /**
7604
+ * @public
6957
7605
  * <p>The unique identifier for your Cost Category.</p>
6958
7606
  */
6959
7607
  CostCategoryArn: string | undefined;
6960
7608
  /**
7609
+ * @public
6961
7610
  * <p>The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.</p>
6962
7611
  */
6963
7612
  EffectiveStart?: string;
6964
7613
  /**
7614
+ * @public
6965
7615
  * <p>The rule schema version in this particular Cost Category.</p>
6966
7616
  */
6967
7617
  RuleVersion: CostCategoryRuleVersion | string | undefined;
6968
7618
  /**
7619
+ * @public
6969
7620
  * <p>The <code>Expression</code> object used to categorize costs. For more information, see
6970
7621
  * <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html">CostCategoryRule
6971
7622
  * </a>. </p>
6972
7623
  */
6973
7624
  Rules: CostCategoryRule[] | undefined;
6974
7625
  /**
7626
+ * @public
6975
7627
  * <p>The
6976
7628
  * default value for the cost category.</p>
6977
7629
  */
6978
7630
  DefaultValue?: string;
6979
7631
  /**
7632
+ * @public
6980
7633
  * <p> The split charge rules used to allocate your charges between your Cost Category values.
6981
7634
  * </p>
6982
7635
  */
@@ -6987,6 +7640,7 @@ export interface UpdateCostCategoryDefinitionRequest {
6987
7640
  */
6988
7641
  export interface DescribeCostCategoryDefinitionResponse {
6989
7642
  /**
7643
+ * @public
6990
7644
  * <p>The structure of Cost Categories. This includes detailed metadata and the set of rules
6991
7645
  * for the <code>CostCategory</code> object.</p>
6992
7646
  */