From e96bea818208a47f5819effc4819802b5cea27bc Mon Sep 17 00:00:00 2001
From: awstools 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. Budgets provide you with a way to see the following information: Budgets provide you with a way to see the following information: How close your plan is to your budgeted amount or to the free tier limits How close your plan is to your budgeted amount or to the free tier limits Your usage-to-date, including how much you've used of your Reserved Instances (RIs) Your usage-to-date, including how much you've used of your Reserved Instances (RIs) Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month How much of your budget has been used How much of your budget has been used 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: 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:
+ *
* Cost budgets - Plan how much you want to spend on a service.
+ *
* Usage budgets - Plan how much you want to use one or more services.
+ *
* RI utilization budgets - 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.
+ *
* RI coverage budgets - 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. Service Endpoint The Amazon Web Services Budgets API provides the following endpoint: Service Endpoint The Amazon Web Services Budgets API provides the following endpoint: https://budgets.amazonaws.com https://budgets.amazonaws.com For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing. For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing. 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. Budgets provide you with a way to see the following information: Budgets provide you with a way to see the following information: How close your plan is to your budgeted amount or to the free tier limits How close your plan is to your budgeted amount or to the free tier limits Your usage-to-date, including how much you've used of your Reserved Instances (RIs) Your usage-to-date, including how much you've used of your Reserved Instances (RIs) Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month How much of your budget has been used How much of your budget has been used 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: 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:
+ *
* Cost budgets - Plan how much you want to spend on a service.
+ *
* Usage budgets - Plan how much you want to use one or more services.
+ *
* RI utilization budgets - 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.
+ *
* RI coverage budgets - 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. Service Endpoint The Amazon Web Services Budgets API provides the following endpoint: Service Endpoint The Amazon Web Services Budgets API provides the following endpoint: https://budgets.amazonaws.com https://budgets.amazonaws.com For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing. For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing. We can’t locate the resource that you specified.
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
- * The number of API requests has exceeded the maximum allowed API request throttling limit
+ * for the account. Base exception class for all service exceptions from Budgets service. Creates a budget and, if included, notifications and subscribers. Only one of Only one of An error on the client occurred. Typically, the cause is an invalid input value.
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
- * The number of API requests has exceeded the maximum allowed API request throttling limit
+ * for the account. Base exception class for all service exceptions from Budgets service. We can’t locate the resource that you specified.
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
- * The number of API requests has exceeded the maximum allowed API request throttling limit
+ * for the account. Base exception class for all service exceptions from Budgets service. We can’t locate the resource that you specified.
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
- * The number of API requests has exceeded the maximum allowed API request throttling limit
+ * for the account. Base exception class for all service exceptions from Budgets service.
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- * BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section. BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DeleteBudgetCommand.ts b/clients/client-budgets/src/commands/DeleteBudgetCommand.ts index 131cbe47978d7..36c45edd6ebc0 100644 --- a/clients/client-budgets/src/commands/DeleteBudgetCommand.ts +++ b/clients/client-budgets/src/commands/DeleteBudgetCommand.ts @@ -37,9 +37,9 @@ export interface DeleteBudgetCommandOutput extends DeleteBudgetResponse, __Metad /** * @public *Deletes a budget. You can delete your budget at any time.
- *Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
- *Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
+ *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DeleteNotificationCommand.ts b/clients/client-budgets/src/commands/DeleteNotificationCommand.ts index 0259d7fa4edf8..7a7746bca7021 100644 --- a/clients/client-budgets/src/commands/DeleteNotificationCommand.ts +++ b/clients/client-budgets/src/commands/DeleteNotificationCommand.ts @@ -37,9 +37,9 @@ export interface DeleteNotificationCommandOutput extends DeleteNotificationRespo /** * @public *Deletes a notification.
- *Deleting a notification also deletes the subscribers that are associated with the notification.
- *Deleting a notification also deletes the subscribers that are associated with the notification.
+ *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DeleteSubscriberCommand.ts b/clients/client-budgets/src/commands/DeleteSubscriberCommand.ts index 38756b4e24ed6..7b92c9964f325 100644 --- a/clients/client-budgets/src/commands/DeleteSubscriberCommand.ts +++ b/clients/client-budgets/src/commands/DeleteSubscriberCommand.ts @@ -41,9 +41,9 @@ export interface DeleteSubscriberCommandOutput extends DeleteSubscriberResponse, /** * @public *Deletes a subscriber.
- *Deleting the last subscriber to a notification also deletes the notification.
- *Deleting the last subscriber to a notification also deletes the notification.
+ *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetActionCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetActionCommand.ts index 344da4b1d3bbc..50616c3871249 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetActionCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetActionCommand.ts @@ -62,11 +62,11 @@ export interface DescribeBudgetActionCommandOutput extends DescribeBudgetActionR * // Action: { // Action * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { // ActionThreshold * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { // Definition * // IamActionDefinition: { // IamActionDefinition @@ -88,7 +88,7 @@ export interface DescribeBudgetActionCommandOutput extends DescribeBudgetActionR * // ], * // }, * // SsmActionDefinition: { // SsmActionDefinition - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // InstanceIds // required * // "STRING_VALUE", @@ -96,11 +96,11 @@ export interface DescribeBudgetActionCommandOutput extends DescribeBudgetActionR * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // Subscribers // required * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -128,9 +128,8 @@ export interface DescribeBudgetActionCommandOutput extends DescribeBudgetActionR *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetActionHistoriesCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetActionHistoriesCommand.ts index b0cd68518e5ac..c963d62e83c27 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetActionHistoriesCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetActionHistoriesCommand.ts @@ -71,18 +71,18 @@ export interface DescribeBudgetActionHistoriesCommandOutput * // ActionHistories: [ // ActionHistories // required * // { // ActionHistory * // Timestamp: new Date("TIMESTAMP"), // required - * // Status: "STRING_VALUE", // required - * // EventType: "STRING_VALUE", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required + * // EventType: "SYSTEM" || "CREATE_ACTION" || "DELETE_ACTION" || "UPDATE_ACTION" || "EXECUTE_ACTION", // required * // ActionHistoryDetails: { // ActionHistoryDetails * // Message: "STRING_VALUE", // required * // Action: { // Action * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { // ActionThreshold * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { // Definition * // IamActionDefinition: { // IamActionDefinition @@ -104,7 +104,7 @@ export interface DescribeBudgetActionHistoriesCommandOutput * // ], * // }, * // SsmActionDefinition: { // SsmActionDefinition - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // InstanceIds // required * // "STRING_VALUE", @@ -112,11 +112,11 @@ export interface DescribeBudgetActionHistoriesCommandOutput * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // Subscribers // required * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -151,9 +151,8 @@ export interface DescribeBudgetActionHistoriesCommandOutput *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetActionsForAccountCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetActionsForAccountCommand.ts index c63e3effb1ba6..db939ddd797ca 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetActionsForAccountCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetActionsForAccountCommand.ts @@ -66,11 +66,11 @@ export interface DescribeBudgetActionsForAccountCommandOutput * // { // Action * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { // ActionThreshold * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { // Definition * // IamActionDefinition: { // IamActionDefinition @@ -92,7 +92,7 @@ export interface DescribeBudgetActionsForAccountCommandOutput * // ], * // }, * // SsmActionDefinition: { // SsmActionDefinition - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // InstanceIds // required * // "STRING_VALUE", @@ -100,11 +100,11 @@ export interface DescribeBudgetActionsForAccountCommandOutput * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // Subscribers // required * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -134,9 +134,8 @@ export interface DescribeBudgetActionsForAccountCommandOutput *An error on the client occurred. Typically, the cause is an invalid input value.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetActionsForBudgetCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetActionsForBudgetCommand.ts index 1eae9e2c6a7db..ce5d594b2f5a5 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetActionsForBudgetCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetActionsForBudgetCommand.ts @@ -67,11 +67,11 @@ export interface DescribeBudgetActionsForBudgetCommandOutput * // { // Action * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { // ActionThreshold * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { // Definition * // IamActionDefinition: { // IamActionDefinition @@ -93,7 +93,7 @@ export interface DescribeBudgetActionsForBudgetCommandOutput * // ], * // }, * // SsmActionDefinition: { // SsmActionDefinition - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // InstanceIds // required * // "STRING_VALUE", @@ -101,11 +101,11 @@ export interface DescribeBudgetActionsForBudgetCommandOutput * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // Subscribers // required * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -138,9 +138,8 @@ export interface DescribeBudgetActionsForBudgetCommandOutput *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetCommand.ts index a398a5556b8d6..425594fb67ce0 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetCommand.ts @@ -37,9 +37,9 @@ export interface DescribeBudgetCommandOutput extends DescribeBudgetResponse, __M /** * @public *Describes a budget.
- *The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetNotificationsForAccountCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetNotificationsForAccountCommand.ts index 03ac5569c526a..719c8457ea683 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetNotificationsForAccountCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetNotificationsForAccountCommand.ts @@ -66,11 +66,11 @@ export interface DescribeBudgetNotificationsForAccountCommandOutput * // { // BudgetNotificationsForAccount * // Notifications: [ // Notifications * // { // Notification - * // NotificationType: "STRING_VALUE", // required - * // ComparisonOperator: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * // Threshold: Number("double"), // required - * // ThresholdType: "STRING_VALUE", - * // NotificationState: "STRING_VALUE", + * // ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * // NotificationState: "OK" || "ALARM", * // }, * // ], * // BudgetName: "STRING_VALUE", @@ -106,9 +106,8 @@ export interface DescribeBudgetNotificationsForAccountCommandOutput *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetPerformanceHistoryCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetPerformanceHistoryCommand.ts index dcb18b7caed12..5ca668366225c 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetPerformanceHistoryCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetPerformanceHistoryCommand.ts @@ -63,7 +63,7 @@ export interface DescribeBudgetPerformanceHistoryCommandOutput * // { // DescribeBudgetPerformanceHistoryResponse * // BudgetPerformanceHistory: { // BudgetPerformanceHistory * // BudgetName: "STRING_VALUE", - * // BudgetType: "STRING_VALUE", + * // BudgetType: "USAGE" || "COST" || "RI_UTILIZATION" || "RI_COVERAGE" || "SAVINGS_PLANS_UTILIZATION" || "SAVINGS_PLANS_COVERAGE", * // CostFilters: { // CostFilters * // "We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeBudgetsCommand.ts b/clients/client-budgets/src/commands/DescribeBudgetsCommand.ts index 08acb8538f075..eac1321d79e8d 100644 --- a/clients/client-budgets/src/commands/DescribeBudgetsCommand.ts +++ b/clients/client-budgets/src/commands/DescribeBudgetsCommand.ts @@ -37,9 +37,9 @@ export interface DescribeBudgetsCommandOutput extends DescribeBudgetsResponse, _ /** * @public *Lists the budgets that are associated with an account.
- *The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeNotificationsForBudgetCommand.ts b/clients/client-budgets/src/commands/DescribeNotificationsForBudgetCommand.ts index e43f6c23074db..211cd02c1d459 100644 --- a/clients/client-budgets/src/commands/DescribeNotificationsForBudgetCommand.ts +++ b/clients/client-budgets/src/commands/DescribeNotificationsForBudgetCommand.ts @@ -59,11 +59,11 @@ export interface DescribeNotificationsForBudgetCommandOutput * // { // DescribeNotificationsForBudgetResponse * // Notifications: [ // Notifications * // { // Notification - * // NotificationType: "STRING_VALUE", // required - * // ComparisonOperator: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * // Threshold: Number("double"), // required - * // ThresholdType: "STRING_VALUE", - * // NotificationState: "STRING_VALUE", + * // ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * // NotificationState: "OK" || "ALARM", * // }, * // ], * // NextToken: "STRING_VALUE", @@ -96,9 +96,8 @@ export interface DescribeNotificationsForBudgetCommandOutput *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/DescribeSubscribersForNotificationCommand.ts b/clients/client-budgets/src/commands/DescribeSubscribersForNotificationCommand.ts index c663a9950d59b..d78961eea1a8e 100644 --- a/clients/client-budgets/src/commands/DescribeSubscribersForNotificationCommand.ts +++ b/clients/client-budgets/src/commands/DescribeSubscribersForNotificationCommand.ts @@ -56,11 +56,11 @@ export interface DescribeSubscribersForNotificationCommandOutput * AccountId: "STRING_VALUE", // required * BudgetName: "STRING_VALUE", // required * Notification: { // Notification - * NotificationType: "STRING_VALUE", // required - * ComparisonOperator: "STRING_VALUE", // required + * NotificationType: "ACTUAL" || "FORECASTED", // required + * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * Threshold: Number("double"), // required - * ThresholdType: "STRING_VALUE", - * NotificationState: "STRING_VALUE", + * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * NotificationState: "OK" || "ALARM", * }, * MaxResults: Number("int"), * NextToken: "STRING_VALUE", @@ -70,7 +70,7 @@ export interface DescribeSubscribersForNotificationCommandOutput * // { // DescribeSubscribersForNotificationResponse * // Subscribers: [ // Subscribers * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -104,9 +104,8 @@ export interface DescribeSubscribersForNotificationCommandOutput *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/ExecuteBudgetActionCommand.ts b/clients/client-budgets/src/commands/ExecuteBudgetActionCommand.ts index af07c9071cce5..94e50158b0767 100644 --- a/clients/client-budgets/src/commands/ExecuteBudgetActionCommand.ts +++ b/clients/client-budgets/src/commands/ExecuteBudgetActionCommand.ts @@ -49,7 +49,7 @@ export interface ExecuteBudgetActionCommandOutput extends ExecuteBudgetActionRes * AccountId: "STRING_VALUE", // required * BudgetName: "STRING_VALUE", // required * ActionId: "STRING_VALUE", // required - * ExecutionType: "STRING_VALUE", // required + * ExecutionType: "APPROVE_BUDGET_ACTION" || "RETRY_BUDGET_ACTION" || "REVERSE_BUDGET_ACTION" || "RESET_BUDGET_ACTION", // required * }; * const command = new ExecuteBudgetActionCommand(input); * const response = await client.send(command); @@ -57,7 +57,7 @@ export interface ExecuteBudgetActionCommandOutput extends ExecuteBudgetActionRes * // AccountId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required * // ActionId: "STRING_VALUE", // required - * // ExecutionType: "STRING_VALUE", // required + * // ExecutionType: "APPROVE_BUDGET_ACTION" || "RETRY_BUDGET_ACTION" || "REVERSE_BUDGET_ACTION" || "RESET_BUDGET_ACTION", // required * // }; * * ``` @@ -85,9 +85,8 @@ export interface ExecuteBudgetActionCommandOutput extends ExecuteBudgetActionRes * particular method for the requested resource. * * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/UpdateBudgetActionCommand.ts b/clients/client-budgets/src/commands/UpdateBudgetActionCommand.ts index 145df074ee15e..7564cd8fc54e4 100644 --- a/clients/client-budgets/src/commands/UpdateBudgetActionCommand.ts +++ b/clients/client-budgets/src/commands/UpdateBudgetActionCommand.ts @@ -54,10 +54,10 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * AccountId: "STRING_VALUE", // required * BudgetName: "STRING_VALUE", // required * ActionId: "STRING_VALUE", // required - * NotificationType: "STRING_VALUE", + * NotificationType: "ACTUAL" || "FORECASTED", * ActionThreshold: { // ActionThreshold * ActionThresholdValue: Number("double"), // required - * ActionThresholdType: "STRING_VALUE", // required + * ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * }, * Definition: { // Definition * IamActionDefinition: { // IamActionDefinition @@ -79,7 +79,7 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * ], * }, * SsmActionDefinition: { // SsmActionDefinition - * ActionSubType: "STRING_VALUE", // required + * ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * Region: "STRING_VALUE", // required * InstanceIds: [ // InstanceIds // required * "STRING_VALUE", @@ -87,10 +87,10 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * }, * }, * ExecutionRoleArn: "STRING_VALUE", - * ApprovalModel: "STRING_VALUE", + * ApprovalModel: "AUTOMATIC" || "MANUAL", * Subscribers: [ // Subscribers * { // Subscriber - * SubscriptionType: "STRING_VALUE", // required + * SubscriptionType: "SNS" || "EMAIL", // required * Address: "STRING_VALUE", // required * }, * ], @@ -103,11 +103,11 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // OldAction: { // Action * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { // ActionThreshold * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { // Definition * // IamActionDefinition: { // IamActionDefinition @@ -129,7 +129,7 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // ], * // }, * // SsmActionDefinition: { // SsmActionDefinition - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // InstanceIds // required * // "STRING_VALUE", @@ -137,11 +137,11 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // Subscribers // required * // { // Subscriber - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -149,11 +149,11 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // NewAction: { * // ActionId: "STRING_VALUE", // required * // BudgetName: "STRING_VALUE", // required - * // NotificationType: "STRING_VALUE", // required - * // ActionType: "STRING_VALUE", // required + * // NotificationType: "ACTUAL" || "FORECASTED", // required + * // ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required * // ActionThreshold: { * // ActionThresholdValue: Number("double"), // required - * // ActionThresholdType: "STRING_VALUE", // required + * // ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required * // }, * // Definition: { * // IamActionDefinition: { @@ -175,7 +175,7 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // ], * // }, * // SsmActionDefinition: { - * // ActionSubType: "STRING_VALUE", // required + * // ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required * // Region: "STRING_VALUE", // required * // InstanceIds: [ // required * // "STRING_VALUE", @@ -183,11 +183,11 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * // }, * // }, * // ExecutionRoleArn: "STRING_VALUE", // required - * // ApprovalModel: "STRING_VALUE", // required - * // Status: "STRING_VALUE", // required + * // ApprovalModel: "AUTOMATIC" || "MANUAL", // required + * // Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required * // Subscribers: [ // required * // { - * // SubscriptionType: "STRING_VALUE", // required + * // SubscriptionType: "SNS" || "EMAIL", // required * // Address: "STRING_VALUE", // required * // }, * // ], @@ -219,9 +219,8 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo * particular method for the requested resource. * * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/UpdateBudgetCommand.ts b/clients/client-budgets/src/commands/UpdateBudgetCommand.ts index bfe89d2a9ed93..8415f73292e7e 100644 --- a/clients/client-budgets/src/commands/UpdateBudgetCommand.ts +++ b/clients/client-budgets/src/commands/UpdateBudgetCommand.ts @@ -37,9 +37,9 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad /** * @public *Updates a budget. You can change every part of a budget except for the budgetName
and the calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/UpdateNotificationCommand.ts b/clients/client-budgets/src/commands/UpdateNotificationCommand.ts index c462935776a9a..016fe68f3b02c 100644 --- a/clients/client-budgets/src/commands/UpdateNotificationCommand.ts +++ b/clients/client-budgets/src/commands/UpdateNotificationCommand.ts @@ -47,18 +47,18 @@ export interface UpdateNotificationCommandOutput extends UpdateNotificationRespo * AccountId: "STRING_VALUE", // required * BudgetName: "STRING_VALUE", // required * OldNotification: { // Notification - * NotificationType: "STRING_VALUE", // required - * ComparisonOperator: "STRING_VALUE", // required + * NotificationType: "ACTUAL" || "FORECASTED", // required + * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * Threshold: Number("double"), // required - * ThresholdType: "STRING_VALUE", - * NotificationState: "STRING_VALUE", + * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * NotificationState: "OK" || "ALARM", * }, * NewNotification: { - * NotificationType: "STRING_VALUE", // required - * ComparisonOperator: "STRING_VALUE", // required + * NotificationType: "ACTUAL" || "FORECASTED", // required + * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * Threshold: Number("double"), // required - * ThresholdType: "STRING_VALUE", - * NotificationState: "STRING_VALUE", + * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * NotificationState: "OK" || "ALARM", * }, * }; * const command = new UpdateNotificationCommand(input); @@ -89,9 +89,8 @@ export interface UpdateNotificationCommandOutput extends UpdateNotificationRespo *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/commands/UpdateSubscriberCommand.ts b/clients/client-budgets/src/commands/UpdateSubscriberCommand.ts index d1550c95af943..8787d39dfef42 100644 --- a/clients/client-budgets/src/commands/UpdateSubscriberCommand.ts +++ b/clients/client-budgets/src/commands/UpdateSubscriberCommand.ts @@ -51,18 +51,18 @@ export interface UpdateSubscriberCommandOutput extends UpdateSubscriberResponse, * AccountId: "STRING_VALUE", // required * BudgetName: "STRING_VALUE", // required * Notification: { // Notification - * NotificationType: "STRING_VALUE", // required - * ComparisonOperator: "STRING_VALUE", // required + * NotificationType: "ACTUAL" || "FORECASTED", // required + * ComparisonOperator: "GREATER_THAN" || "LESS_THAN" || "EQUAL_TO", // required * Threshold: Number("double"), // required - * ThresholdType: "STRING_VALUE", - * NotificationState: "STRING_VALUE", + * ThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", + * NotificationState: "OK" || "ALARM", * }, * OldSubscriber: { // Subscriber - * SubscriptionType: "STRING_VALUE", // required + * SubscriptionType: "SNS" || "EMAIL", // required * Address: "STRING_VALUE", // required * }, * NewSubscriber: { - * SubscriptionType: "STRING_VALUE", // required + * SubscriptionType: "SNS" || "EMAIL", // required * Address: "STRING_VALUE", // required * }, * }; @@ -94,9 +94,8 @@ export interface UpdateSubscriberCommandOutput extends UpdateSubscriberResponse, *We can’t locate the resource that you specified.
* * @throws {@link ThrottlingException} (client fault) - *- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
* * @throws {@link BudgetsServiceException} *Base exception class for all service exceptions from Budgets service.
diff --git a/clients/client-budgets/src/endpoint/ruleset.ts b/clients/client-budgets/src/endpoint/ruleset.ts index 9ab3b85da698f..4b688932ad46b 100644 --- a/clients/client-budgets/src/endpoint/ruleset.ts +++ b/clients/client-budgets/src/endpoint/ruleset.ts @@ -6,40 +6,31 @@ import { RuleSetObject } from "@smithy/types"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/budgets.json */ -const z="required", -A="type", -B="fn", -C="argv", -D="ref", -E="properties", -F="headers", -G="authSchemes", -H="signingName", -I="signingRegion"; -const a="PartitionResult", +const w="required", +x="fn", +y="argv", +z="ref"; +const a="isSet", b="tree", c="error", d="endpoint", -e="stringEquals", -f={[z]:false,[A]:"String"}, -g={[z]:true,"default":false,[A]:"Boolean"}, -h={[D]:"Region"}, -i={[D]:"Endpoint"}, -j={}, -k={[B]:"getAttr",[C]:[{[D]:a},"name"]}, -l={[G]:[{"name":"sigv4",[H]:"budgets",[I]:"us-east-1"}]}, -m={[c]:"FIPS and DualStack are enabled, but this partition does not support one or both",[A]:c}, -n={[c]:"FIPS is enabled but this partition does not support FIPS",[A]:c}, -o={[c]:"DualStack is enabled but this partition does not support DualStack",[A]:c}, -p={"url":"https://budgets.amazonaws.com",[E]:l,[F]:{}}, -q={[G]:[{"name":"sigv4",[H]:"budgets",[I]:"cn-northwest-1"}]}, -r={"url":"https://budgets.amazonaws.com.cn",[E]:q,[F]:{}}, -s=[i], -t=[{[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},true]}], -u=[{[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},true]}], -v=[{[B]:"booleanEquals",[C]:[{[D]:"UseFIPS"},true]},{[B]:"booleanEquals",[C]:[{[D]:"UseDualStack"},true]}], -w=[{[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:a},"supportsFIPS"]}]},{[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:a},"supportsDualStack"]}]}], -x=[{[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:a},"supportsFIPS"]}]}], -y=[{[B]:"booleanEquals",[C]:[true,{[B]:"getAttr",[C]:[{[D]:a},"supportsDualStack"]}]}]; -const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[B]:"aws.partition",[C]:[h],assign:a}],[A]:b,rules:[{conditions:[{[B]:"isSet",[C]:s},{[B]:"parseURL",[C]:s,assign:"url"}],[A]:b,rules:[{conditions:t,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[A]:c},{[A]:b,rules:[{conditions:u,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[A]:c},{endpoint:{url:i,[E]:j,[F]:j},[A]:d}]}]},{conditions:[{[B]:e,[C]:[k,"aws"]}],[A]:b,rules:[{conditions:v,[A]:b,rules:[{conditions:w,[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.api.aws",[E]:l,[F]:j},[A]:d}]},m]},{conditions:t,[A]:b,rules:[{conditions:x,[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.amazonaws.com",[E]:l,[F]:j},[A]:d}]},n]},{conditions:u,[A]:b,rules:[{conditions:y,[A]:b,rules:[{endpoint:{url:"https://budgets.{Region}.api.aws",[E]:l,[F]:j},[A]:d}]},o]},{endpoint:p,[A]:d}]},{conditions:[{[B]:e,[C]:[k,"aws-cn"]}],[A]:b,rules:[{conditions:v,[A]:b,rules:[{conditions:w,[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.api.amazonwebservices.com.cn",[E]:q,[F]:j},[A]:d}]},m]},{conditions:t,[A]:b,rules:[{conditions:x,[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.amazonaws.com.cn",[E]:q,[F]:j},[A]:d}]},n]},{conditions:u,[A]:b,rules:[{conditions:y,[A]:b,rules:[{endpoint:{url:"https://budgets.{Region}.api.amazonwebservices.com.cn",[E]:q,[F]:j},[A]:d}]},o]},{endpoint:r,[A]:d}]},{conditions:v,[A]:b,rules:[{conditions:w,[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[E]:j,[F]:j},[A]:d}]},m]},{conditions:t,[A]:b,rules:[{conditions:x,[A]:b,rules:[{[A]:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}",[E]:j,[F]:j},[A]:d}]}]},n]},{conditions:u,[A]:b,rules:[{conditions:y,[A]:b,rules:[{endpoint:{url:"https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}",[E]:j,[F]:j},[A]:d}]},o]},{[A]:b,rules:[{conditions:[{[B]:e,[C]:[h,"aws-global"]}],endpoint:p,[A]:d},{conditions:[{[B]:e,[C]:[h,"aws-cn-global"]}],endpoint:r,[A]:d},{endpoint:{url:"https://budgets.{Region}.{PartitionResult#dnsSuffix}",[E]:j,[F]:j},[A]:d}]}]}]}; +e="PartitionResult", +f="stringEquals", +g="sigv4", +h="budgets", +i={[w]:false,"type":"String"}, +j={[w]:true,"default":false,"type":"Boolean"}, +k={[z]:"Endpoint"}, +l={[x]:"booleanEquals",[y]:[{[z]:"UseFIPS"},true]}, +m={[x]:"booleanEquals",[y]:[{[z]:"UseDualStack"},true]}, +n={}, +o={[x]:"getAttr",[y]:[{[z]:e},"name"]}, +p={[x]:"booleanEquals",[y]:[{[z]:"UseFIPS"},false]}, +q={[x]:"booleanEquals",[y]:[{[z]:"UseDualStack"},false]}, +r={[x]:"booleanEquals",[y]:[true,{[x]:"getAttr",[y]:[{[z]:e},"supportsFIPS"]}]}, +s={[x]:"booleanEquals",[y]:[true,{[x]:"getAttr",[y]:[{[z]:e},"supportsDualStack"]}]}, +t=[l], +u=[m], +v=[{[z]:"Region"}]; +const _data={version:"1.0",parameters:{Region:i,UseDualStack:j,UseFIPS:j,Endpoint:i},rules:[{conditions:[{[x]:a,[y]:[k]}],type:b,rules:[{conditions:t,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:u,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:k,properties:n,headers:n},type:d}]},{conditions:[{[x]:a,[y]:v}],type:b,rules:[{conditions:[{[x]:"aws.partition",[y]:v,assign:e}],type:b,rules:[{conditions:[{[x]:f,[y]:[o,"aws"]},p,q],endpoint:{url:"https://budgets.amazonaws.com",properties:{authSchemes:[{name:g,signingName:h,signingRegion:"us-east-1"}]},headers:n},type:d},{conditions:[{[x]:f,[y]:[o,"aws-cn"]},p,q],endpoint:{url:"https://budgets.amazonaws.com.cn",properties:{authSchemes:[{name:g,signingName:h,signingRegion:"cn-northwest-1"}]},headers:n},type:d},{conditions:[l,m],type:b,rules:[{conditions:[r,s],type:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:t,type:b,rules:[{conditions:[r],type:b,rules:[{endpoint:{url:"https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:u,type:b,rules:[{conditions:[s],type:b,rules:[{endpoint:{url:"https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://budgets.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-budgets/src/index.ts b/clients/client-budgets/src/index.ts index 0f75a2813f97f..ef37ae9bb7822 100644 --- a/clients/client-budgets/src/index.ts +++ b/clients/client-budgets/src/index.ts @@ -2,48 +2,48 @@ /* eslint-disable */ /** *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.
- *Budgets provide you with a way to see the following information:
- *Budgets provide you with a way to see the following information:
+ *How close your plan is to your budgeted amount or to the free tier limits
- *How close your plan is to your budgeted amount or to the free tier limits
+ * *Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
- *Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
+ * *Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
- *Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
+ * *How much of your budget has been used
- *How much of your budget has been used
+ * *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:
- *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:
+ *+ *
* Cost budgets - Plan how much you want to spend on a service.
- *+ *
* Usage budgets - Plan how much you want to use one or more services.
- *+ *
* RI utilization budgets - 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.
- *+ *
* RI coverage budgets - 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.
- *Service Endpoint
- *The Amazon Web Services Budgets API provides the following endpoint:
- *Service Endpoint
+ *The Amazon Web Services Budgets API provides the following endpoint:
+ *https://budgets.amazonaws.com
- *https://budgets.amazonaws.com
+ * *For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
+ *For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
* * @packageDocumentation */ diff --git a/clients/client-budgets/src/models/models_0.ts b/clients/client-budgets/src/models/models_0.ts index db11fe2718778..61d1aaf1aa27b 100644 --- a/clients/client-budgets/src/models/models_0.ts +++ b/clients/client-budgets/src/models/models_0.ts @@ -253,16 +253,16 @@ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof Subscripti /** * @public *The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
- *For example, an email subscriber has the following parameters:
- *For example, an email subscriber has the following parameters:
+ *A subscriptionType
of EMAIL
+ *
A subscriptionType
of EMAIL
*
An address
of example@example.com
+ *
An address
of example@example.com
*
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
- *When you create a subscriber, the value of Address
can't contain line breaks.
When you create a subscriber, the value of Address
can't contain line breaks.
A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -436,7 +437,7 @@ export interface HistoricalOptions { /** * @public *The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit
granularity of the budget:
For the DAILY
granularity, the maximum value is 60
.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod
are included in the calculation of your current BudgetLimit
. If the first budget period in your BudgetAdjustmentPeriod
has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod
as 4
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, LookBackAvailablePeriods
returns 3
.
You can’t set your own LookBackAvailablePeriods
. The value is automatically calculated from the BudgetAdjustmentPeriod
and your historical cost data.
For example, if you set BudgetAdjustmentPeriod
as 4
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, LookBackAvailablePeriods
returns 3
.
You can’t set your own LookBackAvailablePeriods
. The value is automatically calculated from the BudgetAdjustmentPeriod
and your historical cost data.
The amount of cost or usage that's measured for a budget.
- *For example, a Spend
for 3 GB
of S3 usage has the following
+ *
For example, a Spend
for 3 GB
of S3 usage has the following
* parameters:
An Amount
of 3
+ *
An Amount
of 3
*
A unit
of GB
+ *
A unit
of GB
*
forecastedSpend
tracks how much that you're predicted to spend based on
* your historical usage profile.
- * For example, if it's the 20th of the month and you have spent 50
dollars on
+ *
For example, if it's the 20th of the month and you have spent 50
dollars on
* Amazon EC2, your actualSpend
is 50 USD
, and your
* forecastedSpend
is 75 USD
.
The types of cost that are included in a COST
budget, such as tax and subscriptions.
+ *
* USAGE
, RI_UTILIZATION
, RI_COVERAGE
,
* SAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
* budgets don't have CostTypes
.
Specifies whether a budget includes taxes.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes subscriptions.
- *The default value is true
.
The default value is true
.
Specifies whether a budget uses a blended rate.
- *The default value is false
.
The default value is false
.
Specifies whether a budget includes refunds.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes credits.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes upfront RI costs.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes recurring fees such as monthly RI fees.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes non-RI subscription costs.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes support subscription fees.
- *The default value is true
.
The default value is true
.
Specifies whether a budget includes discounts.
- *The default value is true
.
The default value is true
.
Specifies whether a budget uses the amortized rate.
- *The default value is false
.
The default value is false
.
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 DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.
You can change your start date with the UpdateBudget
operation.
The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated + *
After the end date, Amazon Web Services deletes the budget and all the associated
* notifications and subscribers. You can change your end date with the
* UpdateBudget
operation.
Represents the output of the CreateBudget
operation. The content consists of the detailed metadata and data file information, and the current status of the budget
object.
This is the Amazon Resource Name (ARN) pattern for a budget:
- *+ *
This is the Amazon Resource Name (ARN) pattern for a budget:
+ *
* arn:aws:budgets::AccountId:budget/budgetName
*
The name of a budget. The name must be unique within an account. The :
and \
characters aren't allowed in BudgetName
.
The name of a budget. The name must be unique within an account. The :
and
+ * \
characters, and the "/action/" substring, aren't allowed in
+ * BudgetName
.
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or * Savings Plans coverage that you want to track with your budget.
- *+ *
* BudgetLimit
is required for cost or usage budgets, but optional for RI or
* Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or
* coverage budgets default to 100
. This is the only valid value for RI or
@@ -719,20 +722,20 @@ export interface Budget {
/**
* @public
*
A map containing multiple BudgetLimit
, including current or future limits.
+ *
* PlannedBudgetLimits
is available for cost or usage budget and supports both
* monthly and quarterly TimeUnit
.
For monthly budgets, provide 12 months of PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. The key
is the start of the month, UTC
in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits
value
+ *
For monthly budgets, provide 12 months of PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. The key
is the start of the month, UTC
in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits
value
* entries in standard calendar quarter increments. This must start from the current
* quarter and include the next three quarters. The key
is the start of the
* quarter, UTC
in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly, + *
If the planned budget expires before 12 months for monthly or four quarters for quarterly,
* provide the PlannedBudgetLimits
values only for the remaining
* periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits
values from the start date of the budget.
After all of the BudgetLimit
values in PlannedBudgetLimits
are used, the budget continues to use the last limit as the BudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.
+ *
If the budget begins at a date in the future, provide PlannedBudgetLimits
values from the start date of the budget.
After all of the BudgetLimit
values in PlannedBudgetLimits
are used, the budget continues to use the last limit as the BudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.
* DescribeBudget
and DescribeBudgets
response along with
* PlannedBudgetLimits
also contain BudgetLimit
representing
* the current month or quarter limit present in PlannedBudgetLimits
. This
@@ -746,23 +749,23 @@ export interface Budget {
/**
* @public
*
The cost filters, such as Region
, Service
, member account
, Tag
, or Cost Category
, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service
filter for RI budgets:
Amazon Web Services Budgets supports the following services as a Service
filter for RI budgets:
Amazon EC2
- *Amazon EC2
+ * *Amazon Redshift
- *Amazon Redshift
+ * *Amazon Relational Database Service
- *Amazon Relational Database Service
+ * *Amazon ElastiCache
- *Amazon ElastiCache
+ * *Amazon OpenSearch Service
- *Amazon OpenSearch Service
+ * *The types of costs that are included in this COST
budget.
+ *
* USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
budgets do not have CostTypes
.
The period of time that's covered by a budget. You setthe start date and end date. The start
* date must come before the end date. The end date must come before 06/15/87 00:00
* UTC
.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the + *
If you create your budget and don'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 DAILY
, and didn't set
* a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
.
* If you chose MONTHLY
, Amazon Web Services set your start date to
* 01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for
* the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated + *
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated * notifications and subscribers.
*/ TimePeriod?: TimePeriod; @@ -857,25 +860,25 @@ export type NotificationState = (typeof NotificationState)[keyof typeof Notifica /** * @public *A notification that's associated with a budget. A budget can have up to ten notifications.
- *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.
- *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:
- *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.
+ *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:
+ *A notificationType of ACTUAL
+ *
A notificationType of ACTUAL
*
A thresholdType
of PERCENTAGE
+ *
A thresholdType
of PERCENTAGE
*
A comparisonOperator
of GREATER_THAN
+ *
A comparisonOperator
of GREATER_THAN
*
A notification threshold
of 80
+ *
A notification threshold
of 80
*
- * The number of API requests has exceeded the maximum allowed API request throttling limit for the account. - *
+ *The number of API requests has exceeded the maximum allowed API request throttling limit + * for the account.
*/ export class ThrottlingException extends __BaseException { readonly name: "ThrottlingException" = "ThrottlingException"; @@ -1106,7 +1108,8 @@ export interface CreateBudgetActionRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1171,7 +1174,8 @@ export interface CreateBudgetActionResponse { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1318,7 +1322,8 @@ export interface DeleteBudgetActionRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1343,7 +1348,8 @@ export interface DeleteBudgetActionResponse { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1489,7 +1495,8 @@ export interface DescribeBudgetActionRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1514,7 +1521,8 @@ export interface DescribeBudgetActionResponse { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1539,7 +1547,8 @@ export interface DescribeBudgetActionHistoriesRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1670,7 +1679,8 @@ export interface DescribeBudgetActionsForBudgetRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1746,7 +1756,8 @@ export interface BudgetNotificationsForAccount { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName?: string; } @@ -1808,7 +1819,8 @@ export interface DescribeBudgetPerformanceHistoryRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -1862,14 +1874,15 @@ export interface BudgetedAndActualAmounts { export interface BudgetPerformanceHistory { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName?: string; /** * @public *The type of a budget. It must be one of the following types:
- *+ *
* COST
, USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, or SAVINGS_PLANS_COVERAGE
.
A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -2123,7 +2137,8 @@ export interface ExecuteBudgetActionResponse { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -2180,7 +2195,8 @@ export interface UpdateBudgetActionRequest { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; @@ -2245,7 +2261,8 @@ export interface UpdateBudgetActionResponse { /** * @public - *A string that represents the budget name. The ":" and "\" characters aren't allowed.
+ *A string that represents the budget name. The ":" and "\" characters, and the "/action/" + * substring, aren't allowed.
*/ BudgetName: string | undefined; diff --git a/codegen/sdk-codegen/aws-models/budgets.json b/codegen/sdk-codegen/aws-models/budgets.json index deb5ec72cfaed..0c164a30b6052 100644 --- a/codegen/sdk-codegen/aws-models/budgets.json +++ b/codegen/sdk-codegen/aws-models/budgets.json @@ -115,7 +115,7 @@ "name": "budgets" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "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.
\n\t\tBudgets provide you with a way to see the following information:
\n\t\tHow close your plan is to your budgeted amount or to the free tier limits
\n\t\t\tYour usage-to-date, including how much you've used of your Reserved Instances (RIs)
\n\t\t\tYour current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
\n\t\t\tHow much of your budget has been used
\n\t\t\tAmazon 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:
\n\t\t\n Cost budgets - Plan how much you want to spend on a service.
\n\t\t\t\n Usage budgets - Plan how much you want to use one or more services.
\n\t\t\t\n RI utilization budgets - 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.
\n\t\t\t\n RI coverage budgets - 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.
\n\t\t\tService Endpoint
\n\tThe Amazon Web Services Budgets API provides the following endpoint:
\n\t\thttps://budgets.amazonaws.com
\n\t\t\tFor information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
", + "smithy.api#documentation": "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.
\nBudgets provide you with a way to see the following information:
\nHow close your plan is to your budgeted amount or to the free tier limits
\nYour usage-to-date, including how much you've used of your Reserved Instances (RIs)
\nYour current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
\nHow much of your budget has been used
\nAmazon 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:
\n\n Cost budgets - Plan how much you want to spend on a service.
\n\n Usage budgets - Plan how much you want to use one or more services.
\n\n RI utilization budgets - 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.
\n\n RI coverage budgets - 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.
\nService Endpoint
\nThe Amazon Web Services Budgets API provides the following endpoint:
\nhttps://budgets.amazonaws.com
\nFor information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
", "smithy.api#title": "AWS Budgets", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -151,13 +151,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -165,94 +164,175 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "fn": "parseURL", + "fn": "aws.partition", "argv": [ { - "ref": "Endpoint" + "ref": "Region" } ], - "assign": "url" + "assign": "PartitionResult" } ], "type": "tree", "rules": [ { "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, - true + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": "https://budgets.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ { - "ref": "UseDualStack" + "ref": "PartitionResult" }, - true + "name" ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + }, + "aws-cn" + ] }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ + false + ] + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false + ] + } + ], + "endpoint": { + "url": "https://budgets.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "cn-northwest-1" + } ] }, - "aws" - ] - } - ], - "type": "tree", - "rules": [ + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -314,16 +394,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets-fips.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -374,16 +446,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets-fips.{Region}.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -434,16 +498,8 @@ { "conditions": [], "endpoint": { - "url": "https://budgets.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, + "url": "https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" @@ -460,526 +516,108 @@ { "conditions": [], "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-global" - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-cn-global" - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, + "url": "https://budgets.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, "headers": {} }, "type": "endpoint" } ] } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", "expect": { @@ -998,12 +636,51 @@ }, "params": { "Region": "aws-cn-global", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { @@ -1011,21 +688,169 @@ { "name": "sigv4", "signingName": "budgets", - "signingRegion": "us-east-1" + "signingRegion": "cn-northwest-1" } ] }, - "url": "https://budgets.amazonaws.com" + "url": "https://budgets.amazonaws.com.cn" } }, "params": { - "Region": "aws-global", - "UseDualStack": false, - "UseFIPS": false + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://budgets.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -1033,8 +858,21 @@ }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1045,8 +883,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1057,10 +895,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -1219,91 +1063,111 @@ "Message": { "target": "com.amazonaws.budgets#GenericString", "traits": { - "smithy.api#required": {} + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "The budget action resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The description of the details for the event.
" + } + }, + "com.amazonaws.budgets#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.budgets#ActionStatus": { + "type": "enum", + "members": { + "Standby": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDBY" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Execution_In_Progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_IN_PROGRESS" + } + }, + "Execution_Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_SUCCESS" + } + }, + "Execution_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_FAILURE" + } + }, + "Reverse_In_Progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_IN_PROGRESS" + } + }, + "Reverse_Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_SUCCESS" + } + }, + "Reverse_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_FAILURE" } }, - "Action": { - "target": "com.amazonaws.budgets#Action", + "Reset_In_Progress": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The budget action resource.
", - "smithy.api#required": {} + "smithy.api#enumValue": "RESET_IN_PROGRESS" } - } - }, - "traits": { - "smithy.api#documentation": "The description of the details for the event.
" - } - }, - "com.amazonaws.budgets#ActionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 }, - "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" - } - }, - "com.amazonaws.budgets#ActionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDBY", - "name": "Standby" - }, - { - "value": "PENDING", - "name": "Pending" - }, - { - "value": "EXECUTION_IN_PROGRESS", - "name": "Execution_In_Progress" - }, - { - "value": "EXECUTION_SUCCESS", - "name": "Execution_Success" - }, - { - "value": "EXECUTION_FAILURE", - "name": "Execution_Failure" - }, - { - "value": "REVERSE_IN_PROGRESS", - "name": "Reverse_In_Progress" - }, - { - "value": "REVERSE_SUCCESS", - "name": "Reverse_Success" - }, - { - "value": "REVERSE_FAILURE", - "name": "Reverse_Failure" - }, - { - "value": "RESET_IN_PROGRESS", - "name": "Reset_In_Progress" - }, - { - "value": "RESET_FAILURE", - "name": "Reset_Failure" + "Reset_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_FAILURE" } - ] + } } }, "com.amazonaws.budgets#ActionSubType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STOP_EC2_INSTANCES", - "name": "STOP_EC2" - }, - { - "value": "STOP_RDS_INSTANCES", - "name": "STOP_RDS" + "type": "enum", + "members": { + "STOP_EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_EC2_INSTANCES" } - ] + }, + "STOP_RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_RDS_INSTANCES" + } + } } }, "com.amazonaws.budgets#ActionThreshold": { @@ -1328,22 +1192,26 @@ } }, "com.amazonaws.budgets#ActionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPLY_IAM_POLICY", - "name": "IAM" - }, - { - "value": "APPLY_SCP_POLICY", - "name": "SCP" - }, - { - "value": "RUN_SSM_DOCUMENTS", - "name": "SSM" + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLY_IAM_POLICY" + } + }, + "SCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLY_SCP_POLICY" + } + }, + "SSM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUN_SSM_DOCUMENTS" } - ] + } } }, "com.amazonaws.budgets#Actions": { @@ -1368,18 +1236,20 @@ } }, "com.amazonaws.budgets#ApprovalModel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTOMATIC", - "name": "AUTO" - }, - { - "value": "MANUAL", - "name": "MANUAL" + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" } - ] + } } }, "com.amazonaws.budgets#AutoAdjustData": { @@ -1410,18 +1280,20 @@ } }, "com.amazonaws.budgets#AutoAdjustType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HISTORICAL", - "name": "HISTORICAL" - }, - { - "value": "FORECAST", - "name": "FORECAST" + "type": "enum", + "members": { + "HISTORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL" + } + }, + "FORECAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORECAST" } - ] + } } }, "com.amazonaws.budgets#Budget": { @@ -1430,32 +1302,32 @@ "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "The name of a budget. The name must be unique within an account. The :
and \\
characters aren't allowed in BudgetName
.
The name of a budget. The name must be unique within an account. The :
and\n\t\t\t\t\\
characters, and the \"/action/\" substring, aren't allowed in\n\t\t\t\tBudgetName
.
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or\n\t\t\tSavings Plans coverage that you want to track with your budget.
\n\t\t\n BudgetLimit
is required for cost or usage budgets, but optional for RI or\n\t\t\tSavings Plans utilization or coverage budgets. RI and Savings Plans utilization or\n\t\t\tcoverage budgets default to 100
. This is the only valid value for RI or\n\t\t\tSavings Plans utilization or coverage budgets. You can't use BudgetLimit
\n\t\t\twith PlannedBudgetLimits
for CreateBudget
and\n\t\t\t\tUpdateBudget
actions.
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or\n\t\t\tSavings Plans coverage that you want to track with your budget.
\n\n BudgetLimit
is required for cost or usage budgets, but optional for RI or\n\t\t\tSavings Plans utilization or coverage budgets. RI and Savings Plans utilization or\n\t\t\tcoverage budgets default to 100
. This is the only valid value for RI or\n\t\t\tSavings Plans utilization or coverage budgets. You can't use BudgetLimit
\n\t\t\twith PlannedBudgetLimits
for CreateBudget
and\n\t\t\t\tUpdateBudget
actions.
A map containing multiple BudgetLimit
, including current or future limits.
\n PlannedBudgetLimits
is available for cost or usage budget and supports both\n\t\t\tmonthly and quarterly TimeUnit
.
For monthly budgets, provide 12 months of PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. The key
is the start of the month, UTC
in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits
value\n\t\t\tentries in standard calendar quarter increments. This must start from the current\n\t\t\tquarter and include the next three quarters. The key
is the start of the\n\t\t\tquarter, UTC
in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly,\n\t\t\tprovide the PlannedBudgetLimits
values only for the remaining\n\t\t\tperiods.
If the budget begins at a date in the future, provide PlannedBudgetLimits
values from the start date of the budget.
After all of the BudgetLimit
values in PlannedBudgetLimits
are used, the budget continues to use the last limit as the BudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.
\n DescribeBudget
and DescribeBudgets
response along with\n\t\t\t\tPlannedBudgetLimits
also contain BudgetLimit
representing\n\t\t\tthe current month or quarter limit present in PlannedBudgetLimits
. This\n\t\t\tonly applies to budgets that are created with PlannedBudgetLimits
. Budgets\n\t\t\tthat are created without PlannedBudgetLimits
only contain\n\t\t\t\tBudgetLimit
. They don't contain\n\t\t\tPlannedBudgetLimits
.
A map containing multiple BudgetLimit
, including current or future limits.
\n PlannedBudgetLimits
is available for cost or usage budget and supports both\n\t\t\tmonthly and quarterly TimeUnit
.
For monthly budgets, provide 12 months of PlannedBudgetLimits
values. This must start from the current month and include the next 11 months. The key
is the start of the month, UTC
in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits
value\n\t\t\tentries in standard calendar quarter increments. This must start from the current\n\t\t\tquarter and include the next three quarters. The key
is the start of the\n\t\t\tquarter, UTC
in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly,\n\t\t\tprovide the PlannedBudgetLimits
values only for the remaining\n\t\t\tperiods.
If the budget begins at a date in the future, provide PlannedBudgetLimits
values from the start date of the budget.
After all of the BudgetLimit
values in PlannedBudgetLimits
are used, the budget continues to use the last limit as the BudgetLimit
. At that point, the planned budget provides the same experience as a fixed budget.
\n DescribeBudget
and DescribeBudgets
response along with\n\t\t\t\tPlannedBudgetLimits
also contain BudgetLimit
representing\n\t\t\tthe current month or quarter limit present in PlannedBudgetLimits
. This\n\t\t\tonly applies to budgets that are created with PlannedBudgetLimits
. Budgets\n\t\t\tthat are created without PlannedBudgetLimits
only contain\n\t\t\t\tBudgetLimit
. They don't contain\n\t\t\tPlannedBudgetLimits
.
The cost filters, such as Region
, Service
, member account
, Tag
, or Cost Category
, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service
filter for RI budgets:
Amazon EC2
\n\t\t\tAmazon Redshift
\n\t\t\tAmazon Relational Database Service
\n\t\t\tAmazon ElastiCache
\n\t\t\tAmazon OpenSearch Service
\n\t\t\tThe cost filters, such as Region
, Service
, member account
, Tag
, or Cost Category
, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service
filter for RI budgets:
Amazon EC2
\nAmazon Redshift
\nAmazon Relational Database Service
\nAmazon ElastiCache
\nAmazon OpenSearch Service
\nThe types of costs that are included in this COST
budget.
\n USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
budgets do not have CostTypes
.
The types of costs that are included in this COST
budget.
\n USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
budgets do not have CostTypes
.
The period of time that's covered by a budget. You setthe start date and end date. The start\n\t\t\tdate must come before the end date. The end date must come before 06/15/87 00:00\n\t\t\t\tUTC
.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the\n\t\t\tstart of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example,\n\t\t\tif you created your budget on January 24, 2018, chose DAILY
, and didn't set\n\t\t\ta start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
.\n\t\t\tIf you chose MONTHLY
, Amazon Web Services set your start date to\n\t\t\t\t01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for\n\t\t\tthe Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.
" + "smithy.api#documentation": "The period of time that's covered by a budget. You setthe start date and end date. The start\n\t\t\tdate must come before the end date. The end date must come before 06/15/87 00:00\n\t\t\t\tUTC
.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the\n\t\t\tstart of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example,\n\t\t\tif you created your budget on January 24, 2018, chose DAILY
, and didn't set\n\t\t\ta start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
.\n\t\t\tIf you chose MONTHLY
, Amazon Web Services set your start date to\n\t\t\t\t01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for\n\t\t\tthe Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.
" } }, "CalculatedSpend": { @@ -1498,18 +1370,18 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output of the CreateBudget
operation. The content consists of the detailed metadata and data file information, and the current status of the budget
object.
This is the Amazon Resource Name (ARN) pattern for a budget:
\n\t\t\n arn:aws:budgets::AccountId:budget/budgetName
\n
Represents the output of the CreateBudget
operation. The content consists of the detailed metadata and data file information, and the current status of the budget
object.
This is the Amazon Resource Name (ARN) pattern for a budget:
\n\n arn:aws:budgets::AccountId:budget/budgetName
\n
A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.
", + "smithy.api#documentation": "A string that represents the budget name. The \":\" and \"\\\" characters, and the \"/action/\"\n\t\t\tsubstring, aren't allowed.
", "smithy.api#length": { "min": 1, "max": 100 }, - "smithy.api#pattern": "^[^:\\\\]+$" + "smithy.api#pattern": "^(?![^:\\\\]*/action/)[^:\\\\]+$" } }, "com.amazonaws.budgets#BudgetNotificationsForAccount": { @@ -1574,35 +1446,47 @@ } }, "com.amazonaws.budgets#BudgetType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The type of a budget. It must be one of the following types:
\n\t\t\n COST
, USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, or SAVINGS_PLANS_COVERAGE
.
The type of a budget. It must be one of the following types:
\n\n COST
, USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
, or SAVINGS_PLANS_COVERAGE
.
The spend objects that are associated with this budget. The actualSpend
tracks\n\t\t\thow much you've used, cost, usage, RI units, or Savings Plans units and the\n\t\t\t\tforecastedSpend
tracks how much that you're predicted to spend based on\n\t\t\tyour historical usage profile.
For example, if it's the 20th of the month and you have spent 50
dollars on\n\t\t\tAmazon EC2, your actualSpend
is 50 USD
, and your\n\t\t\t\tforecastedSpend
is 75 USD
.
The spend objects that are associated with this budget. The actualSpend
tracks\n\t\t\thow much you've used, cost, usage, RI units, or Savings Plans units and the\n\t\t\t\tforecastedSpend
tracks how much that you're predicted to spend based on\n\t\t\tyour historical usage profile.
For example, if it's the 20th of the month and you have spent 50
dollars on\n\t\t\tAmazon EC2, your actualSpend
is 50 USD
, and your\n\t\t\t\tforecastedSpend
is 75 USD
.
The comparison operator of a notification. Currently, the service supports the following\n\t\t\toperators:
\n\t\t\n GREATER_THAN
, LESS_THAN
, EQUAL_TO
\n
The comparison operator of a notification. Currently, the service supports the following\n\t\t\toperators:
\n\n GREATER_THAN
, LESS_THAN
, EQUAL_TO
\n
Specifies whether a budget includes taxes.
\n\t\tThe default value is true
.
Specifies whether a budget includes taxes.
\nThe default value is true
.
Specifies whether a budget includes subscriptions.
\n\t\tThe default value is true
.
Specifies whether a budget includes subscriptions.
\nThe default value is true
.
Specifies whether a budget uses a blended rate.
\n\t\tThe default value is false
.
Specifies whether a budget uses a blended rate.
\nThe default value is false
.
Specifies whether a budget includes refunds.
\n\t\tThe default value is true
.
Specifies whether a budget includes refunds.
\nThe default value is true
.
Specifies whether a budget includes credits.
\n\t\tThe default value is true
.
Specifies whether a budget includes credits.
\nThe default value is true
.
Specifies whether a budget includes upfront RI costs.
\n\t\tThe default value is true
.
Specifies whether a budget includes upfront RI costs.
\nThe default value is true
.
Specifies whether a budget includes recurring fees such as monthly RI fees.
\n\t\tThe default value is true
.
Specifies whether a budget includes recurring fees such as monthly RI fees.
\nThe default value is true
.
Specifies whether a budget includes non-RI subscription costs.
\n\t\tThe default value is true
.
Specifies whether a budget includes non-RI subscription costs.
\nThe default value is true
.
Specifies whether a budget includes support subscription fees.
\n\t\tThe default value is true
.
Specifies whether a budget includes support subscription fees.
\nThe default value is true
.
Specifies whether a budget includes discounts.
\n\t\tThe default value is true
.
Specifies whether a budget includes discounts.
\nThe default value is true
.
Specifies whether a budget uses the amortized rate.
\n\t\tThe default value is false
.
Specifies whether a budget uses the amortized rate.
\nThe default value is false
.
The types of cost that are included in a COST
budget, such as tax and subscriptions.
\n USAGE
, RI_UTILIZATION
, RI_COVERAGE
,\n\t\t\t\tSAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
\n\t\t\tbudgets don't have CostTypes
.
The types of cost that are included in a COST
budget, such as tax and subscriptions.
\n USAGE
, RI_UTILIZATION
, RI_COVERAGE
,\n\t\t\t\tSAVINGS_PLANS_UTILIZATION
, and SAVINGS_PLANS_COVERAGE
\n\t\t\tbudgets don't have CostTypes
.
Creates a budget and, if included, notifications and subscribers.
\n\t\tOnly one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Creates a budget and, if included, notifications and subscribers.
\nOnly one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Request of CreateBudget
" + "smithy.api#documentation": "Request of CreateBudget
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of CreateBudget
" + "smithy.api#documentation": "Response of CreateBudget
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreateNotification": { @@ -2029,14 +1927,16 @@ } }, "traits": { - "smithy.api#documentation": "Request of CreateNotification
" + "smithy.api#documentation": "Request of CreateNotification
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of CreateNotification
" + "smithy.api#documentation": "Response of CreateNotification
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreateSubscriber": { @@ -2107,14 +2007,16 @@ } }, "traits": { - "smithy.api#documentation": "Request of CreateSubscriber
" + "smithy.api#documentation": "Request of CreateSubscriber
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of CreateSubscriber
" + "smithy.api#documentation": "Response of CreateSubscriber
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreationLimitExceededException": { @@ -2182,7 +2084,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a budget. You can delete your budget at any time.
\n\t\tDeleting a budget also deletes the notifications and subscribers that are associated with that budget.
\n\t\tDeletes a budget. You can delete your budget at any time.
\nDeleting a budget also deletes the notifications and subscribers that are associated with that budget.
\nRequest of DeleteBudget
" + "smithy.api#documentation": "Request of DeleteBudget
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of DeleteBudget
" + "smithy.api#documentation": "Response of DeleteBudget
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DeleteNotification": { @@ -2319,7 +2229,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a notification.
\n\t\tDeleting a notification also deletes the subscribers that are associated with the notification.
\n\t\tDeletes a notification.
\nDeleting a notification also deletes the subscribers that are associated with the notification.
\nRequest of DeleteNotification
" + "smithy.api#documentation": "Request of DeleteNotification
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of DeleteNotification
" + "smithy.api#documentation": "Response of DeleteNotification
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DeleteSubscriber": { @@ -2384,7 +2296,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a subscriber.
\n\t\tDeleting the last subscriber to a notification also deletes the notification.
\n\t\tDeletes a subscriber.
\nDeleting the last subscriber to a notification also deletes the notification.
\nRequest of DeleteSubscriber
" + "smithy.api#documentation": "Request of DeleteSubscriber
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of DeleteSubscriber
" + "smithy.api#documentation": "Response of DeleteSubscriber
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudget": { @@ -2456,7 +2370,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a budget.
\n\t\tThe Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Describes a budget.
\nThe Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Request of DescribeBudget
" + "smithy.api#documentation": "Request of DescribeBudget
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetResponse": { @@ -2956,7 +2907,8 @@ } }, "traits": { - "smithy.api#documentation": "Response of DescribeBudget
" + "smithy.api#documentation": "Response of DescribeBudget
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgets": { @@ -2991,7 +2943,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the budgets that are associated with an account.
\n\t\tThe Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Lists the budgets that are associated with an account.
\nThe Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Request of DescribeBudgets
" + "smithy.api#documentation": "Request of DescribeBudgets
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetsResponse": { @@ -3044,7 +2997,8 @@ } }, "traits": { - "smithy.api#documentation": "Response of DescribeBudgets
" + "smithy.api#documentation": "Response of DescribeBudgets
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeNotificationsForBudget": { @@ -3119,7 +3073,8 @@ } }, "traits": { - "smithy.api#documentation": "Request of DescribeNotificationsForBudget
" + "smithy.api#documentation": "Request of DescribeNotificationsForBudget
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeNotificationsForBudgetResponse": { @@ -3139,7 +3094,8 @@ } }, "traits": { - "smithy.api#documentation": "Response of GetNotificationsForBudget
" + "smithy.api#documentation": "Response of GetNotificationsForBudget
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeSubscribersForNotification": { @@ -3221,7 +3177,8 @@ } }, "traits": { - "smithy.api#documentation": "Request of DescribeSubscribersForNotification
" + "smithy.api#documentation": "Request of DescribeSubscribersForNotification
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeSubscribersForNotificationResponse": { @@ -3241,7 +3198,8 @@ } }, "traits": { - "smithy.api#documentation": "Response of DescribeSubscribersForNotification
" + "smithy.api#documentation": "Response of DescribeSubscribersForNotification
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DimensionValue": { @@ -3274,30 +3232,38 @@ } }, "com.amazonaws.budgets#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYSTEM", - "name": "System" - }, - { - "value": "CREATE_ACTION", - "name": "CreateAction" - }, - { - "value": "DELETE_ACTION", - "name": "DeleteAction" - }, - { - "value": "UPDATE_ACTION", - "name": "UpdateAction" - }, - { - "value": "EXECUTE_ACTION", - "name": "ExecuteAction" + "type": "enum", + "members": { + "System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "CreateAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ACTION" } - ] + }, + "DeleteAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_ACTION" + } + }, + "UpdateAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ACTION" + } + }, + "ExecuteAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTE_ACTION" + } + } } }, "com.amazonaws.budgets#ExecuteBudgetAction": { @@ -3361,6 +3327,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#ExecuteBudgetActionResponse": { @@ -3392,29 +3361,38 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#ExecutionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPROVE_BUDGET_ACTION", - "name": "ApproveBudgetAction" - }, - { - "value": "RETRY_BUDGET_ACTION", - "name": "RetryBudgetAction" - }, - { - "value": "REVERSE_BUDGET_ACTION", - "name": "ReverseBudgetAction" - }, - { - "value": "RESET_BUDGET_ACTION", - "name": "ResetBudgetAction" + "type": "enum", + "members": { + "ApproveBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVE_BUDGET_ACTION" + } + }, + "RetryBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY_BUDGET_ACTION" } - ] + }, + "ReverseBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_BUDGET_ACTION" + } + }, + "ResetBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_BUDGET_ACTION" + } + } } }, "com.amazonaws.budgets#ExpiredNextTokenException": { @@ -3475,14 +3453,14 @@ "BudgetAdjustmentPeriod": { "target": "com.amazonaws.budgets#AdjustmentPeriod", "traits": { - "smithy.api#documentation": "The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit
granularity of the budget:
For the DAILY
granularity, the maximum value is 60
.
For the MONTHLY
granularity, the maximum value is 12
.
For the QUARTERLY
granularity, the maximum value is 4
.
For the ANNUALLY
granularity, the maximum value is 1
.
The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit
granularity of the budget:
For the DAILY
granularity, the maximum value is 60
.
For the MONTHLY
granularity, the maximum value is 12
.
For the QUARTERLY
granularity, the maximum value is 4
.
For the ANNUALLY
granularity, the maximum value is 1
.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod
are included in the calculation of your current BudgetLimit
. If the first budget period in your BudgetAdjustmentPeriod
has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod
as 4
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, LookBackAvailablePeriods
returns 3
.
You can’t set your own LookBackAvailablePeriods
. The value is automatically calculated from the BudgetAdjustmentPeriod
and your historical cost data.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod
are included in the calculation of your current BudgetLimit
. If the first budget period in your BudgetAdjustmentPeriod
has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod
as 4
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, LookBackAvailablePeriods
returns 3
.
You can’t set your own LookBackAvailablePeriods
. The value is automatically calculated from the BudgetAdjustmentPeriod
and your historical cost data.
A notification that's associated with a budget. A budget can have up to ten notifications.
\n\t\tEach 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.
\n\t\tFor 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:
\n\t\tA notificationType of ACTUAL
\n
A thresholdType
of PERCENTAGE
\n
A comparisonOperator
of GREATER_THAN
\n
A notification threshold
of 80
\n
A notification that's associated with a budget. A budget can have up to ten notifications.
\nEach 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.
\nFor 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:
\nA notificationType of ACTUAL
\n
A thresholdType
of PERCENTAGE
\n
A comparisonOperator
of GREATER_THAN
\n
A notification threshold
of 80
\n
The type of a notification. It must be ACTUAL or FORECASTED.
", - "smithy.api#enum": [ - { - "value": "ACTUAL", - "name": "ACTUAL" - }, - { - "value": "FORECASTED", - "name": "FORECASTED" + "type": "enum", + "members": { + "ACTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTUAL" + } + }, + "FORECASTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORECASTED" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The type of a notification. It must be ACTUAL or FORECASTED.
" } }, "com.amazonaws.budgets#NotificationWithSubscribers": { @@ -3883,7 +3867,7 @@ } }, "traits": { - "smithy.api#documentation": "The amount of cost or usage that's measured for a budget.
\n\t\tFor example, a Spend
for 3 GB
of S3 usage has the following\n\t\t\tparameters:
An Amount
of 3
\n
A unit
of GB
\n
The amount of cost or usage that's measured for a budget.
\nFor example, a Spend
for 3 GB
of S3 usage has the following\n\t\t\tparameters:
An Amount
of 3
\n
A unit
of GB
\n
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
\n\t\tWhen you create a subscriber, the value of Address
can't contain line breaks.
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
\nWhen you create a subscriber, the value of Address
can't contain line breaks.
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
\n\t\tFor example, an email subscriber has the following parameters:
\n\t\tA subscriptionType
of EMAIL
\n
An address
of example@example.com
\n
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
\nFor example, an email subscriber has the following parameters:
\nA subscriptionType
of EMAIL
\n
An address
of example@example.com
\n
The subscription type of the subscriber. It can be SMS or EMAIL.
", - "smithy.api#enum": [ - { - "value": "SNS", - "name": "SNS" - }, - { - "value": "EMAIL", - "name": "EMAIL" + "type": "enum", + "members": { + "SNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNS" } - ] + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + }, + "traits": { + "smithy.api#documentation": "The subscription type of the subscriber. It can be SMS or EMAIL.
" } }, "com.amazonaws.budgets#TargetId": { @@ -4001,19 +3989,23 @@ } }, "com.amazonaws.budgets#ThresholdType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The type of threshold for a notification.
", - "smithy.api#enum": [ - { - "value": "PERCENTAGE", - "name": "PERCENTAGE" - }, - { - "value": "ABSOLUTE_VALUE", - "name": "ABSOLUTE_VALUE" + "type": "enum", + "members": { + "PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + }, + "ABSOLUTE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_VALUE" } - ] + } + }, + "traits": { + "smithy.api#documentation": "The type of threshold for a notification.
" } }, "com.amazonaws.budgets#ThrottlingException": { @@ -4024,7 +4016,7 @@ } }, "traits": { - "smithy.api#documentation": "\n The number of API requests has exceeded the maximum allowed API request throttling limit for the account.\n
", + "smithy.api#documentation": "The number of API requests has exceeded the maximum allowed API request throttling limit\n for the account.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4035,13 +4027,13 @@ "Start": { "target": "com.amazonaws.budgets#GenericTimestamp", "traits": { - "smithy.api#documentation": "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 DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.
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 DAILY
, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set your start date to 01/01/18 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.
The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers. You can change your end date with the\n\t\t\t\tUpdateBudget
operation.
The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC
. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers. You can change your end date with the\n\t\t\t\tUpdateBudget
operation.
The time unit of the budget, such as MONTHLY or QUARTERLY.
", - "smithy.api#enum": [ - { - "value": "DAILY", - "name": "DAILY" - }, - { - "value": "MONTHLY", - "name": "MONTHLY" - }, - { - "value": "QUARTERLY", - "name": "QUARTERLY" - }, - { - "value": "ANNUALLY", - "name": "ANNUALLY" + "type": "enum", + "members": { + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" } - ] + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + }, + "QUARTERLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTERLY" + } + }, + "ANNUALLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANNUALLY" + } + } + }, + "traits": { + "smithy.api#documentation": "The time unit of the budget, such as MONTHLY or QUARTERLY.
" } }, "com.amazonaws.budgets#UnitValue": { @@ -4110,7 +4110,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a budget. You can change every part of a budget except for the budgetName
and the calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Updates a budget. You can change every part of a budget except for the budgetName
and the calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Request of UpdateBudget
" + "smithy.api#documentation": "Request of UpdateBudget
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of UpdateBudget
" + "smithy.api#documentation": "Response of UpdateBudget
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#UpdateNotification": { @@ -4318,14 +4326,16 @@ } }, "traits": { - "smithy.api#documentation": "Request of UpdateNotification
" + "smithy.api#documentation": "Request of UpdateNotification
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of UpdateNotification
" + "smithy.api#documentation": "Response of UpdateNotification
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#UpdateSubscriber": { @@ -4400,14 +4410,16 @@ } }, "traits": { - "smithy.api#documentation": "Request of UpdateSubscriber
" + "smithy.api#documentation": "Request of UpdateSubscriber
", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Response of UpdateSubscriber
" + "smithy.api#documentation": "Response of UpdateSubscriber
", + "smithy.api#output": {} } }, "com.amazonaws.budgets#User": { @@ -4439,4 +4451,4 @@ } } } -} \ No newline at end of file +}