AbstractAWSBudgets (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.budgets.AbstractAWSBudgets

All Implemented Interfaces:

AWSBudgets

Direct Known Subclasses:

AbstractAWSBudgetsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSBudgets
extends Object
implements AWSBudgets
```
Abstract implementation of AWSBudgets. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.budgets.AWSBudgets
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBudgetResult`	`createBudget(CreateBudgetRequest request)` Creates a budget and, if included, notifications and subscribers.
`CreateNotificationResult`	`createNotification(CreateNotificationRequest request)` Creates a notification.
`CreateSubscriberResult`	`createSubscriber(CreateSubscriberRequest request)` Creates a subscriber.
`DeleteBudgetResult`	`deleteBudget(DeleteBudgetRequest request)` Deletes a budget.
`DeleteNotificationResult`	`deleteNotification(DeleteNotificationRequest request)` Deletes a notification.
`DeleteSubscriberResult`	`deleteSubscriber(DeleteSubscriberRequest request)` Deletes a subscriber.
`DescribeBudgetResult`	`describeBudget(DescribeBudgetRequest request)` Describes a budget.
`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.
`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)` Overrides the default endpoint for this client ("budgets.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSBudgets.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateBudgetResult`	`updateBudget(UpdateBudgetRequest request)` Updates a budget.
`UpdateNotificationResult`	`updateNotification(UpdateNotificationRequest request)` Updates a notification.
`UpdateSubscriberResult`	`updateSubscriber(UpdateSubscriberRequest request)` Updates a subscriber.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSBudgets
    
    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.
    
    Specified by:
    
    setEndpoint in interface AWSBudgets
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AWSBudgets
    
    An alternative to AWSBudgets.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.
    
    Specified by:
    
    setRegion in interface AWSBudgets
    
    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
```
public CreateBudgetResult createBudget(CreateBudgetRequest request)
```
    Description copied from interface: AWSBudgets
    
    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:
    
    request - Request of CreateBudget
    
    Returns:
    
    Result of the CreateBudget operation returned by the service.
  - createNotification
```
public CreateNotificationResult createNotification(CreateNotificationRequest request)
```
    Description copied from interface: AWSBudgets
    
    Creates a notification. You must create the budget before you create the associated notification.
    
    Specified by:
    
    createNotification in interface AWSBudgets
    
    Parameters:
    
    request - Request of CreateNotification
    
    Returns:
    
    Result of the CreateNotification operation returned by the service.
  - createSubscriber
```
public CreateSubscriberResult createSubscriber(CreateSubscriberRequest request)
```
    Description copied from interface: AWSBudgets
    
    Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
    
    Specified by:
    
    createSubscriber in interface AWSBudgets
    
    Parameters:
    
    request - Request of CreateSubscriber
    
    Returns:
    
    Result of the CreateSubscriber operation returned by the service.
  - deleteBudget
```
public DeleteBudgetResult deleteBudget(DeleteBudgetRequest request)
```
    Description copied from interface: AWSBudgets
    
    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:
    
    request - Request of DeleteBudget
    
    Returns:
    
    Result of the DeleteBudget operation returned by the service.
  - deleteNotification
```
public DeleteNotificationResult deleteNotification(DeleteNotificationRequest request)
```
    Description copied from interface: AWSBudgets
    
    Deletes a notification.
    
    Deleting a notification also deletes the subscribers that are associated with the notification.
    
    Specified by:
    
    deleteNotification in interface AWSBudgets
    
    Parameters:
    
    request - Request of DeleteNotification
    
    Returns:
    
    Result of the DeleteNotification operation returned by the service.
  - deleteSubscriber
```
public DeleteSubscriberResult deleteSubscriber(DeleteSubscriberRequest request)
```
    Description copied from interface: AWSBudgets
    
    Deletes a subscriber.
    
    Deleting the last subscriber to a notification also deletes the notification.
    
    Specified by:
    
    deleteSubscriber in interface AWSBudgets
    
    Parameters:
    
    request - Request of DeleteSubscriber
    
    Returns:
    
    Result of the DeleteSubscriber operation returned by the service.
  - describeBudget
```
public DescribeBudgetResult describeBudget(DescribeBudgetRequest request)
```
    Description copied from interface: AWSBudgets
    
    Describes a budget.
    
    The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
    
    Specified by:
    
    describeBudget in interface AWSBudgets
    
    Parameters:
    
    request - Request of DescribeBudget
    
    Returns:
    
    Result of the DescribeBudget operation returned by the service.
  - describeBudgetPerformanceHistory
```
public DescribeBudgetPerformanceHistoryResult describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest request)
```
    Description copied from interface: AWSBudgets
    
    Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.
    
    Specified by:
    
    describeBudgetPerformanceHistory in interface AWSBudgets
    
    Returns:
    
    Result of the DescribeBudgetPerformanceHistory operation returned by the service.
  - describeBudgets
```
public DescribeBudgetsResult describeBudgets(DescribeBudgetsRequest request)
```
    Description copied from interface: AWSBudgets
    
    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:
    
    request - Request of DescribeBudgets
    
    Returns:
    
    Result of the DescribeBudgets operation returned by the service.
  - describeNotificationsForBudget
```
public DescribeNotificationsForBudgetResult describeNotificationsForBudget(DescribeNotificationsForBudgetRequest request)
```
    Description copied from interface: AWSBudgets
    
    Lists the notifications that are associated with a budget.
    
    Specified by:
    
    describeNotificationsForBudget in interface AWSBudgets
    
    Parameters:
    
    request - Request of DescribeNotificationsForBudget
    
    Returns:
    
    Result of the DescribeNotificationsForBudget operation returned by the service.
  - describeSubscribersForNotification
```
public DescribeSubscribersForNotificationResult describeSubscribersForNotification(DescribeSubscribersForNotificationRequest request)
```
    Description copied from interface: AWSBudgets
    
    Lists the subscribers that are associated with a notification.
    
    Specified by:
    
    describeSubscribersForNotification in interface AWSBudgets
    
    Parameters:
    
    request - Request of DescribeSubscribersForNotification
    
    Returns:
    
    Result of the DescribeSubscribersForNotification operation returned by the service.
  - updateBudget
```
public UpdateBudgetResult updateBudget(UpdateBudgetRequest request)
```
    Description copied from interface: AWSBudgets
    
    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.
    
    Specified by:
    
    updateBudget in interface AWSBudgets
    
    Parameters:
    
    request - Request of UpdateBudget
    
    Returns:
    
    Result of the UpdateBudget operation returned by the service.
  - updateNotification
```
public UpdateNotificationResult updateNotification(UpdateNotificationRequest request)
```
    Description copied from interface: AWSBudgets
    
    Updates a notification.
    
    Specified by:
    
    updateNotification in interface AWSBudgets
    
    Parameters:
    
    request - Request of UpdateNotification
    
    Returns:
    
    Result of the UpdateNotification operation returned by the service.
  - updateSubscriber
```
public UpdateSubscriberResult updateSubscriber(UpdateSubscriberRequest request)
```
    Description copied from interface: AWSBudgets
    
    Updates a subscriber.
    
    Specified by:
    
    updateSubscriber in interface AWSBudgets
    
    Parameters:
    
    request - Request of UpdateSubscriber
    
    Returns:
    
    Result of the UpdateSubscriber operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSBudgets
    
    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.
    
    Specified by:
    
    shutdown in interface AWSBudgets
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSBudgets
    
    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.
    
    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.

Did this page help you?

Class AbstractAWSBudgets

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createBudget

createNotification

createSubscriber

deleteBudget

deleteNotification

deleteSubscriber

describeBudget

describeBudgetPerformanceHistory

describeBudgets

describeNotificationsForBudget

describeSubscribersForNotification

updateBudget

updateNotification

updateSubscriber

shutdown

getCachedResponseMetadata