com.amazonaws.services.budgets

Interface AWSBudgets

All Known Subinterfaces:

AWSBudgetsAsync

All Known Implementing Classes:

AbstractAWSBudgets, AbstractAWSBudgetsAsync, AWSBudgetsAsyncClient, AWSBudgetsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBudgets

Interface for accessing AWSBudgets.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBudgets instead.

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	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateBudgetResult	createBudget(CreateBudgetRequest createBudgetRequest) Creates a budget and, if included, notifications and subscribers.
CreateNotificationResult	createNotification(CreateNotificationRequest createNotificationRequest) Creates a notification.
CreateSubscriberResult	createSubscriber(CreateSubscriberRequest createSubscriberRequest) Creates a subscriber.
DeleteBudgetResult	deleteBudget(DeleteBudgetRequest deleteBudgetRequest) Deletes a budget.
DeleteNotificationResult	deleteNotification(DeleteNotificationRequest deleteNotificationRequest) Deletes a notification.
DeleteSubscriberResult	deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) Deletes a subscriber.
DescribeBudgetResult	describeBudget(DescribeBudgetRequest describeBudgetRequest) Describes a budget.
DescribeBudgetPerformanceHistoryResult	describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
DescribeBudgetsResult	describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) Lists the budgets that are associated with an account.
DescribeNotificationsForBudgetResult	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.
DescribeSubscribersForNotificationResult	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) Lists the subscribers that are 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.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateBudgetResult	updateBudget(UpdateBudgetRequest updateBudgetRequest) Updates a budget.
UpdateNotificationResult	updateNotification(UpdateNotificationRequest updateNotificationRequest) Updates a notification.
UpdateSubscriberResult	updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) Updates a subscriber.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("budgets.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "budgets.amazonaws.com") or a full URL, including the protocol (ex: "budgets.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "budgets.amazonaws.com") or a full URL, including the protocol (ex: "budgets.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createBudget

CreateBudgetResult createBudget(CreateBudgetRequest createBudgetRequest)

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

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

CreateNotificationResult createNotification(CreateNotificationRequest createNotificationRequest)

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.

createSubscriber

CreateSubscriberResult createSubscriber(CreateSubscriberRequest createSubscriberRequest)

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.

deleteBudget

DeleteBudgetResult deleteBudget(DeleteBudgetRequest deleteBudgetRequest)

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

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

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

DeleteNotificationResult deleteNotification(DeleteNotificationRequest deleteNotificationRequest)

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.

deleteSubscriber

DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)

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.

describeBudget

DescribeBudgetResult describeBudget(DescribeBudgetRequest describeBudgetRequest)

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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.

describeBudgetPerformanceHistory

DescribeBudgetPerformanceHistoryResult describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest)

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.

describeBudgets

DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)

Lists the budgets that are associated with an account.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)

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.

describeSubscribersForNotification

DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)

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.

updateBudget

UpdateBudgetResult updateBudget(UpdateBudgetRequest updateBudgetRequest)

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

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

UpdateNotificationResult updateNotification(UpdateNotificationRequest updateNotificationRequest)

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.

updateSubscriber

UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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