com.amazonaws.services.budgets

Class AWSBudgetsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.budgets.AWSBudgetsClient

All Implemented Interfaces:

AWSBudgets

Direct Known Subclasses:

AWSBudgetsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBudgetsClient
extends AmazonWebServiceClient
implements AWSBudgets

Client for accessing AWSBudgets. All service calls made using this client are blocking, and will not return until the service call completes.

Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of budgets:

• Cost budgets allow you to say how much you want to spend on a service.

• Usage budgets allow you to say how many hours you want to use for one or more services.

• RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that threshold.

You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see Creating an Amazon SNS Topic for Budget Notifications. AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget limits.

Service Endpoint

The AWS Budgets API provides the following endpoint:

• https://budgets.amazonaws.com

For information about costs associated with the AWS Budgets API, see AWS Cost Management Pricing.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.budgets.AWSBudgets

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSBudgetsClient() Deprecated. use AWSBudgetsClientBuilder.defaultClient()
AWSBudgetsClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSBudgetsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSBudgetsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSBudgetsClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSBudgetsClientBuilder	builder()
CreateBudgetResult	createBudget(CreateBudgetRequest request) Creates a budget and, if included, notifications and subscribers.
CreateNotificationResult	createNotification(CreateNotificationRequest request) Creates a notification.
CreateSubscriberResult	createSubscriber(CreateSubscriberRequest request) Creates a subscriber.
DeleteBudgetResult	deleteBudget(DeleteBudgetRequest request) Deletes a budget.
DeleteNotificationResult	deleteNotification(DeleteNotificationRequest request) Deletes a notification.
DeleteSubscriberResult	deleteSubscriber(DeleteSubscriberRequest request) Deletes a subscriber.
DescribeBudgetResult	describeBudget(DescribeBudgetRequest request) Describes a budget.
DescribeBudgetsResult	describeBudgets(DescribeBudgetsRequest request) Lists the budgets associated with an account.
DescribeNotificationsForBudgetResult	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest request) Lists the notifications associated with a budget.
DescribeSubscribersForNotificationResult	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest request) Lists the subscribers associated with a notification.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
UpdateBudgetResult	updateBudget(UpdateBudgetRequest request) Updates a budget.
UpdateNotificationResult	updateNotification(UpdateNotificationRequest request) Updates a notification.
UpdateSubscriberResult	updateSubscriber(UpdateSubscriberRequest request) Updates a subscriber.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.budgets.AWSBudgets

setEndpoint, setRegion, shutdown

Constructor Detail

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient()

Deprecated. use AWSBudgetsClientBuilder.defaultClient()

Constructs a new client to invoke service methods on AWSBudgets. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSBudgets. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSBudgets (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSBudgetsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSBudgets (ex: proxy settings, retry counts, etc.).

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSBudgets (ex: proxy settings, retry counts, etc.).

AWSBudgetsClient

@Deprecated
public AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSBudgets (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSBudgetsClientBuilder builder()

createBudget

public CreateBudgetResult createBudget(CreateBudgetRequest request)

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

Specified by:

createBudget in interface AWSBudgets

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.

createNotification

public CreateNotificationResult createNotification(CreateNotificationRequest request)

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

Specified by:

createNotification in interface AWSBudgets

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.

createSubscriber

public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)

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

Specified by:

createSubscriber in interface AWSBudgets

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.

deleteBudget

public DeleteBudgetResult deleteBudget(DeleteBudgetRequest request)

Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers associated with that budget.

Specified by:

deleteBudget in interface AWSBudgets

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.

deleteNotification

public DeleteNotificationResult deleteNotification(DeleteNotificationRequest request)

Deletes a notification.

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

Specified by:

deleteNotification in interface AWSBudgets

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.

deleteSubscriber

public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)

Deletes a subscriber.

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

Specified by:

deleteSubscriber in interface AWSBudgets

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.

describeBudget

public DescribeBudgetResult describeBudget(DescribeBudgetRequest request)

Describes a budget.

Specified by:

describeBudget in interface AWSBudgets

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.

describeBudgets

public DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest request)

Lists the budgets associated with an account.

Specified by:

describeBudgets in interface AWSBudgets

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.

describeNotificationsForBudget

public DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest request)

Lists the notifications associated with a budget.

Specified by:

describeNotificationsForBudget in interface AWSBudgets

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.

describeSubscribersForNotification

public DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest request)

Lists the subscribers associated with a notification.

Specified by:

describeSubscribersForNotification in interface AWSBudgets

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.

updateBudget

public UpdateBudgetResult updateBudget(UpdateBudgetRequest request)

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When a budget is modified, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.

Specified by:

updateBudget in interface AWSBudgets

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.

updateNotification

public UpdateNotificationResult updateNotification(UpdateNotificationRequest request)

Updates a notification.

Specified by:

updateNotification in interface AWSBudgets

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.

updateSubscriber

public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)

Updates a subscriber.

Specified by:

updateSubscriber in interface AWSBudgets

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.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSBudgets

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.