Interface BillingAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BillingAsyncClient extends AwsClient
Service client for accessing AWS Billing asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.
The Billing API provides the following endpoint:
https://billing.us-east-1.api.aws
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createBillingView
default CompletableFuture<CreateBillingViewResponse> createBillingView(CreateBillingViewRequest createBillingViewRequest)
Creates a billing view with the specified billing view attributes.
- Parameters:
createBillingViewRequest-- Returns:
- A Java Future containing the result of the CreateBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You've reached the limit of resources you can create, or exceeded the size of an individual resource.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createBillingView
default CompletableFuture<CreateBillingViewResponse> createBillingView(Consumer<CreateBillingViewRequest.Builder> createBillingViewRequest)
Creates a billing view with the specified billing view attributes.
This is a convenience which creates an instance of the
CreateBillingViewRequest.Builderavoiding the need to create one manually viaCreateBillingViewRequest.builder()- Parameters:
createBillingViewRequest- AConsumerthat will call methods onCreateBillingViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You've reached the limit of resources you can create, or exceeded the size of an individual resource.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteBillingView
default CompletableFuture<DeleteBillingViewResponse> deleteBillingView(DeleteBillingViewRequest deleteBillingViewRequest)
Deletes the specified billing view.
- Parameters:
deleteBillingViewRequest-- Returns:
- A Java Future containing the result of the DeleteBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteBillingView
default CompletableFuture<DeleteBillingViewResponse> deleteBillingView(Consumer<DeleteBillingViewRequest.Builder> deleteBillingViewRequest)
Deletes the specified billing view.
This is a convenience which creates an instance of the
DeleteBillingViewRequest.Builderavoiding the need to create one manually viaDeleteBillingViewRequest.builder()- Parameters:
deleteBillingViewRequest- AConsumerthat will call methods onDeleteBillingViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getBillingView
default CompletableFuture<GetBillingViewResponse> getBillingView(GetBillingViewRequest getBillingViewRequest)
Returns the metadata associated to the specified billing view ARN.
- Parameters:
getBillingViewRequest-- Returns:
- A Java Future containing the result of the GetBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getBillingView
default CompletableFuture<GetBillingViewResponse> getBillingView(Consumer<GetBillingViewRequest.Builder> getBillingViewRequest)
Returns the metadata associated to the specified billing view ARN.
This is a convenience which creates an instance of the
GetBillingViewRequest.Builderavoiding the need to create one manually viaGetBillingViewRequest.builder()- Parameters:
getBillingViewRequest- AConsumerthat will call methods onGetBillingViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Returns the resource-based policy document attached to the resource in
JSONformat.- Parameters:
getResourcePolicyRequest-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
Returns the resource-based policy document attached to the resource in
JSONformat.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builderavoiding the need to create one manually viaGetResourcePolicyRequest.builder()- Parameters:
getResourcePolicyRequest- AConsumerthat will call methods onGetResourcePolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBillingViews
default CompletableFuture<ListBillingViewsResponse> listBillingViews(ListBillingViewsRequest listBillingViewsRequest)
Lists the billing views available for a given time period.
Every Amazon Web Services account has a unique
PRIMARYbilling view that represents the billing data available by default. Accounts that use Billing Conductor also haveBILLING_GROUPbilling views representing pro forma costs associated with each created billing group.- Parameters:
listBillingViewsRequest-- Returns:
- A Java Future containing the result of the ListBillingViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBillingViews
default CompletableFuture<ListBillingViewsResponse> listBillingViews(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)
Lists the billing views available for a given time period.
Every Amazon Web Services account has a unique
PRIMARYbilling view that represents the billing data available by default. Accounts that use Billing Conductor also haveBILLING_GROUPbilling views representing pro forma costs associated with each created billing group.
This is a convenience which creates an instance of the
ListBillingViewsRequest.Builderavoiding the need to create one manually viaListBillingViewsRequest.builder()- Parameters:
listBillingViewsRequest- AConsumerthat will call methods onListBillingViewsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListBillingViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBillingViewsPaginator
default ListBillingViewsPublisher listBillingViewsPaginator(ListBillingViewsRequest listBillingViewsRequest)
This is a variant of
listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.billing.paginators.ListBillingViewsPublisher publisher = client.listBillingViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.billing.paginators.ListBillingViewsPublisher publisher = client.listBillingViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.billing.model.ListBillingViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.billing.model.ListBillingViewsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest)operation.- Parameters:
listBillingViewsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listBillingViewsPaginator
default ListBillingViewsPublisher listBillingViewsPaginator(Consumer<ListBillingViewsRequest.Builder> listBillingViewsRequest)
This is a variant of
listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.billing.paginators.ListBillingViewsPublisher publisher = client.listBillingViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.billing.paginators.ListBillingViewsPublisher publisher = client.listBillingViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.billing.model.ListBillingViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.billing.model.ListBillingViewsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBillingViews(software.amazon.awssdk.services.billing.model.ListBillingViewsRequest)operation.
This is a convenience which creates an instance of the
ListBillingViewsRequest.Builderavoiding the need to create one manually viaListBillingViewsRequest.builder()- Parameters:
listBillingViewsRequest- AConsumerthat will call methods onListBillingViewsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listSourceViewsForBillingView
default CompletableFuture<ListSourceViewsForBillingViewResponse> listSourceViewsForBillingView(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
- Parameters:
listSourceViewsForBillingViewRequest-- Returns:
- A Java Future containing the result of the ListSourceViewsForBillingView operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listSourceViewsForBillingView
default CompletableFuture<ListSourceViewsForBillingViewResponse> listSourceViewsForBillingView(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
This is a convenience which creates an instance of the
ListSourceViewsForBillingViewRequest.Builderavoiding the need to create one manually viaListSourceViewsForBillingViewRequest.builder()- Parameters:
listSourceViewsForBillingViewRequest- AConsumerthat will call methods onListSourceViewsForBillingViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSourceViewsForBillingView operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listSourceViewsForBillingViewPaginator
default ListSourceViewsForBillingViewPublisher listSourceViewsForBillingViewPaginator(ListSourceViewsForBillingViewRequest listSourceViewsForBillingViewRequest)
This is a variant of
listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewPublisher publisher = client.listSourceViewsForBillingViewPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewPublisher publisher = client.listSourceViewsForBillingViewPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest)operation.- Parameters:
listSourceViewsForBillingViewRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listSourceViewsForBillingViewPaginator
default ListSourceViewsForBillingViewPublisher listSourceViewsForBillingViewPaginator(Consumer<ListSourceViewsForBillingViewRequest.Builder> listSourceViewsForBillingViewRequest)
This is a variant of
listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewPublisher publisher = client.listSourceViewsForBillingViewPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.billing.paginators.ListSourceViewsForBillingViewPublisher publisher = client.listSourceViewsForBillingViewPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceViewsForBillingView(software.amazon.awssdk.services.billing.model.ListSourceViewsForBillingViewRequest)operation.
This is a convenience which creates an instance of the
ListSourceViewsForBillingViewRequest.Builderavoiding the need to create one manually viaListSourceViewsForBillingViewRequest.builder()- Parameters:
listSourceViewsForBillingViewRequest- AConsumerthat will call methods onListSourceViewsForBillingViewRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags associated with the billing view resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists tags associated with the billing view resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
An API operation for adding one or more tags (key-value pairs) to a resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
An API operation for adding one or more tags (key-value pairs) to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateBillingView
default CompletableFuture<UpdateBillingViewResponse> updateBillingView(UpdateBillingViewRequest updateBillingViewRequest)
An API to update the attributes of the billing view.
- Parameters:
updateBillingViewRequest-- Returns:
- A Java Future containing the result of the UpdateBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You've reached the limit of resources you can create, or exceeded the size of an individual resource.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateBillingView
default CompletableFuture<UpdateBillingViewResponse> updateBillingView(Consumer<UpdateBillingViewRequest.Builder> updateBillingViewRequest)
An API to update the attributes of the billing view.
This is a convenience which creates an instance of the
UpdateBillingViewRequest.Builderavoiding the need to create one manually viaUpdateBillingViewRequest.builder()- Parameters:
updateBillingViewRequest- AConsumerthat will call methods onUpdateBillingViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateBillingView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You've reached the limit of resources you can create, or exceeded the size of an individual resource.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException The specified ARN in the request doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this action.
- ConflictException The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing failed because of an unknown error, exception, or failure.
- 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.
- BillingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default BillingServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static BillingAsyncClient create()
Create aBillingAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static BillingAsyncClientBuilder builder()
Create a builder that can be used to configure and create aBillingAsyncClient.
-
-