AWS SDK for C++AWS SDK for C++ Version 1.11.606 |
#include <BudgetsClient.h>
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:
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
Definition at line 46 of file BudgetsClient.h.
Definition at line 49 of file BudgetsClient.h.
Definition at line 53 of file BudgetsClient.h.
Definition at line 54 of file BudgetsClient.h.
Aws::Budgets::BudgetsClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Budgets::BudgetsClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Budgets::BudgetsClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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 use case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
Similarly, only one set of filter and metric selections can be present in the syntax at one time. Either FilterExpression
and Metrics
or CostFilters
and CostTypes
, not both or a different combination. We recommend using FilterExpression
and Metrics
as they provide more flexible and powerful filtering capabilities. The Request Syntax section shows the FilterExpression
/Metrics
syntax.
nullptr
An Async wrapper for CreateBudgetAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 163 of file BudgetsClient.h.
A Callable wrapper for CreateBudgetAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 154 of file BudgetsClient.h.
nullptr
An Async wrapper for CreateBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 138 of file BudgetsClient.h.
A Callable wrapper for CreateBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 129 of file BudgetsClient.h.
Creates a notification. You must create the budget before you create the associated notification.
nullptr
An Async wrapper for CreateNotification that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 189 of file BudgetsClient.h.
A Callable wrapper for CreateNotification that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 180 of file BudgetsClient.h.
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
nullptr
An Async wrapper for CreateSubscriber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 215 of file BudgetsClient.h.
A Callable wrapper for CreateSubscriber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 206 of file BudgetsClient.h.
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.
nullptr
An Async wrapper for DeleteBudgetAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 267 of file BudgetsClient.h.
A Callable wrapper for DeleteBudgetAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 258 of file BudgetsClient.h.
nullptr
An Async wrapper for DeleteBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 242 of file BudgetsClient.h.
A Callable wrapper for DeleteBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 233 of file BudgetsClient.h.
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
nullptr
An Async wrapper for DeleteNotification that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 294 of file BudgetsClient.h.
A Callable wrapper for DeleteNotification that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 285 of file BudgetsClient.h.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
nullptr
An Async wrapper for DeleteSubscriber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 321 of file BudgetsClient.h.
A Callable wrapper for DeleteSubscriber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 312 of file BudgetsClient.h.
Describes a budget.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
nullptr
An Async wrapper for DescribeBudgetAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 375 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 366 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeBudgetActionHistories that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 400 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetActionHistories that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 391 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeBudgetActionsForAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 426 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetActionsForAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 417 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeBudgetActionsForBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 452 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetActionsForBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 443 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 350 of file BudgetsClient.h.
A Callable wrapper for DescribeBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 341 of file BudgetsClient.h.
Lists the budget names and notifications that are associated with an account.
nullptr
An Async wrapper for DescribeBudgetNotificationsForAccount that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 478 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetNotificationsForAccount that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 469 of file BudgetsClient.h.
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget history isn't available for ANNUAL
budgets.
nullptr
An Async wrapper for DescribeBudgetPerformanceHistory that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 505 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgetPerformanceHistory that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 496 of file BudgetsClient.h.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
nullptr
An Async wrapper for DescribeBudgets that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 534 of file BudgetsClient.h.
A Callable wrapper for DescribeBudgets that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 525 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeNotificationsForBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 560 of file BudgetsClient.h.
A Callable wrapper for DescribeNotificationsForBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 551 of file BudgetsClient.h.
nullptr
An Async wrapper for DescribeSubscribersForNotification that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 586 of file BudgetsClient.h.
A Callable wrapper for DescribeSubscribersForNotification that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 577 of file BudgetsClient.h.
nullptr
An Async wrapper for ExecuteBudgetAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 611 of file BudgetsClient.h.
A Callable wrapper for ExecuteBudgetAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 602 of file BudgetsClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 637 of file BudgetsClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 628 of file BudgetsClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 663 of file BudgetsClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 654 of file BudgetsClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 689 of file BudgetsClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 680 of file BudgetsClient.h.
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.
Similarly, only one set of filter and metric selections can be present in the syntax at one time. Either FilterExpression
and Metrics
or CostFilters
and CostTypes
, not both or a different combination. We recommend using FilterExpression
and Metrics
as they provide more flexible and powerful filtering capabilities. The Request Syntax section shows the FilterExpression
/Metrics
syntax.
nullptr
An Async wrapper for UpdateBudgetAction that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 755 of file BudgetsClient.h.
A Callable wrapper for UpdateBudgetAction that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 746 of file BudgetsClient.h.
nullptr
An Async wrapper for UpdateBudget that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 730 of file BudgetsClient.h.
A Callable wrapper for UpdateBudget that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 721 of file BudgetsClient.h.
nullptr
An Async wrapper for UpdateNotification that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 780 of file BudgetsClient.h.
A Callable wrapper for UpdateNotification that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 771 of file BudgetsClient.h.
nullptr
An Async wrapper for UpdateSubscriber that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 805 of file BudgetsClient.h.
A Callable wrapper for UpdateSubscriber that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 796 of file BudgetsClient.h.
Definition at line 812 of file BudgetsClient.h.