@aws-sdk/client-budgets 3.51.0 → 3.54.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/CHANGELOG.md +30 -0
- package/README.md +5 -5
- package/dist-cjs/Budgets.js +15 -0
- package/dist-cjs/commands/DescribeBudgetNotificationsForAccountCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/BudgetsServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +164 -2
- package/dist-cjs/pagination/DescribeBudgetNotificationsForAccountPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +392 -937
- package/dist-es/Budgets.js +15 -0
- package/dist-es/commands/DescribeBudgetNotificationsForAccountCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/BudgetsServiceException.js +12 -0
- package/dist-es/models/models_0.js +144 -1
- package/dist-es/pagination/DescribeBudgetNotificationsForAccountPaginator.js +74 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +688 -1009
- package/dist-types/Budgets.d.ts +15 -6
- package/dist-types/BudgetsClient.d.ts +10 -9
- package/dist-types/commands/DescribeBudgetNotificationsForAccountCommand.d.ts +37 -0
- package/dist-types/commands/UpdateBudgetCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/BudgetsServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +345 -202
- package/dist-types/pagination/DescribeBudgetNotificationsForAccountPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/Budgets.d.ts +5 -0
- package/dist-types/ts3.4/BudgetsClient.d.ts +5 -4
- package/dist-types/ts3.4/commands/DescribeBudgetNotificationsForAccountCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/BudgetsServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +114 -32
- package/dist-types/ts3.4/pagination/DescribeBudgetNotificationsForAccountPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +33 -33
|
@@ -1,23 +1,26 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { BudgetsServiceException as __BaseException } from "./BudgetsServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>You are not authorized to use this operation with the given parameters.</p>
|
|
4
5
|
*/
|
|
5
|
-
export
|
|
6
|
-
name: "AccessDeniedException";
|
|
7
|
-
$fault: "client";
|
|
6
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
7
|
+
readonly name: "AccessDeniedException";
|
|
8
|
+
readonly $fault: "client";
|
|
8
9
|
/**
|
|
9
10
|
* <p>The error message the exception carries.</p>
|
|
10
11
|
*/
|
|
11
12
|
Message?: string;
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
12
17
|
}
|
|
13
18
|
export declare enum ThresholdType {
|
|
14
19
|
ABSOLUTE_VALUE = "ABSOLUTE_VALUE",
|
|
15
20
|
PERCENTAGE = "PERCENTAGE"
|
|
16
21
|
}
|
|
17
22
|
/**
|
|
18
|
-
* <p>
|
|
19
|
-
* The trigger threshold of the action.
|
|
20
|
-
* </p>
|
|
23
|
+
* <p>The trigger threshold of the action. </p>
|
|
21
24
|
*/
|
|
22
25
|
export interface ActionThreshold {
|
|
23
26
|
/**
|
|
@@ -45,33 +48,23 @@ export declare enum ApprovalModel {
|
|
|
45
48
|
MANUAL = "MANUAL"
|
|
46
49
|
}
|
|
47
50
|
/**
|
|
48
|
-
* <p>
|
|
49
|
-
* The AWS Identity and Access Management (IAM) action definition details.
|
|
50
|
-
* </p>
|
|
51
|
+
* <p>The Identity and Access Management (IAM) action definition details. </p>
|
|
51
52
|
*/
|
|
52
53
|
export interface IamActionDefinition {
|
|
53
54
|
/**
|
|
54
|
-
* <p>
|
|
55
|
-
* The Amazon Resource Name (ARN) of the policy to be attached.
|
|
56
|
-
* </p>
|
|
55
|
+
* <p>The Amazon Resource Name (ARN) of the policy to be attached. </p>
|
|
57
56
|
*/
|
|
58
57
|
PolicyArn: string | undefined;
|
|
59
58
|
/**
|
|
60
|
-
* <p>
|
|
61
|
-
* A list of roles to be attached. There must be at least one role.
|
|
62
|
-
* </p>
|
|
59
|
+
* <p>A list of roles to be attached. There must be at least one role. </p>
|
|
63
60
|
*/
|
|
64
61
|
Roles?: string[];
|
|
65
62
|
/**
|
|
66
|
-
* <p>
|
|
67
|
-
* A list of groups to be attached. There must be at least one group.
|
|
68
|
-
* </p>
|
|
63
|
+
* <p>A list of groups to be attached. There must be at least one group. </p>
|
|
69
64
|
*/
|
|
70
65
|
Groups?: string[];
|
|
71
66
|
/**
|
|
72
|
-
* <p>
|
|
73
|
-
* A list of users to be attached. There must be at least one user.
|
|
74
|
-
* </p>
|
|
67
|
+
* <p>A list of users to be attached. There must be at least one user. </p>
|
|
75
68
|
*/
|
|
76
69
|
Users?: string[];
|
|
77
70
|
}
|
|
@@ -82,21 +75,15 @@ export declare namespace IamActionDefinition {
|
|
|
82
75
|
const filterSensitiveLog: (obj: IamActionDefinition) => any;
|
|
83
76
|
}
|
|
84
77
|
/**
|
|
85
|
-
* <p>
|
|
86
|
-
* The service control policies (SCP) action definition details.
|
|
87
|
-
* </p>
|
|
78
|
+
* <p>The service control policies (SCP) action definition details. </p>
|
|
88
79
|
*/
|
|
89
80
|
export interface ScpActionDefinition {
|
|
90
81
|
/**
|
|
91
|
-
* <p>
|
|
92
|
-
* The policy ID attached.
|
|
93
|
-
* </p>
|
|
82
|
+
* <p>The policy ID attached. </p>
|
|
94
83
|
*/
|
|
95
84
|
PolicyId: string | undefined;
|
|
96
85
|
/**
|
|
97
|
-
* <p>
|
|
98
|
-
* A list of target IDs.
|
|
99
|
-
* </p>
|
|
86
|
+
* <p>A list of target IDs. </p>
|
|
100
87
|
*/
|
|
101
88
|
TargetIds: string[] | undefined;
|
|
102
89
|
}
|
|
@@ -111,27 +98,19 @@ export declare enum ActionSubType {
|
|
|
111
98
|
STOP_RDS = "STOP_RDS_INSTANCES"
|
|
112
99
|
}
|
|
113
100
|
/**
|
|
114
|
-
* <p>
|
|
115
|
-
* The AWS Systems Manager (SSM) action definition details.
|
|
116
|
-
* </p>
|
|
101
|
+
* <p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>
|
|
117
102
|
*/
|
|
118
103
|
export interface SsmActionDefinition {
|
|
119
104
|
/**
|
|
120
|
-
* <p>
|
|
121
|
-
* The action subType.
|
|
122
|
-
* </p>
|
|
105
|
+
* <p>The action subType. </p>
|
|
123
106
|
*/
|
|
124
107
|
ActionSubType: ActionSubType | string | undefined;
|
|
125
108
|
/**
|
|
126
|
-
* <p>
|
|
127
|
-
* The Region to run the SSM document.
|
|
128
|
-
* </p>
|
|
109
|
+
* <p>The Region to run the SSM document. </p>
|
|
129
110
|
*/
|
|
130
111
|
Region: string | undefined;
|
|
131
112
|
/**
|
|
132
|
-
* <p>
|
|
133
|
-
* The EC2 and RDS instance IDs.
|
|
134
|
-
* </p>
|
|
113
|
+
* <p>The EC2 and RDS instance IDs. </p>
|
|
135
114
|
*/
|
|
136
115
|
InstanceIds: string[] | undefined;
|
|
137
116
|
}
|
|
@@ -142,27 +121,19 @@ export declare namespace SsmActionDefinition {
|
|
|
142
121
|
const filterSensitiveLog: (obj: SsmActionDefinition) => any;
|
|
143
122
|
}
|
|
144
123
|
/**
|
|
145
|
-
* <p>
|
|
146
|
-
* Specifies all of the type-specific parameters.
|
|
147
|
-
* </p>
|
|
124
|
+
* <p>Specifies all of the type-specific parameters. </p>
|
|
148
125
|
*/
|
|
149
126
|
export interface Definition {
|
|
150
127
|
/**
|
|
151
|
-
* <p>
|
|
152
|
-
* The AWS Identity and Access Management (IAM) action definition details.
|
|
153
|
-
* </p>
|
|
128
|
+
* <p>The Identity and Access Management (IAM) action definition details. </p>
|
|
154
129
|
*/
|
|
155
130
|
IamActionDefinition?: IamActionDefinition;
|
|
156
131
|
/**
|
|
157
|
-
* <p>
|
|
158
|
-
* The service control policies (SCPs) action definition details.
|
|
159
|
-
* </p>
|
|
132
|
+
* <p>The service control policies (SCPs) action definition details. </p>
|
|
160
133
|
*/
|
|
161
134
|
ScpActionDefinition?: ScpActionDefinition;
|
|
162
135
|
/**
|
|
163
|
-
* <p>
|
|
164
|
-
* The AWS Systems Manager (SSM) action definition details.
|
|
165
|
-
* </p>
|
|
136
|
+
* <p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>
|
|
166
137
|
*/
|
|
167
138
|
SsmActionDefinition?: SsmActionDefinition;
|
|
168
139
|
}
|
|
@@ -194,7 +165,7 @@ export declare enum SubscriptionType {
|
|
|
194
165
|
}
|
|
195
166
|
/**
|
|
196
167
|
* <p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p>
|
|
197
|
-
* <p>For example, an email subscriber
|
|
168
|
+
* <p>For example, an email subscriber has the following parameters:</p>
|
|
198
169
|
* <ul>
|
|
199
170
|
* <li>
|
|
200
171
|
* <p>A <code>subscriptionType</code> of <code>EMAIL</code>
|
|
@@ -208,11 +179,11 @@ export declare enum SubscriptionType {
|
|
|
208
179
|
*/
|
|
209
180
|
export interface Subscriber {
|
|
210
181
|
/**
|
|
211
|
-
* <p>The type of notification that
|
|
182
|
+
* <p>The type of notification that Amazon Web Services sends to a subscriber.</p>
|
|
212
183
|
*/
|
|
213
184
|
SubscriptionType: SubscriptionType | string | undefined;
|
|
214
185
|
/**
|
|
215
|
-
* <p>The address that
|
|
186
|
+
* <p>The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.</p>
|
|
216
187
|
* <p>When you create a subscriber, the value of <code>Address</code> can't contain line breaks.</p>
|
|
217
188
|
*/
|
|
218
189
|
Address: string | undefined;
|
|
@@ -224,15 +195,11 @@ export declare namespace Subscriber {
|
|
|
224
195
|
const filterSensitiveLog: (obj: Subscriber) => any;
|
|
225
196
|
}
|
|
226
197
|
/**
|
|
227
|
-
* <p>
|
|
228
|
-
* A budget action resource.
|
|
229
|
-
* </p>
|
|
198
|
+
* <p>A budget action resource. </p>
|
|
230
199
|
*/
|
|
231
200
|
export interface Action {
|
|
232
201
|
/**
|
|
233
|
-
* <p>
|
|
234
|
-
* A system-generated universally unique identifier (UUID) for the action.
|
|
235
|
-
* </p>
|
|
202
|
+
* <p>A system-generated universally unique identifier (UUID) for the action. </p>
|
|
236
203
|
*/
|
|
237
204
|
ActionId: string | undefined;
|
|
238
205
|
/**
|
|
@@ -244,39 +211,29 @@ export interface Action {
|
|
|
244
211
|
*/
|
|
245
212
|
NotificationType: NotificationType | string | undefined;
|
|
246
213
|
/**
|
|
247
|
-
* <p>
|
|
248
|
-
*
|
|
249
|
-
* </p>
|
|
214
|
+
* <p>The type of action. This defines the type of tasks that can be carried out by this action.
|
|
215
|
+
* This field also determines the format for definition. </p>
|
|
250
216
|
*/
|
|
251
217
|
ActionType: ActionType | string | undefined;
|
|
252
218
|
/**
|
|
253
|
-
* <p>
|
|
254
|
-
* The trigger threshold of the action.
|
|
255
|
-
* </p>
|
|
219
|
+
* <p>The trigger threshold of the action. </p>
|
|
256
220
|
*/
|
|
257
221
|
ActionThreshold: ActionThreshold | undefined;
|
|
258
222
|
/**
|
|
259
|
-
* <p>
|
|
260
|
-
* Where you specify all of the type-specific parameters.
|
|
261
|
-
* </p>
|
|
223
|
+
* <p>Where you specify all of the type-specific parameters. </p>
|
|
262
224
|
*/
|
|
263
225
|
Definition: Definition | undefined;
|
|
264
226
|
/**
|
|
265
|
-
* <p>
|
|
266
|
-
*
|
|
267
|
-
* </p>
|
|
227
|
+
* <p>The role passed for action execution and reversion. Roles and actions must be in the same
|
|
228
|
+
* account. </p>
|
|
268
229
|
*/
|
|
269
230
|
ExecutionRoleArn: string | undefined;
|
|
270
231
|
/**
|
|
271
|
-
* <p>
|
|
272
|
-
* This specifies if the action needs manual or automatic approval.
|
|
273
|
-
* </p>
|
|
232
|
+
* <p>This specifies if the action needs manual or automatic approval. </p>
|
|
274
233
|
*/
|
|
275
234
|
ApprovalModel: ApprovalModel | string | undefined;
|
|
276
235
|
/**
|
|
277
|
-
* <p>
|
|
278
|
-
* The status of action.
|
|
279
|
-
* </p>
|
|
236
|
+
* <p>The status of the action. </p>
|
|
280
237
|
*/
|
|
281
238
|
Status: ActionStatus | string | undefined;
|
|
282
239
|
/**
|
|
@@ -291,9 +248,7 @@ export declare namespace Action {
|
|
|
291
248
|
const filterSensitiveLog: (obj: Action) => any;
|
|
292
249
|
}
|
|
293
250
|
/**
|
|
294
|
-
* <p>
|
|
295
|
-
* The description of details of the event.
|
|
296
|
-
* </p>
|
|
251
|
+
* <p>The description of the details for the event. </p>
|
|
297
252
|
*/
|
|
298
253
|
export interface ActionHistoryDetails {
|
|
299
254
|
/**
|
|
@@ -301,9 +256,7 @@ export interface ActionHistoryDetails {
|
|
|
301
256
|
*/
|
|
302
257
|
Message: string | undefined;
|
|
303
258
|
/**
|
|
304
|
-
* <p>
|
|
305
|
-
* The budget action resource.
|
|
306
|
-
* </p>
|
|
259
|
+
* <p>The budget action resource. </p>
|
|
307
260
|
*/
|
|
308
261
|
Action: Action | undefined;
|
|
309
262
|
}
|
|
@@ -321,31 +274,24 @@ export declare enum EventType {
|
|
|
321
274
|
UpdateAction = "UPDATE_ACTION"
|
|
322
275
|
}
|
|
323
276
|
/**
|
|
324
|
-
* <p>
|
|
325
|
-
* The historical records for a budget action.
|
|
326
|
-
* </p>
|
|
277
|
+
* <p>The historical records for a budget action. </p>
|
|
327
278
|
*/
|
|
328
279
|
export interface ActionHistory {
|
|
329
280
|
/**
|
|
330
|
-
* <p> A generic time stamp. In Java, it
|
|
281
|
+
* <p> A generic time stamp. In Java, it's transformed to a <code>Date</code> object.</p>
|
|
331
282
|
*/
|
|
332
283
|
Timestamp: Date | undefined;
|
|
333
284
|
/**
|
|
334
|
-
* <p>
|
|
335
|
-
* The status of action at the time of the event.
|
|
336
|
-
* </p>
|
|
285
|
+
* <p>The status of action at the time of the event. </p>
|
|
337
286
|
*/
|
|
338
287
|
Status: ActionStatus | string | undefined;
|
|
339
288
|
/**
|
|
340
|
-
* <p>
|
|
341
|
-
*
|
|
342
|
-
* </p>
|
|
289
|
+
* <p>This distinguishes between whether the events are triggered by the user or are generated by
|
|
290
|
+
* the system. </p>
|
|
343
291
|
*/
|
|
344
292
|
EventType: EventType | string | undefined;
|
|
345
293
|
/**
|
|
346
|
-
* <p>
|
|
347
|
-
* The description of details of the event.
|
|
348
|
-
* </p>
|
|
294
|
+
* <p>The description of the details for the event. </p>
|
|
349
295
|
*/
|
|
350
296
|
ActionHistoryDetails: ActionHistoryDetails | undefined;
|
|
351
297
|
}
|
|
@@ -355,9 +301,72 @@ export declare namespace ActionHistory {
|
|
|
355
301
|
*/
|
|
356
302
|
const filterSensitiveLog: (obj: ActionHistory) => any;
|
|
357
303
|
}
|
|
304
|
+
export declare enum AutoAdjustType {
|
|
305
|
+
FORECAST = "FORECAST",
|
|
306
|
+
HISTORICAL = "HISTORICAL"
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* <p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>
|
|
310
|
+
*/
|
|
311
|
+
export interface HistoricalOptions {
|
|
312
|
+
/**
|
|
313
|
+
* <p>The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the <code>TimeUnit</code> granularity of the budget:</p>
|
|
314
|
+
* <ul>
|
|
315
|
+
* <li>
|
|
316
|
+
* <p>For the <code>DAILY</code> granularity, the maximum value is <code>60</code>.</p>
|
|
317
|
+
* </li>
|
|
318
|
+
* <li>
|
|
319
|
+
* <p>For the <code>MONTHLY</code> granularity, the maximum value is <code>12</code>.</p>
|
|
320
|
+
* </li>
|
|
321
|
+
* <li>
|
|
322
|
+
* <p>For the <code>QUARTERLY</code> granularity, the maximum value is <code>4</code>.</p>
|
|
323
|
+
* </li>
|
|
324
|
+
* <li>
|
|
325
|
+
* <p>For the <code>ANNUALLY</code> granularity, the maximum value is <code>1</code>.</p>
|
|
326
|
+
* </li>
|
|
327
|
+
* </ul>
|
|
328
|
+
*/
|
|
329
|
+
BudgetAdjustmentPeriod: number | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The integer that describes how many budget periods in your <code>BudgetAdjustmentPeriod</code> are included in the calculation of your current <code>BudgetLimit</code>. If the first budget period in your <code>BudgetAdjustmentPeriod</code> has no cost data, then that budget period isn’t included in the average that determines your budget limit. </p>
|
|
332
|
+
* <p>For example, if you set <code>BudgetAdjustmentPeriod</code> as <code>4</code> quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, <code>LookBackAvailablePeriods</code> returns <code>3</code>. </p>
|
|
333
|
+
* <p>You can’t set your own <code>LookBackAvailablePeriods</code>. The value is automatically calculated from the <code>BudgetAdjustmentPeriod</code> and your historical cost data.</p>
|
|
334
|
+
*/
|
|
335
|
+
LookBackAvailablePeriods?: number;
|
|
336
|
+
}
|
|
337
|
+
export declare namespace HistoricalOptions {
|
|
338
|
+
/**
|
|
339
|
+
* @internal
|
|
340
|
+
*/
|
|
341
|
+
const filterSensitiveLog: (obj: HistoricalOptions) => any;
|
|
342
|
+
}
|
|
358
343
|
/**
|
|
359
|
-
* <p>The
|
|
360
|
-
|
|
344
|
+
* <p>The parameters that determine the budget amount for an auto-adjusting budget.</p>
|
|
345
|
+
*/
|
|
346
|
+
export interface AutoAdjustData {
|
|
347
|
+
/**
|
|
348
|
+
* <p>The string that defines whether your budget auto-adjusts based on historical or forecasted data.</p>
|
|
349
|
+
*/
|
|
350
|
+
AutoAdjustType: AutoAdjustType | string | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>
|
|
353
|
+
*/
|
|
354
|
+
HistoricalOptions?: HistoricalOptions;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The last time that your budget was auto-adjusted.</p>
|
|
357
|
+
*/
|
|
358
|
+
LastAutoAdjustTime?: Date;
|
|
359
|
+
}
|
|
360
|
+
export declare namespace AutoAdjustData {
|
|
361
|
+
/**
|
|
362
|
+
* @internal
|
|
363
|
+
*/
|
|
364
|
+
const filterSensitiveLog: (obj: AutoAdjustData) => any;
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* <p>The amount of cost or usage that's measured for a budget.</p>
|
|
368
|
+
* <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage has the following
|
|
369
|
+
* parameters:</p>
|
|
361
370
|
* <ul>
|
|
362
371
|
* <li>
|
|
363
372
|
* <p>An <code>Amount</code> of <code>3</code>
|
|
@@ -371,11 +380,13 @@ export declare namespace ActionHistory {
|
|
|
371
380
|
*/
|
|
372
381
|
export interface Spend {
|
|
373
382
|
/**
|
|
374
|
-
* <p>The cost or usage amount that
|
|
383
|
+
* <p>The cost or usage amount that's associated with a budget forecast, actual spend, or budget
|
|
384
|
+
* threshold.</p>
|
|
375
385
|
*/
|
|
376
386
|
Amount: string | undefined;
|
|
377
387
|
/**
|
|
378
|
-
* <p>The unit of measurement that
|
|
388
|
+
* <p>The unit of measurement that's used for the budget forecast, actual spend, or budget
|
|
389
|
+
* threshold, such as USD or GBP.</p>
|
|
379
390
|
*/
|
|
380
391
|
Unit: string | undefined;
|
|
381
392
|
}
|
|
@@ -394,16 +405,22 @@ export declare enum BudgetType {
|
|
|
394
405
|
Usage = "USAGE"
|
|
395
406
|
}
|
|
396
407
|
/**
|
|
397
|
-
* <p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks
|
|
398
|
-
*
|
|
408
|
+
* <p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks
|
|
409
|
+
* how much you've used, cost, usage, RI units, or Savings Plans units and the
|
|
410
|
+
* <code>forecastedSpend</code> tracks how much that you're predicted to spend based on
|
|
411
|
+
* your historical usage profile.</p>
|
|
412
|
+
* <p>For example, if it's the 20th of the month and you have spent <code>50</code> dollars on
|
|
413
|
+
* Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your
|
|
414
|
+
* <code>forecastedSpend</code> is <code>75 USD</code>.</p>
|
|
399
415
|
*/
|
|
400
416
|
export interface CalculatedSpend {
|
|
401
417
|
/**
|
|
402
|
-
* <p>The amount of cost, usage, RI units, or Savings Plans units that you
|
|
418
|
+
* <p>The amount of cost, usage, RI units, or Savings Plans units that you used.</p>
|
|
403
419
|
*/
|
|
404
420
|
ActualSpend: Spend | undefined;
|
|
405
421
|
/**
|
|
406
|
-
* <p>The amount of cost, usage, RI units, or Savings Plans units that you
|
|
422
|
+
* <p>The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to
|
|
423
|
+
* use.</p>
|
|
407
424
|
*/
|
|
408
425
|
ForecastedSpend?: Spend;
|
|
409
426
|
}
|
|
@@ -416,7 +433,9 @@ export declare namespace CalculatedSpend {
|
|
|
416
433
|
/**
|
|
417
434
|
* <p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p>
|
|
418
435
|
* <p>
|
|
419
|
-
* <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>,
|
|
436
|
+
* <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>,
|
|
437
|
+
* <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code>
|
|
438
|
+
* budgets don't have <code>CostTypes</code>.</p>
|
|
420
439
|
*/
|
|
421
440
|
export interface CostTypes {
|
|
422
441
|
/**
|
|
@@ -482,17 +501,20 @@ export declare namespace CostTypes {
|
|
|
482
501
|
const filterSensitiveLog: (obj: CostTypes) => any;
|
|
483
502
|
}
|
|
484
503
|
/**
|
|
485
|
-
* <p>The period of time that
|
|
504
|
+
* <p>The period of time that's covered by a budget. The period has a start date and an end date.
|
|
505
|
+
* The start date must come before the end date. There are no restrictions on the end date. </p>
|
|
486
506
|
*/
|
|
487
507
|
export interface TimePeriod {
|
|
488
508
|
/**
|
|
489
|
-
* <p>The start date for a budget. If you created your budget and didn't specify a start date,
|
|
509
|
+
* <p>The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p>
|
|
490
510
|
* <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>
|
|
491
511
|
*/
|
|
492
512
|
Start?: Date;
|
|
493
513
|
/**
|
|
494
|
-
* <p>The end date for a budget. If you didn't specify an end date,
|
|
495
|
-
* <p>After the end date,
|
|
514
|
+
* <p>The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p>
|
|
515
|
+
* <p>After the end date, Amazon Web Services deletes the budget and all the associated
|
|
516
|
+
* notifications and subscribers. You can change your end date with the
|
|
517
|
+
* <code>UpdateBudget</code> operation.</p>
|
|
496
518
|
*/
|
|
497
519
|
End?: Date;
|
|
498
520
|
}
|
|
@@ -510,7 +532,7 @@ export declare enum TimeUnit {
|
|
|
510
532
|
}
|
|
511
533
|
/**
|
|
512
534
|
* <p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p>
|
|
513
|
-
* <p>This is the ARN pattern for a budget: </p>
|
|
535
|
+
* <p>This is the Amazon Resource Name (ARN) pattern for a budget: </p>
|
|
514
536
|
* <p>
|
|
515
537
|
* <code>arn:aws:budgets::AccountId:budget/budgetName</code>
|
|
516
538
|
* </p>
|
|
@@ -521,32 +543,50 @@ export interface Budget {
|
|
|
521
543
|
*/
|
|
522
544
|
BudgetName: string | undefined;
|
|
523
545
|
/**
|
|
524
|
-
* <p>The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or
|
|
546
|
+
* <p>The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or
|
|
547
|
+
* Savings Plans coverage that you want to track with your budget.</p>
|
|
525
548
|
* <p>
|
|
526
|
-
* <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI or
|
|
549
|
+
* <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI or
|
|
550
|
+
* Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or
|
|
551
|
+
* coverage budgets default to <code>100</code>. This is the only valid value for RI or
|
|
552
|
+
* Savings Plans utilization or coverage budgets. You can't use <code>BudgetLimit</code>
|
|
553
|
+
* with <code>PlannedBudgetLimits</code> for <code>CreateBudget</code> and
|
|
554
|
+
* <code>UpdateBudget</code> actions. </p>
|
|
527
555
|
*/
|
|
528
556
|
BudgetLimit?: Spend;
|
|
529
557
|
/**
|
|
530
558
|
* <p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p>
|
|
531
559
|
* <p>
|
|
532
|
-
* <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports
|
|
560
|
+
* <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports both
|
|
561
|
+
* monthly and quarterly <code>TimeUnit</code>. </p>
|
|
533
562
|
* <p>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </p>
|
|
534
|
-
* <p>For quarterly budgets, provide
|
|
535
|
-
*
|
|
563
|
+
* <p>For quarterly budgets, provide four quarters of <code>PlannedBudgetLimits</code> value
|
|
564
|
+
* entries in standard calendar quarter increments. This must start from the current
|
|
565
|
+
* quarter and include the next three quarters. The <code>key</code> is the start of the
|
|
566
|
+
* quarter, <code>UTC</code> in epoch seconds. </p>
|
|
567
|
+
* <p>If the planned budget expires before 12 months for monthly or four quarters for quarterly,
|
|
568
|
+
* provide the <code>PlannedBudgetLimits</code> values only for the remaining
|
|
569
|
+
* periods.</p>
|
|
536
570
|
* <p>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </p>
|
|
537
571
|
* <p>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </p>
|
|
538
572
|
* <p>
|
|
539
|
-
* <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with
|
|
573
|
+
* <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with
|
|
574
|
+
* <code>PlannedBudgetLimits</code> also contain <code>BudgetLimit</code> representing
|
|
575
|
+
* the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This
|
|
576
|
+
* only applies to budgets that are created with <code>PlannedBudgetLimits</code>. Budgets
|
|
577
|
+
* that are created without <code>PlannedBudgetLimits</code> only contain
|
|
578
|
+
* <code>BudgetLimit</code>. They don't contain
|
|
579
|
+
* <code>PlannedBudgetLimits</code>.</p>
|
|
540
580
|
*/
|
|
541
581
|
PlannedBudgetLimits?: {
|
|
542
582
|
[key: string]: Spend;
|
|
543
583
|
};
|
|
544
584
|
/**
|
|
545
|
-
* <p>The cost filters, such as
|
|
546
|
-
* <p>
|
|
585
|
+
* <p>The cost filters, such as <code>Region</code>, <code>Service</code>, <code>member account</code>, <code>Tag</code>, or <code>Cost Category</code>, that are applied to a budget.</p>
|
|
586
|
+
* <p>Amazon Web Services Budgets supports the following services as a <code>Service</code> filter for RI budgets:</p>
|
|
547
587
|
* <ul>
|
|
548
588
|
* <li>
|
|
549
|
-
* <p>Amazon
|
|
589
|
+
* <p>Amazon EC2</p>
|
|
550
590
|
* </li>
|
|
551
591
|
* <li>
|
|
552
592
|
* <p>Amazon Redshift</p>
|
|
@@ -558,7 +598,7 @@ export interface Budget {
|
|
|
558
598
|
* <p>Amazon ElastiCache</p>
|
|
559
599
|
* </li>
|
|
560
600
|
* <li>
|
|
561
|
-
* <p>Amazon
|
|
601
|
+
* <p>Amazon OpenSearch Service</p>
|
|
562
602
|
* </li>
|
|
563
603
|
* </ul>
|
|
564
604
|
*/
|
|
@@ -576,10 +616,19 @@ export interface Budget {
|
|
|
576
616
|
*/
|
|
577
617
|
TimeUnit: TimeUnit | string | undefined;
|
|
578
618
|
/**
|
|
579
|
-
* <p>The period of time that
|
|
580
|
-
*
|
|
619
|
+
* <p>The period of time that's covered by a budget. You setthe start date and end date. The start
|
|
620
|
+
* date must come before the end date. The end date must come before <code>06/15/87 00:00
|
|
621
|
+
* UTC</code>. </p>
|
|
622
|
+
* <p>If you create your budget and don't specify a start date, Amazon Web Services defaults to the
|
|
623
|
+
* start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example,
|
|
624
|
+
* if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set
|
|
625
|
+
* a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>.
|
|
626
|
+
* If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to
|
|
627
|
+
* <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for
|
|
628
|
+
* the Billing and Cost Management console and the API. </p>
|
|
581
629
|
* <p>You can change either date with the <code>UpdateBudget</code> operation.</p>
|
|
582
|
-
* <p>After the end date,
|
|
630
|
+
* <p>After the end date, Amazon Web Services deletes the budget and all the associated
|
|
631
|
+
* notifications and subscribers.</p>
|
|
583
632
|
*/
|
|
584
633
|
TimePeriod?: TimePeriod;
|
|
585
634
|
/**
|
|
@@ -587,13 +636,18 @@ export interface Budget {
|
|
|
587
636
|
*/
|
|
588
637
|
CalculatedSpend?: CalculatedSpend;
|
|
589
638
|
/**
|
|
590
|
-
* <p>
|
|
639
|
+
* <p>Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings
|
|
640
|
+
* Plans utilization, or Savings Plans coverage.</p>
|
|
591
641
|
*/
|
|
592
642
|
BudgetType: BudgetType | string | undefined;
|
|
593
643
|
/**
|
|
594
644
|
* <p>The last time that you updated this budget.</p>
|
|
595
645
|
*/
|
|
596
646
|
LastUpdatedTime?: Date;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The parameters that determine the budget amount for an auto-adjusting budget.</p>
|
|
649
|
+
*/
|
|
650
|
+
AutoAdjustData?: AutoAdjustData;
|
|
597
651
|
}
|
|
598
652
|
export declare namespace Budget {
|
|
599
653
|
/**
|
|
@@ -611,7 +665,7 @@ export declare enum NotificationState {
|
|
|
611
665
|
OK = "OK"
|
|
612
666
|
}
|
|
613
667
|
/**
|
|
614
|
-
* <p>A notification that
|
|
668
|
+
* <p>A notification that's associated with a budget. A budget can have up to ten notifications. </p>
|
|
615
669
|
* <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p>
|
|
616
670
|
* <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p>
|
|
617
671
|
* <ul>
|
|
@@ -635,23 +689,27 @@ export declare enum NotificationState {
|
|
|
635
689
|
*/
|
|
636
690
|
export interface Notification {
|
|
637
691
|
/**
|
|
638
|
-
* <p>
|
|
692
|
+
* <p>Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or
|
|
693
|
+
* for how much that you're forecasted to spend (<code>FORECASTED</code>).</p>
|
|
639
694
|
*/
|
|
640
695
|
NotificationType: NotificationType | string | undefined;
|
|
641
696
|
/**
|
|
642
|
-
* <p>The comparison that
|
|
697
|
+
* <p>The comparison that's used for this notification.</p>
|
|
643
698
|
*/
|
|
644
699
|
ComparisonOperator: ComparisonOperator | string | undefined;
|
|
645
700
|
/**
|
|
646
|
-
* <p>The threshold that
|
|
701
|
+
* <p>The threshold that's associated with a notification. Thresholds are always a percentage, and
|
|
702
|
+
* many customers find value being alerted between 50% - 200% of the budgeted amount. The
|
|
703
|
+
* maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>
|
|
647
704
|
*/
|
|
648
705
|
Threshold: number | undefined;
|
|
649
706
|
/**
|
|
650
|
-
* <p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds,
|
|
707
|
+
* <p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.</p>
|
|
651
708
|
*/
|
|
652
709
|
ThresholdType?: ThresholdType | string;
|
|
653
710
|
/**
|
|
654
|
-
* <p>
|
|
711
|
+
* <p>Specifies whether this notification is in alarm. If a budget notification is in the
|
|
712
|
+
* <code>ALARM</code> state, you passed the set threshold for the budget.</p>
|
|
655
713
|
*/
|
|
656
714
|
NotificationState?: NotificationState | string;
|
|
657
715
|
}
|
|
@@ -666,7 +724,7 @@ export declare namespace Notification {
|
|
|
666
724
|
*/
|
|
667
725
|
export interface NotificationWithSubscribers {
|
|
668
726
|
/**
|
|
669
|
-
* <p>The notification that
|
|
727
|
+
* <p>The notification that's associated with a budget.</p>
|
|
670
728
|
*/
|
|
671
729
|
Notification: Notification | undefined;
|
|
672
730
|
/**
|
|
@@ -693,7 +751,7 @@ export interface CreateBudgetRequest {
|
|
|
693
751
|
*/
|
|
694
752
|
Budget: Budget | undefined;
|
|
695
753
|
/**
|
|
696
|
-
* <p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call,
|
|
754
|
+
* <p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, Amazon Web Services creates the notifications and subscribers for you.</p>
|
|
697
755
|
*/
|
|
698
756
|
NotificationsWithSubscribers?: NotificationWithSubscribers[];
|
|
699
757
|
}
|
|
@@ -717,50 +775,66 @@ export declare namespace CreateBudgetResponse {
|
|
|
717
775
|
/**
|
|
718
776
|
* <p>You've exceeded the notification or subscriber limit.</p>
|
|
719
777
|
*/
|
|
720
|
-
export
|
|
721
|
-
name: "CreationLimitExceededException";
|
|
722
|
-
$fault: "client";
|
|
778
|
+
export declare class CreationLimitExceededException extends __BaseException {
|
|
779
|
+
readonly name: "CreationLimitExceededException";
|
|
780
|
+
readonly $fault: "client";
|
|
723
781
|
/**
|
|
724
782
|
* <p>The error message the exception carries.</p>
|
|
725
783
|
*/
|
|
726
784
|
Message?: string;
|
|
785
|
+
/**
|
|
786
|
+
* @internal
|
|
787
|
+
*/
|
|
788
|
+
constructor(opts: __ExceptionOptionType<CreationLimitExceededException, __BaseException>);
|
|
727
789
|
}
|
|
728
790
|
/**
|
|
729
791
|
* <p>The budget name already exists. Budget names must be unique within an account.</p>
|
|
730
792
|
*/
|
|
731
|
-
export
|
|
732
|
-
name: "DuplicateRecordException";
|
|
733
|
-
$fault: "client";
|
|
793
|
+
export declare class DuplicateRecordException extends __BaseException {
|
|
794
|
+
readonly name: "DuplicateRecordException";
|
|
795
|
+
readonly $fault: "client";
|
|
734
796
|
/**
|
|
735
797
|
* <p>The error message the exception carries.</p>
|
|
736
798
|
*/
|
|
737
799
|
Message?: string;
|
|
800
|
+
/**
|
|
801
|
+
* @internal
|
|
802
|
+
*/
|
|
803
|
+
constructor(opts: __ExceptionOptionType<DuplicateRecordException, __BaseException>);
|
|
738
804
|
}
|
|
739
805
|
/**
|
|
740
806
|
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
|
|
741
807
|
*/
|
|
742
|
-
export
|
|
743
|
-
name: "InternalErrorException";
|
|
744
|
-
$fault: "server";
|
|
808
|
+
export declare class InternalErrorException extends __BaseException {
|
|
809
|
+
readonly name: "InternalErrorException";
|
|
810
|
+
readonly $fault: "server";
|
|
745
811
|
/**
|
|
746
812
|
* <p>The error message the exception carries.</p>
|
|
747
813
|
*/
|
|
748
814
|
Message?: string;
|
|
815
|
+
/**
|
|
816
|
+
* @internal
|
|
817
|
+
*/
|
|
818
|
+
constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
|
|
749
819
|
}
|
|
750
820
|
/**
|
|
751
821
|
* <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
|
|
752
822
|
*/
|
|
753
|
-
export
|
|
754
|
-
name: "InvalidParameterException";
|
|
755
|
-
$fault: "client";
|
|
823
|
+
export declare class InvalidParameterException extends __BaseException {
|
|
824
|
+
readonly name: "InvalidParameterException";
|
|
825
|
+
readonly $fault: "client";
|
|
756
826
|
/**
|
|
757
827
|
* <p>The error message the exception carries.</p>
|
|
758
828
|
*/
|
|
759
829
|
Message?: string;
|
|
830
|
+
/**
|
|
831
|
+
* @internal
|
|
832
|
+
*/
|
|
833
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
760
834
|
}
|
|
761
835
|
export interface CreateBudgetActionRequest {
|
|
762
836
|
/**
|
|
763
|
-
* <p>The account ID of the user. It
|
|
837
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
764
838
|
*/
|
|
765
839
|
AccountId: string | undefined;
|
|
766
840
|
/**
|
|
@@ -778,15 +852,11 @@ export interface CreateBudgetActionRequest {
|
|
|
778
852
|
*/
|
|
779
853
|
ActionType: ActionType | string | undefined;
|
|
780
854
|
/**
|
|
781
|
-
* <p>
|
|
782
|
-
* The trigger threshold of the action.
|
|
783
|
-
* </p>
|
|
855
|
+
* <p>The trigger threshold of the action. </p>
|
|
784
856
|
*/
|
|
785
857
|
ActionThreshold: ActionThreshold | undefined;
|
|
786
858
|
/**
|
|
787
|
-
* <p>
|
|
788
|
-
* Specifies all of the type-specific parameters.
|
|
789
|
-
* </p>
|
|
859
|
+
* <p>Specifies all of the type-specific parameters. </p>
|
|
790
860
|
*/
|
|
791
861
|
Definition: Definition | undefined;
|
|
792
862
|
/**
|
|
@@ -814,7 +884,7 @@ export declare namespace CreateBudgetActionRequest {
|
|
|
814
884
|
}
|
|
815
885
|
export interface CreateBudgetActionResponse {
|
|
816
886
|
/**
|
|
817
|
-
* <p>The account ID of the user. It
|
|
887
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
818
888
|
*/
|
|
819
889
|
AccountId: string | undefined;
|
|
820
890
|
/**
|
|
@@ -837,13 +907,17 @@ export declare namespace CreateBudgetActionResponse {
|
|
|
837
907
|
/**
|
|
838
908
|
* <p>We can’t locate the resource that you specified.</p>
|
|
839
909
|
*/
|
|
840
|
-
export
|
|
841
|
-
name: "NotFoundException";
|
|
842
|
-
$fault: "client";
|
|
910
|
+
export declare class NotFoundException extends __BaseException {
|
|
911
|
+
readonly name: "NotFoundException";
|
|
912
|
+
readonly $fault: "client";
|
|
843
913
|
/**
|
|
844
914
|
* <p>The error message the exception carries.</p>
|
|
845
915
|
*/
|
|
846
916
|
Message?: string;
|
|
917
|
+
/**
|
|
918
|
+
* @internal
|
|
919
|
+
*/
|
|
920
|
+
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
847
921
|
}
|
|
848
922
|
/**
|
|
849
923
|
* <p> Request of CreateNotification </p>
|
|
@@ -854,7 +928,7 @@ export interface CreateNotificationRequest {
|
|
|
854
928
|
*/
|
|
855
929
|
AccountId: string | undefined;
|
|
856
930
|
/**
|
|
857
|
-
* <p>The name of the budget that you want
|
|
931
|
+
* <p>The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.</p>
|
|
858
932
|
*/
|
|
859
933
|
BudgetName: string | undefined;
|
|
860
934
|
/**
|
|
@@ -953,7 +1027,7 @@ export declare namespace DeleteBudgetResponse {
|
|
|
953
1027
|
}
|
|
954
1028
|
export interface DeleteBudgetActionRequest {
|
|
955
1029
|
/**
|
|
956
|
-
* <p>The account ID of the user. It
|
|
1030
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
957
1031
|
*/
|
|
958
1032
|
AccountId: string | undefined;
|
|
959
1033
|
/**
|
|
@@ -975,7 +1049,7 @@ export declare namespace DeleteBudgetActionRequest {
|
|
|
975
1049
|
}
|
|
976
1050
|
export interface DeleteBudgetActionResponse {
|
|
977
1051
|
/**
|
|
978
|
-
* <p>The account ID of the user. It
|
|
1052
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
979
1053
|
*/
|
|
980
1054
|
AccountId: string | undefined;
|
|
981
1055
|
/**
|
|
@@ -983,9 +1057,7 @@ export interface DeleteBudgetActionResponse {
|
|
|
983
1057
|
*/
|
|
984
1058
|
BudgetName: string | undefined;
|
|
985
1059
|
/**
|
|
986
|
-
* <p>
|
|
987
|
-
* A budget action resource.
|
|
988
|
-
* </p>
|
|
1060
|
+
* <p>A budget action resource. </p>
|
|
989
1061
|
*/
|
|
990
1062
|
Action: Action | undefined;
|
|
991
1063
|
}
|
|
@@ -999,13 +1071,17 @@ export declare namespace DeleteBudgetActionResponse {
|
|
|
999
1071
|
* <p> The request was received and recognized by the server, but the server rejected that
|
|
1000
1072
|
* particular method for the requested resource. </p>
|
|
1001
1073
|
*/
|
|
1002
|
-
export
|
|
1003
|
-
name: "ResourceLockedException";
|
|
1004
|
-
$fault: "client";
|
|
1074
|
+
export declare class ResourceLockedException extends __BaseException {
|
|
1075
|
+
readonly name: "ResourceLockedException";
|
|
1076
|
+
readonly $fault: "client";
|
|
1005
1077
|
/**
|
|
1006
1078
|
* <p>The error message the exception carries.</p>
|
|
1007
1079
|
*/
|
|
1008
1080
|
Message?: string;
|
|
1081
|
+
/**
|
|
1082
|
+
* @internal
|
|
1083
|
+
*/
|
|
1084
|
+
constructor(opts: __ExceptionOptionType<ResourceLockedException, __BaseException>);
|
|
1009
1085
|
}
|
|
1010
1086
|
/**
|
|
1011
1087
|
* <p> Request of DeleteNotification </p>
|
|
@@ -1115,7 +1191,7 @@ export declare namespace DescribeBudgetResponse {
|
|
|
1115
1191
|
}
|
|
1116
1192
|
export interface DescribeBudgetActionRequest {
|
|
1117
1193
|
/**
|
|
1118
|
-
* <p>The account ID of the user. It
|
|
1194
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1119
1195
|
*/
|
|
1120
1196
|
AccountId: string | undefined;
|
|
1121
1197
|
/**
|
|
@@ -1137,7 +1213,7 @@ export declare namespace DescribeBudgetActionRequest {
|
|
|
1137
1213
|
}
|
|
1138
1214
|
export interface DescribeBudgetActionResponse {
|
|
1139
1215
|
/**
|
|
1140
|
-
* <p>The account ID of the user. It
|
|
1216
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1141
1217
|
*/
|
|
1142
1218
|
AccountId: string | undefined;
|
|
1143
1219
|
/**
|
|
@@ -1159,7 +1235,7 @@ export declare namespace DescribeBudgetActionResponse {
|
|
|
1159
1235
|
}
|
|
1160
1236
|
export interface DescribeBudgetActionHistoriesRequest {
|
|
1161
1237
|
/**
|
|
1162
|
-
* <p>The account ID of the user. It
|
|
1238
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1163
1239
|
*/
|
|
1164
1240
|
AccountId: string | undefined;
|
|
1165
1241
|
/**
|
|
@@ -1173,7 +1249,8 @@ export interface DescribeBudgetActionHistoriesRequest {
|
|
|
1173
1249
|
*/
|
|
1174
1250
|
ActionId: string | undefined;
|
|
1175
1251
|
/**
|
|
1176
|
-
* <p>The period of time that
|
|
1252
|
+
* <p>The period of time that's covered by a budget. The period has a start date and an end date.
|
|
1253
|
+
* The start date must come before the end date. There are no restrictions on the end date. </p>
|
|
1177
1254
|
*/
|
|
1178
1255
|
TimePeriod?: TimePeriod;
|
|
1179
1256
|
/**
|
|
@@ -1212,17 +1289,21 @@ export declare namespace DescribeBudgetActionHistoriesResponse {
|
|
|
1212
1289
|
/**
|
|
1213
1290
|
* <p>The pagination token is invalid.</p>
|
|
1214
1291
|
*/
|
|
1215
|
-
export
|
|
1216
|
-
name: "InvalidNextTokenException";
|
|
1217
|
-
$fault: "client";
|
|
1292
|
+
export declare class InvalidNextTokenException extends __BaseException {
|
|
1293
|
+
readonly name: "InvalidNextTokenException";
|
|
1294
|
+
readonly $fault: "client";
|
|
1218
1295
|
/**
|
|
1219
1296
|
* <p>The error message the exception carries.</p>
|
|
1220
1297
|
*/
|
|
1221
1298
|
Message?: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* @internal
|
|
1301
|
+
*/
|
|
1302
|
+
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
1222
1303
|
}
|
|
1223
1304
|
export interface DescribeBudgetActionsForAccountRequest {
|
|
1224
1305
|
/**
|
|
1225
|
-
* <p>The account ID of the user. It
|
|
1306
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1226
1307
|
*/
|
|
1227
1308
|
AccountId: string | undefined;
|
|
1228
1309
|
/**
|
|
@@ -1260,7 +1341,7 @@ export declare namespace DescribeBudgetActionsForAccountResponse {
|
|
|
1260
1341
|
}
|
|
1261
1342
|
export interface DescribeBudgetActionsForBudgetRequest {
|
|
1262
1343
|
/**
|
|
1263
|
-
* <p>The account ID of the user. It
|
|
1344
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1264
1345
|
*/
|
|
1265
1346
|
AccountId: string | undefined;
|
|
1266
1347
|
/**
|
|
@@ -1300,9 +1381,85 @@ export declare namespace DescribeBudgetActionsForBudgetResponse {
|
|
|
1300
1381
|
*/
|
|
1301
1382
|
const filterSensitiveLog: (obj: DescribeBudgetActionsForBudgetResponse) => any;
|
|
1302
1383
|
}
|
|
1384
|
+
export interface DescribeBudgetNotificationsForAccountRequest {
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1387
|
+
*/
|
|
1388
|
+
AccountId: string | undefined;
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>
|
|
1391
|
+
* An integer that shows how many budget name entries a paginated response contains.
|
|
1392
|
+
* </p>
|
|
1393
|
+
*/
|
|
1394
|
+
MaxResults?: number;
|
|
1395
|
+
/**
|
|
1396
|
+
* <p> A generic string.</p>
|
|
1397
|
+
*/
|
|
1398
|
+
NextToken?: string;
|
|
1399
|
+
}
|
|
1400
|
+
export declare namespace DescribeBudgetNotificationsForAccountRequest {
|
|
1401
|
+
/**
|
|
1402
|
+
* @internal
|
|
1403
|
+
*/
|
|
1404
|
+
const filterSensitiveLog: (obj: DescribeBudgetNotificationsForAccountRequest) => any;
|
|
1405
|
+
}
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>
|
|
1408
|
+
* The budget name and associated notifications for an account.
|
|
1409
|
+
* </p>
|
|
1410
|
+
*/
|
|
1411
|
+
export interface BudgetNotificationsForAccount {
|
|
1412
|
+
/**
|
|
1413
|
+
* <p> A list of notifications.</p>
|
|
1414
|
+
*/
|
|
1415
|
+
Notifications?: Notification[];
|
|
1416
|
+
/**
|
|
1417
|
+
* <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
|
|
1418
|
+
*/
|
|
1419
|
+
BudgetName?: string;
|
|
1420
|
+
}
|
|
1421
|
+
export declare namespace BudgetNotificationsForAccount {
|
|
1422
|
+
/**
|
|
1423
|
+
* @internal
|
|
1424
|
+
*/
|
|
1425
|
+
const filterSensitiveLog: (obj: BudgetNotificationsForAccount) => any;
|
|
1426
|
+
}
|
|
1427
|
+
export interface DescribeBudgetNotificationsForAccountResponse {
|
|
1428
|
+
/**
|
|
1429
|
+
* <p>
|
|
1430
|
+
* A list of budget names and associated notifications for an account.
|
|
1431
|
+
* </p>
|
|
1432
|
+
*/
|
|
1433
|
+
BudgetNotificationsForAccount?: BudgetNotificationsForAccount[];
|
|
1434
|
+
/**
|
|
1435
|
+
* <p> A generic string.</p>
|
|
1436
|
+
*/
|
|
1437
|
+
NextToken?: string;
|
|
1438
|
+
}
|
|
1439
|
+
export declare namespace DescribeBudgetNotificationsForAccountResponse {
|
|
1440
|
+
/**
|
|
1441
|
+
* @internal
|
|
1442
|
+
*/
|
|
1443
|
+
const filterSensitiveLog: (obj: DescribeBudgetNotificationsForAccountResponse) => any;
|
|
1444
|
+
}
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>The pagination token expired.</p>
|
|
1447
|
+
*/
|
|
1448
|
+
export declare class ExpiredNextTokenException extends __BaseException {
|
|
1449
|
+
readonly name: "ExpiredNextTokenException";
|
|
1450
|
+
readonly $fault: "client";
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>The error message the exception carries.</p>
|
|
1453
|
+
*/
|
|
1454
|
+
Message?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* @internal
|
|
1457
|
+
*/
|
|
1458
|
+
constructor(opts: __ExceptionOptionType<ExpiredNextTokenException, __BaseException>);
|
|
1459
|
+
}
|
|
1303
1460
|
export interface DescribeBudgetPerformanceHistoryRequest {
|
|
1304
1461
|
/**
|
|
1305
|
-
* <p>The account ID of the user. It
|
|
1462
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1306
1463
|
*/
|
|
1307
1464
|
AccountId: string | undefined;
|
|
1308
1465
|
/**
|
|
@@ -1341,7 +1498,7 @@ export interface BudgetedAndActualAmounts {
|
|
|
1341
1498
|
*/
|
|
1342
1499
|
ActualAmount?: Spend;
|
|
1343
1500
|
/**
|
|
1344
|
-
* <p>The time period covered by this budget comparison.</p>
|
|
1501
|
+
* <p>The time period that's covered by this budget comparison.</p>
|
|
1345
1502
|
*/
|
|
1346
1503
|
TimePeriod?: TimePeriod;
|
|
1347
1504
|
}
|
|
@@ -1380,7 +1537,8 @@ export interface BudgetPerformanceHistory {
|
|
|
1380
1537
|
*/
|
|
1381
1538
|
TimeUnit?: TimeUnit | string;
|
|
1382
1539
|
/**
|
|
1383
|
-
* <p>A list of amounts of cost or usage that you created budgets for, compared to your
|
|
1540
|
+
* <p>A list of amounts of cost or usage that you created budgets for, which are compared to your
|
|
1541
|
+
* actual costs or usage.</p>
|
|
1384
1542
|
*/
|
|
1385
1543
|
BudgetedAndActualAmountsList?: BudgetedAndActualAmounts[];
|
|
1386
1544
|
}
|
|
@@ -1407,17 +1565,6 @@ export declare namespace DescribeBudgetPerformanceHistoryResponse {
|
|
|
1407
1565
|
*/
|
|
1408
1566
|
const filterSensitiveLog: (obj: DescribeBudgetPerformanceHistoryResponse) => any;
|
|
1409
1567
|
}
|
|
1410
|
-
/**
|
|
1411
|
-
* <p>The pagination token expired.</p>
|
|
1412
|
-
*/
|
|
1413
|
-
export interface ExpiredNextTokenException extends __SmithyException, $MetadataBearer {
|
|
1414
|
-
name: "ExpiredNextTokenException";
|
|
1415
|
-
$fault: "client";
|
|
1416
|
-
/**
|
|
1417
|
-
* <p>The error message the exception carries.</p>
|
|
1418
|
-
*/
|
|
1419
|
-
Message?: string;
|
|
1420
|
-
}
|
|
1421
1568
|
/**
|
|
1422
1569
|
* <p> Request of DescribeBudgets </p>
|
|
1423
1570
|
*/
|
|
@@ -1564,7 +1711,7 @@ export declare enum ExecutionType {
|
|
|
1564
1711
|
}
|
|
1565
1712
|
export interface ExecuteBudgetActionRequest {
|
|
1566
1713
|
/**
|
|
1567
|
-
* <p>The account ID of the user. It
|
|
1714
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1568
1715
|
*/
|
|
1569
1716
|
AccountId: string | undefined;
|
|
1570
1717
|
/**
|
|
@@ -1592,7 +1739,7 @@ export declare namespace ExecuteBudgetActionRequest {
|
|
|
1592
1739
|
}
|
|
1593
1740
|
export interface ExecuteBudgetActionResponse {
|
|
1594
1741
|
/**
|
|
1595
|
-
* <p>The account ID of the user. It
|
|
1742
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1596
1743
|
*/
|
|
1597
1744
|
AccountId: string | undefined;
|
|
1598
1745
|
/**
|
|
@@ -1650,7 +1797,7 @@ export declare namespace UpdateBudgetResponse {
|
|
|
1650
1797
|
}
|
|
1651
1798
|
export interface UpdateBudgetActionRequest {
|
|
1652
1799
|
/**
|
|
1653
|
-
* <p>The account ID of the user. It
|
|
1800
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1654
1801
|
*/
|
|
1655
1802
|
AccountId: string | undefined;
|
|
1656
1803
|
/**
|
|
@@ -1668,15 +1815,11 @@ export interface UpdateBudgetActionRequest {
|
|
|
1668
1815
|
*/
|
|
1669
1816
|
NotificationType?: NotificationType | string;
|
|
1670
1817
|
/**
|
|
1671
|
-
* <p>
|
|
1672
|
-
* The trigger threshold of the action.
|
|
1673
|
-
* </p>
|
|
1818
|
+
* <p>The trigger threshold of the action. </p>
|
|
1674
1819
|
*/
|
|
1675
1820
|
ActionThreshold?: ActionThreshold;
|
|
1676
1821
|
/**
|
|
1677
|
-
* <p>
|
|
1678
|
-
* Specifies all of the type-specific parameters.
|
|
1679
|
-
* </p>
|
|
1822
|
+
* <p>Specifies all of the type-specific parameters. </p>
|
|
1680
1823
|
*/
|
|
1681
1824
|
Definition?: Definition;
|
|
1682
1825
|
/**
|
|
@@ -1704,7 +1847,7 @@ export declare namespace UpdateBudgetActionRequest {
|
|
|
1704
1847
|
}
|
|
1705
1848
|
export interface UpdateBudgetActionResponse {
|
|
1706
1849
|
/**
|
|
1707
|
-
* <p>The account ID of the user. It
|
|
1850
|
+
* <p>The account ID of the user. It's a 12-digit number.</p>
|
|
1708
1851
|
*/
|
|
1709
1852
|
AccountId: string | undefined;
|
|
1710
1853
|
/**
|