Interface BudgetsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic BudgetsAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aBudgetsAsyncClient.static BudgetsAsyncClientcreate()Create aBudgetsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateBudgetResponse> createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest) Creates a budget and, if included, notifications and subscribers.default CompletableFuture<CreateBudgetResponse> createBudget(CreateBudgetRequest createBudgetRequest) Creates a budget and, if included, notifications and subscribers.createBudgetAction(Consumer<CreateBudgetActionRequest.Builder> createBudgetActionRequest) Creates a budget action.createBudgetAction(CreateBudgetActionRequest createBudgetActionRequest) Creates a budget action.createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest) Creates a notification.createNotification(CreateNotificationRequest createNotificationRequest) Creates a notification.createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest) Creates a subscriber.createSubscriber(CreateSubscriberRequest createSubscriberRequest) Creates a subscriber.default CompletableFuture<DeleteBudgetResponse> deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest) Deletes a budget.default CompletableFuture<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest deleteBudgetRequest) Deletes a budget.deleteBudgetAction(Consumer<DeleteBudgetActionRequest.Builder> deleteBudgetActionRequest) Deletes a budget action.deleteBudgetAction(DeleteBudgetActionRequest deleteBudgetActionRequest) Deletes a budget action.deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest) Deletes a notification.deleteNotification(DeleteNotificationRequest deleteNotificationRequest) Deletes a notification.deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest) Deletes a subscriber.deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) Deletes a subscriber.default CompletableFuture<DescribeBudgetResponse> describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest) Describes a budget.default CompletableFuture<DescribeBudgetResponse> describeBudget(DescribeBudgetRequest describeBudgetRequest) Describes a budget.describeBudgetAction(Consumer<DescribeBudgetActionRequest.Builder> describeBudgetActionRequest) Describes a budget action detail.describeBudgetAction(DescribeBudgetActionRequest describeBudgetActionRequest) Describes a budget action detail.describeBudgetActionHistories(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) Describes a budget action history detail.describeBudgetActionHistories(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) Describes a budget action history detail.describeBudgetActionHistoriesPaginator(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) This is a variant ofdescribeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation.describeBudgetActionHistoriesPaginator(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) This is a variant ofdescribeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation.describeBudgetActionsForAccount(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) Describes all of the budget actions for an account.describeBudgetActionsForAccount(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) Describes all of the budget actions for an account.describeBudgetActionsForAccountPaginator(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) This is a variant ofdescribeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation.describeBudgetActionsForAccountPaginator(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) This is a variant ofdescribeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation.describeBudgetActionsForBudget(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) Describes all of the budget actions for a budget.describeBudgetActionsForBudget(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) Describes all of the budget actions for a budget.describeBudgetActionsForBudgetPaginator(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) This is a variant ofdescribeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation.describeBudgetActionsForBudgetPaginator(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) This is a variant ofdescribeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation.describeBudgetNotificationsForAccount(Consumer<DescribeBudgetNotificationsForAccountRequest.Builder> describeBudgetNotificationsForAccountRequest) Lists the budget names and notifications that are associated with an account.describeBudgetNotificationsForAccount(DescribeBudgetNotificationsForAccountRequest describeBudgetNotificationsForAccountRequest) Lists the budget names and notifications that are associated with an account.describeBudgetNotificationsForAccountPaginator(Consumer<DescribeBudgetNotificationsForAccountRequest.Builder> describeBudgetNotificationsForAccountRequest) describeBudgetNotificationsForAccountPaginator(DescribeBudgetNotificationsForAccountRequest describeBudgetNotificationsForAccountRequest) describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) Describes the history forDAILY,MONTHLY, andQUARTERLYbudgets.describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) Describes the history forDAILY,MONTHLY, andQUARTERLYbudgets.describeBudgetPerformanceHistoryPaginator(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) This is a variant ofdescribeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation.describeBudgetPerformanceHistoryPaginator(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) This is a variant ofdescribeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation.default CompletableFuture<DescribeBudgetsResponse> describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) Lists the budgets that are associated with an account.default CompletableFuture<DescribeBudgetsResponse> describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) Lists the budgets that are associated with an account.default DescribeBudgetsPublisherdescribeBudgetsPaginator(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) This is a variant ofdescribeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation.default DescribeBudgetsPublisherdescribeBudgetsPaginator(DescribeBudgetsRequest describeBudgetsRequest) This is a variant ofdescribeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation.describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.describeNotificationsForBudgetPaginator(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) This is a variant ofdescribeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation.describeNotificationsForBudgetPaginator(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) This is a variant ofdescribeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation.describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.describeSubscribersForNotificationPaginator(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) This is a variant ofdescribeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation.describeSubscribersForNotificationPaginator(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) This is a variant ofdescribeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation.executeBudgetAction(Consumer<ExecuteBudgetActionRequest.Builder> executeBudgetActionRequest) Executes a budget action.executeBudgetAction(ExecuteBudgetActionRequest executeBudgetActionRequest) Executes a budget action.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a budget or budget action resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a budget or budget action resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tags for a budget or budget action resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Creates tags for a budget or budget action resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes tags associated with a budget or budget action resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes tags associated with a budget or budget action resource.default CompletableFuture<UpdateBudgetResponse> updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest) Updates a budget.default CompletableFuture<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest updateBudgetRequest) Updates a budget.updateBudgetAction(Consumer<UpdateBudgetActionRequest.Builder> updateBudgetActionRequest) Updates a budget action.updateBudgetAction(UpdateBudgetActionRequest updateBudgetActionRequest) Updates a budget action.updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest) Updates a notification.updateNotification(UpdateNotificationRequest updateNotificationRequest) Updates a notification.updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest) Updates a subscriber.updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) Updates a subscriber.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createBudget
default CompletableFuture<CreateBudgetResponse> createBudget(CreateBudgetRequest createBudgetRequest) Creates a budget and, if included, notifications and subscribers.
Only one of
BudgetLimitorPlannedBudgetLimitscan be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows theBudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.- Parameters:
createBudgetRequest- Request of CreateBudget- Returns:
- A Java Future containing the result of the CreateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createBudget
default CompletableFuture<CreateBudgetResponse> createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest) Creates a budget and, if included, notifications and subscribers.
Only one of
BudgetLimitorPlannedBudgetLimitscan be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows theBudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.
This is a convenience which creates an instance of the
CreateBudgetRequest.Builderavoiding the need to create one manually viaCreateBudgetRequest.builder()- Parameters:
createBudgetRequest- AConsumerthat will call methods onCreateBudgetRequest.Builderto create a request. Request of CreateBudget- Returns:
- A Java Future containing the result of the CreateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createBudgetAction
default CompletableFuture<CreateBudgetActionResponse> createBudgetAction(CreateBudgetActionRequest createBudgetActionRequest) Creates a budget action.
- Parameters:
createBudgetActionRequest-- Returns:
- A Java Future containing the result of the CreateBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createBudgetAction
default CompletableFuture<CreateBudgetActionResponse> createBudgetAction(Consumer<CreateBudgetActionRequest.Builder> createBudgetActionRequest) Creates a budget action.
This is a convenience which creates an instance of the
CreateBudgetActionRequest.Builderavoiding the need to create one manually viaCreateBudgetActionRequest.builder()- Parameters:
createBudgetActionRequest- AConsumerthat will call methods onCreateBudgetActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createNotification
default CompletableFuture<CreateNotificationResponse> createNotification(CreateNotificationRequest createNotificationRequest) Creates a notification. You must create the budget before you create the associated notification.
- Parameters:
createNotificationRequest- Request of CreateNotification- Returns:
- A Java Future containing the result of the CreateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createNotification
default CompletableFuture<CreateNotificationResponse> createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest) Creates a notification. You must create the budget before you create the associated notification.
This is a convenience which creates an instance of the
CreateNotificationRequest.Builderavoiding the need to create one manually viaCreateNotificationRequest.builder()- Parameters:
createNotificationRequest- AConsumerthat will call methods onCreateNotificationRequest.Builderto create a request. Request of CreateNotification- Returns:
- A Java Future containing the result of the CreateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createSubscriber
default CompletableFuture<CreateSubscriberResponse> createSubscriber(CreateSubscriberRequest createSubscriberRequest) Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
- Parameters:
createSubscriberRequest- Request of CreateSubscriber- Returns:
- A Java Future containing the result of the CreateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createSubscriber
default CompletableFuture<CreateSubscriberResponse> createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest) Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
This is a convenience which creates an instance of the
CreateSubscriberRequest.Builderavoiding the need to create one manually viaCreateSubscriberRequest.builder()- Parameters:
createSubscriberRequest- AConsumerthat will call methods onCreateSubscriberRequest.Builderto create a request. Request of CreateSubscriber- Returns:
- A Java Future containing the result of the CreateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBudget
default CompletableFuture<DeleteBudgetResponse> deleteBudget(DeleteBudgetRequest deleteBudgetRequest) Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
- Parameters:
deleteBudgetRequest- Request of DeleteBudget- Returns:
- A Java Future containing the result of the DeleteBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBudget
default CompletableFuture<DeleteBudgetResponse> deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest) Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
This is a convenience which creates an instance of the
DeleteBudgetRequest.Builderavoiding the need to create one manually viaDeleteBudgetRequest.builder()- Parameters:
deleteBudgetRequest- AConsumerthat will call methods onDeleteBudgetRequest.Builderto create a request. Request of DeleteBudget- Returns:
- A Java Future containing the result of the DeleteBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBudgetAction
default CompletableFuture<DeleteBudgetActionResponse> deleteBudgetAction(DeleteBudgetActionRequest deleteBudgetActionRequest) Deletes a budget action.
- Parameters:
deleteBudgetActionRequest-- Returns:
- A Java Future containing the result of the DeleteBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBudgetAction
default CompletableFuture<DeleteBudgetActionResponse> deleteBudgetAction(Consumer<DeleteBudgetActionRequest.Builder> deleteBudgetActionRequest) Deletes a budget action.
This is a convenience which creates an instance of the
DeleteBudgetActionRequest.Builderavoiding the need to create one manually viaDeleteBudgetActionRequest.builder()- Parameters:
deleteBudgetActionRequest- AConsumerthat will call methods onDeleteBudgetActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteNotification
default CompletableFuture<DeleteNotificationResponse> deleteNotification(DeleteNotificationRequest deleteNotificationRequest) Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
- Parameters:
deleteNotificationRequest- Request of DeleteNotification- Returns:
- A Java Future containing the result of the DeleteNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteNotification
default CompletableFuture<DeleteNotificationResponse> deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest) Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
This is a convenience which creates an instance of the
DeleteNotificationRequest.Builderavoiding the need to create one manually viaDeleteNotificationRequest.builder()- Parameters:
deleteNotificationRequest- AConsumerthat will call methods onDeleteNotificationRequest.Builderto create a request. Request of DeleteNotification- Returns:
- A Java Future containing the result of the DeleteNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteSubscriber
default CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
- Parameters:
deleteSubscriberRequest- Request of DeleteSubscriber- Returns:
- A Java Future containing the result of the DeleteSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteSubscriber
default CompletableFuture<DeleteSubscriberResponse> deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest) Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
This is a convenience which creates an instance of the
DeleteSubscriberRequest.Builderavoiding the need to create one manually viaDeleteSubscriberRequest.builder()- Parameters:
deleteSubscriberRequest- AConsumerthat will call methods onDeleteSubscriberRequest.Builderto create a request. Request of DeleteSubscriber- Returns:
- A Java Future containing the result of the DeleteSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudget
default CompletableFuture<DescribeBudgetResponse> describeBudget(DescribeBudgetRequest describeBudgetRequest) Describes a budget.
The Request Syntax section shows the
BudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.- Parameters:
describeBudgetRequest- Request of DescribeBudget- Returns:
- A Java Future containing the result of the DescribeBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudget
default CompletableFuture<DescribeBudgetResponse> describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest) Describes a budget.
The Request Syntax section shows the
BudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.
This is a convenience which creates an instance of the
DescribeBudgetRequest.Builderavoiding the need to create one manually viaDescribeBudgetRequest.builder()- Parameters:
describeBudgetRequest- AConsumerthat will call methods onDescribeBudgetRequest.Builderto create a request. Request of DescribeBudget- Returns:
- A Java Future containing the result of the DescribeBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetAction
default CompletableFuture<DescribeBudgetActionResponse> describeBudgetAction(DescribeBudgetActionRequest describeBudgetActionRequest) Describes a budget action detail.
- Parameters:
describeBudgetActionRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetAction
default CompletableFuture<DescribeBudgetActionResponse> describeBudgetAction(Consumer<DescribeBudgetActionRequest.Builder> describeBudgetActionRequest) Describes a budget action detail.
This is a convenience which creates an instance of the
DescribeBudgetActionRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionRequest.builder()- Parameters:
describeBudgetActionRequest- AConsumerthat will call methods onDescribeBudgetActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionHistories
default CompletableFuture<DescribeBudgetActionHistoriesResponse> describeBudgetActionHistories(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) Describes a budget action history detail.
- Parameters:
describeBudgetActionHistoriesRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetActionHistories operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionHistories
default CompletableFuture<DescribeBudgetActionHistoriesResponse> describeBudgetActionHistories(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) Describes a budget action history detail.
This is a convenience which creates an instance of the
DescribeBudgetActionHistoriesRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionHistoriesRequest.builder()- Parameters:
describeBudgetActionHistoriesRequest- AConsumerthat will call methods onDescribeBudgetActionHistoriesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetActionHistories operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionHistoriesPaginator
default DescribeBudgetActionHistoriesPublisher describeBudgetActionHistoriesPaginator(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) This is a variant of
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesPublisher publisher = client.describeBudgetActionHistoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesPublisher publisher = client.describeBudgetActionHistoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation.- Parameters:
describeBudgetActionHistoriesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionHistoriesPaginator
default DescribeBudgetActionHistoriesPublisher describeBudgetActionHistoriesPaginator(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) This is a variant of
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesPublisher publisher = client.describeBudgetActionHistoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesPublisher publisher = client.describeBudgetActionHistoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetActionHistoriesRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionHistoriesRequest.builder()- Parameters:
describeBudgetActionHistoriesRequest- AConsumerthat will call methods onDescribeBudgetActionHistoriesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForAccount
default CompletableFuture<DescribeBudgetActionsForAccountResponse> describeBudgetActionsForAccount(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) Describes all of the budget actions for an account.
- Parameters:
describeBudgetActionsForAccountRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetActionsForAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForAccount
default CompletableFuture<DescribeBudgetActionsForAccountResponse> describeBudgetActionsForAccount(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) Describes all of the budget actions for an account.
This is a convenience which creates an instance of the
DescribeBudgetActionsForAccountRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionsForAccountRequest.builder()- Parameters:
describeBudgetActionsForAccountRequest- AConsumerthat will call methods onDescribeBudgetActionsForAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetActionsForAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForAccountPaginator
default DescribeBudgetActionsForAccountPublisher describeBudgetActionsForAccountPaginator(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) This is a variant of
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountPublisher publisher = client.describeBudgetActionsForAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountPublisher publisher = client.describeBudgetActionsForAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation.- Parameters:
describeBudgetActionsForAccountRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForAccountPaginator
default DescribeBudgetActionsForAccountPublisher describeBudgetActionsForAccountPaginator(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) This is a variant of
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountPublisher publisher = client.describeBudgetActionsForAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountPublisher publisher = client.describeBudgetActionsForAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetActionsForAccountRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionsForAccountRequest.builder()- Parameters:
describeBudgetActionsForAccountRequest- AConsumerthat will call methods onDescribeBudgetActionsForAccountRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForBudget
default CompletableFuture<DescribeBudgetActionsForBudgetResponse> describeBudgetActionsForBudget(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) Describes all of the budget actions for a budget.
- Parameters:
describeBudgetActionsForBudgetRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetActionsForBudget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForBudget
default CompletableFuture<DescribeBudgetActionsForBudgetResponse> describeBudgetActionsForBudget(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) Describes all of the budget actions for a budget.
This is a convenience which creates an instance of the
DescribeBudgetActionsForBudgetRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionsForBudgetRequest.builder()- Parameters:
describeBudgetActionsForBudgetRequest- AConsumerthat will call methods onDescribeBudgetActionsForBudgetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetActionsForBudget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForBudgetPaginator
default DescribeBudgetActionsForBudgetPublisher describeBudgetActionsForBudgetPaginator(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) This is a variant of
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetPublisher publisher = client.describeBudgetActionsForBudgetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetPublisher publisher = client.describeBudgetActionsForBudgetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation.- Parameters:
describeBudgetActionsForBudgetRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetActionsForBudgetPaginator
default DescribeBudgetActionsForBudgetPublisher describeBudgetActionsForBudgetPaginator(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) This is a variant of
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetPublisher publisher = client.describeBudgetActionsForBudgetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetPublisher publisher = client.describeBudgetActionsForBudgetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetActionsForBudgetRequest.Builderavoiding the need to create one manually viaDescribeBudgetActionsForBudgetRequest.builder()- Parameters:
describeBudgetActionsForBudgetRequest- AConsumerthat will call methods onDescribeBudgetActionsForBudgetRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetNotificationsForAccount
default CompletableFuture<DescribeBudgetNotificationsForAccountResponse> describeBudgetNotificationsForAccount(DescribeBudgetNotificationsForAccountRequest describeBudgetNotificationsForAccountRequest) Lists the budget names and notifications that are associated with an account.
- Parameters:
describeBudgetNotificationsForAccountRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetNotificationsForAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetNotificationsForAccount
default CompletableFuture<DescribeBudgetNotificationsForAccountResponse> describeBudgetNotificationsForAccount(Consumer<DescribeBudgetNotificationsForAccountRequest.Builder> describeBudgetNotificationsForAccountRequest) Lists the budget names and notifications that are associated with an account.
This is a convenience which creates an instance of the
DescribeBudgetNotificationsForAccountRequest.Builderavoiding the need to create one manually viaDescribeBudgetNotificationsForAccountRequest.builder()- Parameters:
describeBudgetNotificationsForAccountRequest- AConsumerthat will call methods onDescribeBudgetNotificationsForAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetNotificationsForAccount operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetNotificationsForAccountPaginator
default DescribeBudgetNotificationsForAccountPublisher describeBudgetNotificationsForAccountPaginator(DescribeBudgetNotificationsForAccountRequest describeBudgetNotificationsForAccountRequest) This is a variant of
describeBudgetNotificationsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetNotificationsForAccountPublisher publisher = client.describeBudgetNotificationsForAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetNotificationsForAccountPublisher publisher = client.describeBudgetNotificationsForAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetNotificationsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountRequest)operation.- Parameters:
describeBudgetNotificationsForAccountRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetNotificationsForAccountPaginator
default DescribeBudgetNotificationsForAccountPublisher describeBudgetNotificationsForAccountPaginator(Consumer<DescribeBudgetNotificationsForAccountRequest.Builder> describeBudgetNotificationsForAccountRequest) This is a variant of
describeBudgetNotificationsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetNotificationsForAccountPublisher publisher = client.describeBudgetNotificationsForAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetNotificationsForAccountPublisher publisher = client.describeBudgetNotificationsForAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetNotificationsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetNotificationsForAccountRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetNotificationsForAccountRequest.Builderavoiding the need to create one manually viaDescribeBudgetNotificationsForAccountRequest.builder()- Parameters:
describeBudgetNotificationsForAccountRequest- AConsumerthat will call methods onDescribeBudgetNotificationsForAccountRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetPerformanceHistory
default CompletableFuture<DescribeBudgetPerformanceHistoryResponse> describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) Describes the history for
DAILY,MONTHLY, andQUARTERLYbudgets. Budget history isn't available forANNUALbudgets.- Parameters:
describeBudgetPerformanceHistoryRequest-- Returns:
- A Java Future containing the result of the DescribeBudgetPerformanceHistory operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetPerformanceHistory
default CompletableFuture<DescribeBudgetPerformanceHistoryResponse> describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) Describes the history for
DAILY,MONTHLY, andQUARTERLYbudgets. Budget history isn't available forANNUALbudgets.
This is a convenience which creates an instance of the
DescribeBudgetPerformanceHistoryRequest.Builderavoiding the need to create one manually viaDescribeBudgetPerformanceHistoryRequest.builder()- Parameters:
describeBudgetPerformanceHistoryRequest- AConsumerthat will call methods onDescribeBudgetPerformanceHistoryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBudgetPerformanceHistory operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetPerformanceHistoryPaginator
default DescribeBudgetPerformanceHistoryPublisher describeBudgetPerformanceHistoryPaginator(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) This is a variant of
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryPublisher publisher = client.describeBudgetPerformanceHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryPublisher publisher = client.describeBudgetPerformanceHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation.- Parameters:
describeBudgetPerformanceHistoryRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetPerformanceHistoryPaginator
default DescribeBudgetPerformanceHistoryPublisher describeBudgetPerformanceHistoryPaginator(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) This is a variant of
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryPublisher publisher = client.describeBudgetPerformanceHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryPublisher publisher = client.describeBudgetPerformanceHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetPerformanceHistoryRequest.Builderavoiding the need to create one manually viaDescribeBudgetPerformanceHistoryRequest.builder()- Parameters:
describeBudgetPerformanceHistoryRequest- AConsumerthat will call methods onDescribeBudgetPerformanceHistoryRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgets
default CompletableFuture<DescribeBudgetsResponse> describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) Lists the budgets that are associated with an account.
The Request Syntax section shows the
BudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.- Parameters:
describeBudgetsRequest- Request of DescribeBudgets- Returns:
- A Java Future containing the result of the DescribeBudgets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgets
default CompletableFuture<DescribeBudgetsResponse> describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) Lists the budgets that are associated with an account.
The Request Syntax section shows the
BudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.
This is a convenience which creates an instance of the
DescribeBudgetsRequest.Builderavoiding the need to create one manually viaDescribeBudgetsRequest.builder()- Parameters:
describeBudgetsRequest- AConsumerthat will call methods onDescribeBudgetsRequest.Builderto create a request. Request of DescribeBudgets- Returns:
- A Java Future containing the result of the DescribeBudgets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetsPaginator
default DescribeBudgetsPublisher describeBudgetsPaginator(DescribeBudgetsRequest describeBudgetsRequest) This is a variant of
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetsPublisher publisher = client.describeBudgetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsPublisher publisher = client.describeBudgetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation.- Parameters:
describeBudgetsRequest- Request of DescribeBudgets- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBudgetsPaginator
default DescribeBudgetsPublisher describeBudgetsPaginator(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) This is a variant of
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeBudgetsPublisher publisher = client.describeBudgetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsPublisher publisher = client.describeBudgetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)operation.
This is a convenience which creates an instance of the
DescribeBudgetsRequest.Builderavoiding the need to create one manually viaDescribeBudgetsRequest.builder()- Parameters:
describeBudgetsRequest- AConsumerthat will call methods onDescribeBudgetsRequest.Builderto create a request. Request of DescribeBudgets- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeNotificationsForBudget
default CompletableFuture<DescribeNotificationsForBudgetResponse> describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.
- Parameters:
describeNotificationsForBudgetRequest- Request of DescribeNotificationsForBudget- Returns:
- A Java Future containing the result of the DescribeNotificationsForBudget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeNotificationsForBudget
default CompletableFuture<DescribeNotificationsForBudgetResponse> describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) Lists the notifications that are associated with a budget.
This is a convenience which creates an instance of the
DescribeNotificationsForBudgetRequest.Builderavoiding the need to create one manually viaDescribeNotificationsForBudgetRequest.builder()- Parameters:
describeNotificationsForBudgetRequest- AConsumerthat will call methods onDescribeNotificationsForBudgetRequest.Builderto create a request. Request of DescribeNotificationsForBudget- Returns:
- A Java Future containing the result of the DescribeNotificationsForBudget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeNotificationsForBudgetPaginator
default DescribeNotificationsForBudgetPublisher describeNotificationsForBudgetPaginator(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) This is a variant of
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetPublisher publisher = client.describeNotificationsForBudgetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetPublisher publisher = client.describeNotificationsForBudgetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation.- Parameters:
describeNotificationsForBudgetRequest- Request of DescribeNotificationsForBudget- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeNotificationsForBudgetPaginator
default DescribeNotificationsForBudgetPublisher describeNotificationsForBudgetPaginator(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) This is a variant of
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetPublisher publisher = client.describeNotificationsForBudgetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetPublisher publisher = client.describeNotificationsForBudgetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)operation.
This is a convenience which creates an instance of the
DescribeNotificationsForBudgetRequest.Builderavoiding the need to create one manually viaDescribeNotificationsForBudgetRequest.builder()- Parameters:
describeNotificationsForBudgetRequest- AConsumerthat will call methods onDescribeNotificationsForBudgetRequest.Builderto create a request. Request of DescribeNotificationsForBudget- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSubscribersForNotification
default CompletableFuture<DescribeSubscribersForNotificationResponse> describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.
- Parameters:
describeSubscribersForNotificationRequest- Request of DescribeSubscribersForNotification- Returns:
- A Java Future containing the result of the DescribeSubscribersForNotification operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSubscribersForNotification
default CompletableFuture<DescribeSubscribersForNotificationResponse> describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) Lists the subscribers that are associated with a notification.
This is a convenience which creates an instance of the
DescribeSubscribersForNotificationRequest.Builderavoiding the need to create one manually viaDescribeSubscribersForNotificationRequest.builder()- Parameters:
describeSubscribersForNotificationRequest- AConsumerthat will call methods onDescribeSubscribersForNotificationRequest.Builderto create a request. Request of DescribeSubscribersForNotification- Returns:
- A Java Future containing the result of the DescribeSubscribersForNotification operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSubscribersForNotificationPaginator
default DescribeSubscribersForNotificationPublisher describeSubscribersForNotificationPaginator(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) This is a variant of
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationPublisher publisher = client.describeSubscribersForNotificationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationPublisher publisher = client.describeSubscribersForNotificationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation.- Parameters:
describeSubscribersForNotificationRequest- Request of DescribeSubscribersForNotification- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSubscribersForNotificationPaginator
default DescribeSubscribersForNotificationPublisher describeSubscribersForNotificationPaginator(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) This is a variant of
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationPublisher publisher = client.describeSubscribersForNotificationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationPublisher publisher = client.describeSubscribersForNotificationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)operation.
This is a convenience which creates an instance of the
DescribeSubscribersForNotificationRequest.Builderavoiding the need to create one manually viaDescribeSubscribersForNotificationRequest.builder()- Parameters:
describeSubscribersForNotificationRequest- AConsumerthat will call methods onDescribeSubscribersForNotificationRequest.Builderto create a request. Request of DescribeSubscribersForNotification- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
executeBudgetAction
default CompletableFuture<ExecuteBudgetActionResponse> executeBudgetAction(ExecuteBudgetActionRequest executeBudgetActionRequest) Executes a budget action.
- Parameters:
executeBudgetActionRequest-- Returns:
- A Java Future containing the result of the ExecuteBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
executeBudgetAction
default CompletableFuture<ExecuteBudgetActionResponse> executeBudgetAction(Consumer<ExecuteBudgetActionRequest.Builder> executeBudgetActionRequest) Executes a budget action.
This is a convenience which creates an instance of the
ExecuteBudgetActionRequest.Builderavoiding the need to create one manually viaExecuteBudgetActionRequest.builder()- Parameters:
executeBudgetActionRequest- AConsumerthat will call methods onExecuteBudgetActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ExecuteBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a budget or budget action resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a budget or budget action resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
tagResource
Creates tags for a budget or budget action resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tags for a budget or budget action resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes tags associated with a budget or budget action resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes tags associated with a budget or budget action resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBudget
default CompletableFuture<UpdateBudgetResponse> updateBudget(UpdateBudgetRequest updateBudgetRequest) Updates a budget. You can change every part of a budget except for the
budgetNameand thecalculatedSpend. When you modify a budget, thecalculatedSpenddrops to zero until Amazon Web Services has new usage data to use for forecasting.Only one of
BudgetLimitorPlannedBudgetLimitscan be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows theBudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.- Parameters:
updateBudgetRequest- Request of UpdateBudget- Returns:
- A Java Future containing the result of the UpdateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBudget
default CompletableFuture<UpdateBudgetResponse> updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest) Updates a budget. You can change every part of a budget except for the
budgetNameand thecalculatedSpend. When you modify a budget, thecalculatedSpenddrops to zero until Amazon Web Services has new usage data to use for forecasting.Only one of
BudgetLimitorPlannedBudgetLimitscan be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows theBudgetLimitsyntax. ForPlannedBudgetLimits, see the Examples section.
This is a convenience which creates an instance of the
UpdateBudgetRequest.Builderavoiding the need to create one manually viaUpdateBudgetRequest.builder()- Parameters:
updateBudgetRequest- AConsumerthat will call methods onUpdateBudgetRequest.Builderto create a request. Request of UpdateBudget- Returns:
- A Java Future containing the result of the UpdateBudget operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBudgetAction
default CompletableFuture<UpdateBudgetActionResponse> updateBudgetAction(UpdateBudgetActionRequest updateBudgetActionRequest) Updates a budget action.
- Parameters:
updateBudgetActionRequest-- Returns:
- A Java Future containing the result of the UpdateBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBudgetAction
default CompletableFuture<UpdateBudgetActionResponse> updateBudgetAction(Consumer<UpdateBudgetActionRequest.Builder> updateBudgetActionRequest) Updates a budget action.
This is a convenience which creates an instance of the
UpdateBudgetActionRequest.Builderavoiding the need to create one manually viaUpdateBudgetActionRequest.builder()- Parameters:
updateBudgetActionRequest- AConsumerthat will call methods onUpdateBudgetActionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateBudgetAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateNotification
default CompletableFuture<UpdateNotificationResponse> updateNotification(UpdateNotificationRequest updateNotificationRequest) Updates a notification.
- Parameters:
updateNotificationRequest- Request of UpdateNotification- Returns:
- A Java Future containing the result of the UpdateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateNotification
default CompletableFuture<UpdateNotificationResponse> updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest) Updates a notification.
This is a convenience which creates an instance of the
UpdateNotificationRequest.Builderavoiding the need to create one manually viaUpdateNotificationRequest.builder()- Parameters:
updateNotificationRequest- AConsumerthat will call methods onUpdateNotificationRequest.Builderto create a request. Request of UpdateNotification- Returns:
- A Java Future containing the result of the UpdateNotification operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateSubscriber
default CompletableFuture<UpdateSubscriberResponse> updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) Updates a subscriber.
- Parameters:
updateSubscriberRequest- Request of UpdateSubscriber- Returns:
- A Java Future containing the result of the UpdateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateSubscriber
default CompletableFuture<UpdateSubscriberResponse> updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest) Updates a subscriber.
This is a convenience which creates an instance of the
UpdateSubscriberRequest.Builderavoiding the need to create one manually viaUpdateSubscriberRequest.builder()- Parameters:
updateSubscriberRequest- AConsumerthat will call methods onUpdateSubscriberRequest.Builderto create a request. Request of UpdateSubscriber- Returns:
- A Java Future containing the result of the UpdateSubscriber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BudgetsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aBudgetsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aBudgetsAsyncClient.
-