BudgetsClient

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.

Properties

Link copied to clipboard
abstract override val config: BudgetsClient.Config

BudgetsClient's configuration

Functions

Link copied to clipboard

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

Link copied to clipboard

Creates a budget action.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes a budget. You can delete your budget at any time.

Link copied to clipboard

Deletes a budget action.

Link copied to clipboard

Deletes a notification.

Link copied to clipboard

Deletes a subscriber.

Link copied to clipboard

Describes a budget.

Link copied to clipboard

Describes a budget action detail.

Link copied to clipboard

Describes a budget action history detail.

Link copied to clipboard

Describes all of the budget actions for an account.

Link copied to clipboard

Describes all of the budget actions for a budget.

Link copied to clipboard

Lists the budget names and notifications that are associated with an account.

Link copied to clipboard

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

Link copied to clipboard

Lists the budgets that are associated with an account.

Link copied to clipboard

Lists the notifications that are associated with a budget.

Link copied to clipboard

Lists the subscribers that are associated with a notification.

Link copied to clipboard

Executes a budget action.

Link copied to clipboard

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.

Link copied to clipboard

Updates a budget action.

Link copied to clipboard

Updates a notification.

Link copied to clipboard

Updates a subscriber.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard

Creates a budget action.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes a budget. You can delete your budget at any time.

Link copied to clipboard

Deletes a budget action.

Link copied to clipboard

Deletes a notification.

Link copied to clipboard

Deletes a subscriber.

Link copied to clipboard

Describes a budget.

Link copied to clipboard

Describes a budget action detail.

Link copied to clipboard

Describes a budget action history detail.

Link copied to clipboard

Describes all of the budget actions for an account.

Link copied to clipboard

Describes all of the budget actions for a budget.

Link copied to clipboard

Lists the budget names and notifications that are associated with an account.

Link copied to clipboard

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

Link copied to clipboard

Lists the budgets that are associated with an account.

Link copied to clipboard

Lists the notifications that are associated with a budget.

Link copied to clipboard

Lists the subscribers that are associated with a notification.

Link copied to clipboard

Executes a budget action.

Link copied to clipboard

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.

Link copied to clipboard

Updates a budget action.

Link copied to clipboard

Updates a notification.

Link copied to clipboard

Updates a subscriber.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.