@aws-sdk/client-budgets

Description

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 .

Installation

NPM
npm install @aws-sdk/client-budgets
Yarn
yarn add @aws-sdk/client-budgets
pnpm
pnpm add @aws-sdk/client-budgets

Types

Type Name
Type
AccessDeniedExceptionClass
ActionInterface
ActionHistoryInterface
ActionHistoryDetailsInterface
ActionStatusTypeAlias
ActionStatusenumVariable
ActionSubTypeTypeAlias
ActionSubTypeenumVariable
ActionThresholdInterface
ActionTypeTypeAlias
ActionTypeenumVariable
ApprovalModelTypeAlias
ApprovalModelenumVariable
AutoAdjustDataInterface
AutoAdjustTypeTypeAlias
AutoAdjustTypeenumVariable
BudgetInterface
BudgetedAndActualAmountsInterface
BudgetNotificationsForAccountInterface
BudgetPerformanceHistoryInterface
BudgetsClass
BudgetsInterface
BudgetsClientClass
BudgetsClientConfigInterface
BudgetsClientConfigTypeTypeAlias
BudgetsClientResolvedConfigInterface
BudgetsClientResolvedConfigTypeTypeAlias
BudgetsPaginationConfigurationInterface
BudgetsServiceExceptionClass
BudgetTypeTypeAlias
BudgetTypeenumVariable
CalculatedSpendInterface
ClientDefaultsInterface
ClientInputEndpointParametersInterface
ComparisonOperatorTypeAlias
ComparisonOperatorenumVariable
CostTypesInterface
CreateBudgetActionCommandClass
CreateBudgetActionCommandInputInterface
CreateBudgetActionCommandOutputInterface
CreateBudgetActionRequestInterface
CreateBudgetActionResponseInterface
CreateBudgetCommandClass
CreateBudgetCommandInputInterface
CreateBudgetCommandOutputInterface
CreateBudgetRequestInterface
CreateBudgetResponseInterface
CreateNotificationCommandClass
CreateNotificationCommandInputInterface
CreateNotificationCommandOutputInterface
CreateNotificationRequestInterface
CreateNotificationResponseInterface
CreateSubscriberCommandClass
CreateSubscriberCommandInputInterface
CreateSubscriberCommandOutputInterface
CreateSubscriberRequestInterface
CreateSubscriberResponseInterface
CreationLimitExceededExceptionClass
DefinitionInterface
DeleteBudgetActionCommandClass
DeleteBudgetActionCommandInputInterface
DeleteBudgetActionCommandOutputInterface
DeleteBudgetActionRequestInterface
DeleteBudgetActionResponseInterface
DeleteBudgetCommandClass
DeleteBudgetCommandInputInterface
DeleteBudgetCommandOutputInterface
DeleteBudgetRequestInterface
DeleteBudgetResponseInterface
DeleteNotificationCommandClass
DeleteNotificationCommandInputInterface
DeleteNotificationCommandOutputInterface
DeleteNotificationRequestInterface
DeleteNotificationResponseInterface
DeleteSubscriberCommandClass
DeleteSubscriberCommandInputInterface
DeleteSubscriberCommandOutputInterface
DeleteSubscriberRequestInterface
DeleteSubscriberResponseInterface
DescribeBudgetActionCommandClass
DescribeBudgetActionCommandInputInterface
DescribeBudgetActionCommandOutputInterface
DescribeBudgetActionHistoriesCommandClass
DescribeBudgetActionHistoriesCommandInputInterface
DescribeBudgetActionHistoriesCommandOutputInterface
DescribeBudgetActionHistoriesRequestInterface
DescribeBudgetActionHistoriesResponseInterface
DescribeBudgetActionRequestInterface
DescribeBudgetActionResponseInterface
DescribeBudgetActionsForAccountCommandClass
DescribeBudgetActionsForAccountCommandInputInterface
DescribeBudgetActionsForAccountCommandOutputInterface
DescribeBudgetActionsForAccountRequestInterface
DescribeBudgetActionsForAccountResponseInterface
DescribeBudgetActionsForBudgetCommandClass
DescribeBudgetActionsForBudgetCommandInputInterface
DescribeBudgetActionsForBudgetCommandOutputInterface
DescribeBudgetActionsForBudgetRequestInterface
DescribeBudgetActionsForBudgetResponseInterface
DescribeBudgetCommandClass
DescribeBudgetCommandInputInterface
DescribeBudgetCommandOutputInterface
DescribeBudgetNotificationsForAccountCommandClass
DescribeBudgetNotificationsForAccountCommandInputInterface
DescribeBudgetNotificationsForAccountCommandOutputInterface
DescribeBudgetNotificationsForAccountRequestInterface
DescribeBudgetNotificationsForAccountResponseInterface
DescribeBudgetPerformanceHistoryCommandClass
DescribeBudgetPerformanceHistoryCommandInputInterface
DescribeBudgetPerformanceHistoryCommandOutputInterface
DescribeBudgetPerformanceHistoryRequestInterface
DescribeBudgetPerformanceHistoryResponseInterface
DescribeBudgetRequestInterface
DescribeBudgetResponseInterface
DescribeBudgetsCommandClass
DescribeBudgetsCommandInputInterface
DescribeBudgetsCommandOutputInterface
DescribeBudgetsRequestInterface
DescribeBudgetsResponseInterface
DescribeNotificationsForBudgetCommandClass
DescribeNotificationsForBudgetCommandInputInterface
DescribeNotificationsForBudgetCommandOutputInterface
DescribeNotificationsForBudgetRequestInterface
DescribeNotificationsForBudgetResponseInterface
DescribeSubscribersForNotificationCommandClass
DescribeSubscribersForNotificationCommandInputInterface
DescribeSubscribersForNotificationCommandOutputInterface
DescribeSubscribersForNotificationRequestInterface
DescribeSubscribersForNotificationResponseInterface
DuplicateRecordExceptionClass
EventTypeTypeAlias
EventTypeenumVariable
ExecuteBudgetActionCommandClass
ExecuteBudgetActionCommandInputInterface
ExecuteBudgetActionCommandOutputInterface
ExecuteBudgetActionRequestInterface
ExecuteBudgetActionResponseInterface
ExecutionTypeTypeAlias
ExecutionTypeenumVariable
ExpiredNextTokenExceptionClass
HistoricalOptionsInterface
IamActionDefinitionInterface
InternalErrorExceptionClass
InvalidNextTokenExceptionClass
InvalidParameterExceptionClass
ListTagsForResourceCommandClass
ListTagsForResourceCommandInputInterface
ListTagsForResourceCommandOutputInterface
ListTagsForResourceRequestInterface
ListTagsForResourceResponseInterface
NotFoundExceptionClass
NotificationInterface
NotificationStateTypeAlias
NotificationStateenumVariable
NotificationTypeTypeAlias
NotificationTypeenumVariable
NotificationWithSubscribersInterface
paginateDescribeBudgetActionHistoriesVariable
paginateDescribeBudgetActionsForAccountVariable
paginateDescribeBudgetActionsForBudgetVariable
paginateDescribeBudgetNotificationsForAccountVariable
paginateDescribeBudgetPerformanceHistoryVariable
paginateDescribeBudgetsVariable
paginateDescribeNotificationsForBudgetVariable
paginateDescribeSubscribersForNotificationVariable
ResourceLockedExceptionClass
ResourceTagInterface
RuntimeExtensionInterface
ScpActionDefinitionInterface
ServiceInputTypesTypeAlias
ServiceOutputTypesTypeAlias
ServiceQuotaExceededExceptionClass
SpendInterface
SsmActionDefinitionInterface
SubscriberInterface
SubscriptionTypeTypeAlias
SubscriptionTypeenumVariable
TagResourceCommandClass
TagResourceCommandInputInterface
TagResourceCommandOutputInterface
TagResourceRequestInterface
TagResourceResponseInterface
ThresholdTypeTypeAlias
ThresholdTypeenumVariable
ThrottlingExceptionClass
TimePeriodInterface
TimeUnitTypeAlias
TimeUnitenumVariable
UntagResourceCommandClass
UntagResourceCommandInputInterface
UntagResourceCommandOutputInterface
UntagResourceRequestInterface
UntagResourceResponseInterface
UpdateBudgetActionCommandClass
UpdateBudgetActionCommandInputInterface
UpdateBudgetActionCommandOutputInterface
UpdateBudgetActionRequestInterface
UpdateBudgetActionResponseInterface
UpdateBudgetCommandClass
UpdateBudgetCommandInputInterface
UpdateBudgetCommandOutputInterface
UpdateBudgetRequestInterface
UpdateBudgetResponseInterface
UpdateNotificationCommandClass
UpdateNotificationCommandInputInterface
UpdateNotificationCommandOutputInterface
UpdateNotificationRequestInterface
UpdateNotificationResponseInterface
UpdateSubscriberCommandClass
UpdateSubscriberCommandInputInterface
UpdateSubscriberCommandOutputInterface
UpdateSubscriberRequestInterface
UpdateSubscriberResponseInterface