@aws-sdk/client-budgets 3.382.0 → 3.383.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-es/endpoint/ruleset.js +3 -3
  3. package/dist-types/Budgets.d.ts +26 -26
  4. package/dist-types/BudgetsClient.d.ts +26 -26
  5. package/dist-types/commands/CreateBudgetActionCommand.d.ts +8 -9
  6. package/dist-types/commands/CreateBudgetCommand.d.ts +13 -14
  7. package/dist-types/commands/CreateNotificationCommand.d.ts +7 -8
  8. package/dist-types/commands/CreateSubscriberCommand.d.ts +7 -8
  9. package/dist-types/commands/DeleteBudgetActionCommand.d.ts +9 -10
  10. package/dist-types/commands/DeleteBudgetCommand.d.ts +5 -6
  11. package/dist-types/commands/DeleteNotificationCommand.d.ts +9 -10
  12. package/dist-types/commands/DeleteSubscriberCommand.d.ts +10 -11
  13. package/dist-types/commands/DescribeBudgetActionCommand.d.ts +9 -10
  14. package/dist-types/commands/DescribeBudgetActionHistoriesCommand.d.ts +11 -12
  15. package/dist-types/commands/DescribeBudgetActionsForAccountCommand.d.ts +9 -10
  16. package/dist-types/commands/DescribeBudgetActionsForBudgetCommand.d.ts +9 -10
  17. package/dist-types/commands/DescribeBudgetCommand.d.ts +8 -9
  18. package/dist-types/commands/DescribeBudgetNotificationsForAccountCommand.d.ts +6 -7
  19. package/dist-types/commands/DescribeBudgetPerformanceHistoryCommand.d.ts +4 -5
  20. package/dist-types/commands/DescribeBudgetsCommand.d.ts +8 -9
  21. package/dist-types/commands/DescribeNotificationsForBudgetCommand.d.ts +6 -7
  22. package/dist-types/commands/DescribeSubscribersForNotificationCommand.d.ts +7 -8
  23. package/dist-types/commands/ExecuteBudgetActionCommand.d.ts +4 -5
  24. package/dist-types/commands/UpdateBudgetActionCommand.d.ts +21 -22
  25. package/dist-types/commands/UpdateBudgetCommand.d.ts +8 -9
  26. package/dist-types/commands/UpdateNotificationCommand.d.ts +10 -11
  27. package/dist-types/commands/UpdateSubscriberCommand.d.ts +8 -9
  28. package/dist-types/index.d.ts +26 -26
  29. package/dist-types/models/models_0.d.ts +106 -89
  30. package/package.json +1 -1
package/dist-types/commands/UpdateBudgetCommand.d.ts CHANGED
@@ -24,9 +24,9 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until Amazon Web Services has new usage data to use for forecasting.</p>
27
- * <important>
28
- * <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples">Examples</a> section. </p>
29
- * </important>
27
+ * <important>
28
+ * <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples">Examples</a> section. </p>
29
+ * </important>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -65,7 +65,7 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad
65
65
  * IncludeDiscount: true || false,
66
66
  * UseAmortized: true || false,
67
67
  * },
68
- * TimeUnit: "STRING_VALUE", // required
68
+ * TimeUnit: "DAILY" || "MONTHLY" || "QUARTERLY" || "ANNUALLY", // required
69
69
  * TimePeriod: { // TimePeriod
70
70
  * Start: new Date("TIMESTAMP"),
71
71
  * End: new Date("TIMESTAMP"),
@@ -80,10 +80,10 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad
80
80
  * Unit: "STRING_VALUE", // required
81
81
  * },
82
82
  * },
83
- * BudgetType: "STRING_VALUE", // required
83
+ * BudgetType: "USAGE" || "COST" || "RI_UTILIZATION" || "RI_COVERAGE" || "SAVINGS_PLANS_UTILIZATION" || "SAVINGS_PLANS_COVERAGE", // required
84
84
  * LastUpdatedTime: new Date("TIMESTAMP"),
85
85
  * AutoAdjustData: { // AutoAdjustData
86
- * AutoAdjustType: "STRING_VALUE", // required
86
+ * AutoAdjustType: "HISTORICAL" || "FORECAST", // required
87
87
  * HistoricalOptions: { // HistoricalOptions
88
88
  * BudgetAdjustmentPeriod: Number("int"), // required
89
89
  * LookBackAvailablePeriods: Number("int"),
@@ -117,9 +117,8 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad
117
117
  * <p>We can’t locate the resource that you specified.</p>
118
118
  *
119
119
  * @throws {@link ThrottlingException} (client fault)
120
- * <p>
121
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
122
- * </p>
120
+ * <p>The number of API requests has exceeded the maximum allowed API request throttling limit
121
+ * for the account.</p>
123
122
  *
124
123
  * @throws {@link BudgetsServiceException}
125
124
  * <p>Base exception class for all service exceptions from Budgets service.</p>
package/dist-types/commands/UpdateNotificationCommand.d.ts CHANGED
@@ -34,18 +34,18 @@ export interface UpdateNotificationCommandOutput extends UpdateNotificationRespo
34
34
  * AccountId: "STRING_VALUE", // required
35
35
  * BudgetName: "STRING_VALUE", // required
36
36
  * OldNotification: { // Notification
37
- * NotificationType: "STRING_VALUE", // required
38
- * ComparisonOperator: "STRING_VALUE", // required
37
+ * NotificationType: "ACTUAL" || "FORECASTED", // required
38
+ * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required
39
39
  * Threshold: Number("double"), // required
40
- * ThresholdType: "STRING_VALUE",
41
- * NotificationState: "STRING_VALUE",
40
+ * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE",
41
+ * NotificationState: "OK" || "ALARM",
42
42
  * },
43
43
  * NewNotification: {
44
- * NotificationType: "STRING_VALUE", // required
45
- * ComparisonOperator: "STRING_VALUE", // required
44
+ * NotificationType: "ACTUAL" || "FORECASTED", // required
45
+ * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required
46
46
  * Threshold: Number("double"), // required
47
- * ThresholdType: "STRING_VALUE",
48
- * NotificationState: "STRING_VALUE",
47
+ * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE",
48
+ * NotificationState: "OK" || "ALARM",
49
49
  * },
50
50
  * };
51
51
  * const command = new UpdateNotificationCommand(input);
@@ -76,9 +76,8 @@ export interface UpdateNotificationCommandOutput extends UpdateNotificationRespo
76
76
  * <p>We can’t locate the resource that you specified.</p>
77
77
  *
78
78
  * @throws {@link ThrottlingException} (client fault)
79
- * <p>
80
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
81
- * </p>
79
+ * <p>The number of API requests has exceeded the maximum allowed API request throttling limit
80
+ * for the account.</p>
82
81
  *
83
82
  * @throws {@link BudgetsServiceException}
84
83
  * <p>Base exception class for all service exceptions from Budgets service.</p>
package/dist-types/commands/UpdateSubscriberCommand.d.ts CHANGED
@@ -34,18 +34,18 @@ export interface UpdateSubscriberCommandOutput extends UpdateSubscriberResponse,
34
34
  * AccountId: "STRING_VALUE", // required
35
35
  * BudgetName: "STRING_VALUE", // required
36
36
  * Notification: { // Notification
37
- * NotificationType: "STRING_VALUE", // required
38
- * ComparisonOperator: "STRING_VALUE", // required
37
+ * NotificationType: "ACTUAL" || "FORECASTED", // required
38
+ * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required
39
39
  * Threshold: Number("double"), // required
40
- * ThresholdType: "STRING_VALUE",
41
- * NotificationState: "STRING_VALUE",
40
+ * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE",
41
+ * NotificationState: "OK" || "ALARM",
42
42
  * },
43
43
  * OldSubscriber: { // Subscriber
44
- * SubscriptionType: "STRING_VALUE", // required
44
+ * SubscriptionType: "SNS" || "EMAIL", // required
45
45
  * Address: "STRING_VALUE", // required
46
46
  * },
47
47
  * NewSubscriber: {
48
- * SubscriptionType: "STRING_VALUE", // required
48
+ * SubscriptionType: "SNS" || "EMAIL", // required
49
49
  * Address: "STRING_VALUE", // required
50
50
  * },
51
51
  * };
@@ -77,9 +77,8 @@ export interface UpdateSubscriberCommandOutput extends UpdateSubscriberResponse,
77
77
  * <p>We can’t locate the resource that you specified.</p>
78
78
  *
79
79
  * @throws {@link ThrottlingException} (client fault)
80
- * <p>
81
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
82
- * </p>
80
+ * <p>The number of API requests has exceeded the maximum allowed API request throttling limit
81
+ * for the account.</p>
83
82
  *
84
83
  * @throws {@link BudgetsServiceException}
85
84
  * <p>Base exception class for all service exceptions from Budgets service.</p>
package/dist-types/index.d.ts CHANGED
@@ -1,47 +1,47 @@
1
1
  /**
2
2
  * <p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p>
3
- * <p>Budgets provide you with a way to see the following information:</p>
4
- * <ul>
3
+ * <p>Budgets provide you with a way to see the following information:</p>
4
+ * <ul>
5
5
  * <li>
6
- * <p>How close your plan is to your budgeted amount or to the free tier limits</p>
7
- * </li>
6
+ * <p>How close your plan is to your budgeted amount or to the free tier limits</p>
7
+ * </li>
8
8
  * <li>
9
- * <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
10
- * </li>
9
+ * <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
10
+ * </li>
11
11
  * <li>
12
- * <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
13
- * </li>
12
+ * <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
13
+ * </li>
14
14
  * <li>
15
- * <p>How much of your budget has been used</p>
16
- * </li>
15
+ * <p>How much of your budget has been used</p>
16
+ * </li>
17
17
  * </ul>
18
- * <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
19
- * <ul>
18
+ * <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
19
+ * <ul>
20
20
  * <li>
21
- * <p>
21
+ * <p>
22
22
  * <b>Cost budgets</b> - Plan how much you want to spend on a service.</p>
23
- * </li>
23
+ * </li>
24
24
  * <li>
25
- * <p>
25
+ * <p>
26
26
  * <b>Usage budgets</b> - Plan how much you want to use one or more services.</p>
27
- * </li>
27
+ * </li>
28
28
  * <li>
29
- * <p>
29
+ * <p>
30
30
  * <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p>
31
- * </li>
31
+ * </li>
32
32
  * <li>
33
- * <p>
33
+ * <p>
34
34
  * <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p>
35
- * </li>
35
+ * </li>
36
36
  * </ul>
37
- * <p>Service Endpoint</p>
38
- * <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
39
- * <ul>
37
+ * <p>Service Endpoint</p>
38
+ * <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
39
+ * <ul>
40
40
  * <li>
41
- * <p>https://budgets.amazonaws.com</p>
42
- * </li>
41
+ * <p>https://budgets.amazonaws.com</p>
42
+ * </li>
43
43
  * </ul>
44
- * <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
44
+ * <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
45
45
  *
46
46
  * @packageDocumentation
47
47
  */