@aws-sdk/client-cost-optimization-hub 3.817.0 → 3.819.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.
- package/README.md +1 -8
- package/dist-cjs/index.js +13 -0
- package/dist-es/models/models_0.js +9 -0
- package/dist-types/CostOptimizationHub.d.ts +1 -8
- package/dist-types/CostOptimizationHubClient.d.ts +1 -8
- package/dist-types/commands/GetPreferencesCommand.d.ts +7 -8
- package/dist-types/commands/GetRecommendationCommand.d.ts +3 -9
- package/dist-types/commands/ListEnrollmentStatusesCommand.d.ts +3 -6
- package/dist-types/commands/ListRecommendationSummariesCommand.d.ts +3 -10
- package/dist-types/commands/ListRecommendationsCommand.d.ts +2 -4
- package/dist-types/commands/UpdateEnrollmentStatusCommand.d.ts +3 -11
- package/dist-types/commands/UpdatePreferencesCommand.d.ts +11 -7
- package/dist-types/index.d.ts +1 -8
- package/dist-types/models/models_0.d.ts +106 -112
- package/dist-types/ts3.4/models/models_0.d.ts +18 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,14 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript CostOptimizationHub Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
|
|
10
|
-
and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
|
|
11
|
-
<p>The Cost Optimization Hub API provides the following endpoint:</p>
|
|
12
|
-
<ul>
|
|
13
|
-
<li>
|
|
14
|
-
<p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
|
|
15
|
-
</li>
|
|
16
|
-
</ul>
|
|
9
|
+
<p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p> <p>The Cost Optimization Hub API provides the following endpoint:</p> <ul> <li> <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p> </li> </ul>
|
|
17
10
|
|
|
18
11
|
## Installing
|
|
19
12
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -38,12 +38,14 @@ __export(index_exports, {
|
|
|
38
38
|
ListRecommendationsCommand: () => ListRecommendationsCommand,
|
|
39
39
|
MemberAccountDiscountVisibility: () => MemberAccountDiscountVisibility,
|
|
40
40
|
Order: () => Order,
|
|
41
|
+
PaymentOption: () => PaymentOption,
|
|
41
42
|
ResourceDetails: () => ResourceDetails,
|
|
42
43
|
ResourceNotFoundException: () => ResourceNotFoundException,
|
|
43
44
|
ResourceType: () => ResourceType,
|
|
44
45
|
SavingsEstimationMode: () => SavingsEstimationMode,
|
|
45
46
|
Source: () => Source,
|
|
46
47
|
SummaryMetrics: () => SummaryMetrics,
|
|
48
|
+
Term: () => Term,
|
|
47
49
|
ThrottlingException: () => ThrottlingException,
|
|
48
50
|
UpdateEnrollmentStatusCommand: () => UpdateEnrollmentStatusCommand,
|
|
49
51
|
UpdatePreferencesCommand: () => UpdatePreferencesCommand,
|
|
@@ -266,6 +268,15 @@ var MemberAccountDiscountVisibility = {
|
|
|
266
268
|
ALL: "All",
|
|
267
269
|
NONE: "None"
|
|
268
270
|
};
|
|
271
|
+
var PaymentOption = {
|
|
272
|
+
ALL_UPFRONT: "AllUpfront",
|
|
273
|
+
NO_UPFRONT: "NoUpfront",
|
|
274
|
+
PARTIAL_UPFRONT: "PartialUpfront"
|
|
275
|
+
};
|
|
276
|
+
var Term = {
|
|
277
|
+
ONE_YEAR: "OneYear",
|
|
278
|
+
THREE_YEARS: "ThreeYears"
|
|
279
|
+
};
|
|
269
280
|
var SavingsEstimationMode = {
|
|
270
281
|
AFTER_DISCOUNTS: "AfterDiscounts",
|
|
271
282
|
BEFORE_DISCOUNTS: "BeforeDiscounts"
|
|
@@ -1236,6 +1247,8 @@ var paginateListRecommendations = (0, import_core.createPaginator)(CostOptimizat
|
|
|
1236
1247
|
ActionType,
|
|
1237
1248
|
AllocationStrategy,
|
|
1238
1249
|
MemberAccountDiscountVisibility,
|
|
1250
|
+
PaymentOption,
|
|
1251
|
+
Term,
|
|
1239
1252
|
SavingsEstimationMode,
|
|
1240
1253
|
InternalServerException,
|
|
1241
1254
|
ThrottlingException,
|
|
@@ -33,6 +33,15 @@ export const MemberAccountDiscountVisibility = {
|
|
|
33
33
|
ALL: "All",
|
|
34
34
|
NONE: "None",
|
|
35
35
|
};
|
|
36
|
+
export const PaymentOption = {
|
|
37
|
+
ALL_UPFRONT: "AllUpfront",
|
|
38
|
+
NO_UPFRONT: "NoUpfront",
|
|
39
|
+
PARTIAL_UPFRONT: "PartialUpfront",
|
|
40
|
+
};
|
|
41
|
+
export const Term = {
|
|
42
|
+
ONE_YEAR: "OneYear",
|
|
43
|
+
THREE_YEARS: "ThreeYears",
|
|
44
|
+
};
|
|
36
45
|
export const SavingsEstimationMode = {
|
|
37
46
|
AFTER_DISCOUNTS: "AfterDiscounts",
|
|
38
47
|
BEFORE_DISCOUNTS: "BeforeDiscounts",
|
|
@@ -56,14 +56,7 @@ export interface CostOptimizationHub {
|
|
|
56
56
|
updatePreferences(args: UpdatePreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePreferencesCommandOutput) => void): void;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
|
|
60
|
-
* and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
|
|
61
|
-
* <p>The Cost Optimization Hub API provides the following endpoint:</p>
|
|
62
|
-
* <ul>
|
|
63
|
-
* <li>
|
|
64
|
-
* <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
|
|
65
|
-
* </li>
|
|
66
|
-
* </ul>
|
|
59
|
+
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p> <p>The Cost Optimization Hub API provides the following endpoint:</p> <ul> <li> <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p> </li> </ul>
|
|
67
60
|
* @public
|
|
68
61
|
*/
|
|
69
62
|
export declare class CostOptimizationHub extends CostOptimizationHubClient implements CostOptimizationHub {
|
|
@@ -176,14 +176,7 @@ export type CostOptimizationHubClientResolvedConfigType = __SmithyResolvedConfig
|
|
|
176
176
|
export interface CostOptimizationHubClientResolvedConfig extends CostOptimizationHubClientResolvedConfigType {
|
|
177
177
|
}
|
|
178
178
|
/**
|
|
179
|
-
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
|
|
180
|
-
* and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
|
|
181
|
-
* <p>The Cost Optimization Hub API provides the following endpoint:</p>
|
|
182
|
-
* <ul>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
|
|
185
|
-
* </li>
|
|
186
|
-
* </ul>
|
|
179
|
+
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p> <p>The Cost Optimization Hub API provides the following endpoint:</p> <ul> <li> <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p> </li> </ul>
|
|
187
180
|
* @public
|
|
188
181
|
*/
|
|
189
182
|
export declare class CostOptimizationHubClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CostOptimizationHubClientResolvedConfig> {
|
|
@@ -27,10 +27,7 @@ declare const GetPreferencesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a set of preferences for an account in order to add account-specific preferences
|
|
31
|
-
* into the service. These preferences impact how the savings associated with recommendations are
|
|
32
|
-
* presented—estimated savings after discounts or estimated savings before discounts, for
|
|
33
|
-
* example.</p>
|
|
30
|
+
* <p>Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -43,6 +40,10 @@ declare const GetPreferencesCommand_base: {
|
|
|
43
40
|
* // { // GetPreferencesResponse
|
|
44
41
|
* // savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
|
|
45
42
|
* // memberAccountDiscountVisibility: "All" || "None",
|
|
43
|
+
* // preferredCommitment: { // PreferredCommitment
|
|
44
|
+
* // term: "OneYear" || "ThreeYears",
|
|
45
|
+
* // paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
|
|
46
|
+
* // },
|
|
46
47
|
* // };
|
|
47
48
|
*
|
|
48
49
|
* ```
|
|
@@ -57,15 +58,13 @@ declare const GetPreferencesCommand_base: {
|
|
|
57
58
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
58
59
|
*
|
|
59
60
|
* @throws {@link InternalServerException} (server fault)
|
|
60
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
61
|
-
* later.</p>
|
|
61
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
64
64
|
* <p>The request was denied due to request throttling.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ValidationException} (client fault)
|
|
67
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
68
|
-
* service.</p>
|
|
67
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link CostOptimizationHubServiceException}
|
|
71
70
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -27,11 +27,7 @@ declare const GetRecommendationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns both the current and recommended resource configuration and the estimated cost
|
|
31
|
-
* impact for a recommendation.</p>
|
|
32
|
-
* <p>The <code>recommendationId</code> is only valid for up to a maximum of 24 hours as
|
|
33
|
-
* recommendations are refreshed daily. To retrieve the <code>recommendationId</code>, use the
|
|
34
|
-
* <code>ListRecommendations</code> API.</p>
|
|
30
|
+
* <p>Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.</p> <p>The <code>recommendationId</code> is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the <code>recommendationId</code>, use the <code>ListRecommendations</code> API.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -724,8 +720,7 @@ declare const GetRecommendationCommand_base: {
|
|
|
724
720
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
725
721
|
*
|
|
726
722
|
* @throws {@link InternalServerException} (server fault)
|
|
727
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
728
|
-
* later.</p>
|
|
723
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
729
724
|
*
|
|
730
725
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
731
726
|
* <p>The specified Amazon Resource Name (ARN) in the request doesn't exist.</p>
|
|
@@ -734,8 +729,7 @@ declare const GetRecommendationCommand_base: {
|
|
|
734
729
|
* <p>The request was denied due to request throttling.</p>
|
|
735
730
|
*
|
|
736
731
|
* @throws {@link ValidationException} (client fault)
|
|
737
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
738
|
-
* service.</p>
|
|
732
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
739
733
|
*
|
|
740
734
|
* @throws {@link CostOptimizationHubServiceException}
|
|
741
735
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -27,8 +27,7 @@ declare const ListEnrollmentStatusesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the enrollment status for an account. It can also return the list of accounts
|
|
31
|
-
* that are enrolled under the organization.</p>
|
|
30
|
+
* <p>Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -68,15 +67,13 @@ declare const ListEnrollmentStatusesCommand_base: {
|
|
|
68
67
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
69
68
|
*
|
|
70
69
|
* @throws {@link InternalServerException} (server fault)
|
|
71
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
72
|
-
* later.</p>
|
|
70
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
73
71
|
*
|
|
74
72
|
* @throws {@link ThrottlingException} (client fault)
|
|
75
73
|
* <p>The request was denied due to request throttling.</p>
|
|
76
74
|
*
|
|
77
75
|
* @throws {@link ValidationException} (client fault)
|
|
78
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
79
|
-
* service.</p>
|
|
76
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
80
77
|
*
|
|
81
78
|
* @throws {@link CostOptimizationHubServiceException}
|
|
82
79
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -27,12 +27,7 @@ declare const ListRecommendationSummariesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a concise representation of savings estimates for resources. Also returns de-duped
|
|
31
|
-
* savings across different types of recommendations.</p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>The following filters are not supported for this API: <code>recommendationIds</code>,
|
|
34
|
-
* <code>resourceArns</code>, and <code>resourceIds</code>.</p>
|
|
35
|
-
* </note>
|
|
30
|
+
* <p>Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.</p> <note> <p>The following filters are not supported for this API: <code>recommendationIds</code>, <code>resourceArns</code>, and <code>resourceIds</code>.</p> </note>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -112,15 +107,13 @@ declare const ListRecommendationSummariesCommand_base: {
|
|
|
112
107
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
113
108
|
*
|
|
114
109
|
* @throws {@link InternalServerException} (server fault)
|
|
115
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
116
|
-
* later.</p>
|
|
110
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
117
111
|
*
|
|
118
112
|
* @throws {@link ThrottlingException} (client fault)
|
|
119
113
|
* <p>The request was denied due to request throttling.</p>
|
|
120
114
|
*
|
|
121
115
|
* @throws {@link ValidationException} (client fault)
|
|
122
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
123
|
-
* service.</p>
|
|
116
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
124
117
|
*
|
|
125
118
|
* @throws {@link CostOptimizationHubServiceException}
|
|
126
119
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -125,15 +125,13 @@ declare const ListRecommendationsCommand_base: {
|
|
|
125
125
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
126
126
|
*
|
|
127
127
|
* @throws {@link InternalServerException} (server fault)
|
|
128
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
129
|
-
* later.</p>
|
|
128
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
130
129
|
*
|
|
131
130
|
* @throws {@link ThrottlingException} (client fault)
|
|
132
131
|
* <p>The request was denied due to request throttling.</p>
|
|
133
132
|
*
|
|
134
133
|
* @throws {@link ValidationException} (client fault)
|
|
135
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
136
|
-
* service.</p>
|
|
134
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
137
135
|
*
|
|
138
136
|
* @throws {@link CostOptimizationHubServiceException}
|
|
139
137
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -27,13 +27,7 @@ declare const UpdateEnrollmentStatusCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization
|
|
31
|
-
* Hub service.</p>
|
|
32
|
-
* <p>If the account is a management account or delegated administrator of an organization, this
|
|
33
|
-
* action can also be used to enroll member accounts of the organization.</p>
|
|
34
|
-
* <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view
|
|
35
|
-
* its recommendations. When you opt in, Cost Optimization Hub automatically creates a
|
|
36
|
-
* service-linked role in your account to access its data.</p>
|
|
30
|
+
* <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.</p> <p>If the account is a management account or delegated administrator of an organization, this action can also be used to enroll member accounts of the organization.</p> <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.</p>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -62,15 +56,13 @@ declare const UpdateEnrollmentStatusCommand_base: {
|
|
|
62
56
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
63
57
|
*
|
|
64
58
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
66
|
-
* later.</p>
|
|
59
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
67
60
|
*
|
|
68
61
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
62
|
* <p>The request was denied due to request throttling.</p>
|
|
70
63
|
*
|
|
71
64
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
73
|
-
* service.</p>
|
|
65
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
74
66
|
*
|
|
75
67
|
* @throws {@link CostOptimizationHubServiceException}
|
|
76
68
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
|
@@ -27,9 +27,7 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates a set of preferences for an account in order to add account-specific preferences
|
|
31
|
-
* into the service. These preferences impact how the savings associated with recommendations are
|
|
32
|
-
* presented.</p>
|
|
30
|
+
* <p>Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -39,12 +37,20 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
39
37
|
* const input = { // UpdatePreferencesRequest
|
|
40
38
|
* savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
|
|
41
39
|
* memberAccountDiscountVisibility: "All" || "None",
|
|
40
|
+
* preferredCommitment: { // PreferredCommitment
|
|
41
|
+
* term: "OneYear" || "ThreeYears",
|
|
42
|
+
* paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
|
|
43
|
+
* },
|
|
42
44
|
* };
|
|
43
45
|
* const command = new UpdatePreferencesCommand(input);
|
|
44
46
|
* const response = await client.send(command);
|
|
45
47
|
* // { // UpdatePreferencesResponse
|
|
46
48
|
* // savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
|
|
47
49
|
* // memberAccountDiscountVisibility: "All" || "None",
|
|
50
|
+
* // preferredCommitment: { // PreferredCommitment
|
|
51
|
+
* // term: "OneYear" || "ThreeYears",
|
|
52
|
+
* // paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
|
|
53
|
+
* // },
|
|
48
54
|
* // };
|
|
49
55
|
*
|
|
50
56
|
* ```
|
|
@@ -59,15 +65,13 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
59
65
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
60
66
|
*
|
|
61
67
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
63
|
-
* later.</p>
|
|
68
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
64
69
|
*
|
|
65
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
71
|
* <p>The request was denied due to request throttling.</p>
|
|
67
72
|
*
|
|
68
73
|
* @throws {@link ValidationException} (client fault)
|
|
69
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
70
|
-
* service.</p>
|
|
74
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
71
75
|
*
|
|
72
76
|
* @throws {@link CostOptimizationHubServiceException}
|
|
73
77
|
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,12 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
|
|
3
|
-
* and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
|
|
4
|
-
* <p>The Cost Optimization Hub API provides the following endpoint:</p>
|
|
5
|
-
* <ul>
|
|
6
|
-
* <li>
|
|
7
|
-
* <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
|
|
8
|
-
* </li>
|
|
9
|
-
* </ul>
|
|
2
|
+
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p> <p>The Cost Optimization Hub API provides the following endpoint:</p> <ul> <li> <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p> </li> </ul>
|
|
10
3
|
*
|
|
11
4
|
* @packageDocumentation
|
|
12
5
|
*/
|
|
@@ -25,8 +25,7 @@ export declare const EnrollmentStatus: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type EnrollmentStatus = (typeof EnrollmentStatus)[keyof typeof EnrollmentStatus];
|
|
27
27
|
/**
|
|
28
|
-
* <p>Describes the enrollment status of an organization's member accounts in Cost Optimization
|
|
29
|
-
* Hub.</p>
|
|
28
|
+
* <p>Describes the enrollment status of an organization's member accounts in Cost Optimization Hub.</p>
|
|
30
29
|
* @public
|
|
31
30
|
*/
|
|
32
31
|
export interface AccountEnrollmentStatus {
|
|
@@ -82,8 +81,7 @@ export declare const AllocationStrategy: {
|
|
|
82
81
|
*/
|
|
83
82
|
export type AllocationStrategy = (typeof AllocationStrategy)[keyof typeof AllocationStrategy];
|
|
84
83
|
/**
|
|
85
|
-
* <p>Describes the Amazon Elastic Block Store performance configuration of the current and
|
|
86
|
-
* recommended resource configuration for a recommendation.</p>
|
|
84
|
+
* <p>Describes the Amazon Elastic Block Store performance configuration of the current and recommended resource configuration for a recommendation.</p>
|
|
87
85
|
* @public
|
|
88
86
|
*/
|
|
89
87
|
export interface BlockStoragePerformanceConfiguration {
|
|
@@ -99,8 +97,7 @@ export interface BlockStoragePerformanceConfiguration {
|
|
|
99
97
|
throughput?: number | undefined;
|
|
100
98
|
}
|
|
101
99
|
/**
|
|
102
|
-
* <p>Describes the performance configuration for compute services such as Amazon EC2, Lambda,
|
|
103
|
-
* and ECS.</p>
|
|
100
|
+
* <p>Describes the performance configuration for compute services such as Amazon EC2, Lambda, and ECS.</p>
|
|
104
101
|
* @public
|
|
105
102
|
*/
|
|
106
103
|
export interface ComputeConfiguration {
|
|
@@ -120,8 +117,7 @@ export interface ComputeConfiguration {
|
|
|
120
117
|
*/
|
|
121
118
|
architecture?: string | undefined;
|
|
122
119
|
/**
|
|
123
|
-
* <p>The platform of the resource. The platform is the specific combination of operating
|
|
124
|
-
* system, license model, and software on an instance.</p>
|
|
120
|
+
* <p>The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.</p>
|
|
125
121
|
* @public
|
|
126
122
|
*/
|
|
127
123
|
platform?: string | undefined;
|
|
@@ -132,10 +128,7 @@ export interface ComputeConfiguration {
|
|
|
132
128
|
*/
|
|
133
129
|
export interface ComputeSavingsPlansConfiguration {
|
|
134
130
|
/**
|
|
135
|
-
* <p>The account scope for which you want recommendations. Amazon Web Services calculates
|
|
136
|
-
* recommendations including the management account and member accounts if the value is set to
|
|
137
|
-
* <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for
|
|
138
|
-
* individual member accounts only.</p>
|
|
131
|
+
* <p>The account scope for which you want recommendations. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to <code>PAYER</code>. If the value is <code>LINKED</code>, recommendations are calculated for individual member accounts only.</p>
|
|
139
132
|
* @public
|
|
140
133
|
*/
|
|
141
134
|
accountScope?: string | undefined;
|
|
@@ -225,6 +218,47 @@ export declare const MemberAccountDiscountVisibility: {
|
|
|
225
218
|
* @public
|
|
226
219
|
*/
|
|
227
220
|
export type MemberAccountDiscountVisibility = (typeof MemberAccountDiscountVisibility)[keyof typeof MemberAccountDiscountVisibility];
|
|
221
|
+
/**
|
|
222
|
+
* @public
|
|
223
|
+
* @enum
|
|
224
|
+
*/
|
|
225
|
+
export declare const PaymentOption: {
|
|
226
|
+
readonly ALL_UPFRONT: "AllUpfront";
|
|
227
|
+
readonly NO_UPFRONT: "NoUpfront";
|
|
228
|
+
readonly PARTIAL_UPFRONT: "PartialUpfront";
|
|
229
|
+
};
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export type PaymentOption = (typeof PaymentOption)[keyof typeof PaymentOption];
|
|
234
|
+
/**
|
|
235
|
+
* @public
|
|
236
|
+
* @enum
|
|
237
|
+
*/
|
|
238
|
+
export declare const Term: {
|
|
239
|
+
readonly ONE_YEAR: "OneYear";
|
|
240
|
+
readonly THREE_YEARS: "ThreeYears";
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export type Term = (typeof Term)[keyof typeof Term];
|
|
246
|
+
/**
|
|
247
|
+
* <p>The preferred configuration for Reserved Instances and Savings Plans commitment-based discounts, consisting of a payment option and a commitment duration.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
export interface PreferredCommitment {
|
|
251
|
+
/**
|
|
252
|
+
* <p>The preferred length of the commitment period. If the value is null, it will default to <code>ThreeYears</code> (highest savings) where applicable.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
term?: Term | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>The preferred upfront payment structure for commitments. If the value is null, it will default to <code>AllUpfront</code> (highest savings) where applicable.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
paymentOption?: PaymentOption | undefined;
|
|
261
|
+
}
|
|
228
262
|
/**
|
|
229
263
|
* @public
|
|
230
264
|
* @enum
|
|
@@ -251,10 +285,14 @@ export interface GetPreferencesResponse {
|
|
|
251
285
|
* @public
|
|
252
286
|
*/
|
|
253
287
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* <p>Retrieves the current preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.</p>
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
254
293
|
}
|
|
255
294
|
/**
|
|
256
|
-
* <p>An error on the server occurred during the processing of your request. Try again
|
|
257
|
-
* later.</p>
|
|
295
|
+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
258
296
|
* @public
|
|
259
297
|
*/
|
|
260
298
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -278,8 +316,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
278
316
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
279
317
|
}
|
|
280
318
|
/**
|
|
281
|
-
* <p>The input failed to meet the constraints specified by the Amazon Web Services service in a
|
|
282
|
-
* specified field.</p>
|
|
319
|
+
* <p>The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.</p>
|
|
283
320
|
* @public
|
|
284
321
|
*/
|
|
285
322
|
export interface ValidationExceptionDetail {
|
|
@@ -307,8 +344,7 @@ export declare const ValidationExceptionReason: {
|
|
|
307
344
|
*/
|
|
308
345
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
309
346
|
/**
|
|
310
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
311
|
-
* service.</p>
|
|
347
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
312
348
|
* @public
|
|
313
349
|
*/
|
|
314
350
|
export declare class ValidationException extends __BaseException {
|
|
@@ -380,8 +416,7 @@ export interface DynamoDbReservedCapacityConfiguration {
|
|
|
380
416
|
*/
|
|
381
417
|
monthlyRecurringCost?: string | undefined;
|
|
382
418
|
/**
|
|
383
|
-
* <p>The number of reserved capacity units that Amazon Web Services recommends that you
|
|
384
|
-
* purchase.</p>
|
|
419
|
+
* <p>The number of reserved capacity units that Amazon Web Services recommends that you purchase.</p>
|
|
385
420
|
* @public
|
|
386
421
|
*/
|
|
387
422
|
numberOfCapacityUnitsToPurchase?: string | undefined;
|
|
@@ -397,8 +432,7 @@ export interface DynamoDbReservedCapacityConfiguration {
|
|
|
397
432
|
*/
|
|
398
433
|
export interface ReservedInstancesPricing {
|
|
399
434
|
/**
|
|
400
|
-
* <p>The remaining On-Demand cost estimated to not be covered by the recommended reserved
|
|
401
|
-
* instance, over the length of the lookback period.</p>
|
|
435
|
+
* <p>The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.</p>
|
|
402
436
|
* @public
|
|
403
437
|
*/
|
|
404
438
|
estimatedOnDemandCost?: number | undefined;
|
|
@@ -408,14 +442,12 @@ export interface ReservedInstancesPricing {
|
|
|
408
442
|
*/
|
|
409
443
|
monthlyReservationEligibleCost?: number | undefined;
|
|
410
444
|
/**
|
|
411
|
-
* <p>The savings percentage relative to the total On-Demand costs that are associated with this
|
|
412
|
-
* instance.</p>
|
|
445
|
+
* <p>The savings percentage relative to the total On-Demand costs that are associated with this instance.</p>
|
|
413
446
|
* @public
|
|
414
447
|
*/
|
|
415
448
|
savingsPercentage?: number | undefined;
|
|
416
449
|
/**
|
|
417
|
-
* <p>The estimated cost of your recurring monthly fees for the recommended reserved instance
|
|
418
|
-
* across the month.</p>
|
|
450
|
+
* <p>The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.</p>
|
|
419
451
|
* @public
|
|
420
452
|
*/
|
|
421
453
|
estimatedMonthlyAmortizedReservationCost?: number | undefined;
|
|
@@ -485,8 +517,7 @@ export interface EbsVolumeConfiguration {
|
|
|
485
517
|
attachmentState?: string | undefined;
|
|
486
518
|
}
|
|
487
519
|
/**
|
|
488
|
-
* <p>Estimated discount details of the current and recommended resource configuration for a
|
|
489
|
-
* recommendation.</p>
|
|
520
|
+
* <p>Estimated discount details of the current and recommended resource configuration for a recommendation.</p>
|
|
490
521
|
* @public
|
|
491
522
|
*/
|
|
492
523
|
export interface EstimatedDiscounts {
|
|
@@ -501,8 +532,7 @@ export interface EstimatedDiscounts {
|
|
|
501
532
|
*/
|
|
502
533
|
reservedInstancesDiscount?: number | undefined;
|
|
503
534
|
/**
|
|
504
|
-
* <p>Estimated other discounts include all discounts that are not itemized. Itemized discounts
|
|
505
|
-
* include <code>reservedInstanceDiscount</code> and <code>savingsPlansDiscount</code>.</p>
|
|
535
|
+
* <p>Estimated other discounts include all discounts that are not itemized. Itemized discounts include <code>reservedInstanceDiscount</code> and <code>savingsPlansDiscount</code>.</p>
|
|
506
536
|
* @public
|
|
507
537
|
*/
|
|
508
538
|
otherDiscount?: number | undefined;
|
|
@@ -513,8 +543,7 @@ export interface EstimatedDiscounts {
|
|
|
513
543
|
*/
|
|
514
544
|
export interface ResourcePricing {
|
|
515
545
|
/**
|
|
516
|
-
* <p>The savings estimate using Amazon Web Services public pricing without incorporating any
|
|
517
|
-
* discounts.</p>
|
|
546
|
+
* <p>The savings estimate using Amazon Web Services public pricing without incorporating any discounts.</p>
|
|
518
547
|
* @public
|
|
519
548
|
*/
|
|
520
549
|
estimatedCostBeforeDiscounts?: number | undefined;
|
|
@@ -529,8 +558,7 @@ export interface ResourcePricing {
|
|
|
529
558
|
*/
|
|
530
559
|
estimatedDiscounts?: EstimatedDiscounts | undefined;
|
|
531
560
|
/**
|
|
532
|
-
* <p>The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved
|
|
533
|
-
* Instances and Savings Plans.</p>
|
|
561
|
+
* <p>The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.</p>
|
|
534
562
|
* @public
|
|
535
563
|
*/
|
|
536
564
|
estimatedCostAfterDiscounts?: number | undefined;
|
|
@@ -583,8 +611,7 @@ export interface ResourceCostCalculation {
|
|
|
583
611
|
pricing?: ResourcePricing | undefined;
|
|
584
612
|
}
|
|
585
613
|
/**
|
|
586
|
-
* <p>Describes the Amazon Elastic Block Store volume configuration of the current and recommended
|
|
587
|
-
* resource configuration for a recommendation.</p>
|
|
614
|
+
* <p>Describes the Amazon Elastic Block Store volume configuration of the current and recommended resource configuration for a recommendation.</p>
|
|
588
615
|
* @public
|
|
589
616
|
*/
|
|
590
617
|
export interface EbsVolume {
|
|
@@ -639,8 +666,7 @@ export type Ec2AutoScalingGroupType = (typeof Ec2AutoScalingGroupType)[keyof typ
|
|
|
639
666
|
*/
|
|
640
667
|
export interface Ec2AutoScalingGroupConfiguration {
|
|
641
668
|
/**
|
|
642
|
-
* <p>Details about the instance for the EC2 Auto Scaling group with a single instance
|
|
643
|
-
* type.</p>
|
|
669
|
+
* <p>Details about the instance for the EC2 Auto Scaling group with a single instance type.</p>
|
|
644
670
|
* @public
|
|
645
671
|
*/
|
|
646
672
|
instance?: InstanceConfiguration | undefined;
|
|
@@ -650,14 +676,12 @@ export interface Ec2AutoScalingGroupConfiguration {
|
|
|
650
676
|
*/
|
|
651
677
|
mixedInstances?: MixedInstanceConfiguration[] | undefined;
|
|
652
678
|
/**
|
|
653
|
-
* <p>The type of EC2 Auto Scaling group, showing whether it consists of a single instance type
|
|
654
|
-
* or mixed instance types.</p>
|
|
679
|
+
* <p>The type of EC2 Auto Scaling group, showing whether it consists of a single instance type or mixed instance types.</p>
|
|
655
680
|
* @public
|
|
656
681
|
*/
|
|
657
682
|
type?: Ec2AutoScalingGroupType | undefined;
|
|
658
683
|
/**
|
|
659
|
-
* <p>The strategy used for allocating instances, based on a predefined priority order or based
|
|
660
|
-
* on the lowest available price.</p>
|
|
684
|
+
* <p>The strategy used for allocating instances, based on a predefined priority order or based on the lowest available price.</p>
|
|
661
685
|
* @public
|
|
662
686
|
*/
|
|
663
687
|
allocationStrategy?: AllocationStrategy | undefined;
|
|
@@ -690,8 +714,7 @@ export interface Ec2InstanceConfiguration {
|
|
|
690
714
|
instance?: InstanceConfiguration | undefined;
|
|
691
715
|
}
|
|
692
716
|
/**
|
|
693
|
-
* <p>Describes the EC2 instance configuration of the current and recommended resource
|
|
694
|
-
* configuration for a recommendation.</p>
|
|
717
|
+
* <p>Describes the EC2 instance configuration of the current and recommended resource configuration for a recommendation.</p>
|
|
695
718
|
* @public
|
|
696
719
|
*/
|
|
697
720
|
export interface Ec2Instance {
|
|
@@ -799,8 +822,7 @@ export interface Ec2ReservedInstancesConfiguration {
|
|
|
799
822
|
*/
|
|
800
823
|
monthlyRecurringCost?: string | undefined;
|
|
801
824
|
/**
|
|
802
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
803
|
-
* purchase.</p>
|
|
825
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
804
826
|
* @public
|
|
805
827
|
*/
|
|
806
828
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -830,8 +852,7 @@ export interface Ec2ReservedInstancesConfiguration {
|
|
|
830
852
|
*/
|
|
831
853
|
currentGeneration?: string | undefined;
|
|
832
854
|
/**
|
|
833
|
-
* <p>The platform of the recommended reservation. The platform is the specific combination of
|
|
834
|
-
* operating system, license model, and software on an instance.</p>
|
|
855
|
+
* <p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>
|
|
835
856
|
* @public
|
|
836
857
|
*/
|
|
837
858
|
platform?: string | undefined;
|
|
@@ -930,8 +951,7 @@ export interface ElastiCacheReservedInstancesConfiguration {
|
|
|
930
951
|
*/
|
|
931
952
|
monthlyRecurringCost?: string | undefined;
|
|
932
953
|
/**
|
|
933
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
934
|
-
* purchase.</p>
|
|
954
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
935
955
|
* @public
|
|
936
956
|
*/
|
|
937
957
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -1005,11 +1025,7 @@ export interface LambdaFunction {
|
|
|
1005
1025
|
costCalculation?: ResourceCostCalculation | undefined;
|
|
1006
1026
|
}
|
|
1007
1027
|
/**
|
|
1008
|
-
* <p>The MemoryDB reserved instances configuration used for recommendations.</p>
|
|
1009
|
-
* <note>
|
|
1010
|
-
* <p>MemoryDB reserved instances are referred to as "MemoryDB reserved nodes" in
|
|
1011
|
-
* customer-facing documentation.</p>
|
|
1012
|
-
* </note>
|
|
1028
|
+
* <p>The MemoryDB reserved instances configuration used for recommendations.</p> <note> <p>While the API reference uses "MemoryDB reserved instances", the user guide and other documentation refer to them as "MemoryDB reserved nodes", as the terms are used interchangeably.</p> </note>
|
|
1013
1029
|
* @public
|
|
1014
1030
|
*/
|
|
1015
1031
|
export interface MemoryDbReservedInstancesConfiguration {
|
|
@@ -1049,8 +1065,7 @@ export interface MemoryDbReservedInstancesConfiguration {
|
|
|
1049
1065
|
*/
|
|
1050
1066
|
monthlyRecurringCost?: string | undefined;
|
|
1051
1067
|
/**
|
|
1052
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
1053
|
-
* purchase.</p>
|
|
1068
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
1054
1069
|
* @public
|
|
1055
1070
|
*/
|
|
1056
1071
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -1081,11 +1096,7 @@ export interface MemoryDbReservedInstancesConfiguration {
|
|
|
1081
1096
|
currentGeneration?: string | undefined;
|
|
1082
1097
|
}
|
|
1083
1098
|
/**
|
|
1084
|
-
* <p>The MemoryDB reserved instances recommendation details.</p>
|
|
1085
|
-
* <note>
|
|
1086
|
-
* <p>MemoryDB reserved instances are referred to as "MemoryDB reserved nodes" in
|
|
1087
|
-
* customer-facing documentation.</p>
|
|
1088
|
-
* </note>
|
|
1099
|
+
* <p>The MemoryDB reserved instances recommendation details.</p> <note> <p>While the API reference uses "MemoryDB reserved instances", the user guide and other documentation refer to them as "MemoryDB reserved nodes", as the terms are used interchangeably.</p> </note>
|
|
1089
1100
|
* @public
|
|
1090
1101
|
*/
|
|
1091
1102
|
export interface MemoryDbReservedInstances {
|
|
@@ -1141,8 +1152,7 @@ export interface OpenSearchReservedInstancesConfiguration {
|
|
|
1141
1152
|
*/
|
|
1142
1153
|
monthlyRecurringCost?: string | undefined;
|
|
1143
1154
|
/**
|
|
1144
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
1145
|
-
* purchase.</p>
|
|
1155
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
1146
1156
|
* @public
|
|
1147
1157
|
*/
|
|
1148
1158
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -1237,8 +1247,7 @@ export interface RdsDbInstanceStorageConfiguration {
|
|
|
1237
1247
|
*/
|
|
1238
1248
|
allocatedStorageInGb?: number | undefined;
|
|
1239
1249
|
/**
|
|
1240
|
-
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially
|
|
1241
|
-
* allocated for the DB instance.</p>
|
|
1250
|
+
* <p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.</p>
|
|
1242
1251
|
* @public
|
|
1243
1252
|
*/
|
|
1244
1253
|
iops?: number | undefined;
|
|
@@ -1305,8 +1314,7 @@ export interface RdsReservedInstancesConfiguration {
|
|
|
1305
1314
|
*/
|
|
1306
1315
|
monthlyRecurringCost?: string | undefined;
|
|
1307
1316
|
/**
|
|
1308
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
1309
|
-
* purchase.</p>
|
|
1317
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
1310
1318
|
* @public
|
|
1311
1319
|
*/
|
|
1312
1320
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -1351,8 +1359,7 @@ export interface RdsReservedInstancesConfiguration {
|
|
|
1351
1359
|
*/
|
|
1352
1360
|
databaseEngine?: string | undefined;
|
|
1353
1361
|
/**
|
|
1354
|
-
* <p>Determines whether the recommendation is for a reservation in a single Availability Zone
|
|
1355
|
-
* or a reservation with a backup in a second Availability Zone.</p>
|
|
1362
|
+
* <p>Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.</p>
|
|
1356
1363
|
* @public
|
|
1357
1364
|
*/
|
|
1358
1365
|
deploymentOption?: string | undefined;
|
|
@@ -1414,8 +1421,7 @@ export interface RedshiftReservedInstancesConfiguration {
|
|
|
1414
1421
|
*/
|
|
1415
1422
|
monthlyRecurringCost?: string | undefined;
|
|
1416
1423
|
/**
|
|
1417
|
-
* <p>The number of normalized units that Amazon Web Services recommends that you
|
|
1418
|
-
* purchase.</p>
|
|
1424
|
+
* <p>The number of normalized units that Amazon Web Services recommends that you purchase.</p>
|
|
1419
1425
|
* @public
|
|
1420
1426
|
*/
|
|
1421
1427
|
normalizedUnitsToPurchase?: string | undefined;
|
|
@@ -1801,8 +1807,7 @@ export declare namespace ResourceDetails {
|
|
|
1801
1807
|
$unknown?: never;
|
|
1802
1808
|
}
|
|
1803
1809
|
/**
|
|
1804
|
-
* <p>The SageMaker AI
|
|
1805
|
-
* Savings Plans recommendation details.</p>
|
|
1810
|
+
* <p>The SageMaker AI Savings Plans recommendation details.</p>
|
|
1806
1811
|
* @public
|
|
1807
1812
|
*/
|
|
1808
1813
|
interface SageMakerSavingsPlansMember {
|
|
@@ -1874,8 +1879,7 @@ export declare namespace ResourceDetails {
|
|
|
1874
1879
|
$unknown?: never;
|
|
1875
1880
|
}
|
|
1876
1881
|
/**
|
|
1877
|
-
* <p>The DynamoDB reserved capacity recommendation
|
|
1878
|
-
* details.</p>
|
|
1882
|
+
* <p>The DynamoDB reserved capacity recommendation details.</p>
|
|
1879
1883
|
* @public
|
|
1880
1884
|
*/
|
|
1881
1885
|
interface DynamoDbReservedCapacityMember {
|
|
@@ -1899,8 +1903,7 @@ export declare namespace ResourceDetails {
|
|
|
1899
1903
|
$unknown?: never;
|
|
1900
1904
|
}
|
|
1901
1905
|
/**
|
|
1902
|
-
* <p>The MemoryDB reserved instances recommendation
|
|
1903
|
-
* details.</p>
|
|
1906
|
+
* <p>The MemoryDB reserved instances recommendation details.</p>
|
|
1904
1907
|
* @public
|
|
1905
1908
|
*/
|
|
1906
1909
|
interface MemoryDbReservedInstancesMember {
|
|
@@ -2048,8 +2051,7 @@ export interface GetRecommendationResponse {
|
|
|
2048
2051
|
*/
|
|
2049
2052
|
recommendationId?: string | undefined;
|
|
2050
2053
|
/**
|
|
2051
|
-
* <p>The unique identifier for the resource. This is the same as the Amazon Resource Name
|
|
2052
|
-
* (ARN), if available.</p>
|
|
2054
|
+
* <p>The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.</p>
|
|
2053
2055
|
* @public
|
|
2054
2056
|
*/
|
|
2055
2057
|
resourceId?: string | undefined;
|
|
@@ -2079,14 +2081,12 @@ export interface GetRecommendationResponse {
|
|
|
2079
2081
|
*/
|
|
2080
2082
|
costCalculationLookbackPeriodInDays?: number | undefined;
|
|
2081
2083
|
/**
|
|
2082
|
-
* <p>The estimated savings percentage relative to the total cost over the cost calculation
|
|
2083
|
-
* lookback period.</p>
|
|
2084
|
+
* <p>The estimated savings percentage relative to the total cost over the cost calculation lookback period.</p>
|
|
2084
2085
|
* @public
|
|
2085
2086
|
*/
|
|
2086
2087
|
estimatedSavingsPercentage?: number | undefined;
|
|
2087
2088
|
/**
|
|
2088
|
-
* <p>The estimated savings amount over the lookback period used to calculate cost impact for a
|
|
2089
|
-
* recommendation.</p>
|
|
2089
|
+
* <p>The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.</p>
|
|
2090
2090
|
* @public
|
|
2091
2091
|
*/
|
|
2092
2092
|
estimatedSavingsOverCostCalculationLookbackPeriod?: number | undefined;
|
|
@@ -2208,14 +2208,12 @@ export interface ListEnrollmentStatusesRequest {
|
|
|
2208
2208
|
*/
|
|
2209
2209
|
export interface ListEnrollmentStatusesResponse {
|
|
2210
2210
|
/**
|
|
2211
|
-
* <p>The enrollment status of a specific account ID, including creation and last updated
|
|
2212
|
-
* timestamps.</p>
|
|
2211
|
+
* <p>The enrollment status of a specific account ID, including creation and last updated timestamps.</p>
|
|
2213
2212
|
* @public
|
|
2214
2213
|
*/
|
|
2215
2214
|
items?: AccountEnrollmentStatus[] | undefined;
|
|
2216
2215
|
/**
|
|
2217
|
-
* <p>The enrollment status of all member accounts in the organization if the account is the
|
|
2218
|
-
* management account or delegated administrator.</p>
|
|
2216
|
+
* <p>The enrollment status of all member accounts in the organization if the account is the management account or delegated administrator.</p>
|
|
2219
2217
|
* @public
|
|
2220
2218
|
*/
|
|
2221
2219
|
includeMemberAccounts?: boolean | undefined;
|
|
@@ -2226,8 +2224,7 @@ export interface ListEnrollmentStatusesResponse {
|
|
|
2226
2224
|
nextToken?: string | undefined;
|
|
2227
2225
|
}
|
|
2228
2226
|
/**
|
|
2229
|
-
* <p>Describes a filter that returns a more specific list of recommendations. Filters
|
|
2230
|
-
* recommendations by different dimensions.</p>
|
|
2227
|
+
* <p>Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.</p>
|
|
2231
2228
|
* @public
|
|
2232
2229
|
*/
|
|
2233
2230
|
export interface Filter {
|
|
@@ -2330,8 +2327,7 @@ export interface ListRecommendationsRequest {
|
|
|
2330
2327
|
*/
|
|
2331
2328
|
orderBy?: OrderBy | undefined;
|
|
2332
2329
|
/**
|
|
2333
|
-
* <p>List of all recommendations for a resource, or a single recommendation if de-duped by
|
|
2334
|
-
* <code>resourceId</code>.</p>
|
|
2330
|
+
* <p>List of all recommendations for a resource, or a single recommendation if de-duped by <code>resourceId</code>.</p>
|
|
2335
2331
|
* @public
|
|
2336
2332
|
*/
|
|
2337
2333
|
includeAllRecommendations?: boolean | undefined;
|
|
@@ -2392,8 +2388,7 @@ export interface Recommendation {
|
|
|
2392
2388
|
*/
|
|
2393
2389
|
estimatedMonthlySavings?: number | undefined;
|
|
2394
2390
|
/**
|
|
2395
|
-
* <p>The estimated savings percentage relative to the total cost over the cost calculation
|
|
2396
|
-
* lookback period.</p>
|
|
2391
|
+
* <p>The estimated savings percentage relative to the total cost over the cost calculation lookback period.</p>
|
|
2397
2392
|
* @public
|
|
2398
2393
|
*/
|
|
2399
2394
|
estimatedSavingsPercentage?: number | undefined;
|
|
@@ -2489,8 +2484,7 @@ export type SummaryMetrics = (typeof SummaryMetrics)[keyof typeof SummaryMetrics
|
|
|
2489
2484
|
*/
|
|
2490
2485
|
export interface ListRecommendationSummariesRequest {
|
|
2491
2486
|
/**
|
|
2492
|
-
* <p>Describes a filter that returns a more specific list of recommendations. Filters
|
|
2493
|
-
* recommendations by different dimensions.</p>
|
|
2487
|
+
* <p>Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.</p>
|
|
2494
2488
|
* @public
|
|
2495
2489
|
*/
|
|
2496
2490
|
filter?: Filter | undefined;
|
|
@@ -2505,8 +2499,7 @@ export interface ListRecommendationSummariesRequest {
|
|
|
2505
2499
|
*/
|
|
2506
2500
|
maxResults?: number | undefined;
|
|
2507
2501
|
/**
|
|
2508
|
-
* <p>Additional metrics to be returned for the request. The only valid value is
|
|
2509
|
-
* <code>savingsPercentage</code>.</p>
|
|
2502
|
+
* <p>Additional metrics to be returned for the request. The only valid value is <code>savingsPercentage</code>.</p>
|
|
2510
2503
|
* @public
|
|
2511
2504
|
*/
|
|
2512
2505
|
metrics?: SummaryMetrics[] | undefined;
|
|
@@ -2517,8 +2510,7 @@ export interface ListRecommendationSummariesRequest {
|
|
|
2517
2510
|
nextToken?: string | undefined;
|
|
2518
2511
|
}
|
|
2519
2512
|
/**
|
|
2520
|
-
* <p>The summary of rightsizing recommendations, including de-duped savings from all types of
|
|
2521
|
-
* recommendations.</p>
|
|
2513
|
+
* <p>The summary of rightsizing recommendations, including de-duped savings from all types of recommendations.</p>
|
|
2522
2514
|
* @public
|
|
2523
2515
|
*/
|
|
2524
2516
|
export interface RecommendationSummary {
|
|
@@ -2539,18 +2531,12 @@ export interface RecommendationSummary {
|
|
|
2539
2531
|
recommendationCount?: number | undefined;
|
|
2540
2532
|
}
|
|
2541
2533
|
/**
|
|
2542
|
-
* <p>The results or descriptions for the additional metrics, based on whether the metrics were
|
|
2543
|
-
* or were not requested.</p>
|
|
2534
|
+
* <p>The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.</p>
|
|
2544
2535
|
* @public
|
|
2545
2536
|
*/
|
|
2546
2537
|
export interface SummaryMetricsResult {
|
|
2547
2538
|
/**
|
|
2548
|
-
* <p>The savings percentage based on your Amazon Web Services spend over the past 30
|
|
2549
|
-
* days.</p>
|
|
2550
|
-
* <note>
|
|
2551
|
-
* <p>Savings percentage is only supported when filtering by Region, account ID, or
|
|
2552
|
-
* tags.</p>
|
|
2553
|
-
* </note>
|
|
2539
|
+
* <p>The savings percentage based on your Amazon Web Services spend over the past 30 days.</p> <note> <p>Savings percentage is only supported when filtering by Region, account ID, or tags.</p> </note>
|
|
2554
2540
|
* @public
|
|
2555
2541
|
*/
|
|
2556
2542
|
savingsPercentage?: string | undefined;
|
|
@@ -2580,8 +2566,7 @@ export interface ListRecommendationSummariesResponse {
|
|
|
2580
2566
|
*/
|
|
2581
2567
|
currencyCode?: string | undefined;
|
|
2582
2568
|
/**
|
|
2583
|
-
* <p>The results or descriptions for the additional metrics, based on whether the metrics were
|
|
2584
|
-
* or were not requested.</p>
|
|
2569
|
+
* <p>The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.</p>
|
|
2585
2570
|
* @public
|
|
2586
2571
|
*/
|
|
2587
2572
|
metrics?: SummaryMetricsResult | undefined;
|
|
@@ -2601,8 +2586,7 @@ export interface UpdateEnrollmentStatusRequest {
|
|
|
2601
2586
|
*/
|
|
2602
2587
|
status: EnrollmentStatus | undefined;
|
|
2603
2588
|
/**
|
|
2604
|
-
* <p>Indicates whether to enroll member accounts of the organization if the account is the
|
|
2605
|
-
* management account or delegated administrator.</p>
|
|
2589
|
+
* <p>Indicates whether to enroll member accounts of the organization if the account is the management account or delegated administrator.</p>
|
|
2606
2590
|
* @public
|
|
2607
2591
|
*/
|
|
2608
2592
|
includeMemberAccounts?: boolean | undefined;
|
|
@@ -2631,6 +2615,11 @@ export interface UpdatePreferencesRequest {
|
|
|
2631
2615
|
* @public
|
|
2632
2616
|
*/
|
|
2633
2617
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
2618
|
+
/**
|
|
2619
|
+
* <p>Sets the preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.</p>
|
|
2620
|
+
* @public
|
|
2621
|
+
*/
|
|
2622
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
2634
2623
|
}
|
|
2635
2624
|
/**
|
|
2636
2625
|
* @public
|
|
@@ -2646,4 +2635,9 @@ export interface UpdatePreferencesResponse {
|
|
|
2646
2635
|
* @public
|
|
2647
2636
|
*/
|
|
2648
2637
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
2638
|
+
/**
|
|
2639
|
+
* <p>Shows the updated preferences for how Reserved Instances and Savings Plans cost-saving opportunities are prioritized in terms of payment option and term length.</p>
|
|
2640
|
+
* @public
|
|
2641
|
+
*/
|
|
2642
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
2649
2643
|
}
|
|
@@ -72,6 +72,21 @@ export declare const MemberAccountDiscountVisibility: {
|
|
|
72
72
|
};
|
|
73
73
|
export type MemberAccountDiscountVisibility =
|
|
74
74
|
(typeof MemberAccountDiscountVisibility)[keyof typeof MemberAccountDiscountVisibility];
|
|
75
|
+
export declare const PaymentOption: {
|
|
76
|
+
readonly ALL_UPFRONT: "AllUpfront";
|
|
77
|
+
readonly NO_UPFRONT: "NoUpfront";
|
|
78
|
+
readonly PARTIAL_UPFRONT: "PartialUpfront";
|
|
79
|
+
};
|
|
80
|
+
export type PaymentOption = (typeof PaymentOption)[keyof typeof PaymentOption];
|
|
81
|
+
export declare const Term: {
|
|
82
|
+
readonly ONE_YEAR: "OneYear";
|
|
83
|
+
readonly THREE_YEARS: "ThreeYears";
|
|
84
|
+
};
|
|
85
|
+
export type Term = (typeof Term)[keyof typeof Term];
|
|
86
|
+
export interface PreferredCommitment {
|
|
87
|
+
term?: Term | undefined;
|
|
88
|
+
paymentOption?: PaymentOption | undefined;
|
|
89
|
+
}
|
|
75
90
|
export declare const SavingsEstimationMode: {
|
|
76
91
|
readonly AFTER_DISCOUNTS: "AfterDiscounts";
|
|
77
92
|
readonly BEFORE_DISCOUNTS: "BeforeDiscounts";
|
|
@@ -81,6 +96,7 @@ export type SavingsEstimationMode =
|
|
|
81
96
|
export interface GetPreferencesResponse {
|
|
82
97
|
savingsEstimationMode?: SavingsEstimationMode | undefined;
|
|
83
98
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
99
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
84
100
|
}
|
|
85
101
|
export declare class InternalServerException extends __BaseException {
|
|
86
102
|
readonly name: "InternalServerException";
|
|
@@ -960,8 +976,10 @@ export interface UpdateEnrollmentStatusResponse {
|
|
|
960
976
|
export interface UpdatePreferencesRequest {
|
|
961
977
|
savingsEstimationMode?: SavingsEstimationMode | undefined;
|
|
962
978
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
979
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
963
980
|
}
|
|
964
981
|
export interface UpdatePreferencesResponse {
|
|
965
982
|
savingsEstimationMode?: SavingsEstimationMode | undefined;
|
|
966
983
|
memberAccountDiscountVisibility?: MemberAccountDiscountVisibility | undefined;
|
|
984
|
+
preferredCommitment?: PreferredCommitment | undefined;
|
|
967
985
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-cost-optimization-hub",
|
|
3
3
|
"description": "AWS SDK for JavaScript Cost Optimization Hub Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.819.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-cost-optimization-hub",
|