Package software.amazon.awssdk.services.budgets

Interface BudgetsClient

All Superinterfaces:

AutoCloseable

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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(CreateBudgetRequest createBudgetRequest)	Create a new budget
default CreateNotificationResponse	createNotification(CreateNotificationRequest createNotificationRequest)	Create a new Notification with subscribers for a budget
default CreateSubscriberResponse	createSubscriber(CreateSubscriberRequest createSubscriberRequest)	Create a new Subscriber for a notification
default DeleteBudgetResponse	deleteBudget(DeleteBudgetRequest deleteBudgetRequest)	Delete a budget and related notifications
default DeleteNotificationResponse	deleteNotification(DeleteNotificationRequest deleteNotificationRequest)	Delete a notification and related subscribers
default DeleteSubscriberResponse	deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)	Delete a Subscriber for a notification
default DescribeBudgetResponse	describeBudget(DescribeBudgetRequest describeBudgetRequest)	Get a single budget
default DescribeBudgetsResponse	describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)	Get all budgets for an account
default DescribeNotificationsForBudgetResponse	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)	Get notifications of a budget
default DescribeSubscribersForNotificationResponse	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)	Get subscribers of a notification
static ServiceMetadata	serviceMetadata()
default UpdateBudgetResponse	updateBudget(UpdateBudgetRequest updateBudgetRequest)	Update the information of a budget already created
default UpdateNotificationResponse	updateNotification(UpdateNotificationRequest updateNotificationRequest)	Update the information about a notification already created
default UpdateSubscriberResponse	updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)	Update a subscriber

Methods inherited from interface java.lang.AutoCloseable

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,
                                          SdkBaseException,
                                          SdkClientException,
                                          BudgetsException

Create a new budget

Parameters:

createBudgetRequest - Request of CreateBudget

Returns:

Result of the CreateBudget operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createNotification

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

Create a new Notification with subscribers for a budget

Parameters:

createNotificationRequest - Request of CreateNotification

Returns:

Result of the CreateNotification operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createSubscriber

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

Create a new Subscriber for a notification

Parameters:

createSubscriberRequest - Request of CreateSubscriber

Returns:

Result of the CreateSubscriber operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteBudget

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

Delete a budget and related notifications

Parameters:

deleteBudgetRequest - Request of DeleteBudget

Returns:

Result of the DeleteBudget operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteNotification

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

Delete a notification and related subscribers

Parameters:

deleteNotificationRequest - Request of DeleteNotification

Returns:

Result of the DeleteNotification operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteSubscriber

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

Delete a Subscriber for a notification

Parameters:

deleteSubscriberRequest - Request of DeleteSubscriber

Returns:

Result of the DeleteSubscriber operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeBudget

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

Get a single budget

Parameters:

describeBudgetRequest - Request of DescribeBudget

Returns:

Result of the DescribeBudget operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeBudgets

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

Get all budgets for an account

Parameters:

describeBudgetsRequest - Request of DescribeBudgets

Returns:

Result of the DescribeBudgets operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeNotificationsForBudget

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

Get notifications of a budget

Parameters:

describeNotificationsForBudgetRequest - Request of DescribeNotificationsForBudget

Returns:

Result of the DescribeNotificationsForBudget operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

describeSubscribersForNotification

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

Get subscribers of a notification

Parameters:

describeSubscribersForNotificationRequest - Request of DescribeSubscribersForNotification

Returns:

Result of the DescribeSubscribersForNotification operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateBudget

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

Update the information of a budget already created

Parameters:

updateBudgetRequest - Request of UpdateBudget

Returns:

Result of the UpdateBudget operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateNotification

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

Update the information about a notification already created

Parameters:

updateNotificationRequest - Request of UpdateNotification

Returns:

Result of the UpdateNotification operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateSubscriber

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

Update a subscriber

Parameters:

updateSubscriberRequest - Request of UpdateSubscriber

Returns:

Result of the UpdateSubscriber operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

serviceMetadata

static ServiceMetadata serviceMetadata()