Package software.amazon.awssdk.services.budgets

Interface BudgetsAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface BudgetsAsyncClient
extends AutoCloseable

Service client for accessing AWSBudgets asynchronously. This can be created using the static builder() method. All public APIs for AWS Budgets

Method Summary

Modifier and Type	Method	Description
static BudgetsAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a BudgetsAsyncClient.
static BudgetsAsyncClient	create()	Create a BudgetsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateBudgetResponse>	createBudget(CreateBudgetRequest createBudgetRequest)	Create a new budget
default CompletableFuture<CreateNotificationResponse>	createNotification(CreateNotificationRequest createNotificationRequest)	Create a new Notification with subscribers for a budget
default CompletableFuture<CreateSubscriberResponse>	createSubscriber(CreateSubscriberRequest createSubscriberRequest)	Create a new Subscriber for a notification
default CompletableFuture<DeleteBudgetResponse>	deleteBudget(DeleteBudgetRequest deleteBudgetRequest)	Delete a budget and related notifications
default CompletableFuture<DeleteNotificationResponse>	deleteNotification(DeleteNotificationRequest deleteNotificationRequest)	Delete a notification and related subscribers
default CompletableFuture<DeleteSubscriberResponse>	deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)	Delete a Subscriber for a notification
default CompletableFuture<DescribeBudgetResponse>	describeBudget(DescribeBudgetRequest describeBudgetRequest)	Get a single budget
default CompletableFuture<DescribeBudgetsResponse>	describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)	Get all budgets for an account
default CompletableFuture<DescribeNotificationsForBudgetResponse>	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)	Get notifications of a budget
default CompletableFuture<DescribeSubscribersForNotificationResponse>	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)	Get subscribers of a notification
default CompletableFuture<UpdateBudgetResponse>	updateBudget(UpdateBudgetRequest updateBudgetRequest)	Update the information of a budget already created
default CompletableFuture<UpdateNotificationResponse>	updateNotification(UpdateNotificationRequest updateNotificationRequest)	Update the information about a notification already created
default CompletableFuture<UpdateSubscriberResponse>	updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)	Update a subscriber

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static BudgetsAsyncClient create()

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

builder

static BudgetsAsyncClientBuilder builder()

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

createBudget

default CompletableFuture<CreateBudgetResponse> createBudget(CreateBudgetRequest createBudgetRequest)

Create a new budget

Parameters:

createBudgetRequest - Request of CreateBudget

Returns:

A Java Future containing the result of the CreateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• InternalErrorException This exception is thrown on an unknown internal failure.
• CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
• DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
• SdkBaseException 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

createNotification

default CompletableFuture<CreateNotificationResponse> createNotification(CreateNotificationRequest createNotificationRequest)

Create a new Notification with subscribers for a budget

Parameters:

createNotificationRequest - Request of CreateNotification

Returns:

A Java Future containing the result of the CreateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
• DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
• SdkBaseException 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

createSubscriber

default CompletableFuture<CreateSubscriberResponse> createSubscriber(CreateSubscriberRequest createSubscriberRequest)

Create a new Subscriber for a notification

Parameters:

createSubscriberRequest - Request of CreateSubscriber

Returns:

A Java Future containing the result of the CreateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
• DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

deleteBudget

default CompletableFuture<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest deleteBudgetRequest)

Delete a budget and related notifications

Parameters:

deleteBudgetRequest - Request of DeleteBudget

Returns:

A Java Future containing the result of the DeleteBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

deleteNotification

default CompletableFuture<DeleteNotificationResponse> deleteNotification(DeleteNotificationRequest deleteNotificationRequest)

Delete a notification and related subscribers

Parameters:

deleteNotificationRequest - Request of DeleteNotification

Returns:

A Java Future containing the result of the DeleteNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• InternalErrorException This exception is thrown on an unknown internal failure.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

deleteSubscriber

default CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)

Delete a Subscriber for a notification

Parameters:

deleteSubscriberRequest - Request of DeleteSubscriber

Returns:

A Java Future containing the result of the DeleteSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

describeBudget

default CompletableFuture<DescribeBudgetResponse> describeBudget(DescribeBudgetRequest describeBudgetRequest)

Get a single budget

Parameters:

describeBudgetRequest - Request of DescribeBudget

Returns:

A Java Future containing the result of the DescribeBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

describeBudgets

default CompletableFuture<DescribeBudgetsResponse> describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)

Get all budgets for an account

Parameters:

describeBudgetsRequest - Request of DescribeBudgets

Returns:

A Java Future containing the result of the DescribeBudgets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
• ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
• SdkBaseException 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

describeNotificationsForBudget

default CompletableFuture<DescribeNotificationsForBudgetResponse> describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)

Get notifications of a budget

Parameters:

describeNotificationsForBudgetRequest - Request of DescribeNotificationsForBudget

Returns:

A Java Future containing the result of the DescribeNotificationsForBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
• ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
• SdkBaseException 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

describeSubscribersForNotification

default CompletableFuture<DescribeSubscribersForNotificationResponse> describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)

Get subscribers of a notification

Parameters:

describeSubscribersForNotificationRequest - Request of DescribeSubscribersForNotification

Returns:

A Java Future containing the result of the DescribeSubscribersForNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
• ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
• SdkBaseException 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

updateBudget

default CompletableFuture<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest updateBudgetRequest)

Update the information of a budget already created

Parameters:

updateBudgetRequest - Request of UpdateBudget

Returns:

A Java Future containing the result of the UpdateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

updateNotification

default CompletableFuture<UpdateNotificationResponse> updateNotification(UpdateNotificationRequest updateNotificationRequest)

Update the information about a notification already created

Parameters:

updateNotificationRequest - Request of UpdateNotification

Returns:

A Java Future containing the result of the UpdateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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

updateSubscriber

default CompletableFuture<UpdateSubscriberResponse> updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)

Update a subscriber

Parameters:

updateSubscriberRequest - Request of UpdateSubscriber

Returns:

A Java Future containing the result of the UpdateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InternalErrorException This exception is thrown on an unknown internal failure.
• InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
• NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
• SdkBaseException 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