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.

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

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 Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

• How much of your budget has been used

Amazon Web Services 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 Amazon Web Services Budgets API provides the following endpoint:

• https://budgets.amazonaws.com

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services 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.
CreateBudgetActionResult	createBudgetAction(CreateBudgetActionRequest request) Creates a budget action.
CreateNotificationResult	createNotification(CreateNotificationRequest request) Creates a notification.
CreateSubscriberResult	createSubscriber(CreateSubscriberRequest request) Creates a subscriber.
DeleteBudgetResult	deleteBudget(DeleteBudgetRequest request) Deletes a budget.
DeleteBudgetActionResult	deleteBudgetAction(DeleteBudgetActionRequest request) Deletes a budget action.
DeleteNotificationResult	deleteNotification(DeleteNotificationRequest request) Deletes a notification.
DeleteSubscriberResult	deleteSubscriber(DeleteSubscriberRequest request) Deletes a subscriber.
DescribeBudgetResult	describeBudget(DescribeBudgetRequest request) Describes a budget.
DescribeBudgetActionResult	describeBudgetAction(DescribeBudgetActionRequest request) Describes a budget action detail.
DescribeBudgetActionHistoriesResult	describeBudgetActionHistories(DescribeBudgetActionHistoriesRequest request) Describes a budget action history detail.
DescribeBudgetActionsForAccountResult	describeBudgetActionsForAccount(DescribeBudgetActionsForAccountRequest request) Describes all of the budget actions for an account.
DescribeBudgetActionsForBudgetResult	describeBudgetActionsForBudget(DescribeBudgetActionsForBudgetRequest request) Describes all of the budget actions for a budget.
DescribeBudgetNotificationsForAccountResult	describeBudgetNotificationsForAccount(DescribeBudgetNotificationsForAccountRequest request) Lists the budget names and notifications that are associated with an account.
DescribeBudgetPerformanceHistoryResult	describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest request) Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
DescribeBudgetsResult	describeBudgets(DescribeBudgetsRequest request) Lists the budgets that are associated with an account.
DescribeNotificationsForBudgetResult	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest request) Lists the notifications that are associated with a budget.
DescribeSubscribersForNotificationResult	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest request) Lists the subscribers that are associated with a notification.
ExecuteBudgetActionResult	executeBudgetAction(ExecuteBudgetActionRequest request) Executes a budget action.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists tags associated with a budget or budget action resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Creates tags for a budget or budget action resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes tags associated with a budget or budget action resource.
UpdateBudgetResult	updateBudget(UpdateBudgetRequest request) Updates a budget.
UpdateBudgetActionResult	updateBudgetAction(UpdateBudgetActionRequest request) Updates a budget action.
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, 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

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.

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.

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

ServiceQuotaExceededException - You've reached the limit on the number of tags you can associate with a resource.

createBudgetAction

public CreateBudgetActionResult createBudgetAction(CreateBudgetActionRequest request)

Creates a budget action.

Specified by:

createBudgetAction in interface AWSBudgets

Parameters:

createBudgetActionRequest -

Returns:

Result of the CreateBudgetAction 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.

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

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

ServiceQuotaExceededException - You've reached the limit on the number of tags you can associate with a resource.

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

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 that are 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

deleteBudgetAction

public DeleteBudgetActionResult deleteBudgetAction(DeleteBudgetActionRequest request)

Deletes a budget action.

Specified by:

deleteBudgetAction in interface AWSBudgets

Parameters:

deleteBudgetActionRequest -

Returns:

Result of the DeleteBudgetAction 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ResourceLockedException - The request was received and recognized by the server, but the server rejected that particular method for the requested resource.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

deleteNotification

public DeleteNotificationResult deleteNotification(DeleteNotificationRequest request)

Deletes a notification.

Deleting a notification also deletes the subscribers that are 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudget

public DescribeBudgetResult describeBudget(DescribeBudgetRequest request)

Describes a budget.

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

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetAction

public DescribeBudgetActionResult describeBudgetAction(DescribeBudgetActionRequest request)

Describes a budget action detail.

Specified by:

describeBudgetAction in interface AWSBudgets

Parameters:

describeBudgetActionRequest -

Returns:

Result of the DescribeBudgetAction 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetActionHistories

public DescribeBudgetActionHistoriesResult describeBudgetActionHistories(DescribeBudgetActionHistoriesRequest request)

Describes a budget action history detail.

Specified by:

describeBudgetActionHistories in interface AWSBudgets

Parameters:

describeBudgetActionHistoriesRequest -

Returns:

Result of the DescribeBudgetActionHistories 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

InvalidNextTokenException - The pagination token is invalid.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetActionsForAccount

public DescribeBudgetActionsForAccountResult describeBudgetActionsForAccount(DescribeBudgetActionsForAccountRequest request)

Describes all of the budget actions for an account.

Specified by:

describeBudgetActionsForAccount in interface AWSBudgets

Parameters:

describeBudgetActionsForAccountRequest -

Returns:

Result of the DescribeBudgetActionsForAccount 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

InvalidNextTokenException - The pagination token is invalid.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetActionsForBudget

public DescribeBudgetActionsForBudgetResult describeBudgetActionsForBudget(DescribeBudgetActionsForBudgetRequest request)

Describes all of the budget actions for a budget.

Specified by:

describeBudgetActionsForBudget in interface AWSBudgets

Parameters:

describeBudgetActionsForBudgetRequest -

Returns:

Result of the DescribeBudgetActionsForBudget 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

InvalidNextTokenException - The pagination token is invalid.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetNotificationsForAccount

public DescribeBudgetNotificationsForAccountResult describeBudgetNotificationsForAccount(DescribeBudgetNotificationsForAccountRequest request)

Lists the budget names and notifications that are associated with an account.

Specified by:

describeBudgetNotificationsForAccount in interface AWSBudgets

Parameters:

describeBudgetNotificationsForAccountRequest -

Returns:

Result of the DescribeBudgetNotificationsForAccount 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgetPerformanceHistory

public DescribeBudgetPerformanceHistoryResult describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest request)

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

Specified by:

describeBudgetPerformanceHistory in interface AWSBudgets

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeBudgets

public DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest request)

Lists the budgets that are associated with an account.

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

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeNotificationsForBudget

public DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest request)

Lists the notifications that are 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

describeSubscribersForNotification

public DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest request)

Lists the subscribers that are 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

executeBudgetAction

public ExecuteBudgetActionResult executeBudgetAction(ExecuteBudgetActionRequest request)

Executes a budget action.

Specified by:

executeBudgetAction in interface AWSBudgets

Parameters:

executeBudgetActionRequest -

Returns:

Result of the ExecuteBudgetAction 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ResourceLockedException - The request was received and recognized by the server, but the server rejected that particular method for the requested resource.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists tags associated with a budget or budget action resource.

Specified by:

listTagsForResource in interface AWSBudgets

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

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

AccessDeniedException - You are not authorized to use this operation with the given parameters.

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.

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Creates tags for a budget or budget action resource.

Specified by:

tagResource in interface AWSBudgets

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

ServiceQuotaExceededException - You've reached the limit on the number of tags you can associate with a resource.

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

AccessDeniedException - You are not authorized to use this operation with the given parameters.

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.

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes tags associated with a budget or budget action resource.

Specified by:

untagResource in interface AWSBudgets

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

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

AccessDeniedException - You are not authorized to use this operation with the given parameters.

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.

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 you modify a budget, the calculatedSpend drops to zero until Amazon Web Services 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.

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

updateBudgetAction

public UpdateBudgetActionResult updateBudgetAction(UpdateBudgetActionRequest request)

Updates a budget action.

Specified by:

updateBudgetAction in interface AWSBudgets

Parameters:

updateBudgetActionRequest -

Returns:

Result of the UpdateBudgetAction 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ResourceLockedException - The request was received and recognized by the server, but the server rejected that particular method for the requested resource.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the 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.

AccessDeniedException - You are not authorized to use this operation with the given parameters.

ThrottlingException - The number of API requests has exceeded the maximum allowed API request throttling limit for the 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.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBudgets

Overrides:

shutdown in class AmazonWebServiceClient