@aws-sdk/client-budgets 3.295.0 → 3.297.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.
Files changed (37) hide show
  1. package/dist-types/Budgets.d.ts +24 -0
  2. package/dist-types/BudgetsClient.d.ts +24 -4
  3. package/dist-types/commands/CreateBudgetActionCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBudgetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateNotificationCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateSubscriberCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteBudgetActionCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteBudgetCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteNotificationCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteSubscriberCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeBudgetActionCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeBudgetActionHistoriesCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeBudgetActionsForAccountCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeBudgetActionsForBudgetCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeBudgetCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeBudgetNotificationsForAccountCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeBudgetPerformanceHistoryCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeBudgetsCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeNotificationsForBudgetCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeSubscribersForNotificationCommand.d.ts +16 -0
  21. package/dist-types/commands/ExecuteBudgetActionCommand.d.ts +16 -0
  22. package/dist-types/commands/UpdateBudgetActionCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateBudgetCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateNotificationCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateSubscriberCommand.d.ts +16 -0
  26. package/dist-types/models/BudgetsServiceException.d.ts +2 -0
  27. package/dist-types/models/models_0.d.ts +159 -0
  28. package/dist-types/pagination/DescribeBudgetActionHistoriesPaginator.d.ts +3 -0
  29. package/dist-types/pagination/DescribeBudgetActionsForAccountPaginator.d.ts +3 -0
  30. package/dist-types/pagination/DescribeBudgetActionsForBudgetPaginator.d.ts +3 -0
  31. package/dist-types/pagination/DescribeBudgetNotificationsForAccountPaginator.d.ts +3 -0
  32. package/dist-types/pagination/DescribeBudgetPerformanceHistoryPaginator.d.ts +3 -0
  33. package/dist-types/pagination/DescribeBudgetsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/DescribeNotificationsForBudgetPaginator.d.ts +3 -0
  35. package/dist-types/pagination/DescribeSubscribersForNotificationPaginator.d.ts +3 -0
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/package.json +29 -29
@@ -24,6 +24,7 @@ import { UpdateBudgetCommandInput, UpdateBudgetCommandOutput } from "./commands/
24
24
  import { UpdateNotificationCommandInput, UpdateNotificationCommandOutput } from "./commands/UpdateNotificationCommand";
25
25
  import { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand";
26
26
  /**
27
+ * @public
27
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>
28
29
  * <p>Budgets provide you with a way to see the following information:</p>
29
30
  * <ul>
@@ -70,6 +71,7 @@ import { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./c
70
71
  */
71
72
  export declare class Budgets extends BudgetsClient {
72
73
  /**
74
+ * @public
73
75
  * <p>Creates a budget and, if included, notifications and subscribers. </p>
74
76
  * <important>
75
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>
@@ -79,6 +81,7 @@ export declare class Budgets extends BudgetsClient {
79
81
  createBudget(args: CreateBudgetCommandInput, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void;
80
82
  createBudget(args: CreateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetCommandOutput) => void): void;
81
83
  /**
84
+ * @public
82
85
  * <p>
83
86
  * Creates a budget action.
84
87
  * </p>
@@ -87,18 +90,21 @@ export declare class Budgets extends BudgetsClient {
87
90
  createBudgetAction(args: CreateBudgetActionCommandInput, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void;
88
91
  createBudgetAction(args: CreateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBudgetActionCommandOutput) => void): void;
89
92
  /**
93
+ * @public
90
94
  * <p>Creates a notification. You must create the budget before you create the associated notification.</p>
91
95
  */
92
96
  createNotification(args: CreateNotificationCommandInput, options?: __HttpHandlerOptions): Promise<CreateNotificationCommandOutput>;
93
97
  createNotification(args: CreateNotificationCommandInput, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void;
94
98
  createNotification(args: CreateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNotificationCommandOutput) => void): void;
95
99
  /**
100
+ * @public
96
101
  * <p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>
97
102
  */
98
103
  createSubscriber(args: CreateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<CreateSubscriberCommandOutput>;
99
104
  createSubscriber(args: CreateSubscriberCommandInput, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
100
105
  createSubscriber(args: CreateSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSubscriberCommandOutput) => void): void;
101
106
  /**
107
+ * @public
102
108
  * <p>Deletes a budget. You can delete your budget at any time.</p>
103
109
  * <important>
104
110
  * <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p>
@@ -108,6 +114,7 @@ export declare class Budgets extends BudgetsClient {
108
114
  deleteBudget(args: DeleteBudgetCommandInput, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void;
109
115
  deleteBudget(args: DeleteBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetCommandOutput) => void): void;
110
116
  /**
117
+ * @public
111
118
  * <p>
112
119
  * Deletes a budget action.
113
120
  * </p>
@@ -116,6 +123,7 @@ export declare class Budgets extends BudgetsClient {
116
123
  deleteBudgetAction(args: DeleteBudgetActionCommandInput, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void;
117
124
  deleteBudgetAction(args: DeleteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBudgetActionCommandOutput) => void): void;
118
125
  /**
126
+ * @public
119
127
  * <p>Deletes a notification.</p>
120
128
  * <important>
121
129
  * <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p>
@@ -125,6 +133,7 @@ export declare class Budgets extends BudgetsClient {
125
133
  deleteNotification(args: DeleteNotificationCommandInput, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void;
126
134
  deleteNotification(args: DeleteNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationCommandOutput) => void): void;
127
135
  /**
136
+ * @public
128
137
  * <p>Deletes a subscriber.</p>
129
138
  * <important>
130
139
  * <p>Deleting the last subscriber to a notification also deletes the notification.</p>
@@ -134,6 +143,7 @@ export declare class Budgets extends BudgetsClient {
134
143
  deleteSubscriber(args: DeleteSubscriberCommandInput, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
135
144
  deleteSubscriber(args: DeleteSubscriberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriberCommandOutput) => void): void;
136
145
  /**
146
+ * @public
137
147
  * <p>Describes a budget.</p>
138
148
  * <important>
139
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>
@@ -143,6 +153,7 @@ export declare class Budgets extends BudgetsClient {
143
153
  describeBudget(args: DescribeBudgetCommandInput, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void;
144
154
  describeBudget(args: DescribeBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetCommandOutput) => void): void;
145
155
  /**
156
+ * @public
146
157
  * <p>
147
158
  * Describes a budget action detail.
148
159
  * </p>
@@ -151,6 +162,7 @@ export declare class Budgets extends BudgetsClient {
151
162
  describeBudgetAction(args: DescribeBudgetActionCommandInput, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void;
152
163
  describeBudgetAction(args: DescribeBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionCommandOutput) => void): void;
153
164
  /**
165
+ * @public
154
166
  * <p>
155
167
  * Describes a budget action history detail.
156
168
  * </p>
@@ -159,6 +171,7 @@ export declare class Budgets extends BudgetsClient {
159
171
  describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void;
160
172
  describeBudgetActionHistories(args: DescribeBudgetActionHistoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionHistoriesCommandOutput) => void): void;
161
173
  /**
174
+ * @public
162
175
  * <p>
163
176
  * Describes all of the budget actions for an account.
164
177
  * </p>
@@ -167,6 +180,7 @@ export declare class Budgets extends BudgetsClient {
167
180
  describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void;
168
181
  describeBudgetActionsForAccount(args: DescribeBudgetActionsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForAccountCommandOutput) => void): void;
169
182
  /**
183
+ * @public
170
184
  * <p>
171
185
  * Describes all of the budget actions for a budget.
172
186
  * </p>
@@ -175,6 +189,7 @@ export declare class Budgets extends BudgetsClient {
175
189
  describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void;
176
190
  describeBudgetActionsForBudget(args: DescribeBudgetActionsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetActionsForBudgetCommandOutput) => void): void;
177
191
  /**
192
+ * @public
178
193
  * <p>
179
194
  * Lists the budget names and notifications that are associated with an account.
180
195
  * </p>
@@ -183,12 +198,14 @@ export declare class Budgets extends BudgetsClient {
183
198
  describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void;
184
199
  describeBudgetNotificationsForAccount(args: DescribeBudgetNotificationsForAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetNotificationsForAccountCommandOutput) => void): void;
185
200
  /**
201
+ * @public
186
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>
187
203
  */
188
204
  describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBudgetPerformanceHistoryCommandOutput>;
189
205
  describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void;
190
206
  describeBudgetPerformanceHistory(args: DescribeBudgetPerformanceHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetPerformanceHistoryCommandOutput) => void): void;
191
207
  /**
208
+ * @public
192
209
  * <p>Lists the budgets that are associated with an account.</p>
193
210
  * <important>
194
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>
@@ -198,18 +215,21 @@ export declare class Budgets extends BudgetsClient {
198
215
  describeBudgets(args: DescribeBudgetsCommandInput, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void;
199
216
  describeBudgets(args: DescribeBudgetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBudgetsCommandOutput) => void): void;
200
217
  /**
218
+ * @public
201
219
  * <p>Lists the notifications that are associated with a budget.</p>
202
220
  */
203
221
  describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeNotificationsForBudgetCommandOutput>;
204
222
  describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void;
205
223
  describeNotificationsForBudget(args: DescribeNotificationsForBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNotificationsForBudgetCommandOutput) => void): void;
206
224
  /**
225
+ * @public
207
226
  * <p>Lists the subscribers that are associated with a notification.</p>
208
227
  */
209
228
  describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSubscribersForNotificationCommandOutput>;
210
229
  describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void;
211
230
  describeSubscribersForNotification(args: DescribeSubscribersForNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscribersForNotificationCommandOutput) => void): void;
212
231
  /**
232
+ * @public
213
233
  * <p>
214
234
  * Executes a budget action.
215
235
  * </p>
@@ -218,6 +238,7 @@ export declare class Budgets extends BudgetsClient {
218
238
  executeBudgetAction(args: ExecuteBudgetActionCommandInput, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void;
219
239
  executeBudgetAction(args: ExecuteBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteBudgetActionCommandOutput) => void): void;
220
240
  /**
241
+ * @public
221
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>
222
243
  * <important>
223
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>
@@ -227,6 +248,7 @@ export declare class Budgets extends BudgetsClient {
227
248
  updateBudget(args: UpdateBudgetCommandInput, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void;
228
249
  updateBudget(args: UpdateBudgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetCommandOutput) => void): void;
229
250
  /**
251
+ * @public
230
252
  * <p>
231
253
  * Updates a budget action.
232
254
  * </p>
@@ -235,12 +257,14 @@ export declare class Budgets extends BudgetsClient {
235
257
  updateBudgetAction(args: UpdateBudgetActionCommandInput, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void;
236
258
  updateBudgetAction(args: UpdateBudgetActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBudgetActionCommandOutput) => void): void;
237
259
  /**
260
+ * @public
238
261
  * <p>Updates a notification.</p>
239
262
  */
240
263
  updateNotification(args: UpdateNotificationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNotificationCommandOutput>;
241
264
  updateNotification(args: UpdateNotificationCommandInput, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void;
242
265
  updateNotification(args: UpdateNotificationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNotificationCommandOutput) => void): void;
243
266
  /**
267
+ * @public
244
268
  * <p>Updates a subscriber.</p>
245
269
  */
246
270
  updateSubscriber(args: UpdateSubscriberCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSubscriberCommandOutput>;
@@ -31,15 +31,24 @@ import { UpdateBudgetCommandInput, UpdateBudgetCommandOutput } from "./commands/
31
31
  import { UpdateNotificationCommandInput, UpdateNotificationCommandOutput } from "./commands/UpdateNotificationCommand";
32
32
  import { UpdateSubscriberCommandInput, UpdateSubscriberCommandOutput } from "./commands/UpdateSubscriberCommand";
33
33
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
34
+ /**
35
+ * @public
36
+ */
34
37
  export type ServiceInputTypes = CreateBudgetActionCommandInput | CreateBudgetCommandInput | CreateNotificationCommandInput | CreateSubscriberCommandInput | DeleteBudgetActionCommandInput | DeleteBudgetCommandInput | DeleteNotificationCommandInput | DeleteSubscriberCommandInput | DescribeBudgetActionCommandInput | DescribeBudgetActionHistoriesCommandInput | DescribeBudgetActionsForAccountCommandInput | DescribeBudgetActionsForBudgetCommandInput | DescribeBudgetCommandInput | DescribeBudgetNotificationsForAccountCommandInput | DescribeBudgetPerformanceHistoryCommandInput | DescribeBudgetsCommandInput | DescribeNotificationsForBudgetCommandInput | DescribeSubscribersForNotificationCommandInput | ExecuteBudgetActionCommandInput | UpdateBudgetActionCommandInput | UpdateBudgetCommandInput | UpdateNotificationCommandInput | UpdateSubscriberCommandInput;
38
+ /**
39
+ * @public
40
+ */
35
41
  export type ServiceOutputTypes = CreateBudgetActionCommandOutput | CreateBudgetCommandOutput | CreateNotificationCommandOutput | CreateSubscriberCommandOutput | DeleteBudgetActionCommandOutput | DeleteBudgetCommandOutput | DeleteNotificationCommandOutput | DeleteSubscriberCommandOutput | DescribeBudgetActionCommandOutput | DescribeBudgetActionHistoriesCommandOutput | DescribeBudgetActionsForAccountCommandOutput | DescribeBudgetActionsForBudgetCommandOutput | DescribeBudgetCommandOutput | DescribeBudgetNotificationsForAccountCommandOutput | DescribeBudgetPerformanceHistoryCommandOutput | DescribeBudgetsCommandOutput | DescribeNotificationsForBudgetCommandOutput | DescribeSubscribersForNotificationCommandOutput | ExecuteBudgetActionCommandOutput | UpdateBudgetActionCommandOutput | UpdateBudgetCommandOutput | UpdateNotificationCommandOutput | UpdateSubscriberCommandOutput;
42
+ /**
43
+ * @public
44
+ */
36
45
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
37
46
  /**
38
47
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
39
48
  */
40
49
  requestHandler?: __HttpHandler;
41
50
  /**
42
- * A constructor for a class implementing the {@link __Checksum} interface
51
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
43
52
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
44
53
  * @internal
45
54
  */
@@ -129,23 +138,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
138
  */
130
139
  logger?: __Logger;
131
140
  /**
132
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
142
  */
134
143
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
135
144
  }
145
+ /**
146
+ * @public
147
+ */
136
148
  type BudgetsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
137
149
  /**
138
- * The configuration interface of BudgetsClient class constructor that set the region, credentials and other options.
150
+ * @public
151
+ *
152
+ * The configuration interface of BudgetsClient class constructor that set the region, credentials and other options.
139
153
  */
140
154
  export interface BudgetsClientConfig extends BudgetsClientConfigType {
141
155
  }
156
+ /**
157
+ * @public
158
+ */
142
159
  type BudgetsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
143
160
  /**
144
- * The resolved configuration interface of BudgetsClient class. This is resolved and normalized from the {@link BudgetsClientConfig | constructor configuration interface}.
161
+ * @public
162
+ *
163
+ * The resolved configuration interface of BudgetsClient class. This is resolved and normalized from the {@link BudgetsClientConfig | constructor configuration interface}.
145
164
  */
146
165
  export interface BudgetsClientResolvedConfig extends BudgetsClientResolvedConfigType {
147
166
  }
148
167
  /**
168
+ * @public
149
169
  * <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>
150
170
  * <p>Budgets provide you with a way to see the following information:</p>
151
171
  * <ul>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { CreateBudgetActionRequest, CreateBudgetActionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBudgetActionCommand}.
8
10
  */
9
11
  export interface CreateBudgetActionCommandInput extends CreateBudgetActionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBudgetActionCommand}.
13
17
  */
14
18
  export interface CreateBudgetActionCommandOutput extends CreateBudgetActionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Creates a budget action.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateBudgetActionCommandInput - {@link CreateBudgetActionCommandInput}
36
+ * @returns {@link CreateBudgetActionCommandOutput}
30
37
  * @see {@link CreateBudgetActionCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateBudgetActionCommandOutput} for command's `response` shape.
32
39
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo
59
66
  export declare class CreateBudgetActionCommand extends $Command<CreateBudgetActionCommandInput, CreateBudgetActionCommandOutput, BudgetsClientResolvedConfig> {
60
67
  readonly input: CreateBudgetActionCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateBudgetActionCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBudgetActionCommandInput, CreateBudgetActionCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { CreateBudgetRequest, CreateBudgetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBudgetCommand}.
8
10
  */
9
11
  export interface CreateBudgetCommandInput extends CreateBudgetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBudgetCommand}.
13
17
  */
14
18
  export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a budget and, if included, notifications and subscribers. </p>
18
23
  * <important>
19
24
  * <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>
@@ -28,6 +33,8 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateBudgetCommandInput - {@link CreateBudgetCommandInput}
37
+ * @returns {@link CreateBudgetCommandOutput}
31
38
  * @see {@link CreateBudgetCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateBudgetCommandOutput} for command's `response` shape.
33
40
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
57
64
  export declare class CreateBudgetCommand extends $Command<CreateBudgetCommandInput, CreateBudgetCommandOutput, BudgetsClientResolvedConfig> {
58
65
  readonly input: CreateBudgetCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateBudgetCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBudgetCommandInput, CreateBudgetCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { CreateNotificationRequest, CreateNotificationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNotificationCommand}.
8
10
  */
9
11
  export interface CreateNotificationCommandInput extends CreateNotificationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNotificationCommand}.
13
17
  */
14
18
  export interface CreateNotificationCommandOutput extends CreateNotificationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a notification. You must create the budget before you create the associated notification.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateNotificationCommandOutput extends CreateNotificationRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateNotificationCommandInput - {@link CreateNotificationCommandInput}
34
+ * @returns {@link CreateNotificationCommandOutput}
28
35
  * @see {@link CreateNotificationCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateNotificationCommandOutput} for command's `response` shape.
30
37
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateNotificationCommandOutput extends CreateNotificationRespo
57
64
  export declare class CreateNotificationCommand extends $Command<CreateNotificationCommandInput, CreateNotificationCommandOutput, BudgetsClientResolvedConfig> {
58
65
  readonly input: CreateNotificationCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateNotificationCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNotificationCommandInput, CreateNotificationCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { CreateSubscriberRequest, CreateSubscriberResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSubscriberCommand}.
8
10
  */
9
11
  export interface CreateSubscriberCommandInput extends CreateSubscriberRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSubscriberCommand}.
13
17
  */
14
18
  export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateSubscriberCommandInput - {@link CreateSubscriberCommandInput}
34
+ * @returns {@link CreateSubscriberCommandOutput}
28
35
  * @see {@link CreateSubscriberCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateSubscriberCommandOutput} for command's `response` shape.
30
37
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse,
57
64
  export declare class CreateSubscriberCommand extends $Command<CreateSubscriberCommandInput, CreateSubscriberCommandOutput, BudgetsClientResolvedConfig> {
58
65
  readonly input: CreateSubscriberCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateSubscriberCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSubscriberCommandInput, CreateSubscriberCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { DeleteBudgetActionRequest, DeleteBudgetActionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteBudgetActionCommand}.
8
10
  */
9
11
  export interface DeleteBudgetActionCommandInput extends DeleteBudgetActionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteBudgetActionCommand}.
13
17
  */
14
18
  export interface DeleteBudgetActionCommandOutput extends DeleteBudgetActionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Deletes a budget action.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface DeleteBudgetActionCommandOutput extends DeleteBudgetActionRespo
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteBudgetActionCommandInput - {@link DeleteBudgetActionCommandInput}
36
+ * @returns {@link DeleteBudgetActionCommandOutput}
30
37
  * @see {@link DeleteBudgetActionCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteBudgetActionCommandOutput} for command's `response` shape.
32
39
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DeleteBudgetActionCommandOutput extends DeleteBudgetActionRespo
57
64
  export declare class DeleteBudgetActionCommand extends $Command<DeleteBudgetActionCommandInput, DeleteBudgetActionCommandOutput, BudgetsClientResolvedConfig> {
58
65
  readonly input: DeleteBudgetActionCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DeleteBudgetActionCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteBudgetActionCommandInput, DeleteBudgetActionCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { DeleteBudgetRequest, DeleteBudgetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteBudgetCommand}.
8
10
  */
9
11
  export interface DeleteBudgetCommandInput extends DeleteBudgetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteBudgetCommand}.
13
17
  */
14
18
  export interface DeleteBudgetCommandOutput extends DeleteBudgetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a budget. You can delete your budget at any time.</p>
18
23
  * <important>
19
24
  * <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p>
@@ -28,6 +33,8 @@ export interface DeleteBudgetCommandOutput extends DeleteBudgetResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteBudgetCommandInput - {@link DeleteBudgetCommandInput}
37
+ * @returns {@link DeleteBudgetCommandOutput}
31
38
  * @see {@link DeleteBudgetCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteBudgetCommandOutput} for command's `response` shape.
33
40
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteBudgetCommandOutput extends DeleteBudgetResponse, __Metad
54
61
  export declare class DeleteBudgetCommand extends $Command<DeleteBudgetCommandInput, DeleteBudgetCommandOutput, BudgetsClientResolvedConfig> {
55
62
  readonly input: DeleteBudgetCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteBudgetCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteBudgetCommandInput, DeleteBudgetCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BudgetsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BudgetsClient";
5
5
  import { DeleteNotificationRequest, DeleteNotificationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteNotificationCommand}.
8
10
  */
9
11
  export interface DeleteNotificationCommandInput extends DeleteNotificationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteNotificationCommand}.
13
17
  */
14
18
  export interface DeleteNotificationCommandOutput extends DeleteNotificationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a notification.</p>
18
23
  * <important>
19
24
  * <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p>
@@ -28,6 +33,8 @@ export interface DeleteNotificationCommandOutput extends DeleteNotificationRespo
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteNotificationCommandInput - {@link DeleteNotificationCommandInput}
37
+ * @returns {@link DeleteNotificationCommandOutput}
31
38
  * @see {@link DeleteNotificationCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteNotificationCommandOutput} for command's `response` shape.
33
40
  * @see {@link BudgetsClientResolvedConfig | config} for BudgetsClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteNotificationCommandOutput extends DeleteNotificationRespo
54
61
  export declare class DeleteNotificationCommand extends $Command<DeleteNotificationCommandInput, DeleteNotificationCommandOutput, BudgetsClientResolvedConfig> {
55
62
  readonly input: DeleteNotificationCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteNotificationCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BudgetsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteNotificationCommandInput, DeleteNotificationCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }