software.amazon.awssdk.services.budgets

Interface BudgetsClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface BudgetsClient
extends SdkClient

Service client for accessing AWSBudgets. This can be created using the static 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static BudgetsClientBuilder	builder() Create a builder that can be used to configure and create a BudgetsClient.
static BudgetsClient	create() Create a BudgetsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBudgetResponse	createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest) Creates a budget and, if included, notifications and subscribers.
default CreateBudgetResponse	createBudget(CreateBudgetRequest createBudgetRequest) Creates a budget and, if included, notifications and subscribers.
default CreateNotificationResponse	createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest) Creates a notification.
default CreateNotificationResponse	createNotification(CreateNotificationRequest createNotificationRequest) Creates a notification.
default CreateSubscriberResponse	createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest) Creates a subscriber.
default CreateSubscriberResponse	createSubscriber(CreateSubscriberRequest createSubscriberRequest) Creates a subscriber.
default DeleteBudgetResponse	deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest) Deletes a budget.
default DeleteBudgetResponse	deleteBudget(DeleteBudgetRequest deleteBudgetRequest) Deletes a budget.
default DeleteNotificationResponse	deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest) Deletes a notification.
default DeleteNotificationResponse	deleteNotification(DeleteNotificationRequest deleteNotificationRequest) Deletes a notification.
default DeleteSubscriberResponse	deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest) Deletes a subscriber.
default DeleteSubscriberResponse	deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) Deletes a subscriber.
default DescribeBudgetResponse	describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest) Describes a budget.
default DescribeBudgetResponse	describeBudget(DescribeBudgetRequest describeBudgetRequest) Describes a budget.
default DescribeBudgetPerformanceHistoryResponse	describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
default DescribeBudgetPerformanceHistoryResponse	describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
default DescribeBudgetsResponse	describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) Lists the budgets that are associated with an account.
default DescribeBudgetsResponse	describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) Lists the budgets that are associated with an account.
default DescribeNotificationsForBudgetResponse	describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.
default DescribeNotificationsForBudgetResponse	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.
default DescribeSubscribersForNotificationResponse	describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.
default DescribeSubscribersForNotificationResponse	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.
static ServiceMetadata	serviceMetadata()
default UpdateBudgetResponse	updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest) Updates a budget.
default UpdateBudgetResponse	updateBudget(UpdateBudgetRequest updateBudgetRequest) Updates a budget.
default UpdateNotificationResponse	updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest) Updates a notification.
default UpdateNotificationResponse	updateNotification(UpdateNotificationRequest updateNotificationRequest) Updates a notification.
default UpdateSubscriberResponse	updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest) Updates a subscriber.
default UpdateSubscriberResponse	updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) Updates a subscriber.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static BudgetsClient create()

Create a BudgetsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BudgetsClientBuilder builder()

Create a builder that can be used to configure and create a BudgetsClient.

createBudget

default CreateBudgetResponse createBudget(CreateBudgetRequest createBudgetRequest)
                                   throws InvalidParameterException,
                                          InternalErrorException,
                                          CreationLimitExceededException,
                                          DuplicateRecordException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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

Parameters:

createBudgetRequest - Request of CreateBudget

Returns:

Result of the CreateBudget operation returned by the service.

Throws:

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createBudget

default CreateBudgetResponse createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest)
                                   throws InvalidParameterException,
                                          InternalErrorException,
                                          CreationLimitExceededException,
                                          DuplicateRecordException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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()

Parameters:

createBudgetRequest - A Consumer that will call methods on CreateBudgetRequest.Builder to create a request. Request of CreateBudget

Returns:

Result of the CreateBudget operation returned by the service.

Throws:

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createNotification

default CreateNotificationResponse createNotification(CreateNotificationRequest createNotificationRequest)
                                               throws InternalErrorException,
                                                      InvalidParameterException,
                                                      NotFoundException,
                                                      CreationLimitExceededException,
                                                      DuplicateRecordException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

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

Parameters:

createNotificationRequest - Request of CreateNotification

Returns:

Result of the CreateNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createNotification

default CreateNotificationResponse createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest)
                                               throws InternalErrorException,
                                                      InvalidParameterException,
                                                      NotFoundException,
                                                      CreationLimitExceededException,
                                                      DuplicateRecordException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

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()

Parameters:

createNotificationRequest - A Consumer that will call methods on CreateNotificationRequest.Builder to create a request. Request of CreateNotification

Returns:

Result of the CreateNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createSubscriber

default CreateSubscriberResponse createSubscriber(CreateSubscriberRequest createSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  CreationLimitExceededException,
                                                  DuplicateRecordException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

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

Parameters:

createSubscriberRequest - Request of CreateSubscriber

Returns:

Result of the CreateSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

createSubscriber

default CreateSubscriberResponse createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  CreationLimitExceededException,
                                                  DuplicateRecordException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

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()

Parameters:

createSubscriberRequest - A Consumer that will call methods on CreateSubscriberRequest.Builder to create a request. Request of CreateSubscriber

Returns:

Result of the CreateSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

CreationLimitExceededException - You've exceeded the notification or subscriber limit.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteBudget

default DeleteBudgetResponse deleteBudget(DeleteBudgetRequest deleteBudgetRequest)
                                   throws InternalErrorException,
                                          InvalidParameterException,
                                          NotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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.

Parameters:

deleteBudgetRequest - Request of DeleteBudget

Returns:

Result of the DeleteBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteBudget

default DeleteBudgetResponse deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest)
                                   throws InternalErrorException,
                                          InvalidParameterException,
                                          NotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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()

Parameters:

deleteBudgetRequest - A Consumer that will call methods on DeleteBudgetRequest.Builder to create a request. Request of DeleteBudget

Returns:

Result of the DeleteBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteNotification

default DeleteNotificationResponse deleteNotification(DeleteNotificationRequest deleteNotificationRequest)
                                               throws InvalidParameterException,
                                                      InternalErrorException,
                                                      NotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

Deletes a notification.

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

Parameters:

deleteNotificationRequest - Request of DeleteNotification

Returns:

Result of the DeleteNotification operation returned by the service.

Throws:

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteNotification

default DeleteNotificationResponse deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest)
                                               throws InvalidParameterException,
                                                      InternalErrorException,
                                                      NotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

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()

Parameters:

deleteNotificationRequest - A Consumer that will call methods on DeleteNotificationRequest.Builder to create a request. Request of DeleteNotification

Returns:

Result of the DeleteNotification operation returned by the service.

Throws:

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteSubscriber

default DeleteSubscriberResponse deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

Deletes a subscriber.

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

Parameters:

deleteSubscriberRequest - Request of DeleteSubscriber

Returns:

Result of the DeleteSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

deleteSubscriber

default DeleteSubscriberResponse deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  NotFoundException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

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()

Parameters:

deleteSubscriberRequest - A Consumer that will call methods on DeleteSubscriberRequest.Builder to create a request. Request of DeleteSubscriber

Returns:

Result of the DeleteSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudget

default DescribeBudgetResponse describeBudget(DescribeBudgetRequest describeBudgetRequest)
                                       throws InternalErrorException,
                                              InvalidParameterException,
                                              NotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              BudgetsException

Describes a budget.

Parameters:

describeBudgetRequest - Request of DescribeBudget

Returns:

Result of the DescribeBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudget

default DescribeBudgetResponse describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest)
                                       throws InternalErrorException,
                                              InvalidParameterException,
                                              NotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              BudgetsException

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()

Parameters:

describeBudgetRequest - A Consumer that will call methods on DescribeBudgetRequest.Builder to create a request. Request of DescribeBudget

Returns:

Result of the DescribeBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudgetPerformanceHistory

default DescribeBudgetPerformanceHistoryResponse describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest)
                                                                           throws InternalErrorException,
                                                                                  InvalidParameterException,
                                                                                  NotFoundException,
                                                                                  InvalidNextTokenException,
                                                                                  ExpiredNextTokenException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  BudgetsException

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

Parameters:

describeBudgetPerformanceHistoryRequest -

Returns:

Result of the DescribeBudgetPerformanceHistory operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudgetPerformanceHistory

default DescribeBudgetPerformanceHistoryResponse describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest)
                                                                           throws InternalErrorException,
                                                                                  InvalidParameterException,
                                                                                  NotFoundException,
                                                                                  InvalidNextTokenException,
                                                                                  ExpiredNextTokenException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  BudgetsException

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()

Parameters:

describeBudgetPerformanceHistoryRequest - A Consumer that will call methods on DescribeBudgetPerformanceHistoryRequest.Builder to create a request.

Returns:

Result of the DescribeBudgetPerformanceHistory operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudgets

default DescribeBudgetsResponse describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)
                                         throws InternalErrorException,
                                                InvalidParameterException,
                                                NotFoundException,
                                                InvalidNextTokenException,
                                                ExpiredNextTokenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                BudgetsException

Lists the budgets that are associated with an account.

Parameters:

describeBudgetsRequest - Request of DescribeBudgets

Returns:

Result of the DescribeBudgets operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeBudgets

default DescribeBudgetsResponse describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest)
                                         throws InternalErrorException,
                                                InvalidParameterException,
                                                NotFoundException,
                                                InvalidNextTokenException,
                                                ExpiredNextTokenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                BudgetsException

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()

Parameters:

describeBudgetsRequest - A Consumer that will call methods on DescribeBudgetsRequest.Builder to create a request. Request of DescribeBudgets

Returns:

Result of the DescribeBudgets operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeNotificationsForBudget

default DescribeNotificationsForBudgetResponse describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)
                                                                       throws InternalErrorException,
                                                                              InvalidParameterException,
                                                                              NotFoundException,
                                                                              InvalidNextTokenException,
                                                                              ExpiredNextTokenException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              BudgetsException

Lists the notifications that are associated with a budget.

Parameters:

describeNotificationsForBudgetRequest - Request of DescribeNotificationsForBudget

Returns:

Result of the DescribeNotificationsForBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeNotificationsForBudget

default DescribeNotificationsForBudgetResponse describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest)
                                                                       throws InternalErrorException,
                                                                              InvalidParameterException,
                                                                              NotFoundException,
                                                                              InvalidNextTokenException,
                                                                              ExpiredNextTokenException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              BudgetsException

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()

Parameters:

describeNotificationsForBudgetRequest - A Consumer that will call methods on DescribeNotificationsForBudgetRequest.Builder to create a request. Request of DescribeNotificationsForBudget

Returns:

Result of the DescribeNotificationsForBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeSubscribersForNotification

default DescribeSubscribersForNotificationResponse describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)
                                                                               throws InternalErrorException,
                                                                                      NotFoundException,
                                                                                      InvalidParameterException,
                                                                                      InvalidNextTokenException,
                                                                                      ExpiredNextTokenException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      BudgetsException

Lists the subscribers that are associated with a notification.

Parameters:

describeSubscribersForNotificationRequest - Request of DescribeSubscribersForNotification

Returns:

Result of the DescribeSubscribersForNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

NotFoundException - We can’t locate the resource that you specified.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

describeSubscribersForNotification

default DescribeSubscribersForNotificationResponse describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest)
                                                                               throws InternalErrorException,
                                                                                      NotFoundException,
                                                                                      InvalidParameterException,
                                                                                      InvalidNextTokenException,
                                                                                      ExpiredNextTokenException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      BudgetsException

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()

Parameters:

describeSubscribersForNotificationRequest - A Consumer that will call methods on DescribeSubscribersForNotificationRequest.Builder to create a request. Request of DescribeSubscribersForNotification

Returns:

Result of the DescribeSubscribersForNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

NotFoundException - We can’t locate the resource that you specified.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

InvalidNextTokenException - The pagination token is invalid.

ExpiredNextTokenException - The pagination token expired.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateBudget

default UpdateBudgetResponse updateBudget(UpdateBudgetRequest updateBudgetRequest)
                                   throws InternalErrorException,
                                          InvalidParameterException,
                                          NotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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.

Parameters:

updateBudgetRequest - Request of UpdateBudget

Returns:

Result of the UpdateBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateBudget

default UpdateBudgetResponse updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest)
                                   throws InternalErrorException,
                                          InvalidParameterException,
                                          NotFoundException,
                                          AwsServiceException,
                                          SdkClientException,
                                          BudgetsException

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()

Parameters:

updateBudgetRequest - A Consumer that will call methods on UpdateBudgetRequest.Builder to create a request. Request of UpdateBudget

Returns:

Result of the UpdateBudget operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateNotification

default UpdateNotificationResponse updateNotification(UpdateNotificationRequest updateNotificationRequest)
                                               throws InternalErrorException,
                                                      InvalidParameterException,
                                                      NotFoundException,
                                                      DuplicateRecordException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

Updates a notification.

Parameters:

updateNotificationRequest - Request of UpdateNotification

Returns:

Result of the UpdateNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateNotification

default UpdateNotificationResponse updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest)
                                               throws InternalErrorException,
                                                      InvalidParameterException,
                                                      NotFoundException,
                                                      DuplicateRecordException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      BudgetsException

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()

Parameters:

updateNotificationRequest - A Consumer that will call methods on UpdateNotificationRequest.Builder to create a request. Request of UpdateNotification

Returns:

Result of the UpdateNotification operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateSubscriber

default UpdateSubscriberResponse updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  NotFoundException,
                                                  DuplicateRecordException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

Updates a subscriber.

Parameters:

updateSubscriberRequest - Request of UpdateSubscriber

Returns:

Result of the UpdateSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

updateSubscriber

default UpdateSubscriberResponse updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest)
                                           throws InternalErrorException,
                                                  InvalidParameterException,
                                                  NotFoundException,
                                                  DuplicateRecordException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  BudgetsException

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()

Parameters:

updateSubscriberRequest - A Consumer that will call methods on UpdateSubscriberRequest.Builder to create a request. Request of UpdateSubscriber

Returns:

Result of the UpdateSubscriber operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException - An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException - We can’t locate the resource that you specified.

DuplicateRecordException - The budget name already exists. Budget names must be unique within an account.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BudgetsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

serviceMetadata

static ServiceMetadata serviceMetadata()