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

All public APIs for AWS Budgets

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSBudgetsClient() Constructs a new client to invoke service methods on AWSBudgets.
AWSBudgetsClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials.
AWSBudgetsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials and client configuration options.
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials provider.
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSBudgets using the specified AWS account credentials provider and client configuration options.
AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
AWSBudgetsClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSBudgets.

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

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AWSBudgetsClient

public AWSBudgetsClient()

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

public AWSBudgetsClient(ClientConfiguration 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

public AWSBudgetsClient(AWSCredentials awsCredentials)

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

public AWSBudgetsClient(AWSCredentials awsCredentials,
                        ClientConfiguration 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

public AWSBudgetsClient(AWSCredentialsProvider 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

public AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration 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

public AWSBudgetsClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration,
                        RequestMetricCollector 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

createBudget

public CreateBudgetResult createBudget(CreateBudgetRequest createBudgetRequest)

Create a new budget

Specified by:

createBudget in interface AWSBudgets

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

public CreateNotificationResult createNotification(CreateNotificationRequest createNotificationRequest)

Create a new Notification with subscribers for a budget

Specified by:

createNotification in interface AWSBudgets

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

public CreateSubscriberResult createSubscriber(CreateSubscriberRequest createSubscriberRequest)

Create a new Subscriber for a notification

Specified by:

createSubscriber in interface AWSBudgets

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.

deleteBudget

public DeleteBudgetResult deleteBudget(DeleteBudgetRequest deleteBudgetRequest)

Delete a budget and related notifications

Specified by:

deleteBudget in interface AWSBudgets

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

public DeleteNotificationResult deleteNotification(DeleteNotificationRequest deleteNotificationRequest)

Delete a notification and related subscribers

Specified by:

deleteNotification in interface AWSBudgets

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

public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest)

Delete a Subscriber for a notification

Specified by:

deleteSubscriber in interface AWSBudgets

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

public DescribeBudgetResult describeBudget(DescribeBudgetRequest describeBudgetRequest)

Get a single budget

Specified by:

describeBudget in interface AWSBudgets

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

public DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest describeBudgetsRequest)

Get all budgets for 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 - 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

public DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest)

Get notifications of 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 - 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

public DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest)

Get subscribers of 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 - 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

public UpdateBudgetResult updateBudget(UpdateBudgetRequest updateBudgetRequest)

Update the information of a budget already created

Specified by:

updateBudget in interface AWSBudgets

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

public UpdateNotificationResult updateNotification(UpdateNotificationRequest updateNotificationRequest)

Update the information about a notification already created

Specified by:

updateNotification in interface AWSBudgets

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.

updateSubscriber

public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest)

Update 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 - 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.

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.