@Generated(value="software.amazon.awssdk:codegen") public interface BudgetsClient extends SdkClient
builder()
method.
The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.
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 AWS, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
AWS 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 AWS Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static BudgetsClient create()
BudgetsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static BudgetsClientBuilder builder()
BudgetsClient
.default CreateBudgetResponse createBudget(CreateBudgetRequest createBudgetRequest) throws InvalidParameterException, InternalErrorException, CreationLimitExceededException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one
time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
createBudgetRequest
- Request of CreateBudgetInvalidParameterException
- 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.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.AwsServiceException
default CreateBudgetResponse createBudget(Consumer<CreateBudgetRequest.Builder> createBudgetRequest) throws InvalidParameterException, InternalErrorException, CreationLimitExceededException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one
time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
This is a convenience which creates an instance of the CreateBudgetRequest.Builder
avoiding the need to
create one manually via CreateBudgetRequest.builder()
createBudgetRequest
- A Consumer
that will call methods on CreateBudgetRequest.Builder
to create a request.
Request of CreateBudgetInvalidParameterException
- 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.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.AwsServiceException
default CreateBudgetActionResponse createBudgetAction(CreateBudgetActionRequest createBudgetActionRequest) throws InvalidParameterException, InternalErrorException, CreationLimitExceededException, DuplicateRecordException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a budget action.
createBudgetActionRequest
- 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.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.AwsServiceException
default CreateBudgetActionResponse createBudgetAction(Consumer<CreateBudgetActionRequest.Builder> createBudgetActionRequest) throws InvalidParameterException, InternalErrorException, CreationLimitExceededException, DuplicateRecordException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a budget action.
This is a convenience which creates an instance of the CreateBudgetActionRequest.Builder
avoiding the
need to create one manually via CreateBudgetActionRequest.builder()
createBudgetActionRequest
- A Consumer
that will call methods on CreateBudgetActionRequest.Builder
to create a
request.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.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.AwsServiceException
default CreateNotificationResponse createNotification(CreateNotificationRequest createNotificationRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, CreationLimitExceededException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a notification. You must create the budget before you create the associated notification.
createNotificationRequest
- Request of CreateNotificationInternalErrorException
- 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.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.AwsServiceException
default CreateNotificationResponse createNotification(Consumer<CreateNotificationRequest.Builder> createNotificationRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, CreationLimitExceededException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.Builder
avoiding the
need to create one manually via CreateNotificationRequest.builder()
createNotificationRequest
- A Consumer
that will call methods on CreateNotificationRequest.Builder
to create a
request. Request of CreateNotificationInternalErrorException
- 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.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.AwsServiceException
default CreateSubscriberResponse createSubscriber(CreateSubscriberRequest createSubscriberRequest) throws InternalErrorException, InvalidParameterException, CreationLimitExceededException, DuplicateRecordException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
createSubscriberRequest
- Request of CreateSubscriberInternalErrorException
- 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.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.AwsServiceException
default CreateSubscriberResponse createSubscriber(Consumer<CreateSubscriberRequest.Builder> createSubscriberRequest) throws InternalErrorException, InvalidParameterException, CreationLimitExceededException, DuplicateRecordException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.Builder
avoiding the need
to create one manually via CreateSubscriberRequest.builder()
createSubscriberRequest
- A Consumer
that will call methods on CreateSubscriberRequest.Builder
to create a request.
Request of CreateSubscriberInternalErrorException
- 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.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.AwsServiceException
default DeleteBudgetResponse deleteBudget(DeleteBudgetRequest deleteBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.
deleteBudgetRequest
- Request of DeleteBudgetInternalErrorException
- 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.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.AwsServiceException
default DeleteBudgetResponse deleteBudget(Consumer<DeleteBudgetRequest.Builder> deleteBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.Builder
avoiding the need to
create one manually via DeleteBudgetRequest.builder()
deleteBudgetRequest
- A Consumer
that will call methods on DeleteBudgetRequest.Builder
to create a request.
Request of DeleteBudgetInternalErrorException
- 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.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.AwsServiceException
default DeleteBudgetActionResponse deleteBudgetAction(DeleteBudgetActionRequest deleteBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Deletes a budget action.
deleteBudgetActionRequest
- 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.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.AwsServiceException
default DeleteBudgetActionResponse deleteBudgetAction(Consumer<DeleteBudgetActionRequest.Builder> deleteBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Deletes a budget action.
This is a convenience which creates an instance of the DeleteBudgetActionRequest.Builder
avoiding the
need to create one manually via DeleteBudgetActionRequest.builder()
deleteBudgetActionRequest
- A Consumer
that will call methods on DeleteBudgetActionRequest.Builder
to create a
request.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.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.AwsServiceException
default DeleteNotificationResponse deleteNotification(DeleteNotificationRequest deleteNotificationRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
deleteNotificationRequest
- Request of DeleteNotificationInvalidParameterException
- 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.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.AwsServiceException
default DeleteNotificationResponse deleteNotification(Consumer<DeleteNotificationRequest.Builder> deleteNotificationRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.Builder
avoiding the
need to create one manually via DeleteNotificationRequest.builder()
deleteNotificationRequest
- A Consumer
that will call methods on DeleteNotificationRequest.Builder
to create a
request. Request of DeleteNotificationInvalidParameterException
- 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.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.AwsServiceException
default DeleteSubscriberResponse deleteSubscriber(DeleteSubscriberRequest deleteSubscriberRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
deleteSubscriberRequest
- Request of DeleteSubscriberInternalErrorException
- 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.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.AwsServiceException
default DeleteSubscriberResponse deleteSubscriber(Consumer<DeleteSubscriberRequest.Builder> deleteSubscriberRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
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.Builder
avoiding the need
to create one manually via DeleteSubscriberRequest.builder()
deleteSubscriberRequest
- A Consumer
that will call methods on DeleteSubscriberRequest.Builder
to create a request.
Request of DeleteSubscriberInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetResponse describeBudget(DescribeBudgetRequest describeBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
describeBudgetRequest
- Request of DescribeBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetResponse describeBudget(Consumer<DescribeBudgetRequest.Builder> describeBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
This is a convenience which creates an instance of the DescribeBudgetRequest.Builder
avoiding the need to
create one manually via DescribeBudgetRequest.builder()
describeBudgetRequest
- A Consumer
that will call methods on DescribeBudgetRequest.Builder
to create a request.
Request of DescribeBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetActionResponse describeBudgetAction(DescribeBudgetActionRequest describeBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action detail.
describeBudgetActionRequest
- 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.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.AwsServiceException
default DescribeBudgetActionResponse describeBudgetAction(Consumer<DescribeBudgetActionRequest.Builder> describeBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action detail.
This is a convenience which creates an instance of the DescribeBudgetActionRequest.Builder
avoiding the
need to create one manually via DescribeBudgetActionRequest.builder()
describeBudgetActionRequest
- A Consumer
that will call methods on DescribeBudgetActionRequest.Builder
to create a
request.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.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.AwsServiceException
default DescribeBudgetActionHistoriesResponse describeBudgetActionHistories(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action history detail.
describeBudgetActionHistoriesRequest
- 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.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.AwsServiceException
default DescribeBudgetActionHistoriesResponse describeBudgetActionHistories(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action history detail.
This is a convenience which creates an instance of the DescribeBudgetActionHistoriesRequest.Builder
avoiding the need to create one manually via DescribeBudgetActionHistoriesRequest.builder()
describeBudgetActionHistoriesRequest
- A Consumer
that will call methods on DescribeBudgetActionHistoriesRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetActionHistoriesIterable describeBudgetActionHistoriesPaginator(DescribeBudgetActionHistoriesRequest describeBudgetActionHistoriesRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action history detail.
This is a variant of
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client.describeBudgetActionHistoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client .describeBudgetActionHistoriesPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client.describeBudgetActionHistoriesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBudgetActionHistoriesRequest
- 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.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.AwsServiceException
default DescribeBudgetActionHistoriesIterable describeBudgetActionHistoriesPaginator(Consumer<DescribeBudgetActionHistoriesRequest.Builder> describeBudgetActionHistoriesRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes a budget action history detail.
This is a variant of
describeBudgetActionHistories(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client.describeBudgetActionHistoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client .describeBudgetActionHistoriesPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionHistoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionHistoriesIterable responses = client.describeBudgetActionHistoriesPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeBudgetActionHistoriesRequest.builder()
describeBudgetActionHistoriesRequest
- A Consumer
that will call methods on DescribeBudgetActionHistoriesRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetActionsForAccountResponse describeBudgetActionsForAccount(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) throws InternalErrorException, InvalidParameterException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for an account.
describeBudgetActionsForAccountRequest
- 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.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.AwsServiceException
default DescribeBudgetActionsForAccountResponse describeBudgetActionsForAccount(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) throws InternalErrorException, InvalidParameterException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for an account.
This is a convenience which creates an instance of the DescribeBudgetActionsForAccountRequest.Builder
avoiding the need to create one manually via DescribeBudgetActionsForAccountRequest.builder()
describeBudgetActionsForAccountRequest
- A Consumer
that will call methods on DescribeBudgetActionsForAccountRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetActionsForAccountIterable describeBudgetActionsForAccountPaginator(DescribeBudgetActionsForAccountRequest describeBudgetActionsForAccountRequest) throws InternalErrorException, InvalidParameterException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for an account.
This is a variant of
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client.describeBudgetActionsForAccountPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client .describeBudgetActionsForAccountPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client.describeBudgetActionsForAccountPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBudgetActionsForAccountRequest
- 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.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.AwsServiceException
default DescribeBudgetActionsForAccountIterable describeBudgetActionsForAccountPaginator(Consumer<DescribeBudgetActionsForAccountRequest.Builder> describeBudgetActionsForAccountRequest) throws InternalErrorException, InvalidParameterException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for an account.
This is a variant of
describeBudgetActionsForAccount(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client.describeBudgetActionsForAccountPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client .describeBudgetActionsForAccountPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForAccountResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForAccountIterable responses = client.describeBudgetActionsForAccountPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeBudgetActionsForAccountRequest.builder()
describeBudgetActionsForAccountRequest
- A Consumer
that will call methods on DescribeBudgetActionsForAccountRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetActionsForBudgetResponse describeBudgetActionsForBudget(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for a budget.
describeBudgetActionsForBudgetRequest
- 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.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.AwsServiceException
default DescribeBudgetActionsForBudgetResponse describeBudgetActionsForBudget(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for a budget.
This is a convenience which creates an instance of the DescribeBudgetActionsForBudgetRequest.Builder
avoiding the need to create one manually via DescribeBudgetActionsForBudgetRequest.builder()
describeBudgetActionsForBudgetRequest
- A Consumer
that will call methods on DescribeBudgetActionsForBudgetRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetActionsForBudgetIterable describeBudgetActionsForBudgetPaginator(DescribeBudgetActionsForBudgetRequest describeBudgetActionsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for a budget.
This is a variant of
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client.describeBudgetActionsForBudgetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client .describeBudgetActionsForBudgetPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client.describeBudgetActionsForBudgetPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBudgetActionsForBudgetRequest
- 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.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.AwsServiceException
default DescribeBudgetActionsForBudgetIterable describeBudgetActionsForBudgetPaginator(Consumer<DescribeBudgetActionsForBudgetRequest.Builder> describeBudgetActionsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, BudgetsException
Describes all of the budget actions for a budget.
This is a variant of
describeBudgetActionsForBudget(software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client.describeBudgetActionsForBudgetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client .describeBudgetActionsForBudgetPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetActionsForBudgetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetActionsForBudgetIterable responses = client.describeBudgetActionsForBudgetPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeBudgetActionsForBudgetRequest.builder()
describeBudgetActionsForBudgetRequest
- A Consumer
that will call methods on DescribeBudgetActionsForBudgetRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetPerformanceHistoryResponse describeBudgetPerformanceHistory(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget
history isn't available for ANNUAL
budgets.
describeBudgetPerformanceHistoryRequest
- 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.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.AwsServiceException
default DescribeBudgetPerformanceHistoryResponse describeBudgetPerformanceHistory(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget
history isn't available for ANNUAL
budgets.
This is a convenience which creates an instance of the DescribeBudgetPerformanceHistoryRequest.Builder
avoiding the need to create one manually via DescribeBudgetPerformanceHistoryRequest.builder()
describeBudgetPerformanceHistoryRequest
- A Consumer
that will call methods on DescribeBudgetPerformanceHistoryRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetPerformanceHistoryIterable describeBudgetPerformanceHistoryPaginator(DescribeBudgetPerformanceHistoryRequest describeBudgetPerformanceHistoryRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget
history isn't available for ANNUAL
budgets.
This is a variant of
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client.describeBudgetPerformanceHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client .describeBudgetPerformanceHistoryPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client.describeBudgetPerformanceHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBudgetPerformanceHistoryRequest
- 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.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.AwsServiceException
default DescribeBudgetPerformanceHistoryIterable describeBudgetPerformanceHistoryPaginator(Consumer<DescribeBudgetPerformanceHistoryRequest.Builder> describeBudgetPerformanceHistoryRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget
history isn't available for ANNUAL
budgets.
This is a variant of
describeBudgetPerformanceHistory(software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client.describeBudgetPerformanceHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client .describeBudgetPerformanceHistoryPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetPerformanceHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetPerformanceHistoryIterable responses = client.describeBudgetPerformanceHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeBudgetPerformanceHistoryRequest.builder()
describeBudgetPerformanceHistoryRequest
- A Consumer
that will call methods on DescribeBudgetPerformanceHistoryRequest.Builder
to
create a request.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.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.AwsServiceException
default DescribeBudgetsResponse describeBudgets(DescribeBudgetsRequest describeBudgetsRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
describeBudgetsRequest
- Request of DescribeBudgetsInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetsResponse describeBudgets(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
This is a convenience which creates an instance of the DescribeBudgetsRequest.Builder
avoiding the need
to create one manually via DescribeBudgetsRequest.builder()
describeBudgetsRequest
- A Consumer
that will call methods on DescribeBudgetsRequest.Builder
to create a request.
Request of DescribeBudgetsInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetsIterable describeBudgetsPaginator(DescribeBudgetsRequest describeBudgetsRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
This is a variant of
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client.describeBudgetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client .describeBudgetsPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client.describeBudgetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBudgetsRequest
- Request of DescribeBudgetsInternalErrorException
- 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.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.AwsServiceException
default DescribeBudgetsIterable describeBudgetsPaginator(Consumer<DescribeBudgetsRequest.Builder> describeBudgetsRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see
the Examples section.
This is a variant of
describeBudgets(software.amazon.awssdk.services.budgets.model.DescribeBudgetsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client.describeBudgetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client .describeBudgetsPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeBudgetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeBudgetsIterable responses = client.describeBudgetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need
to create one manually via DescribeBudgetsRequest.builder()
describeBudgetsRequest
- A Consumer
that will call methods on DescribeBudgetsRequest.Builder
to create a request.
Request of DescribeBudgetsInternalErrorException
- 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.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.AwsServiceException
default DescribeNotificationsForBudgetResponse describeNotificationsForBudget(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the notifications that are associated with a budget.
describeNotificationsForBudgetRequest
- Request of DescribeNotificationsForBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeNotificationsForBudgetResponse describeNotificationsForBudget(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the notifications that are associated with a budget.
This is a convenience which creates an instance of the DescribeNotificationsForBudgetRequest.Builder
avoiding the need to create one manually via DescribeNotificationsForBudgetRequest.builder()
describeNotificationsForBudgetRequest
- A Consumer
that will call methods on DescribeNotificationsForBudgetRequest.Builder
to
create a request. Request of DescribeNotificationsForBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeNotificationsForBudgetIterable describeNotificationsForBudgetPaginator(DescribeNotificationsForBudgetRequest describeNotificationsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the notifications that are associated with a budget.
This is a variant of
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client.describeNotificationsForBudgetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client .describeNotificationsForBudgetPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client.describeNotificationsForBudgetPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeNotificationsForBudgetRequest
- Request of DescribeNotificationsForBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeNotificationsForBudgetIterable describeNotificationsForBudgetPaginator(Consumer<DescribeNotificationsForBudgetRequest.Builder> describeNotificationsForBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the notifications that are associated with a budget.
This is a variant of
describeNotificationsForBudget(software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client.describeNotificationsForBudgetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client .describeNotificationsForBudgetPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeNotificationsForBudgetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeNotificationsForBudgetIterable responses = client.describeNotificationsForBudgetPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeNotificationsForBudgetRequest.builder()
describeNotificationsForBudgetRequest
- A Consumer
that will call methods on DescribeNotificationsForBudgetRequest.Builder
to
create a request. Request of DescribeNotificationsForBudgetInternalErrorException
- 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.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.AwsServiceException
default DescribeSubscribersForNotificationResponse describeSubscribersForNotification(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) throws InternalErrorException, NotFoundException, InvalidParameterException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the subscribers that are associated with a notification.
describeSubscribersForNotificationRequest
- Request of DescribeSubscribersForNotificationInternalErrorException
- 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.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.AwsServiceException
default DescribeSubscribersForNotificationResponse describeSubscribersForNotification(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) throws InternalErrorException, NotFoundException, InvalidParameterException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the subscribers that are associated with a notification.
This is a convenience which creates an instance of the DescribeSubscribersForNotificationRequest.Builder
avoiding the need to create one manually via DescribeSubscribersForNotificationRequest.builder()
describeSubscribersForNotificationRequest
- A Consumer
that will call methods on DescribeSubscribersForNotificationRequest.Builder
to
create a request. Request of DescribeSubscribersForNotificationInternalErrorException
- 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.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.AwsServiceException
default DescribeSubscribersForNotificationIterable describeSubscribersForNotificationPaginator(DescribeSubscribersForNotificationRequest describeSubscribersForNotificationRequest) throws InternalErrorException, NotFoundException, InvalidParameterException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the subscribers that are associated with a notification.
This is a variant of
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client.describeSubscribersForNotificationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client .describeSubscribersForNotificationPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client.describeSubscribersForNotificationPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeSubscribersForNotificationRequest
- Request of DescribeSubscribersForNotificationInternalErrorException
- 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.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.AwsServiceException
default DescribeSubscribersForNotificationIterable describeSubscribersForNotificationPaginator(Consumer<DescribeSubscribersForNotificationRequest.Builder> describeSubscribersForNotificationRequest) throws InternalErrorException, NotFoundException, InvalidParameterException, InvalidNextTokenException, ExpiredNextTokenException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Lists the subscribers that are associated with a notification.
This is a variant of
describeSubscribersForNotification(software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client.describeSubscribersForNotificationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client .describeSubscribersForNotificationPaginator(request); for (software.amazon.awssdk.services.budgets.model.DescribeSubscribersForNotificationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.budgets.paginators.DescribeSubscribersForNotificationIterable responses = client.describeSubscribersForNotificationPaginator(request);
responses.iterator().forEachRemaining(....);
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.Builder
avoiding the need to create one manually via DescribeSubscribersForNotificationRequest.builder()
describeSubscribersForNotificationRequest
- A Consumer
that will call methods on DescribeSubscribersForNotificationRequest.Builder
to
create a request. Request of DescribeSubscribersForNotificationInternalErrorException
- 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.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.AwsServiceException
default ExecuteBudgetActionResponse executeBudgetAction(ExecuteBudgetActionRequest executeBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Executes a budget action.
executeBudgetActionRequest
- 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.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.AwsServiceException
default ExecuteBudgetActionResponse executeBudgetAction(Consumer<ExecuteBudgetActionRequest.Builder> executeBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Executes a budget action.
This is a convenience which creates an instance of the ExecuteBudgetActionRequest.Builder
avoiding the
need to create one manually via ExecuteBudgetActionRequest.builder()
executeBudgetActionRequest
- A Consumer
that will call methods on ExecuteBudgetActionRequest.Builder
to create a
request.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.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.AwsServiceException
default UpdateBudgetResponse updateBudget(UpdateBudgetRequest updateBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a budget. You can change every part of a budget except for the budgetName
and the
calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until AWS
has new usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one
time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
updateBudgetRequest
- Request of UpdateBudgetInternalErrorException
- 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.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.AwsServiceException
default UpdateBudgetResponse updateBudget(Consumer<UpdateBudgetRequest.Builder> updateBudgetRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a budget. You can change every part of a budget except for the budgetName
and the
calculatedSpend
. When you modify a budget, the calculatedSpend
drops to zero until AWS
has new usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the syntax at one
time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit
syntax. For PlannedBudgetLimits
, see the Examples section.
This is a convenience which creates an instance of the UpdateBudgetRequest.Builder
avoiding the need to
create one manually via UpdateBudgetRequest.builder()
updateBudgetRequest
- A Consumer
that will call methods on UpdateBudgetRequest.Builder
to create a request.
Request of UpdateBudgetInternalErrorException
- 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.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.AwsServiceException
default UpdateBudgetActionResponse updateBudgetAction(UpdateBudgetActionRequest updateBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Updates a budget action.
updateBudgetActionRequest
- 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.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.AwsServiceException
default UpdateBudgetActionResponse updateBudgetAction(Consumer<UpdateBudgetActionRequest.Builder> updateBudgetActionRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, AccessDeniedException, ResourceLockedException, AwsServiceException, SdkClientException, BudgetsException
Updates a budget action.
This is a convenience which creates an instance of the UpdateBudgetActionRequest.Builder
avoiding the
need to create one manually via UpdateBudgetActionRequest.builder()
updateBudgetActionRequest
- A Consumer
that will call methods on UpdateBudgetActionRequest.Builder
to create a
request.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.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.AwsServiceException
default UpdateNotificationResponse updateNotification(UpdateNotificationRequest updateNotificationRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a notification.
updateNotificationRequest
- Request of UpdateNotificationInternalErrorException
- 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.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.AwsServiceException
default UpdateNotificationResponse updateNotification(Consumer<UpdateNotificationRequest.Builder> updateNotificationRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a notification.
This is a convenience which creates an instance of the UpdateNotificationRequest.Builder
avoiding the
need to create one manually via UpdateNotificationRequest.builder()
updateNotificationRequest
- A Consumer
that will call methods on UpdateNotificationRequest.Builder
to create a
request. Request of UpdateNotificationInternalErrorException
- 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.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.AwsServiceException
default UpdateSubscriberResponse updateSubscriber(UpdateSubscriberRequest updateSubscriberRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a subscriber.
updateSubscriberRequest
- Request of UpdateSubscriberInternalErrorException
- 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.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.AwsServiceException
default UpdateSubscriberResponse updateSubscriber(Consumer<UpdateSubscriberRequest.Builder> updateSubscriberRequest) throws InternalErrorException, InvalidParameterException, NotFoundException, DuplicateRecordException, AccessDeniedException, AwsServiceException, SdkClientException, BudgetsException
Updates a subscriber.
This is a convenience which creates an instance of the UpdateSubscriberRequest.Builder
avoiding the need
to create one manually via UpdateSubscriberRequest.builder()
updateSubscriberRequest
- A Consumer
that will call methods on UpdateSubscriberRequest.Builder
to create a request.
Request of UpdateSubscriberInternalErrorException
- 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.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.AwsServiceException
static ServiceMetadata serviceMetadata()