@Generated(value="software.amazon.awssdk:codegen") public interface BudgetsAsyncClient extends SdkClient
builder()
method.
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:
https://budgets.amazonaws.com
For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static BudgetsAsyncClient create()
BudgetsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BudgetsAsyncClientBuilder builder()
BudgetsAsyncClient.default CompletableFuture<CreateBudgetResponse> createBudget(CreateBudgetRequest createBudgetRequest)
Creates a budget and, if included, notifications and subscribers.
createBudgetRequest - Request of CreateBudgetdefault CompletableFuture<CreateBudgetResponse> createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest)
Creates a budget and, if included, notifications and subscribers.
This is a convenience which creates an instance of the CreateBudgetRequest.Builder avoiding the need to
create one manually via CreateBudgetRequest.builder()
createBudgetRequest - A Consumer that will call methods on CreateBudgetRequest.Builder to create a request.
Request of CreateBudgetdefault CompletableFuture<CreateNotificationResponse> createNotification(CreateNotificationRequest createNotificationRequest)
Creates a notification. You must create the budget before you create the associated notification.
createNotificationRequest - Request of CreateNotificationdefault CompletableFuture<CreateNotificationResponse> createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest)
Creates a notification. You must create the budget before you create the associated notification.
This is a convenience which creates an instance of the CreateNotificationRequest.Builder avoiding the
need to create one manually via CreateNotificationRequest.builder()
createNotificationRequest - A Consumer that will call methods on CreateNotificationRequest.Builder to create a
request. Request of CreateNotificationdefault CompletableFuture<CreateSubscriberResponse> createSubscriber(CreateSubscriberRequest createSubscriberRequest)
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
createSubscriberRequest - Request of CreateSubscriberdefault CompletableFuture<CreateSubscriberResponse> createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest)
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
This is a convenience which creates an instance of the CreateSubscriberRequest.Builder avoiding the need
to create one manually via CreateSubscriberRequest.builder()
createSubscriberRequest - A Consumer that will call methods on CreateSubscriberRequest.Builder to create a request.
Request of CreateSubscriberdefault CompletableFuture<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest deleteBudgetRequest)
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.
deleteBudgetRequest - Request of DeleteBudgetdefault CompletableFuture<DeleteBudgetResponse> deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest)
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.
This is a convenience which creates an instance of the DeleteBudgetRequest.Builder avoiding the need to
create one manually via DeleteBudgetRequest.builder()
deleteBudgetRequest - A Consumer that will call methods on DeleteBudgetRequest.Builder to create a request.
Request of DeleteBudgetdefault CompletableFuture<DeleteNotificationResponse> deleteNotification(DeleteNotificationRequest deleteNotificationRequest)
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
deleteNotificationRequest - Request of DeleteNotificationdefault CompletableFuture<DeleteNotificationResponse> deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest)
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
This is a convenience which creates an instance of the DeleteNotificationRequest.Builder avoiding the
need to create one manually via DeleteNotificationRequest.builder()
deleteNotificationRequest - A Consumer that will call methods on DeleteNotificationRequest.Builder to create a
request. Request of DeleteNotificationdefault CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
deleteSubscriberRequest - Request of DeleteSubscriberdefault CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest)
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
This is a convenience which creates an instance of the DeleteSubscriberRequest.Builder avoiding the need
to create one manually via DeleteSubscriberRequest.builder()
deleteSubscriberRequest - A Consumer that will call methods on DeleteSubscriberRequest.Builder to create a request.
Request of DeleteSubscriberdefault CompletableFuture<DescribeBudgetResponse> describeBudget(DescribeBudgetRequest describeBudgetRequest)
Describes a budget.
describeBudgetRequest - Request of DescribeBudgetdefault CompletableFuture<DescribeBudgetResponse> describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest)
Describes a budget.
This is a convenience which creates an instance of the DescribeBudgetRequest.Builder avoiding the need to
create one manually via DescribeBudgetRequest.builder()
describeBudgetRequest - A Consumer that will call methods on DescribeBudgetRequest.Builder to create a request.
Request of DescribeBudgetdefault CompletableFuture<DescribeBudgetPerformanceHistoryResponse> describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest)
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget
history isn't available for ANNUAL budgets.
describeBudgetPerformanceHistoryRequest - default CompletableFuture<DescribeBudgetPerformanceHistoryResponse> describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest)
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget
history isn't available for ANNUAL budgets.
This is a convenience which creates an instance of the DescribeBudgetPerformanceHistoryRequest.Builder
avoiding the need to create one manually via DescribeBudgetPerformanceHistoryRequest.builder()
describeBudgetPerformanceHistoryRequest - A Consumer that will call methods on DescribeBudgetPerformanceHistoryRequest.Builder to
create a request.default CompletableFuture<DescribeBudgetsResponse> describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)
Lists the budgets that are associated with an account.
describeBudgetsRequest - Request of DescribeBudgetsdefault CompletableFuture<DescribeBudgetsResponse> describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest)
Lists the budgets that are associated with an account.
This is a convenience which creates an instance of the DescribeBudgetsRequest.Builder avoiding the need
to create one manually via DescribeBudgetsRequest.builder()
describeBudgetsRequest - A Consumer that will call methods on DescribeBudgetsRequest.Builder to create a request.
Request of DescribeBudgetsdefault CompletableFuture<DescribeNotificationsForBudgetResponse> describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)
Lists the notifications that are associated with a budget.
describeNotificationsForBudgetRequest - Request of DescribeNotificationsForBudgetdefault CompletableFuture<DescribeNotificationsForBudgetResponse> describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest)
Lists the notifications that are associated with a budget.
This is a convenience which creates an instance of the DescribeNotificationsForBudgetRequest.Builder
avoiding the need to create one manually via DescribeNotificationsForBudgetRequest.builder()
describeNotificationsForBudgetRequest - A Consumer that will call methods on DescribeNotificationsForBudgetRequest.Builder to
create a request. Request of DescribeNotificationsForBudgetdefault CompletableFuture<DescribeSubscribersForNotificationResponse> describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)
Lists the subscribers that are associated with a notification.
describeSubscribersForNotificationRequest - Request of DescribeSubscribersForNotificationdefault CompletableFuture<DescribeSubscribersForNotificationResponse> describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest)
Lists the subscribers that are associated with a notification.
This is a convenience which creates an instance of the DescribeSubscribersForNotificationRequest.Builder
avoiding the need to create one manually via DescribeSubscribersForNotificationRequest.builder()
describeSubscribersForNotificationRequest - A Consumer that will call methods on DescribeSubscribersForNotificationRequest.Builder to
create a request. Request of DescribeSubscribersForNotificationdefault CompletableFuture<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest updateBudgetRequest)
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.
updateBudgetRequest - Request of UpdateBudgetdefault CompletableFuture<UpdateBudgetResponse> updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest)
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.
This is a convenience which creates an instance of the UpdateBudgetRequest.Builder avoiding the need to
create one manually via UpdateBudgetRequest.builder()
updateBudgetRequest - A Consumer that will call methods on UpdateBudgetRequest.Builder to create a request.
Request of UpdateBudgetdefault CompletableFuture<UpdateNotificationResponse> updateNotification(UpdateNotificationRequest updateNotificationRequest)
Updates a notification.
updateNotificationRequest - Request of UpdateNotificationdefault CompletableFuture<UpdateNotificationResponse> updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest)
Updates a notification.
This is a convenience which creates an instance of the UpdateNotificationRequest.Builder avoiding the
need to create one manually via UpdateNotificationRequest.builder()
updateNotificationRequest - A Consumer that will call methods on UpdateNotificationRequest.Builder to create a
request. Request of UpdateNotificationdefault CompletableFuture<UpdateSubscriberResponse> updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
Updates a subscriber.
updateSubscriberRequest - Request of UpdateSubscriberdefault CompletableFuture<UpdateSubscriberResponse> updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest)
Updates a subscriber.
This is a convenience which creates an instance of the UpdateSubscriberRequest.Builder avoiding the need
to create one manually via UpdateSubscriberRequest.builder()
updateSubscriberRequest - A Consumer that will call methods on UpdateSubscriberRequest.Builder to create a request.
Request of UpdateSubscriberCopyright © 2017 Amazon Web Services, Inc. All Rights Reserved.