@aws-sdk/client-budgets 3.378.0 → 3.382.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.
@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
10
  /**
11
+ * @public
11
12
  * <p>The error message the exception carries.</p>
12
13
  */
13
14
  Message?: string;
@@ -34,10 +35,12 @@ export type ThresholdType = (typeof ThresholdType)[keyof typeof ThresholdType];
34
35
  */
35
36
  export interface ActionThreshold {
36
37
  /**
38
+ * @public
37
39
  * <p> The threshold of a notification.</p>
38
40
  */
39
41
  ActionThresholdValue: number | undefined;
40
42
  /**
43
+ * @public
41
44
  * <p> The type of threshold for a notification.</p>
42
45
  */
43
46
  ActionThresholdType: ThresholdType | string | undefined;
@@ -73,18 +76,22 @@ export type ApprovalModel = (typeof ApprovalModel)[keyof typeof ApprovalModel];
73
76
  */
74
77
  export interface IamActionDefinition {
75
78
  /**
79
+ * @public
76
80
  * <p>The Amazon Resource Name (ARN) of the policy to be attached. </p>
77
81
  */
78
82
  PolicyArn: string | undefined;
79
83
  /**
84
+ * @public
80
85
  * <p>A list of roles to be attached. There must be at least one role. </p>
81
86
  */
82
87
  Roles?: string[];
83
88
  /**
89
+ * @public
84
90
  * <p>A list of groups to be attached. There must be at least one group. </p>
85
91
  */
86
92
  Groups?: string[];
87
93
  /**
94
+ * @public
88
95
  * <p>A list of users to be attached. There must be at least one user. </p>
89
96
  */
90
97
  Users?: string[];
@@ -95,10 +102,12 @@ export interface IamActionDefinition {
95
102
  */
96
103
  export interface ScpActionDefinition {
97
104
  /**
105
+ * @public
98
106
  * <p>The policy ID attached. </p>
99
107
  */
100
108
  PolicyId: string | undefined;
101
109
  /**
110
+ * @public
102
111
  * <p>A list of target IDs. </p>
103
112
  */
104
113
  TargetIds: string[] | undefined;
@@ -121,14 +130,17 @@ export type ActionSubType = (typeof ActionSubType)[keyof typeof ActionSubType];
121
130
  */
122
131
  export interface SsmActionDefinition {
123
132
  /**
133
+ * @public
124
134
  * <p>The action subType. </p>
125
135
  */
126
136
  ActionSubType: ActionSubType | string | undefined;
127
137
  /**
138
+ * @public
128
139
  * <p>The Region to run the SSM document. </p>
129
140
  */
130
141
  Region: string | undefined;
131
142
  /**
143
+ * @public
132
144
  * <p>The EC2 and RDS instance IDs. </p>
133
145
  */
134
146
  InstanceIds: string[] | undefined;
@@ -139,14 +151,17 @@ export interface SsmActionDefinition {
139
151
  */
140
152
  export interface Definition {
141
153
  /**
154
+ * @public
142
155
  * <p>The Identity and Access Management (IAM) action definition details. </p>
143
156
  */
144
157
  IamActionDefinition?: IamActionDefinition;
145
158
  /**
159
+ * @public
146
160
  * <p>The service control policies (SCPs) action definition details. </p>
147
161
  */
148
162
  ScpActionDefinition?: ScpActionDefinition;
149
163
  /**
164
+ * @public
150
165
  * <p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>
151
166
  */
152
167
  SsmActionDefinition?: SsmActionDefinition;
@@ -212,10 +227,12 @@ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof Subscripti
212
227
  */
213
228
  export interface Subscriber {
214
229
  /**
230
+ * @public
215
231
  * <p>The type of notification that Amazon Web Services sends to a subscriber.</p>
216
232
  */
217
233
  SubscriptionType: SubscriptionType | string | undefined;
218
234
  /**
235
+ * @public
219
236
  * <p>The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.</p>
220
237
  * <p>When you create a subscriber, the value of <code>Address</code> can't contain line breaks.</p>
221
238
  */
@@ -227,44 +244,54 @@ export interface Subscriber {
227
244
  */
228
245
  export interface Action {
229
246
  /**
247
+ * @public
230
248
  * <p>A system-generated universally unique identifier (UUID) for the action. </p>
231
249
  */
232
250
  ActionId: string | undefined;
233
251
  /**
252
+ * @public
234
253
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
235
254
  */
236
255
  BudgetName: string | undefined;
237
256
  /**
257
+ * @public
238
258
  * <p> The type of a notification. It must be ACTUAL or FORECASTED.</p>
239
259
  */
240
260
  NotificationType: NotificationType | string | undefined;
241
261
  /**
262
+ * @public
242
263
  * <p>The type of action. This defines the type of tasks that can be carried out by this action.
243
264
  * This field also determines the format for definition. </p>
244
265
  */
245
266
  ActionType: ActionType | string | undefined;
246
267
  /**
268
+ * @public
247
269
  * <p>The trigger threshold of the action. </p>
248
270
  */
249
271
  ActionThreshold: ActionThreshold | undefined;
250
272
  /**
273
+ * @public
251
274
  * <p>Where you specify all of the type-specific parameters. </p>
252
275
  */
253
276
  Definition: Definition | undefined;
254
277
  /**
278
+ * @public
255
279
  * <p>The role passed for action execution and reversion. Roles and actions must be in the same
256
280
  * account. </p>
257
281
  */
258
282
  ExecutionRoleArn: string | undefined;
259
283
  /**
284
+ * @public
260
285
  * <p>This specifies if the action needs manual or automatic approval. </p>
261
286
  */
262
287
  ApprovalModel: ApprovalModel | string | undefined;
263
288
  /**
289
+ * @public
264
290
  * <p>The status of the action. </p>
265
291
  */
266
292
  Status: ActionStatus | string | undefined;
267
293
  /**
294
+ * @public
268
295
  * <p> A list of subscribers.</p>
269
296
  */
270
297
  Subscribers: Subscriber[] | undefined;
@@ -275,10 +302,12 @@ export interface Action {
275
302
  */
276
303
  export interface ActionHistoryDetails {
277
304
  /**
305
+ * @public
278
306
  * <p> A generic string.</p>
279
307
  */
280
308
  Message: string | undefined;
281
309
  /**
310
+ * @public
282
311
  * <p>The budget action resource. </p>
283
312
  */
284
313
  Action: Action | undefined;
@@ -304,19 +333,23 @@ export type EventType = (typeof EventType)[keyof typeof EventType];
304
333
  */
305
334
  export interface ActionHistory {
306
335
  /**
336
+ * @public
307
337
  * <p> A generic time stamp. In Java, it's transformed to a <code>Date</code> object.</p>
308
338
  */
309
339
  Timestamp: Date | undefined;
310
340
  /**
341
+ * @public
311
342
  * <p>The status of action at the time of the event. </p>
312
343
  */
313
344
  Status: ActionStatus | string | undefined;
314
345
  /**
346
+ * @public
315
347
  * <p>This distinguishes between whether the events are triggered by the user or are generated by
316
348
  * the system. </p>
317
349
  */
318
350
  EventType: EventType | string | undefined;
319
351
  /**
352
+ * @public
320
353
  * <p>The description of the details for the event. </p>
321
354
  */
322
355
  ActionHistoryDetails: ActionHistoryDetails | undefined;
@@ -339,6 +372,7 @@ export type AutoAdjustType = (typeof AutoAdjustType)[keyof typeof AutoAdjustType
339
372
  */
340
373
  export interface HistoricalOptions {
341
374
  /**
375
+ * @public
342
376
  * <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>
343
377
  * <ul>
344
378
  * <li>
@@ -357,6 +391,7 @@ export interface HistoricalOptions {
357
391
  */
358
392
  BudgetAdjustmentPeriod: number | undefined;
359
393
  /**
394
+ * @public
360
395
  * <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>
361
396
  * <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>
362
397
  * <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>
@@ -369,14 +404,17 @@ export interface HistoricalOptions {
369
404
  */
370
405
  export interface AutoAdjustData {
371
406
  /**
407
+ * @public
372
408
  * <p>The string that defines whether your budget auto-adjusts based on historical or forecasted data.</p>
373
409
  */
374
410
  AutoAdjustType: AutoAdjustType | string | undefined;
375
411
  /**
412
+ * @public
376
413
  * <p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>
377
414
  */
378
415
  HistoricalOptions?: HistoricalOptions;
379
416
  /**
417
+ * @public
380
418
  * <p>The last time that your budget was auto-adjusted.</p>
381
419
  */
382
420
  LastAutoAdjustTime?: Date;
@@ -399,11 +437,13 @@ export interface AutoAdjustData {
399
437
  */
400
438
  export interface Spend {
401
439
  /**
440
+ * @public
402
441
  * <p>The cost or usage amount that's associated with a budget forecast, actual spend, or budget
403
442
  * threshold.</p>
404
443
  */
405
444
  Amount: string | undefined;
406
445
  /**
446
+ * @public
407
447
  * <p>The unit of measurement that's used for the budget forecast, actual spend, or budget
408
448
  * threshold, such as USD or GBP.</p>
409
449
  */
@@ -437,10 +477,12 @@ export type BudgetType = (typeof BudgetType)[keyof typeof BudgetType];
437
477
  */
438
478
  export interface CalculatedSpend {
439
479
  /**
480
+ * @public
440
481
  * <p>The amount of cost, usage, RI units, or Savings Plans units that you used.</p>
441
482
  */
442
483
  ActualSpend: Spend | undefined;
443
484
  /**
485
+ * @public
444
486
  * <p>The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to
445
487
  * use.</p>
446
488
  */
@@ -456,56 +498,67 @@ export interface CalculatedSpend {
456
498
  */
457
499
  export interface CostTypes {
458
500
  /**
501
+ * @public
459
502
  * <p>Specifies whether a budget includes taxes.</p>
460
503
  * <p>The default value is <code>true</code>.</p>
461
504
  */
462
505
  IncludeTax?: boolean;
463
506
  /**
507
+ * @public
464
508
  * <p>Specifies whether a budget includes subscriptions.</p>
465
509
  * <p>The default value is <code>true</code>.</p>
466
510
  */
467
511
  IncludeSubscription?: boolean;
468
512
  /**
513
+ * @public
469
514
  * <p>Specifies whether a budget uses a blended rate.</p>
470
515
  * <p>The default value is <code>false</code>.</p>
471
516
  */
472
517
  UseBlended?: boolean;
473
518
  /**
519
+ * @public
474
520
  * <p>Specifies whether a budget includes refunds.</p>
475
521
  * <p>The default value is <code>true</code>.</p>
476
522
  */
477
523
  IncludeRefund?: boolean;
478
524
  /**
525
+ * @public
479
526
  * <p>Specifies whether a budget includes credits.</p>
480
527
  * <p>The default value is <code>true</code>.</p>
481
528
  */
482
529
  IncludeCredit?: boolean;
483
530
  /**
531
+ * @public
484
532
  * <p>Specifies whether a budget includes upfront RI costs.</p>
485
533
  * <p>The default value is <code>true</code>.</p>
486
534
  */
487
535
  IncludeUpfront?: boolean;
488
536
  /**
537
+ * @public
489
538
  * <p>Specifies whether a budget includes recurring fees such as monthly RI fees.</p>
490
539
  * <p>The default value is <code>true</code>.</p>
491
540
  */
492
541
  IncludeRecurring?: boolean;
493
542
  /**
543
+ * @public
494
544
  * <p>Specifies whether a budget includes non-RI subscription costs.</p>
495
545
  * <p>The default value is <code>true</code>.</p>
496
546
  */
497
547
  IncludeOtherSubscription?: boolean;
498
548
  /**
549
+ * @public
499
550
  * <p>Specifies whether a budget includes support subscription fees.</p>
500
551
  * <p>The default value is <code>true</code>.</p>
501
552
  */
502
553
  IncludeSupport?: boolean;
503
554
  /**
555
+ * @public
504
556
  * <p>Specifies whether a budget includes discounts.</p>
505
557
  * <p>The default value is <code>true</code>.</p>
506
558
  */
507
559
  IncludeDiscount?: boolean;
508
560
  /**
561
+ * @public
509
562
  * <p>Specifies whether a budget uses the amortized rate.</p>
510
563
  * <p>The default value is <code>false</code>.</p>
511
564
  */
@@ -518,11 +571,13 @@ export interface CostTypes {
518
571
  */
519
572
  export interface TimePeriod {
520
573
  /**
574
+ * @public
521
575
  * <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>
522
576
  * <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>
523
577
  */
524
578
  Start?: Date;
525
579
  /**
580
+ * @public
526
581
  * <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>
527
582
  * <p>After the end date, Amazon Web Services deletes the budget and all the associated
528
583
  * notifications and subscribers. You can change your end date with the
@@ -554,10 +609,12 @@ export type TimeUnit = (typeof TimeUnit)[keyof typeof TimeUnit];
554
609
  */
555
610
  export interface Budget {
556
611
  /**
612
+ * @public
557
613
  * <p>The name of a budget. The name must be unique within an account. The <code>:</code> and <code>\</code> characters aren't allowed in <code>BudgetName</code>.</p>
558
614
  */
559
615
  BudgetName: string | undefined;
560
616
  /**
617
+ * @public
561
618
  * <p>The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or
562
619
  * Savings Plans coverage that you want to track with your budget.</p>
563
620
  * <p>
@@ -570,6 +627,7 @@ export interface Budget {
570
627
  */
571
628
  BudgetLimit?: Spend;
572
629
  /**
630
+ * @public
573
631
  * <p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p>
574
632
  * <p>
575
633
  * <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports both
@@ -595,6 +653,7 @@ export interface Budget {
595
653
  */
596
654
  PlannedBudgetLimits?: Record<string, Spend>;
597
655
  /**
656
+ * @public
598
657
  * <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>
599
658
  * <p>Amazon Web Services Budgets supports the following services as a <code>Service</code> filter for RI budgets:</p>
600
659
  * <ul>
@@ -617,16 +676,19 @@ export interface Budget {
617
676
  */
618
677
  CostFilters?: Record<string, string[]>;
619
678
  /**
679
+ * @public
620
680
  * <p>The types of costs that are included in this <code>COST</code> budget.</p>
621
681
  * <p>
622
682
  * <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>
623
683
  */
624
684
  CostTypes?: CostTypes;
625
685
  /**
686
+ * @public
626
687
  * <p>The length of time until a budget resets the actual and forecasted spend.</p>
627
688
  */
628
689
  TimeUnit: TimeUnit | string | undefined;
629
690
  /**
691
+ * @public
630
692
  * <p>The period of time that's covered by a budget. You setthe start date and end date. The start
631
693
  * date must come before the end date. The end date must come before <code>06/15/87 00:00
632
694
  * UTC</code>. </p>
@@ -643,19 +705,23 @@ export interface Budget {
643
705
  */
644
706
  TimePeriod?: TimePeriod;
645
707
  /**
708
+ * @public
646
709
  * <p>The actual and forecasted cost or usage that the budget tracks.</p>
647
710
  */
648
711
  CalculatedSpend?: CalculatedSpend;
649
712
  /**
713
+ * @public
650
714
  * <p>Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings
651
715
  * Plans utilization, or Savings Plans coverage.</p>
652
716
  */
653
717
  BudgetType: BudgetType | string | undefined;
654
718
  /**
719
+ * @public
655
720
  * <p>The last time that you updated this budget.</p>
656
721
  */
657
722
  LastUpdatedTime?: Date;
658
723
  /**
724
+ * @public
659
725
  * <p>The parameters that determine the budget amount for an auto-adjusting budget.</p>
660
726
  */
661
727
  AutoAdjustData?: AutoAdjustData;
@@ -711,25 +777,30 @@ export type NotificationState = (typeof NotificationState)[keyof typeof Notifica
711
777
  */
712
778
  export interface Notification {
713
779
  /**
780
+ * @public
714
781
  * <p>Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or
715
782
  * for how much that you're forecasted to spend (<code>FORECASTED</code>).</p>
716
783
  */
717
784
  NotificationType: NotificationType | string | undefined;
718
785
  /**
786
+ * @public
719
787
  * <p>The comparison that's used for this notification.</p>
720
788
  */
721
789
  ComparisonOperator: ComparisonOperator | string | undefined;
722
790
  /**
791
+ * @public
723
792
  * <p>The threshold that's associated with a notification. Thresholds are always a percentage, and
724
793
  * many customers find value being alerted between 50% - 200% of the budgeted amount. The
725
794
  * maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>
726
795
  */
727
796
  Threshold: number | undefined;
728
797
  /**
798
+ * @public
729
799
  * <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>
730
800
  */
731
801
  ThresholdType?: ThresholdType | string;
732
802
  /**
803
+ * @public
733
804
  * <p>Specifies whether this notification is in alarm. If a budget notification is in the
734
805
  * <code>ALARM</code> state, you passed the set threshold for the budget.</p>
735
806
  */
@@ -741,10 +812,12 @@ export interface Notification {
741
812
  */
742
813
  export interface NotificationWithSubscribers {
743
814
  /**
815
+ * @public
744
816
  * <p>The notification that's associated with a budget.</p>
745
817
  */
746
818
  Notification: Notification | undefined;
747
819
  /**
820
+ * @public
748
821
  * <p>A list of subscribers who are subscribed to this notification.</p>
749
822
  */
750
823
  Subscribers: Subscriber[] | undefined;
@@ -755,14 +828,17 @@ export interface NotificationWithSubscribers {
755
828
  */
756
829
  export interface CreateBudgetRequest {
757
830
  /**
831
+ * @public
758
832
  * <p>The <code>accountId</code> that is associated with the budget.</p>
759
833
  */
760
834
  AccountId: string | undefined;
761
835
  /**
836
+ * @public
762
837
  * <p>The budget object that you want to create.</p>
763
838
  */
764
839
  Budget: Budget | undefined;
765
840
  /**
841
+ * @public
766
842
  * <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>
767
843
  */
768
844
  NotificationsWithSubscribers?: NotificationWithSubscribers[];
@@ -781,6 +857,7 @@ export declare class CreationLimitExceededException extends __BaseException {
781
857
  readonly name: "CreationLimitExceededException";
782
858
  readonly $fault: "client";
783
859
  /**
860
+ * @public
784
861
  * <p>The error message the exception carries.</p>
785
862
  */
786
863
  Message?: string;
@@ -797,6 +874,7 @@ export declare class DuplicateRecordException extends __BaseException {
797
874
  readonly name: "DuplicateRecordException";
798
875
  readonly $fault: "client";
799
876
  /**
877
+ * @public
800
878
  * <p>The error message the exception carries.</p>
801
879
  */
802
880
  Message?: string;
@@ -813,6 +891,7 @@ export declare class InternalErrorException extends __BaseException {
813
891
  readonly name: "InternalErrorException";
814
892
  readonly $fault: "server";
815
893
  /**
894
+ * @public
816
895
  * <p>The error message the exception carries.</p>
817
896
  */
818
897
  Message?: string;
@@ -829,6 +908,7 @@ export declare class InvalidParameterException extends __BaseException {
829
908
  readonly name: "InvalidParameterException";
830
909
  readonly $fault: "client";
831
910
  /**
911
+ * @public
832
912
  * <p>The error message the exception carries.</p>
833
913
  */
834
914
  Message?: string;
@@ -847,6 +927,7 @@ export declare class ThrottlingException extends __BaseException {
847
927
  readonly name: "ThrottlingException";
848
928
  readonly $fault: "client";
849
929
  /**
930
+ * @public
850
931
  * <p>The error message the exception carries.</p>
851
932
  */
852
933
  Message?: string;
@@ -860,44 +941,53 @@ export declare class ThrottlingException extends __BaseException {
860
941
  */
861
942
  export interface CreateBudgetActionRequest {
862
943
  /**
944
+ * @public
863
945
  * <p>The account ID of the user. It's a 12-digit number.</p>
864
946
  */
865
947
  AccountId: string | undefined;
866
948
  /**
949
+ * @public
867
950
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
868
951
  */
869
952
  BudgetName: string | undefined;
870
953
  /**
954
+ * @public
871
955
  * <p> The type of a notification. It must be ACTUAL or FORECASTED.</p>
872
956
  */
873
957
  NotificationType: NotificationType | string | undefined;
874
958
  /**
959
+ * @public
875
960
  * <p>
876
961
  * The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
877
962
  * </p>
878
963
  */
879
964
  ActionType: ActionType | string | undefined;
880
965
  /**
966
+ * @public
881
967
  * <p>The trigger threshold of the action. </p>
882
968
  */
883
969
  ActionThreshold: ActionThreshold | undefined;
884
970
  /**
971
+ * @public
885
972
  * <p>Specifies all of the type-specific parameters. </p>
886
973
  */
887
974
  Definition: Definition | undefined;
888
975
  /**
976
+ * @public
889
977
  * <p>
890
978
  * The role passed for action execution and reversion. Roles and actions must be in the same account.
891
979
  * </p>
892
980
  */
893
981
  ExecutionRoleArn: string | undefined;
894
982
  /**
983
+ * @public
895
984
  * <p>
896
985
  * This specifies if the action needs manual or automatic approval.
897
986
  * </p>
898
987
  */
899
988
  ApprovalModel: ApprovalModel | string | undefined;
900
989
  /**
990
+ * @public
901
991
  * <p> A list of subscribers.</p>
902
992
  */
903
993
  Subscribers: Subscriber[] | undefined;
@@ -907,14 +997,17 @@ export interface CreateBudgetActionRequest {
907
997
  */
908
998
  export interface CreateBudgetActionResponse {
909
999
  /**
1000
+ * @public
910
1001
  * <p>The account ID of the user. It's a 12-digit number.</p>
911
1002
  */
912
1003
  AccountId: string | undefined;
913
1004
  /**
1005
+ * @public
914
1006
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
915
1007
  */
916
1008
  BudgetName: string | undefined;
917
1009
  /**
1010
+ * @public
918
1011
  * <p>
919
1012
  * A system-generated universally unique identifier (UUID) for the action.
920
1013
  * </p>
@@ -929,6 +1022,7 @@ export declare class NotFoundException extends __BaseException {
929
1022
  readonly name: "NotFoundException";
930
1023
  readonly $fault: "client";
931
1024
  /**
1025
+ * @public
932
1026
  * <p>The error message the exception carries.</p>
933
1027
  */
934
1028
  Message?: string;
@@ -943,18 +1037,22 @@ export declare class NotFoundException extends __BaseException {
943
1037
  */
944
1038
  export interface CreateNotificationRequest {
945
1039
  /**
1040
+ * @public
946
1041
  * <p>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</p>
947
1042
  */
948
1043
  AccountId: string | undefined;
949
1044
  /**
1045
+ * @public
950
1046
  * <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>
951
1047
  */
952
1048
  BudgetName: string | undefined;
953
1049
  /**
1050
+ * @public
954
1051
  * <p>The notification that you want to create.</p>
955
1052
  */
956
1053
  Notification: Notification | undefined;
957
1054
  /**
1055
+ * @public
958
1056
  * <p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.</p>
959
1057
  */
960
1058
  Subscribers: Subscriber[] | undefined;
@@ -971,18 +1069,22 @@ export interface CreateNotificationResponse {
971
1069
  */
972
1070
  export interface CreateSubscriberRequest {
973
1071
  /**
1072
+ * @public
974
1073
  * <p>The <code>accountId</code> that is associated with the budget that you want to create a subscriber for.</p>
975
1074
  */
976
1075
  AccountId: string | undefined;
977
1076
  /**
1077
+ * @public
978
1078
  * <p>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</p>
979
1079
  */
980
1080
  BudgetName: string | undefined;
981
1081
  /**
1082
+ * @public
982
1083
  * <p>The notification that you want to create a subscriber for.</p>
983
1084
  */
984
1085
  Notification: Notification | undefined;
985
1086
  /**
1087
+ * @public
986
1088
  * <p>The subscriber that you want to associate with a budget notification.</p>
987
1089
  */
988
1090
  Subscriber: Subscriber | undefined;
@@ -999,10 +1101,12 @@ export interface CreateSubscriberResponse {
999
1101
  */
1000
1102
  export interface DeleteBudgetRequest {
1001
1103
  /**
1104
+ * @public
1002
1105
  * <p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>
1003
1106
  */
1004
1107
  AccountId: string | undefined;
1005
1108
  /**
1109
+ * @public
1006
1110
  * <p>The name of the budget that you want to delete.</p>
1007
1111
  */
1008
1112
  BudgetName: string | undefined;
@@ -1018,14 +1122,17 @@ export interface DeleteBudgetResponse {
1018
1122
  */
1019
1123
  export interface DeleteBudgetActionRequest {
1020
1124
  /**
1125
+ * @public
1021
1126
  * <p>The account ID of the user. It's a 12-digit number.</p>
1022
1127
  */
1023
1128
  AccountId: string | undefined;
1024
1129
  /**
1130
+ * @public
1025
1131
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1026
1132
  */
1027
1133
  BudgetName: string | undefined;
1028
1134
  /**
1135
+ * @public
1029
1136
  * <p>
1030
1137
  * A system-generated universally unique identifier (UUID) for the action.
1031
1138
  * </p>
@@ -1037,14 +1144,17 @@ export interface DeleteBudgetActionRequest {
1037
1144
  */
1038
1145
  export interface DeleteBudgetActionResponse {
1039
1146
  /**
1147
+ * @public
1040
1148
  * <p>The account ID of the user. It's a 12-digit number.</p>
1041
1149
  */
1042
1150
  AccountId: string | undefined;
1043
1151
  /**
1152
+ * @public
1044
1153
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1045
1154
  */
1046
1155
  BudgetName: string | undefined;
1047
1156
  /**
1157
+ * @public
1048
1158
  * <p>A budget action resource. </p>
1049
1159
  */
1050
1160
  Action: Action | undefined;
@@ -1058,6 +1168,7 @@ export declare class ResourceLockedException extends __BaseException {
1058
1168
  readonly name: "ResourceLockedException";
1059
1169
  readonly $fault: "client";
1060
1170
  /**
1171
+ * @public
1061
1172
  * <p>The error message the exception carries.</p>
1062
1173
  */
1063
1174
  Message?: string;
@@ -1072,14 +1183,17 @@ export declare class ResourceLockedException extends __BaseException {
1072
1183
  */
1073
1184
  export interface DeleteNotificationRequest {
1074
1185
  /**
1186
+ * @public
1075
1187
  * <p>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</p>
1076
1188
  */
1077
1189
  AccountId: string | undefined;
1078
1190
  /**
1191
+ * @public
1079
1192
  * <p>The name of the budget whose notification you want to delete.</p>
1080
1193
  */
1081
1194
  BudgetName: string | undefined;
1082
1195
  /**
1196
+ * @public
1083
1197
  * <p>The notification that you want to delete.</p>
1084
1198
  */
1085
1199
  Notification: Notification | undefined;
@@ -1096,18 +1210,22 @@ export interface DeleteNotificationResponse {
1096
1210
  */
1097
1211
  export interface DeleteSubscriberRequest {
1098
1212
  /**
1213
+ * @public
1099
1214
  * <p>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</p>
1100
1215
  */
1101
1216
  AccountId: string | undefined;
1102
1217
  /**
1218
+ * @public
1103
1219
  * <p>The name of the budget whose subscriber you want to delete.</p>
1104
1220
  */
1105
1221
  BudgetName: string | undefined;
1106
1222
  /**
1223
+ * @public
1107
1224
  * <p>The notification whose subscriber you want to delete.</p>
1108
1225
  */
1109
1226
  Notification: Notification | undefined;
1110
1227
  /**
1228
+ * @public
1111
1229
  * <p>The subscriber that you want to delete.</p>
1112
1230
  */
1113
1231
  Subscriber: Subscriber | undefined;
@@ -1124,10 +1242,12 @@ export interface DeleteSubscriberResponse {
1124
1242
  */
1125
1243
  export interface DescribeBudgetRequest {
1126
1244
  /**
1245
+ * @public
1127
1246
  * <p>The <code>accountId</code> that is associated with the budget that you want a description of.</p>
1128
1247
  */
1129
1248
  AccountId: string | undefined;
1130
1249
  /**
1250
+ * @public
1131
1251
  * <p>The name of the budget that you want a description of.</p>
1132
1252
  */
1133
1253
  BudgetName: string | undefined;
@@ -1138,6 +1258,7 @@ export interface DescribeBudgetRequest {
1138
1258
  */
1139
1259
  export interface DescribeBudgetResponse {
1140
1260
  /**
1261
+ * @public
1141
1262
  * <p>The description of the budget.</p>
1142
1263
  */
1143
1264
  Budget?: Budget;
@@ -1147,14 +1268,17 @@ export interface DescribeBudgetResponse {
1147
1268
  */
1148
1269
  export interface DescribeBudgetActionRequest {
1149
1270
  /**
1271
+ * @public
1150
1272
  * <p>The account ID of the user. It's a 12-digit number.</p>
1151
1273
  */
1152
1274
  AccountId: string | undefined;
1153
1275
  /**
1276
+ * @public
1154
1277
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1155
1278
  */
1156
1279
  BudgetName: string | undefined;
1157
1280
  /**
1281
+ * @public
1158
1282
  * <p>
1159
1283
  * A system-generated universally unique identifier (UUID) for the action.
1160
1284
  * </p>
@@ -1166,14 +1290,17 @@ export interface DescribeBudgetActionRequest {
1166
1290
  */
1167
1291
  export interface DescribeBudgetActionResponse {
1168
1292
  /**
1293
+ * @public
1169
1294
  * <p>The account ID of the user. It's a 12-digit number.</p>
1170
1295
  */
1171
1296
  AccountId: string | undefined;
1172
1297
  /**
1298
+ * @public
1173
1299
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1174
1300
  */
1175
1301
  BudgetName: string | undefined;
1176
1302
  /**
1303
+ * @public
1177
1304
  * <p>
1178
1305
  * A budget action resource.
1179
1306
  * </p>
@@ -1185,29 +1312,35 @@ export interface DescribeBudgetActionResponse {
1185
1312
  */
1186
1313
  export interface DescribeBudgetActionHistoriesRequest {
1187
1314
  /**
1315
+ * @public
1188
1316
  * <p>The account ID of the user. It's a 12-digit number.</p>
1189
1317
  */
1190
1318
  AccountId: string | undefined;
1191
1319
  /**
1320
+ * @public
1192
1321
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1193
1322
  */
1194
1323
  BudgetName: string | undefined;
1195
1324
  /**
1325
+ * @public
1196
1326
  * <p>
1197
1327
  * A system-generated universally unique identifier (UUID) for the action.
1198
1328
  * </p>
1199
1329
  */
1200
1330
  ActionId: string | undefined;
1201
1331
  /**
1332
+ * @public
1202
1333
  * <p>The period of time that's covered by a budget. The period has a start date and an end date.
1203
1334
  * The start date must come before the end date. There are no restrictions on the end date. </p>
1204
1335
  */
1205
1336
  TimePeriod?: TimePeriod;
1206
1337
  /**
1338
+ * @public
1207
1339
  * <p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1208
1340
  */
1209
1341
  MaxResults?: number;
1210
1342
  /**
1343
+ * @public
1211
1344
  * <p> A generic string.</p>
1212
1345
  */
1213
1346
  NextToken?: string;
@@ -1217,12 +1350,14 @@ export interface DescribeBudgetActionHistoriesRequest {
1217
1350
  */
1218
1351
  export interface DescribeBudgetActionHistoriesResponse {
1219
1352
  /**
1353
+ * @public
1220
1354
  * <p>
1221
1355
  * The historical record of the budget action resource.
1222
1356
  * </p>
1223
1357
  */
1224
1358
  ActionHistories: ActionHistory[] | undefined;
1225
1359
  /**
1360
+ * @public
1226
1361
  * <p> A generic string.</p>
1227
1362
  */
1228
1363
  NextToken?: string;
@@ -1235,6 +1370,7 @@ export declare class InvalidNextTokenException extends __BaseException {
1235
1370
  readonly name: "InvalidNextTokenException";
1236
1371
  readonly $fault: "client";
1237
1372
  /**
1373
+ * @public
1238
1374
  * <p>The error message the exception carries.</p>
1239
1375
  */
1240
1376
  Message?: string;
@@ -1248,14 +1384,17 @@ export declare class InvalidNextTokenException extends __BaseException {
1248
1384
  */
1249
1385
  export interface DescribeBudgetActionsForAccountRequest {
1250
1386
  /**
1387
+ * @public
1251
1388
  * <p>The account ID of the user. It's a 12-digit number.</p>
1252
1389
  */
1253
1390
  AccountId: string | undefined;
1254
1391
  /**
1392
+ * @public
1255
1393
  * <p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1256
1394
  */
1257
1395
  MaxResults?: number;
1258
1396
  /**
1397
+ * @public
1259
1398
  * <p> A generic string.</p>
1260
1399
  */
1261
1400
  NextToken?: string;
@@ -1265,12 +1404,14 @@ export interface DescribeBudgetActionsForAccountRequest {
1265
1404
  */
1266
1405
  export interface DescribeBudgetActionsForAccountResponse {
1267
1406
  /**
1407
+ * @public
1268
1408
  * <p>
1269
1409
  * A list of the budget action resources information.
1270
1410
  * </p>
1271
1411
  */
1272
1412
  Actions: Action[] | undefined;
1273
1413
  /**
1414
+ * @public
1274
1415
  * <p> A generic string.</p>
1275
1416
  */
1276
1417
  NextToken?: string;
@@ -1280,18 +1421,22 @@ export interface DescribeBudgetActionsForAccountResponse {
1280
1421
  */
1281
1422
  export interface DescribeBudgetActionsForBudgetRequest {
1282
1423
  /**
1424
+ * @public
1283
1425
  * <p>The account ID of the user. It's a 12-digit number.</p>
1284
1426
  */
1285
1427
  AccountId: string | undefined;
1286
1428
  /**
1429
+ * @public
1287
1430
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1288
1431
  */
1289
1432
  BudgetName: string | undefined;
1290
1433
  /**
1434
+ * @public
1291
1435
  * <p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1292
1436
  */
1293
1437
  MaxResults?: number;
1294
1438
  /**
1439
+ * @public
1295
1440
  * <p> A generic string.</p>
1296
1441
  */
1297
1442
  NextToken?: string;
@@ -1301,12 +1446,14 @@ export interface DescribeBudgetActionsForBudgetRequest {
1301
1446
  */
1302
1447
  export interface DescribeBudgetActionsForBudgetResponse {
1303
1448
  /**
1449
+ * @public
1304
1450
  * <p>
1305
1451
  * A list of the budget action resources information.
1306
1452
  * </p>
1307
1453
  */
1308
1454
  Actions: Action[] | undefined;
1309
1455
  /**
1456
+ * @public
1310
1457
  * <p> A generic string.</p>
1311
1458
  */
1312
1459
  NextToken?: string;
@@ -1316,16 +1463,19 @@ export interface DescribeBudgetActionsForBudgetResponse {
1316
1463
  */
1317
1464
  export interface DescribeBudgetNotificationsForAccountRequest {
1318
1465
  /**
1466
+ * @public
1319
1467
  * <p>The account ID of the user. It's a 12-digit number.</p>
1320
1468
  */
1321
1469
  AccountId: string | undefined;
1322
1470
  /**
1471
+ * @public
1323
1472
  * <p>
1324
1473
  * An integer that shows how many budget name entries a paginated response contains.
1325
1474
  * </p>
1326
1475
  */
1327
1476
  MaxResults?: number;
1328
1477
  /**
1478
+ * @public
1329
1479
  * <p> A generic string.</p>
1330
1480
  */
1331
1481
  NextToken?: string;
@@ -1338,10 +1488,12 @@ export interface DescribeBudgetNotificationsForAccountRequest {
1338
1488
  */
1339
1489
  export interface BudgetNotificationsForAccount {
1340
1490
  /**
1491
+ * @public
1341
1492
  * <p> A list of notifications.</p>
1342
1493
  */
1343
1494
  Notifications?: Notification[];
1344
1495
  /**
1496
+ * @public
1345
1497
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1346
1498
  */
1347
1499
  BudgetName?: string;
@@ -1351,12 +1503,14 @@ export interface BudgetNotificationsForAccount {
1351
1503
  */
1352
1504
  export interface DescribeBudgetNotificationsForAccountResponse {
1353
1505
  /**
1506
+ * @public
1354
1507
  * <p>
1355
1508
  * A list of budget names and associated notifications for an account.
1356
1509
  * </p>
1357
1510
  */
1358
1511
  BudgetNotificationsForAccount?: BudgetNotificationsForAccount[];
1359
1512
  /**
1513
+ * @public
1360
1514
  * <p> A generic string.</p>
1361
1515
  */
1362
1516
  NextToken?: string;
@@ -1369,6 +1523,7 @@ export declare class ExpiredNextTokenException extends __BaseException {
1369
1523
  readonly name: "ExpiredNextTokenException";
1370
1524
  readonly $fault: "client";
1371
1525
  /**
1526
+ * @public
1372
1527
  * <p>The error message the exception carries.</p>
1373
1528
  */
1374
1529
  Message?: string;
@@ -1382,22 +1537,27 @@ export declare class ExpiredNextTokenException extends __BaseException {
1382
1537
  */
1383
1538
  export interface DescribeBudgetPerformanceHistoryRequest {
1384
1539
  /**
1540
+ * @public
1385
1541
  * <p>The account ID of the user. It's a 12-digit number.</p>
1386
1542
  */
1387
1543
  AccountId: string | undefined;
1388
1544
  /**
1545
+ * @public
1389
1546
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1390
1547
  */
1391
1548
  BudgetName: string | undefined;
1392
1549
  /**
1550
+ * @public
1393
1551
  * <p>Retrieves how often the budget went into an <code>ALARM</code> state for the specified time period.</p>
1394
1552
  */
1395
1553
  TimePeriod?: TimePeriod;
1396
1554
  /**
1555
+ * @public
1397
1556
  * <p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1398
1557
  */
1399
1558
  MaxResults?: number;
1400
1559
  /**
1560
+ * @public
1401
1561
  * <p> A generic string.</p>
1402
1562
  */
1403
1563
  NextToken?: string;
@@ -1408,14 +1568,17 @@ export interface DescribeBudgetPerformanceHistoryRequest {
1408
1568
  */
1409
1569
  export interface BudgetedAndActualAmounts {
1410
1570
  /**
1571
+ * @public
1411
1572
  * <p>The amount of cost or usage that you created the budget for.</p>
1412
1573
  */
1413
1574
  BudgetedAmount?: Spend;
1414
1575
  /**
1576
+ * @public
1415
1577
  * <p>Your actual costs or usage for a budget period.</p>
1416
1578
  */
1417
1579
  ActualAmount?: Spend;
1418
1580
  /**
1581
+ * @public
1419
1582
  * <p>The time period that's covered by this budget comparison.</p>
1420
1583
  */
1421
1584
  TimePeriod?: TimePeriod;
@@ -1426,28 +1589,34 @@ export interface BudgetedAndActualAmounts {
1426
1589
  */
1427
1590
  export interface BudgetPerformanceHistory {
1428
1591
  /**
1592
+ * @public
1429
1593
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1430
1594
  */
1431
1595
  BudgetName?: string;
1432
1596
  /**
1597
+ * @public
1433
1598
  * <p> The type of a budget. It must be one of the following types: </p>
1434
1599
  * <p>
1435
1600
  * <code>COST</code>, <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, or <code>SAVINGS_PLANS_COVERAGE</code>.</p>
1436
1601
  */
1437
1602
  BudgetType?: BudgetType | string;
1438
1603
  /**
1604
+ * @public
1439
1605
  * <p>The history of the cost filters for a budget during the specified time period.</p>
1440
1606
  */
1441
1607
  CostFilters?: Record<string, string[]>;
1442
1608
  /**
1609
+ * @public
1443
1610
  * <p>The history of the cost types for a budget during the specified time period.</p>
1444
1611
  */
1445
1612
  CostTypes?: CostTypes;
1446
1613
  /**
1614
+ * @public
1447
1615
  * <p> The time unit of the budget, such as MONTHLY or QUARTERLY.</p>
1448
1616
  */
1449
1617
  TimeUnit?: TimeUnit | string;
1450
1618
  /**
1619
+ * @public
1451
1620
  * <p>A list of amounts of cost or usage that you created budgets for, which are compared to your
1452
1621
  * actual costs or usage.</p>
1453
1622
  */
@@ -1458,11 +1627,13 @@ export interface BudgetPerformanceHistory {
1458
1627
  */
1459
1628
  export interface DescribeBudgetPerformanceHistoryResponse {
1460
1629
  /**
1630
+ * @public
1461
1631
  * <p>The history of how often the budget has gone into an <code>ALARM</code> state.</p>
1462
1632
  * <p>For <code>DAILY</code> budgets, the history saves the state of the budget for the last 60 days. For <code>MONTHLY</code> budgets, the history saves the state of the budget for the current month plus the last 12 months. For <code>QUARTERLY</code> budgets, the history saves the state of the budget for the last four quarters.</p>
1463
1633
  */
1464
1634
  BudgetPerformanceHistory?: BudgetPerformanceHistory;
1465
1635
  /**
1636
+ * @public
1466
1637
  * <p> A generic string.</p>
1467
1638
  */
1468
1639
  NextToken?: string;
@@ -1473,14 +1644,17 @@ export interface DescribeBudgetPerformanceHistoryResponse {
1473
1644
  */
1474
1645
  export interface DescribeBudgetsRequest {
1475
1646
  /**
1647
+ * @public
1476
1648
  * <p>The <code>accountId</code> that is associated with the budgets that you want descriptions of.</p>
1477
1649
  */
1478
1650
  AccountId: string | undefined;
1479
1651
  /**
1652
+ * @public
1480
1653
  * <p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1481
1654
  */
1482
1655
  MaxResults?: number;
1483
1656
  /**
1657
+ * @public
1484
1658
  * <p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>
1485
1659
  */
1486
1660
  NextToken?: string;
@@ -1491,10 +1665,12 @@ export interface DescribeBudgetsRequest {
1491
1665
  */
1492
1666
  export interface DescribeBudgetsResponse {
1493
1667
  /**
1668
+ * @public
1494
1669
  * <p>A list of budgets.</p>
1495
1670
  */
1496
1671
  Budgets?: Budget[];
1497
1672
  /**
1673
+ * @public
1498
1674
  * <p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>
1499
1675
  */
1500
1676
  NextToken?: string;
@@ -1505,18 +1681,22 @@ export interface DescribeBudgetsResponse {
1505
1681
  */
1506
1682
  export interface DescribeNotificationsForBudgetRequest {
1507
1683
  /**
1684
+ * @public
1508
1685
  * <p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p>
1509
1686
  */
1510
1687
  AccountId: string | undefined;
1511
1688
  /**
1689
+ * @public
1512
1690
  * <p>The name of the budget whose notifications you want descriptions of.</p>
1513
1691
  */
1514
1692
  BudgetName: string | undefined;
1515
1693
  /**
1694
+ * @public
1516
1695
  * <p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1517
1696
  */
1518
1697
  MaxResults?: number;
1519
1698
  /**
1699
+ * @public
1520
1700
  * <p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>
1521
1701
  */
1522
1702
  NextToken?: string;
@@ -1527,10 +1707,12 @@ export interface DescribeNotificationsForBudgetRequest {
1527
1707
  */
1528
1708
  export interface DescribeNotificationsForBudgetResponse {
1529
1709
  /**
1710
+ * @public
1530
1711
  * <p>A list of notifications that are associated with a budget.</p>
1531
1712
  */
1532
1713
  Notifications?: Notification[];
1533
1714
  /**
1715
+ * @public
1534
1716
  * <p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>
1535
1717
  */
1536
1718
  NextToken?: string;
@@ -1541,22 +1723,27 @@ export interface DescribeNotificationsForBudgetResponse {
1541
1723
  */
1542
1724
  export interface DescribeSubscribersForNotificationRequest {
1543
1725
  /**
1726
+ * @public
1544
1727
  * <p>The <code>accountId</code> that is associated with the budget whose subscribers you want descriptions of.</p>
1545
1728
  */
1546
1729
  AccountId: string | undefined;
1547
1730
  /**
1731
+ * @public
1548
1732
  * <p>The name of the budget whose subscribers you want descriptions of.</p>
1549
1733
  */
1550
1734
  BudgetName: string | undefined;
1551
1735
  /**
1736
+ * @public
1552
1737
  * <p>The notification whose subscribers you want to list.</p>
1553
1738
  */
1554
1739
  Notification: Notification | undefined;
1555
1740
  /**
1741
+ * @public
1556
1742
  * <p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>
1557
1743
  */
1558
1744
  MaxResults?: number;
1559
1745
  /**
1746
+ * @public
1560
1747
  * <p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>
1561
1748
  */
1562
1749
  NextToken?: string;
@@ -1567,10 +1754,12 @@ export interface DescribeSubscribersForNotificationRequest {
1567
1754
  */
1568
1755
  export interface DescribeSubscribersForNotificationResponse {
1569
1756
  /**
1757
+ * @public
1570
1758
  * <p>A list of subscribers that are associated with a notification.</p>
1571
1759
  */
1572
1760
  Subscribers?: Subscriber[];
1573
1761
  /**
1762
+ * @public
1574
1763
  * <p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>
1575
1764
  */
1576
1765
  NextToken?: string;
@@ -1594,20 +1783,24 @@ export type ExecutionType = (typeof ExecutionType)[keyof typeof ExecutionType];
1594
1783
  */
1595
1784
  export interface ExecuteBudgetActionRequest {
1596
1785
  /**
1786
+ * @public
1597
1787
  * <p>The account ID of the user. It's a 12-digit number.</p>
1598
1788
  */
1599
1789
  AccountId: string | undefined;
1600
1790
  /**
1791
+ * @public
1601
1792
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1602
1793
  */
1603
1794
  BudgetName: string | undefined;
1604
1795
  /**
1796
+ * @public
1605
1797
  * <p>
1606
1798
  * A system-generated universally unique identifier (UUID) for the action.
1607
1799
  * </p>
1608
1800
  */
1609
1801
  ActionId: string | undefined;
1610
1802
  /**
1803
+ * @public
1611
1804
  * <p>
1612
1805
  * The type of execution.
1613
1806
  * </p>
@@ -1619,20 +1812,24 @@ export interface ExecuteBudgetActionRequest {
1619
1812
  */
1620
1813
  export interface ExecuteBudgetActionResponse {
1621
1814
  /**
1815
+ * @public
1622
1816
  * <p>The account ID of the user. It's a 12-digit number.</p>
1623
1817
  */
1624
1818
  AccountId: string | undefined;
1625
1819
  /**
1820
+ * @public
1626
1821
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1627
1822
  */
1628
1823
  BudgetName: string | undefined;
1629
1824
  /**
1825
+ * @public
1630
1826
  * <p>
1631
1827
  * A system-generated universally unique identifier (UUID) for the action.
1632
1828
  * </p>
1633
1829
  */
1634
1830
  ActionId: string | undefined;
1635
1831
  /**
1832
+ * @public
1636
1833
  * <p>
1637
1834
  * The type of execution.
1638
1835
  * </p>
@@ -1645,10 +1842,12 @@ export interface ExecuteBudgetActionResponse {
1645
1842
  */
1646
1843
  export interface UpdateBudgetRequest {
1647
1844
  /**
1845
+ * @public
1648
1846
  * <p>The <code>accountId</code> that is associated with the budget that you want to update.</p>
1649
1847
  */
1650
1848
  AccountId: string | undefined;
1651
1849
  /**
1850
+ * @public
1652
1851
  * <p>The budget that you want to update your budget to.</p>
1653
1852
  */
1654
1853
  NewBudget: Budget | undefined;
@@ -1664,44 +1863,53 @@ export interface UpdateBudgetResponse {
1664
1863
  */
1665
1864
  export interface UpdateBudgetActionRequest {
1666
1865
  /**
1866
+ * @public
1667
1867
  * <p>The account ID of the user. It's a 12-digit number.</p>
1668
1868
  */
1669
1869
  AccountId: string | undefined;
1670
1870
  /**
1871
+ * @public
1671
1872
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1672
1873
  */
1673
1874
  BudgetName: string | undefined;
1674
1875
  /**
1876
+ * @public
1675
1877
  * <p>
1676
1878
  * A system-generated universally unique identifier (UUID) for the action.
1677
1879
  * </p>
1678
1880
  */
1679
1881
  ActionId: string | undefined;
1680
1882
  /**
1883
+ * @public
1681
1884
  * <p> The type of a notification. It must be ACTUAL or FORECASTED.</p>
1682
1885
  */
1683
1886
  NotificationType?: NotificationType | string;
1684
1887
  /**
1888
+ * @public
1685
1889
  * <p>The trigger threshold of the action. </p>
1686
1890
  */
1687
1891
  ActionThreshold?: ActionThreshold;
1688
1892
  /**
1893
+ * @public
1689
1894
  * <p>Specifies all of the type-specific parameters. </p>
1690
1895
  */
1691
1896
  Definition?: Definition;
1692
1897
  /**
1898
+ * @public
1693
1899
  * <p>
1694
1900
  * The role passed for action execution and reversion. Roles and actions must be in the same account.
1695
1901
  * </p>
1696
1902
  */
1697
1903
  ExecutionRoleArn?: string;
1698
1904
  /**
1905
+ * @public
1699
1906
  * <p>
1700
1907
  * This specifies if the action needs manual or automatic approval.
1701
1908
  * </p>
1702
1909
  */
1703
1910
  ApprovalModel?: ApprovalModel | string;
1704
1911
  /**
1912
+ * @public
1705
1913
  * <p> A list of subscribers.</p>
1706
1914
  */
1707
1915
  Subscribers?: Subscriber[];
@@ -1711,20 +1919,24 @@ export interface UpdateBudgetActionRequest {
1711
1919
  */
1712
1920
  export interface UpdateBudgetActionResponse {
1713
1921
  /**
1922
+ * @public
1714
1923
  * <p>The account ID of the user. It's a 12-digit number.</p>
1715
1924
  */
1716
1925
  AccountId: string | undefined;
1717
1926
  /**
1927
+ * @public
1718
1928
  * <p> A string that represents the budget name. The ":" and "\" characters aren't allowed.</p>
1719
1929
  */
1720
1930
  BudgetName: string | undefined;
1721
1931
  /**
1932
+ * @public
1722
1933
  * <p>
1723
1934
  * The previous action resource information.
1724
1935
  * </p>
1725
1936
  */
1726
1937
  OldAction: Action | undefined;
1727
1938
  /**
1939
+ * @public
1728
1940
  * <p>
1729
1941
  * The updated action resource information.
1730
1942
  * </p>
@@ -1737,18 +1949,22 @@ export interface UpdateBudgetActionResponse {
1737
1949
  */
1738
1950
  export interface UpdateNotificationRequest {
1739
1951
  /**
1952
+ * @public
1740
1953
  * <p>The <code>accountId</code> that is associated with the budget whose notification you want to update.</p>
1741
1954
  */
1742
1955
  AccountId: string | undefined;
1743
1956
  /**
1957
+ * @public
1744
1958
  * <p>The name of the budget whose notification you want to update.</p>
1745
1959
  */
1746
1960
  BudgetName: string | undefined;
1747
1961
  /**
1962
+ * @public
1748
1963
  * <p>The previous notification that is associated with a budget.</p>
1749
1964
  */
1750
1965
  OldNotification: Notification | undefined;
1751
1966
  /**
1967
+ * @public
1752
1968
  * <p>The updated notification to be associated with a budget.</p>
1753
1969
  */
1754
1970
  NewNotification: Notification | undefined;
@@ -1765,22 +1981,27 @@ export interface UpdateNotificationResponse {
1765
1981
  */
1766
1982
  export interface UpdateSubscriberRequest {
1767
1983
  /**
1984
+ * @public
1768
1985
  * <p>The <code>accountId</code> that is associated with the budget whose subscriber you want to update.</p>
1769
1986
  */
1770
1987
  AccountId: string | undefined;
1771
1988
  /**
1989
+ * @public
1772
1990
  * <p>The name of the budget whose subscriber you want to update.</p>
1773
1991
  */
1774
1992
  BudgetName: string | undefined;
1775
1993
  /**
1994
+ * @public
1776
1995
  * <p>The notification whose subscriber you want to update.</p>
1777
1996
  */
1778
1997
  Notification: Notification | undefined;
1779
1998
  /**
1999
+ * @public
1780
2000
  * <p>The previous subscriber that is associated with a budget notification.</p>
1781
2001
  */
1782
2002
  OldSubscriber: Subscriber | undefined;
1783
2003
  /**
2004
+ * @public
1784
2005
  * <p>The updated subscriber that is associated with a budget notification.</p>
1785
2006
  */
1786
2007
  NewSubscriber: Subscriber | undefined;