Skip to content

Commit 09599cb

Browse files
author
awstools
committed
feat(client-cost-optimization-hub): This release allows customers to modify their preferred commitment term and payment options.
1 parent 73b191f commit 09599cb

14 files changed

+298
-269
lines changed

‎clients/client-cost-optimization-hub/README.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@
66

77
AWS SDK for JavaScript CostOptimizationHub Client for Node.js, Browser and React Native.
88

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>
1710

1811
## Installing
1912

‎clients/client-cost-optimization-hub/src/CostOptimizationHub.ts‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,7 @@ export interface CostOptimizationHub {
172172
}
173173

174174
/**
175-
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
176-
* and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
177-
* <p>The Cost Optimization Hub API provides the following endpoint:</p>
178-
* <ul>
179-
* <li>
180-
* <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
181-
* </li>
182-
* </ul>
175+
* <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>
183176
* @public
184177
*/
185178
export class CostOptimizationHub extends CostOptimizationHubClient implements CostOptimizationHub {}

‎clients/client-cost-optimization-hub/src/CostOptimizationHubClient.ts‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -298,14 +298,7 @@ export type CostOptimizationHubClientResolvedConfigType = __SmithyResolvedConfig
298298
export interface CostOptimizationHubClientResolvedConfig extends CostOptimizationHubClientResolvedConfigType {}
299299

300300
/**
301-
* <p>You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate,
302-
* and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.</p>
303-
* <p>The Cost Optimization Hub API provides the following endpoint:</p>
304-
* <ul>
305-
* <li>
306-
* <p> https://cost-optimization-hub.us-east-1.amazonaws.com </p>
307-
* </li>
308-
* </ul>
301+
* <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>
309302
* @public
310303
*/
311304
export class CostOptimizationHubClient extends __Client<

‎clients/client-cost-optimization-hub/src/commands/GetPreferencesCommand.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@ export interface GetPreferencesCommandInput extends GetPreferencesRequest {}
3232
export interface GetPreferencesCommandOutput extends GetPreferencesResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns a set of preferences for an account in order to add account-specific preferences
36-
* into the service. These preferences impact how the savings associated with recommendations are
37-
* presented—estimated savings after discounts or estimated savings before discounts, for
38-
* example.</p>
35+
* <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>
3936
* @example
4037
* Use a bare-bones client and the command you need to make an API call.
4138
* ```javascript
@@ -48,6 +45,10 @@ export interface GetPreferencesCommandOutput extends GetPreferencesResponse, __M
4845
* // { // GetPreferencesResponse
4946
* // savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
5047
* // memberAccountDiscountVisibility: "All" || "None",
48+
* // preferredCommitment: { // PreferredCommitment
49+
* // term: "OneYear" || "ThreeYears",
50+
* // paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
51+
* // },
5152
* // };
5253
*
5354
* ```
@@ -62,15 +63,13 @@ export interface GetPreferencesCommandOutput extends GetPreferencesResponse, __M
6263
* <p>You are not authorized to use this operation with the given parameters.</p>
6364
*
6465
* @throws {@link InternalServerException} (server fault)
65-
* <p>An error on the server occurred during the processing of your request. Try again
66-
* later.</p>
66+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
6767
*
6868
* @throws {@link ThrottlingException} (client fault)
6969
* <p>The request was denied due to request throttling.</p>
7070
*
7171
* @throws {@link ValidationException} (client fault)
72-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
73-
* service.</p>
72+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
7473
*
7574
* @throws {@link CostOptimizationHubServiceException}
7675
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/GetRecommendationCommand.ts‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,7 @@ export interface GetRecommendationCommandInput extends GetRecommendationRequest
3232
export interface GetRecommendationCommandOutput extends GetRecommendationResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Returns both the current and recommended resource configuration and the estimated cost
36-
* impact for a recommendation.</p>
37-
* <p>The <code>recommendationId</code> is only valid for up to a maximum of 24 hours as
38-
* recommendations are refreshed daily. To retrieve the <code>recommendationId</code>, use the
39-
* <code>ListRecommendations</code> API.</p>
35+
* <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>
4036
* @example
4137
* Use a bare-bones client and the command you need to make an API call.
4238
* ```javascript
@@ -729,8 +725,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
729725
* <p>You are not authorized to use this operation with the given parameters.</p>
730726
*
731727
* @throws {@link InternalServerException} (server fault)
732-
* <p>An error on the server occurred during the processing of your request. Try again
733-
* later.</p>
728+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
734729
*
735730
* @throws {@link ResourceNotFoundException} (client fault)
736731
* <p>The specified Amazon Resource Name (ARN) in the request doesn't exist.</p>
@@ -739,8 +734,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
739734
* <p>The request was denied due to request throttling.</p>
740735
*
741736
* @throws {@link ValidationException} (client fault)
742-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
743-
* service.</p>
737+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
744738
*
745739
* @throws {@link CostOptimizationHubServiceException}
746740
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/ListEnrollmentStatusesCommand.ts‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export interface ListEnrollmentStatusesCommandInput extends ListEnrollmentStatus
3232
export interface ListEnrollmentStatusesCommandOutput extends ListEnrollmentStatusesResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Retrieves the enrollment status for an account. It can also return the list of accounts
36-
* that are enrolled under the organization.</p>
35+
* <p>Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.</p>
3736
* @example
3837
* Use a bare-bones client and the command you need to make an API call.
3938
* ```javascript
@@ -73,15 +72,13 @@ export interface ListEnrollmentStatusesCommandOutput extends ListEnrollmentStatu
7372
* <p>You are not authorized to use this operation with the given parameters.</p>
7473
*
7574
* @throws {@link InternalServerException} (server fault)
76-
* <p>An error on the server occurred during the processing of your request. Try again
77-
* later.</p>
75+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
7876
*
7977
* @throws {@link ThrottlingException} (client fault)
8078
* <p>The request was denied due to request throttling.</p>
8179
*
8280
* @throws {@link ValidationException} (client fault)
83-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
84-
* service.</p>
81+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
8582
*
8683
* @throws {@link CostOptimizationHubServiceException}
8784
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/ListRecommendationSummariesCommand.ts‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,7 @@ export interface ListRecommendationSummariesCommandOutput
3434
__MetadataBearer {}
3535

3636
/**
37-
* <p>Returns a concise representation of savings estimates for resources. Also returns de-duped
38-
* savings across different types of recommendations.</p>
39-
* <note>
40-
* <p>The following filters are not supported for this API: <code>recommendationIds</code>,
41-
* <code>resourceArns</code>, and <code>resourceIds</code>.</p>
42-
* </note>
37+
* <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>
4338
* @example
4439
* Use a bare-bones client and the command you need to make an API call.
4540
* ```javascript
@@ -119,15 +114,13 @@ export interface ListRecommendationSummariesCommandOutput
119114
* <p>You are not authorized to use this operation with the given parameters.</p>
120115
*
121116
* @throws {@link InternalServerException} (server fault)
122-
* <p>An error on the server occurred during the processing of your request. Try again
123-
* later.</p>
117+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
124118
*
125119
* @throws {@link ThrottlingException} (client fault)
126120
* <p>The request was denied due to request throttling.</p>
127121
*
128122
* @throws {@link ValidationException} (client fault)
129-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
130-
* service.</p>
123+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
131124
*
132125
* @throws {@link CostOptimizationHubServiceException}
133126
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/ListRecommendationsCommand.ts‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,13 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes
130130
* <p>You are not authorized to use this operation with the given parameters.</p>
131131
*
132132
* @throws {@link InternalServerException} (server fault)
133-
* <p>An error on the server occurred during the processing of your request. Try again
134-
* later.</p>
133+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
135134
*
136135
* @throws {@link ThrottlingException} (client fault)
137136
* <p>The request was denied due to request throttling.</p>
138137
*
139138
* @throws {@link ValidationException} (client fault)
140-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
141-
* service.</p>
139+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
142140
*
143141
* @throws {@link CostOptimizationHubServiceException}
144142
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/UpdateEnrollmentStatusCommand.ts‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,7 @@ export interface UpdateEnrollmentStatusCommandInput extends UpdateEnrollmentStat
3232
export interface UpdateEnrollmentStatusCommandOutput extends UpdateEnrollmentStatusResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization
36-
* Hub service.</p>
37-
* <p>If the account is a management account or delegated administrator of an organization, this
38-
* action can also be used to enroll member accounts of the organization.</p>
39-
* <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view
40-
* its recommendations. When you opt in, Cost Optimization Hub automatically creates a
41-
* service-linked role in your account to access its data.</p>
35+
* <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>
4236
* @example
4337
* Use a bare-bones client and the command you need to make an API call.
4438
* ```javascript
@@ -67,15 +61,13 @@ export interface UpdateEnrollmentStatusCommandOutput extends UpdateEnrollmentSta
6761
* <p>You are not authorized to use this operation with the given parameters.</p>
6862
*
6963
* @throws {@link InternalServerException} (server fault)
70-
* <p>An error on the server occurred during the processing of your request. Try again
71-
* later.</p>
64+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
7265
*
7366
* @throws {@link ThrottlingException} (client fault)
7467
* <p>The request was denied due to request throttling.</p>
7568
*
7669
* @throws {@link ValidationException} (client fault)
77-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
78-
* service.</p>
70+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
7971
*
8072
* @throws {@link CostOptimizationHubServiceException}
8173
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

‎clients/client-cost-optimization-hub/src/commands/UpdatePreferencesCommand.ts‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ export interface UpdatePreferencesCommandInput extends UpdatePreferencesRequest
3232
export interface UpdatePreferencesCommandOutput extends UpdatePreferencesResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Updates a set of preferences for an account in order to add account-specific preferences
36-
* into the service. These preferences impact how the savings associated with recommendations are
37-
* presented.</p>
35+
* <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>
3836
* @example
3937
* Use a bare-bones client and the command you need to make an API call.
4038
* ```javascript
@@ -44,12 +42,20 @@ export interface UpdatePreferencesCommandOutput extends UpdatePreferencesRespons
4442
* const input = { // UpdatePreferencesRequest
4543
* savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
4644
* memberAccountDiscountVisibility: "All" || "None",
45+
* preferredCommitment: { // PreferredCommitment
46+
* term: "OneYear" || "ThreeYears",
47+
* paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
48+
* },
4749
* };
4850
* const command = new UpdatePreferencesCommand(input);
4951
* const response = await client.send(command);
5052
* // { // UpdatePreferencesResponse
5153
* // savingsEstimationMode: "BeforeDiscounts" || "AfterDiscounts",
5254
* // memberAccountDiscountVisibility: "All" || "None",
55+
* // preferredCommitment: { // PreferredCommitment
56+
* // term: "OneYear" || "ThreeYears",
57+
* // paymentOption: "AllUpfront" || "PartialUpfront" || "NoUpfront",
58+
* // },
5359
* // };
5460
*
5561
* ```
@@ -64,15 +70,13 @@ export interface UpdatePreferencesCommandOutput extends UpdatePreferencesRespons
6470
* <p>You are not authorized to use this operation with the given parameters.</p>
6571
*
6672
* @throws {@link InternalServerException} (server fault)
67-
* <p>An error on the server occurred during the processing of your request. Try again
68-
* later.</p>
73+
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
6974
*
7075
* @throws {@link ThrottlingException} (client fault)
7176
* <p>The request was denied due to request throttling.</p>
7277
*
7378
* @throws {@link ValidationException} (client fault)
74-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
75-
* service.</p>
79+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
7680
*
7781
* @throws {@link CostOptimizationHubServiceException}
7882
* <p>Base exception class for all service exceptions from CostOptimizationHub service.</p>

0 commit comments

Comments
 (0)