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.

All public APIs for AWS Budgets

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) Create a new budget
CreateNotificationResult	createNotification(CreateNotificationRequest createNotificationRequest) Create a new Notification with subscribers for a budget
CreateSubscriberResult	createSubscriber(CreateSubscriberRequest createSubscriberRequest) Create a new Subscriber for a notification
DeleteBudgetResult	deleteBudget(DeleteBudgetRequest deleteBudgetRequest) Delete a budget and related notifications
DeleteNotificationResult	deleteNotification(DeleteNotificationRequest deleteNotificationRequest) Delete a notification and related subscribers
DeleteSubscriberResult	deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) Delete a Subscriber for a notification
DescribeBudgetResult	describeBudget(DescribeBudgetRequest describeBudgetRequest) Get a single budget
DescribeBudgetsResult	describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) Get all budgets for an account
DescribeNotificationsForBudgetResult	describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) Get notifications of a budget
DescribeSubscribersForNotificationResult	describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) Get subscribers of 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) Update the information of a budget already created
UpdateNotificationResult	updateNotification(UpdateNotificationRequest updateNotificationRequest) Update the information about a notification already created
UpdateSubscriberResult	updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) Update 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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)

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.

createNotification

CreateNotificationResult createNotification(CreateNotificationRequest createNotificationRequest)

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.

createSubscriber

CreateSubscriberResult createSubscriber(CreateSubscriberRequest createSubscriberRequest)

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.

deleteBudget

DeleteBudgetResult deleteBudget(DeleteBudgetRequest deleteBudgetRequest)

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.

deleteNotification

DeleteNotificationResult deleteNotification(DeleteNotificationRequest deleteNotificationRequest)

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.

deleteSubscriber

DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)

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.

describeBudget

DescribeBudgetResult describeBudget(DescribeBudgetRequest describeBudgetRequest)

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.

describeBudgets

DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)

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

describeNotificationsForBudget

DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)

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

describeSubscribersForNotification

DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)

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

updateBudget

UpdateBudgetResult updateBudget(UpdateBudgetRequest updateBudgetRequest)

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.

updateNotification

UpdateNotificationResult updateNotification(UpdateNotificationRequest updateNotificationRequest)

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.

DuplicateRecordException - The exception is thrown when customer tries to create a record (e.g. budget) that already exists.

updateSubscriber

UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)

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.

DuplicateRecordException - The exception is thrown when customer tries to create a record (e.g. budget) that already exists.

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.