AWS.Budgets (aws-elixir v0.8.0) View Source

The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations.

The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.

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 AWS, and how much your predicted usage will accrue in charges by the end of the month

  • How much of your budget has been used

AWS 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 AWS Budgets API provides the following endpoint:

For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.

Link to this section Summary

Functions

Creates a budget and, if included, notifications and subscribers.

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.

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.

Link to this section Functions

Link to this function

create_budget(client, input, options \\ [])

View Source

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.

Link to this function

create_budget_action(client, input, options \\ [])

View Source

Creates a budget action.

Link to this function

create_notification(client, input, options \\ [])

View Source

Creates a notification.

You must create the budget before you create the associated notification.

Link to this function

create_subscriber(client, input, options \\ [])

View Source

Creates a subscriber.

You must create the associated budget and notification before you create the subscriber.

Link to this function

delete_budget(client, input, options \\ [])

View Source

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.

Link to this function

delete_budget_action(client, input, options \\ [])

View Source

Deletes a budget action.

Link to this function

delete_notification(client, input, options \\ [])

View Source

Deletes a notification.

Deleting a notification also deletes the subscribers that are associated with the notification.

Link to this function

delete_subscriber(client, input, options \\ [])

View Source

Deletes a subscriber.

Deleting the last subscriber to a notification also deletes the notification.

Link to this function

describe_budget(client, input, options \\ [])

View Source

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Link to this function

describe_budget_action(client, input, options \\ [])

View Source

Describes a budget action detail.

Link to this function

describe_budget_action_histories(client, input, options \\ [])

View Source

Describes a budget action history detail.

Link to this function

describe_budget_actions_for_account(client, input, options \\ [])

View Source

Describes all of the budget actions for an account.

Link to this function

describe_budget_actions_for_budget(client, input, options \\ [])

View Source

Describes all of the budget actions for a budget.

Link to this function

describe_budget_performance_history(client, input, options \\ [])

View Source

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.

Budget history isn't available for ANNUAL budgets.

Link to this function

describe_budgets(client, input, options \\ [])

View Source

Lists the budgets that are associated with an account.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Link to this function

describe_notifications_for_budget(client, input, options \\ [])

View Source

Lists the notifications that are associated with a budget.

Link to this function

describe_subscribers_for_notification(client, input, options \\ [])

View Source

Lists the subscribers that are associated with a notification.

Link to this function

execute_budget_action(client, input, options \\ [])

View Source

Executes a budget action.

Link to this function

update_budget(client, input, options \\ [])

View Source

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 AWS 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.

Link to this function

update_budget_action(client, input, options \\ [])

View Source

Updates a budget action.

Link to this function

update_notification(client, input, options \\ [])

View Source

Updates a notification.

Link to this function

update_subscriber(client, input, options \\ [])

View Source

Updates a subscriber.