View Source AWS.Budgets (aws-elixir v1.0.4)
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:
* 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 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
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:
* 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.
Link to this section Summary
Functions
Creates a budget and, if included, notifications and subscribers.
Creates a budget action.
Creates a notification.
Creates a subscriber.
Deletes a budget.
Deletes a budget action.
Deletes a notification.
Deletes a subscriber.
Describes a budget.
Describes a budget action detail.
Describes a budget action history detail.
Describes all of the budget actions for an account.
Describes all of the budget actions for a budget.
Lists the budget names and notifications that are associated with an account.
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
Lists the budgets that are associated with an account.
Lists the notifications that are associated with a budget.
Lists the subscribers that are associated with a notification.
Executes a budget action.
Lists tags associated with a budget or budget action resource.
Creates tags for a budget or budget action resource.
Deletes tags associated with a budget or budget action resource.
Updates a budget.
Updates a budget action.
Updates a notification.
Updates a subscriber.
Link to this section Functions
Creates a budget and, if included, notifications and subscribers.
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.
Creates a budget action.
Creates a notification.
You must create the budget before you create the associated notification.
Creates a subscriber.
You must create the associated budget and notification before you create the subscriber.
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.
Deletes a budget action.
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
Describes a budget.
The Request Syntax section shows the BudgetLimit syntax. For
PlannedBudgetLimits, see the
Examples
section.
Describes a budget action detail.
Describes a budget action history detail.
Describes all of the budget actions for an account.
Describes all of the budget actions for a budget.
describe_budget_notifications_for_account(client, input, options \\ [])
View SourceLists the budget names and notifications that are associated with an account.
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
Budget history isn't available for ANNUAL budgets.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax. For
PlannedBudgetLimits, see the
Examples
section.
Lists the notifications that are associated with a budget.
describe_subscribers_for_notification(client, input, options \\ [])
View SourceLists the subscribers that are associated with a notification.
Executes a budget action.
Lists tags associated with a budget or budget action resource.
Creates tags for a budget or budget action resource.
Deletes tags associated with a budget or budget action resource.
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 action.
Updates a notification.
Updates a subscriber.