Skip to content

Commit

Permalink
feat(client-budgets): As part of CAE tagging integration we need to u…
Browse files Browse the repository at this point in the history 
…pdate our budget names regex filter to prevent customers from using "/action/" in their budget names.
  • Loading branch information
awstools committed Aug 2, 2023
1 parent 54b8be8 commit e96bea8
Show file tree
Hide file tree
Showing 29 changed files with 1,353 additions and 1,356 deletions.
52 changes: 26 additions & 26 deletions clients/client-budgets/src/Budgets.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,48 +517,48 @@ export interface Budgets {
/**
* @public
* <p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p>
* <p>Budgets provide you with a way to see the following information:</p>
* <ul>
* <p>Budgets provide you with a way to see the following information:</p>
* <ul>
* <li>
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
* </li>
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
* </li>
* <li>
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
* </li>
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
* </li>
* <li>
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
* </li>
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
* </li>
* <li>
* <p>How much of your budget has been used</p>
* </li>
* <p>How much of your budget has been used</p>
* </li>
* </ul>
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
* <ul>
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
* <ul>
* <li>
* <p>
* <p>
* <b>Cost budgets</b> - Plan how much you want to spend on a service.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>Usage budgets</b> - Plan how much you want to use one or more services.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p>
* </li>
* </li>
* </ul>
* <p>Service Endpoint</p>
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
* <ul>
* <p>Service Endpoint</p>
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
* <ul>
* <li>
* <p>https://budgets.amazonaws.com</p>
* </li>
* <p>https://budgets.amazonaws.com</p>
* </li>
* </ul>
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
*/
export class Budgets extends BudgetsClient implements Budgets {}
createAggregatedClient(commands, Budgets);
52 changes: 26 additions & 26 deletions clients/client-budgets/src/BudgetsClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,48 +330,48 @@ export interface BudgetsClientResolvedConfig extends BudgetsClientResolvedConfig
/**
* @public
* <p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p>
* <p>Budgets provide you with a way to see the following information:</p>
* <ul>
* <p>Budgets provide you with a way to see the following information:</p>
* <ul>
* <li>
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
* </li>
* <p>How close your plan is to your budgeted amount or to the free tier limits</p>
* </li>
* <li>
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
* </li>
* <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p>
* </li>
* <li>
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
* </li>
* <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p>
* </li>
* <li>
* <p>How much of your budget has been used</p>
* </li>
* <p>How much of your budget has been used</p>
* </li>
* </ul>
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
* <ul>
* <p>Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p>
* <ul>
* <li>
* <p>
* <p>
* <b>Cost budgets</b> - Plan how much you want to spend on a service.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>Usage budgets</b> - Plan how much you want to use one or more services.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p>
* </li>
* </li>
* <li>
* <p>
* <p>
* <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p>
* </li>
* </li>
* </ul>
* <p>Service Endpoint</p>
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
* <ul>
* <p>Service Endpoint</p>
* <p>The Amazon Web Services Budgets API provides the following endpoint:</p>
* <ul>
* <li>
* <p>https://budgets.amazonaws.com</p>
* </li>
* <p>https://budgets.amazonaws.com</p>
* </li>
* </ul>
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
* <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.</p>
*/
export class BudgetsClient extends __Client<
__HttpHandlerOptions,
Expand Down
17 changes: 8 additions & 9 deletions clients/client-budgets/src/commands/CreateBudgetActionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo
* const input = { // CreateBudgetActionRequest
* AccountId: "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
Expand All @@ -78,18 +78,18 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo
* ],
* },
* SsmActionDefinition: { // SsmActionDefinition
* ActionSubType: "STRING_VALUE", // required
* ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required
* Region: "STRING_VALUE", // required
* InstanceIds: [ // InstanceIds // required
* "STRING_VALUE",
* ],
* },
* },
* ExecutionRoleArn: "STRING_VALUE", // required
* ApprovalModel: "STRING_VALUE", // required
* ApprovalModel: "AUTOMATIC" || "MANUAL", // required
* Subscribers: [ // Subscribers // required
* { // Subscriber
* SubscriptionType: "STRING_VALUE", // required
* SubscriptionType: "SNS" || "EMAIL", // required
* Address: "STRING_VALUE", // required
* },
* ],
Expand Down Expand Up @@ -129,9 +129,8 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo
* <p>We can’t locate the resource that you specified.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>
* The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
* </p>
* <p>The number of API requests has exceeded the maximum allowed API request throttling limit
* for the account.</p>
*
* @throws {@link BudgetsServiceException}
* <p>Base exception class for all service exceptions from Budgets service.</p>
Expand Down
27 changes: 13 additions & 14 deletions clients/client-budgets/src/commands/CreateBudgetCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
/**
* @public
* <p>Creates a budget and, if included, notifications and subscribers. </p>
* <important>
* <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples">Examples</a> section. </p>
* </important>
* <important>
* <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples">Examples</a> section. </p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -78,7 +78,7 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
* IncludeDiscount: true || false,
* UseAmortized: true || false,
* },
* TimeUnit: "STRING_VALUE", // required
* TimeUnit: "DAILY" || "MONTHLY" || "QUARTERLY" || "ANNUALLY", // required
* TimePeriod: { // TimePeriod
* Start: new Date("TIMESTAMP"),
* End: new Date("TIMESTAMP"),
Expand All @@ -93,10 +93,10 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
* Unit: "STRING_VALUE", // required
* },
* },
* BudgetType: "STRING_VALUE", // required
* BudgetType: "USAGE" || "COST" || "RI_UTILIZATION" || "RI_COVERAGE" || "SAVINGS_PLANS_UTILIZATION" || "SAVINGS_PLANS_COVERAGE", // required
* LastUpdatedTime: new Date("TIMESTAMP"),
* AutoAdjustData: { // AutoAdjustData
* AutoAdjustType: "STRING_VALUE", // required
* AutoAdjustType: "HISTORICAL" || "FORECAST", // required
* HistoricalOptions: { // HistoricalOptions
* BudgetAdjustmentPeriod: Number("int"), // required
* LookBackAvailablePeriods: Number("int"),
Expand All @@ -107,15 +107,15 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
* NotificationsWithSubscribers: [ // NotificationWithSubscribersList
* { // NotificationWithSubscribers
* 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",
* },
* Subscribers: [ // Subscribers // required
* { // Subscriber
* SubscriptionType: "STRING_VALUE", // required
* SubscriptionType: "SNS" || "EMAIL", // required
* Address: "STRING_VALUE", // required
* },
* ],
Expand Down Expand Up @@ -150,9 +150,8 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad
* <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>
* The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
* </p>
* <p>The number of API requests has exceeded the maximum allowed API request throttling limit
* for the account.</p>
*
* @throws {@link BudgetsServiceException}
* <p>Base exception class for all service exceptions from Budgets service.</p>
Expand Down
15 changes: 7 additions & 8 deletions clients/client-budgets/src/commands/CreateNotificationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ export interface CreateNotificationCommandOutput extends CreateNotificationRespo
* 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",
* },
* Subscribers: [ // Subscribers // required
* { // Subscriber
* SubscriptionType: "STRING_VALUE", // required
* SubscriptionType: "SNS" || "EMAIL", // required
* Address: "STRING_VALUE", // required
* },
* ],
Expand Down Expand Up @@ -95,9 +95,8 @@ export interface CreateNotificationCommandOutput extends CreateNotificationRespo
* <p>We can’t locate the resource that you specified.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>
* The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
* </p>
* <p>The number of API requests has exceeded the maximum allowed API request throttling limit
* for the account.</p>
*
* @throws {@link BudgetsServiceException}
* <p>Base exception class for all service exceptions from Budgets service.</p>
Expand Down
15 changes: 7 additions & 8 deletions clients/client-budgets/src/commands/CreateSubscriberCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse,
* 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",
* },
* Subscriber: { // Subscriber
* SubscriptionType: "STRING_VALUE", // required
* SubscriptionType: "SNS" || "EMAIL", // required
* Address: "STRING_VALUE", // required
* },
* };
Expand Down Expand Up @@ -93,9 +93,8 @@ export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse,
* <p>We can’t locate the resource that you specified.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>
* The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
* </p>
* <p>The number of API requests has exceeded the maximum allowed API request throttling limit
* for the account.</p>
*
* @throws {@link BudgetsServiceException}
* <p>Base exception class for all service exceptions from Budgets service.</p>
Expand Down
Loading

0 comments on commit e96bea8

Please sign in to comment.