@aws-sdk/client-budgets 3.312.0 → 3.316.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/dist-cjs/Budgets.js +27 -322
- package/dist-cjs/protocols/Aws_json1_1.js +320 -849
- package/dist-es/Budgets.js +27 -322
- package/dist-es/protocols/Aws_json1_1.js +321 -850
- package/dist-types/Budgets.d.ts +72 -132
- package/dist-types/ts3.4/Budgets.d.ts +2 -1
- package/package.json +6 -6
package/dist-types/Budgets.d.ts
CHANGED
|
@@ -23,251 +23,191 @@ import { UpdateBudgetActionCommandInput, UpdateBudgetActionCommandOutput } from
|
|
|
23
23
|
import { UpdateBudgetCommandInput, UpdateBudgetCommandOutput } from "./commands/UpdateBudgetCommand";
|
|
24
24
|
import { UpdateNotificationCommandInput, UpdateNotificationCommandOutput } from "./commands/UpdateNotificationCommand";
|
|
25
25
|
import { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand";
|
|
26
|
-
|
|
27
|
-
* @public
|
|
28
|
-
* <p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p>
|
|
29
|
-
* <p>Budgets provide you with a way to see the following information:</p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
|
|
36
|
-
* </li>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
|
|
39
|
-
* </li>
|
|
40
|
-
* <li>
|
|
41
|
-
* <p>How much of your budget has been used</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* </ul>
|
|
44
|
-
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
|
|
45
|
-
* <ul>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>
|
|
48
|
-
* <b>Cost budgets</b> - Plan how much you want to spend on a service.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>
|
|
52
|
-
* <b>Usage budgets</b> - Plan how much you want to use one or more services.</p>
|
|
53
|
-
* </li>
|
|
54
|
-
* <li>
|
|
55
|
-
* <p>
|
|
56
|
-
* <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p>
|
|
57
|
-
* </li>
|
|
58
|
-
* <li>
|
|
59
|
-
* <p>
|
|
60
|
-
* <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p>
|
|
61
|
-
* </li>
|
|
62
|
-
* </ul>
|
|
63
|
-
* <p>Service Endpoint</p>
|
|
64
|
-
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
|
|
65
|
-
* <ul>
|
|
66
|
-
* <li>
|
|
67
|
-
* <p>https://budgets.amazonaws.com</p>
|
|
68
|
-
* </li>
|
|
69
|
-
* </ul>
|
|
70
|
-
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
|
|
71
|
-
*/
|
|
72
|
-
export declare class Budgets extends BudgetsClient {
|
|
26
|
+
export interface Budgets {
|
|
73
27
|
/**
|
|
74
|
-
* @
|
|
75
|
-
* <p>Creates a budget and, if included, notifications and subscribers. </p>
|
|
76
|
-
* <important>
|
|
77
|
-
* <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples">Examples</a> section. </p>
|
|
78
|
-
* </important>
|
|
28
|
+
* @see {@link CreateBudgetCommand}
|
|
79
29
|
*/
|
|
80
30
|
createBudget(args: CreateBudgetCommandInput, options?: __HttpHandlerOptions): Promise<CreateBudgetCommandOutput>;
|
|
81
31
|
createBudget(args: CreateBudgetCommandInput, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void;
|
|
82
32
|
createBudget(args: CreateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void;
|
|
83
33
|
/**
|
|
84
|
-
* @
|
|
85
|
-
* <p>
|
|
86
|
-
* Creates a budget action.
|
|
87
|
-
* </p>
|
|
34
|
+
* @see {@link CreateBudgetActionCommand}
|
|
88
35
|
*/
|
|
89
36
|
createBudgetAction(args: CreateBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise<CreateBudgetActionCommandOutput>;
|
|
90
37
|
createBudgetAction(args: CreateBudgetActionCommandInput, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void;
|
|
91
38
|
createBudgetAction(args: CreateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void;
|
|
92
39
|
/**
|
|
93
|
-
* @
|
|
94
|
-
* <p>Creates a notification. You must create the budget before you create the associated notification.</p>
|
|
40
|
+
* @see {@link CreateNotificationCommand}
|
|
95
41
|
*/
|
|
96
42
|
createNotification(args: CreateNotificationCommandInput, options?: __HttpHandlerOptions): Promise<CreateNotificationCommandOutput>;
|
|
97
43
|
createNotification(args: CreateNotificationCommandInput, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void;
|
|
98
44
|
createNotification(args: CreateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void;
|
|
99
45
|
/**
|
|
100
|
-
* @
|
|
101
|
-
* <p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>
|
|
46
|
+
* @see {@link CreateSubscriberCommand}
|
|
102
47
|
*/
|
|
103
48
|
createSubscriber(args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubscriberCommandOutput>;
|
|
104
49
|
createSubscriber(args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
|
|
105
50
|
createSubscriber(args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
|
|
106
51
|
/**
|
|
107
|
-
* @
|
|
108
|
-
* <p>Deletes a budget. You can delete your budget at any time.</p>
|
|
109
|
-
* <important>
|
|
110
|
-
* <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p>
|
|
111
|
-
* </important>
|
|
52
|
+
* @see {@link DeleteBudgetCommand}
|
|
112
53
|
*/
|
|
113
54
|
deleteBudget(args: DeleteBudgetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBudgetCommandOutput>;
|
|
114
55
|
deleteBudget(args: DeleteBudgetCommandInput, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void;
|
|
115
56
|
deleteBudget(args: DeleteBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void;
|
|
116
57
|
/**
|
|
117
|
-
* @
|
|
118
|
-
* <p>
|
|
119
|
-
* Deletes a budget action.
|
|
120
|
-
* </p>
|
|
58
|
+
* @see {@link DeleteBudgetActionCommand}
|
|
121
59
|
*/
|
|
122
60
|
deleteBudgetAction(args: DeleteBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBudgetActionCommandOutput>;
|
|
123
61
|
deleteBudgetAction(args: DeleteBudgetActionCommandInput, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void;
|
|
124
62
|
deleteBudgetAction(args: DeleteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void;
|
|
125
63
|
/**
|
|
126
|
-
* @
|
|
127
|
-
* <p>Deletes a notification.</p>
|
|
128
|
-
* <important>
|
|
129
|
-
* <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p>
|
|
130
|
-
* </important>
|
|
64
|
+
* @see {@link DeleteNotificationCommand}
|
|
131
65
|
*/
|
|
132
66
|
deleteNotification(args: DeleteNotificationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNotificationCommandOutput>;
|
|
133
67
|
deleteNotification(args: DeleteNotificationCommandInput, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void;
|
|
134
68
|
deleteNotification(args: DeleteNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void;
|
|
135
69
|
/**
|
|
136
|
-
* @
|
|
137
|
-
* <p>Deletes a subscriber.</p>
|
|
138
|
-
* <important>
|
|
139
|
-
* <p>Deleting the last subscriber to a notification also deletes the notification.</p>
|
|
140
|
-
* </important>
|
|
70
|
+
* @see {@link DeleteSubscriberCommand}
|
|
141
71
|
*/
|
|
142
72
|
deleteSubscriber(args: DeleteSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriberCommandOutput>;
|
|
143
73
|
deleteSubscriber(args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
|
|
144
74
|
deleteSubscriber(args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
|
|
145
75
|
/**
|
|
146
|
-
* @
|
|
147
|
-
* <p>Describes a budget.</p>
|
|
148
|
-
* <important>
|
|
149
|
-
* <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples">Examples</a> section. </p>
|
|
150
|
-
* </important>
|
|
76
|
+
* @see {@link DescribeBudgetCommand}
|
|
151
77
|
*/
|
|
152
78
|
describeBudget(args: DescribeBudgetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetCommandOutput>;
|
|
153
79
|
describeBudget(args: DescribeBudgetCommandInput, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void;
|
|
154
80
|
describeBudget(args: DescribeBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void;
|
|
155
81
|
/**
|
|
156
|
-
* @
|
|
157
|
-
* <p>
|
|
158
|
-
* Describes a budget action detail.
|
|
159
|
-
* </p>
|
|
82
|
+
* @see {@link DescribeBudgetActionCommand}
|
|
160
83
|
*/
|
|
161
84
|
describeBudgetAction(args: DescribeBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetActionCommandOutput>;
|
|
162
85
|
describeBudgetAction(args: DescribeBudgetActionCommandInput, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void;
|
|
163
86
|
describeBudgetAction(args: DescribeBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void;
|
|
164
87
|
/**
|
|
165
|
-
* @
|
|
166
|
-
* <p>
|
|
167
|
-
* Describes a budget action history detail.
|
|
168
|
-
* </p>
|
|
88
|
+
* @see {@link DescribeBudgetActionHistoriesCommand}
|
|
169
89
|
*/
|
|
170
90
|
describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetActionHistoriesCommandOutput>;
|
|
171
91
|
describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void;
|
|
172
92
|
describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void;
|
|
173
93
|
/**
|
|
174
|
-
* @
|
|
175
|
-
* <p>
|
|
176
|
-
* Describes all of the budget actions for an account.
|
|
177
|
-
* </p>
|
|
94
|
+
* @see {@link DescribeBudgetActionsForAccountCommand}
|
|
178
95
|
*/
|
|
179
96
|
describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetActionsForAccountCommandOutput>;
|
|
180
97
|
describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void;
|
|
181
98
|
describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void;
|
|
182
99
|
/**
|
|
183
|
-
* @
|
|
184
|
-
* <p>
|
|
185
|
-
* Describes all of the budget actions for a budget.
|
|
186
|
-
* </p>
|
|
100
|
+
* @see {@link DescribeBudgetActionsForBudgetCommand}
|
|
187
101
|
*/
|
|
188
102
|
describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetActionsForBudgetCommandOutput>;
|
|
189
103
|
describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void;
|
|
190
104
|
describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void;
|
|
191
105
|
/**
|
|
192
|
-
* @
|
|
193
|
-
* <p>
|
|
194
|
-
* Lists the budget names and notifications that are associated with an account.
|
|
195
|
-
* </p>
|
|
106
|
+
* @see {@link DescribeBudgetNotificationsForAccountCommand}
|
|
196
107
|
*/
|
|
197
108
|
describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetNotificationsForAccountCommandOutput>;
|
|
198
109
|
describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void;
|
|
199
110
|
describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void;
|
|
200
111
|
/**
|
|
201
|
-
* @
|
|
202
|
-
* <p>Describes the history for <code>DAILY</code>, <code>MONTHLY</code>, and <code>QUARTERLY</code> budgets. Budget history isn't available for <code>ANNUAL</code> budgets.</p>
|
|
112
|
+
* @see {@link DescribeBudgetPerformanceHistoryCommand}
|
|
203
113
|
*/
|
|
204
114
|
describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetPerformanceHistoryCommandOutput>;
|
|
205
115
|
describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void;
|
|
206
116
|
describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void;
|
|
207
117
|
/**
|
|
208
|
-
* @
|
|
209
|
-
* <p>Lists the budgets that are associated with an account.</p>
|
|
210
|
-
* <important>
|
|
211
|
-
* <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples">Examples</a> section. </p>
|
|
212
|
-
* </important>
|
|
118
|
+
* @see {@link DescribeBudgetsCommand}
|
|
213
119
|
*/
|
|
214
120
|
describeBudgets(args: DescribeBudgetsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetsCommandOutput>;
|
|
215
121
|
describeBudgets(args: DescribeBudgetsCommandInput, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void;
|
|
216
122
|
describeBudgets(args: DescribeBudgetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void;
|
|
217
123
|
/**
|
|
218
|
-
* @
|
|
219
|
-
* <p>Lists the notifications that are associated with a budget.</p>
|
|
124
|
+
* @see {@link DescribeNotificationsForBudgetCommand}
|
|
220
125
|
*/
|
|
221
126
|
describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeNotificationsForBudgetCommandOutput>;
|
|
222
127
|
describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void;
|
|
223
128
|
describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void;
|
|
224
129
|
/**
|
|
225
|
-
* @
|
|
226
|
-
* <p>Lists the subscribers that are associated with a notification.</p>
|
|
130
|
+
* @see {@link DescribeSubscribersForNotificationCommand}
|
|
227
131
|
*/
|
|
228
132
|
describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSubscribersForNotificationCommandOutput>;
|
|
229
133
|
describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void;
|
|
230
134
|
describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void;
|
|
231
135
|
/**
|
|
232
|
-
* @
|
|
233
|
-
* <p>
|
|
234
|
-
* Executes a budget action.
|
|
235
|
-
* </p>
|
|
136
|
+
* @see {@link ExecuteBudgetActionCommand}
|
|
236
137
|
*/
|
|
237
138
|
executeBudgetAction(args: ExecuteBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteBudgetActionCommandOutput>;
|
|
238
139
|
executeBudgetAction(args: ExecuteBudgetActionCommandInput, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void;
|
|
239
140
|
executeBudgetAction(args: ExecuteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void;
|
|
240
141
|
/**
|
|
241
|
-
* @
|
|
242
|
-
* <p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until Amazon Web Services has new usage data to use for forecasting.</p>
|
|
243
|
-
* <important>
|
|
244
|
-
* <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples">Examples</a> section. </p>
|
|
245
|
-
* </important>
|
|
142
|
+
* @see {@link UpdateBudgetCommand}
|
|
246
143
|
*/
|
|
247
144
|
updateBudget(args: UpdateBudgetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBudgetCommandOutput>;
|
|
248
145
|
updateBudget(args: UpdateBudgetCommandInput, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void;
|
|
249
146
|
updateBudget(args: UpdateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void;
|
|
250
147
|
/**
|
|
251
|
-
* @
|
|
252
|
-
* <p>
|
|
253
|
-
* Updates a budget action.
|
|
254
|
-
* </p>
|
|
148
|
+
* @see {@link UpdateBudgetActionCommand}
|
|
255
149
|
*/
|
|
256
150
|
updateBudgetAction(args: UpdateBudgetActionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBudgetActionCommandOutput>;
|
|
257
151
|
updateBudgetAction(args: UpdateBudgetActionCommandInput, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void;
|
|
258
152
|
updateBudgetAction(args: UpdateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void;
|
|
259
153
|
/**
|
|
260
|
-
* @
|
|
261
|
-
* <p>Updates a notification.</p>
|
|
154
|
+
* @see {@link UpdateNotificationCommand}
|
|
262
155
|
*/
|
|
263
156
|
updateNotification(args: UpdateNotificationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotificationCommandOutput>;
|
|
264
157
|
updateNotification(args: UpdateNotificationCommandInput, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void;
|
|
265
158
|
updateNotification(args: UpdateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void;
|
|
266
159
|
/**
|
|
267
|
-
* @
|
|
268
|
-
* <p>Updates a subscriber.</p>
|
|
160
|
+
* @see {@link UpdateSubscriberCommand}
|
|
269
161
|
*/
|
|
270
162
|
updateSubscriber(args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubscriberCommandOutput>;
|
|
271
163
|
updateSubscriber(args: UpdateSubscriberCommandInput, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void;
|
|
272
164
|
updateSubscriber(args: UpdateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSubscriberCommandOutput) => void): void;
|
|
273
165
|
}
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
* <p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p>
|
|
169
|
+
* <p>Budgets provide you with a way to see the following information:</p>
|
|
170
|
+
* <ul>
|
|
171
|
+
* <li>
|
|
172
|
+
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
|
|
176
|
+
* </li>
|
|
177
|
+
* <li>
|
|
178
|
+
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
|
|
179
|
+
* </li>
|
|
180
|
+
* <li>
|
|
181
|
+
* <p>How much of your budget has been used</p>
|
|
182
|
+
* </li>
|
|
183
|
+
* </ul>
|
|
184
|
+
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
|
|
185
|
+
* <ul>
|
|
186
|
+
* <li>
|
|
187
|
+
* <p>
|
|
188
|
+
* <b>Cost budgets</b> - Plan how much you want to spend on a service.</p>
|
|
189
|
+
* </li>
|
|
190
|
+
* <li>
|
|
191
|
+
* <p>
|
|
192
|
+
* <b>Usage budgets</b> - Plan how much you want to use one or more services.</p>
|
|
193
|
+
* </li>
|
|
194
|
+
* <li>
|
|
195
|
+
* <p>
|
|
196
|
+
* <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p>
|
|
197
|
+
* </li>
|
|
198
|
+
* <li>
|
|
199
|
+
* <p>
|
|
200
|
+
* <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p>
|
|
201
|
+
* </li>
|
|
202
|
+
* </ul>
|
|
203
|
+
* <p>Service Endpoint</p>
|
|
204
|
+
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
|
|
205
|
+
* <ul>
|
|
206
|
+
* <li>
|
|
207
|
+
* <p>https://budgets.amazonaws.com</p>
|
|
208
|
+
* </li>
|
|
209
|
+
* </ul>
|
|
210
|
+
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
|
|
211
|
+
*/
|
|
212
|
+
export declare class Budgets extends BudgetsClient implements Budgets {
|
|
213
|
+
}
|
|
@@ -92,7 +92,7 @@ import {
|
|
|
92
92
|
UpdateSubscriberCommandInput,
|
|
93
93
|
UpdateSubscriberCommandOutput,
|
|
94
94
|
} from "./commands/UpdateSubscriberCommand";
|
|
95
|
-
export
|
|
95
|
+
export interface Budgets {
|
|
96
96
|
createBudget(
|
|
97
97
|
args: CreateBudgetCommandInput,
|
|
98
98
|
options?: __HttpHandlerOptions
|
|
@@ -405,3 +405,4 @@ export declare class Budgets extends BudgetsClient {
|
|
|
405
405
|
cb: (err: any, data?: UpdateSubscriberCommandOutput) => void
|
|
406
406
|
): void;
|
|
407
407
|
}
|
|
408
|
+
export declare class Budgets extends BudgetsClient implements Budgets {}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-budgets",
|
|
3
3
|
"description": "AWS SDK for JavaScript Budgets Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.316.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.316.0",
|
|
25
25
|
"@aws-sdk/config-resolver": "3.310.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.316.0",
|
|
27
27
|
"@aws-sdk/fetch-http-handler": "3.310.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.310.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.310.0",
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
"@aws-sdk/node-config-provider": "3.310.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.310.0",
|
|
42
42
|
"@aws-sdk/protocol-http": "3.310.0",
|
|
43
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
+
"@aws-sdk/smithy-client": "3.316.0",
|
|
44
44
|
"@aws-sdk/types": "3.310.0",
|
|
45
45
|
"@aws-sdk/url-parser": "3.310.0",
|
|
46
46
|
"@aws-sdk/util-base64": "3.310.0",
|
|
47
47
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
48
48
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
49
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
49
|
+
"@aws-sdk/util-defaults-mode-browser": "3.316.0",
|
|
50
|
+
"@aws-sdk/util-defaults-mode-node": "3.316.0",
|
|
51
51
|
"@aws-sdk/util-endpoints": "3.310.0",
|
|
52
52
|
"@aws-sdk/util-retry": "3.310.0",
|
|
53
53
|
"@aws-sdk/util-user-agent-browser": "3.310.0",
|