Interface InvoicingAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Web Services Invoice Configuration
You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts.
You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
Service endpoint
You can use the following endpoints for Amazon Web Services Invoice Configuration:
-
https://invoicing.us-east-1.api.aws
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetInvoiceProfile
(Consumer<BatchGetInvoiceProfileRequest.Builder> batchGetInvoiceProfileRequest) This gets the invoice profile associated with a set of accounts.batchGetInvoiceProfile
(BatchGetInvoiceProfileRequest batchGetInvoiceProfileRequest) This gets the invoice profile associated with a set of accounts.static InvoicingAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aInvoicingAsyncClient
.static InvoicingAsyncClient
create()
Create aInvoicingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createInvoiceUnit
(Consumer<CreateInvoiceUnitRequest.Builder> createInvoiceUnitRequest) This creates a new invoice unit with the provided definition.createInvoiceUnit
(CreateInvoiceUnitRequest createInvoiceUnitRequest) This creates a new invoice unit with the provided definition.deleteInvoiceUnit
(Consumer<DeleteInvoiceUnitRequest.Builder> deleteInvoiceUnitRequest) This deletes an invoice unit with the provided invoice unit ARN.deleteInvoiceUnit
(DeleteInvoiceUnitRequest deleteInvoiceUnitRequest) This deletes an invoice unit with the provided invoice unit ARN.default CompletableFuture
<GetInvoiceUnitResponse> getInvoiceUnit
(Consumer<GetInvoiceUnitRequest.Builder> getInvoiceUnitRequest) This retrieves the invoice unit definition.default CompletableFuture
<GetInvoiceUnitResponse> getInvoiceUnit
(GetInvoiceUnitRequest getInvoiceUnitRequest) This retrieves the invoice unit definition.listInvoiceSummaries
(Consumer<ListInvoiceSummariesRequest.Builder> listInvoiceSummariesRequest) Retrieves your invoice details programmatically, without line item details.listInvoiceSummaries
(ListInvoiceSummariesRequest listInvoiceSummariesRequest) Retrieves your invoice details programmatically, without line item details.default ListInvoiceSummariesPublisher
listInvoiceSummariesPaginator
(Consumer<ListInvoiceSummariesRequest.Builder> listInvoiceSummariesRequest) This is a variant oflistInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
operation.default ListInvoiceSummariesPublisher
listInvoiceSummariesPaginator
(ListInvoiceSummariesRequest listInvoiceSummariesRequest) This is a variant oflistInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
operation.listInvoiceUnits
(Consumer<ListInvoiceUnitsRequest.Builder> listInvoiceUnitsRequest) This fetches a list of all invoice unit definitions for a given account, as of the providedAsOf
date.listInvoiceUnits
(ListInvoiceUnitsRequest listInvoiceUnitsRequest) This fetches a list of all invoice unit definitions for a given account, as of the providedAsOf
date.default ListInvoiceUnitsPublisher
listInvoiceUnitsPaginator
(Consumer<ListInvoiceUnitsRequest.Builder> listInvoiceUnitsRequest) This is a variant oflistInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
operation.default ListInvoiceUnitsPublisher
listInvoiceUnitsPaginator
(ListInvoiceUnitsRequest listInvoiceUnitsRequest) This is a variant oflistInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds a tag to a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.updateInvoiceUnit
(Consumer<UpdateInvoiceUnitRequest.Builder> updateInvoiceUnitRequest) You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.updateInvoiceUnit
(UpdateInvoiceUnitRequest updateInvoiceUnitRequest) You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetInvoiceProfile
default CompletableFuture<BatchGetInvoiceProfileResponse> batchGetInvoiceProfile(BatchGetInvoiceProfileRequest batchGetInvoiceProfileRequest) This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
- Parameters:
batchGetInvoiceProfileRequest
-- Returns:
- A Java Future containing the result of the BatchGetInvoiceProfile 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetInvoiceProfile
default CompletableFuture<BatchGetInvoiceProfileResponse> batchGetInvoiceProfile(Consumer<BatchGetInvoiceProfileRequest.Builder> batchGetInvoiceProfileRequest) This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
This is a convenience which creates an instance of the
BatchGetInvoiceProfileRequest.Builder
avoiding the need to create one manually viaBatchGetInvoiceProfileRequest.builder()
- Parameters:
batchGetInvoiceProfileRequest
- AConsumer
that will call methods onBatchGetInvoiceProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetInvoiceProfile 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInvoiceUnit
default CompletableFuture<CreateInvoiceUnitResponse> createInvoiceUnit(CreateInvoiceUnitRequest createInvoiceUnitRequest) This creates a new invoice unit with the provided definition.
- Parameters:
createInvoiceUnitRequest
-- Returns:
- A Java Future containing the result of the CreateInvoiceUnit 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInvoiceUnit
default CompletableFuture<CreateInvoiceUnitResponse> createInvoiceUnit(Consumer<CreateInvoiceUnitRequest.Builder> createInvoiceUnitRequest) This creates a new invoice unit with the provided definition.
This is a convenience which creates an instance of the
CreateInvoiceUnitRequest.Builder
avoiding the need to create one manually viaCreateInvoiceUnitRequest.builder()
- Parameters:
createInvoiceUnitRequest
- AConsumer
that will call methods onCreateInvoiceUnitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateInvoiceUnit 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInvoiceUnit
default CompletableFuture<DeleteInvoiceUnitResponse> deleteInvoiceUnit(DeleteInvoiceUnitRequest deleteInvoiceUnitRequest) This deletes an invoice unit with the provided invoice unit ARN.
- Parameters:
deleteInvoiceUnitRequest
-- Returns:
- A Java Future containing the result of the DeleteInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInvoiceUnit
default CompletableFuture<DeleteInvoiceUnitResponse> deleteInvoiceUnit(Consumer<DeleteInvoiceUnitRequest.Builder> deleteInvoiceUnitRequest) This deletes an invoice unit with the provided invoice unit ARN.
This is a convenience which creates an instance of the
DeleteInvoiceUnitRequest.Builder
avoiding the need to create one manually viaDeleteInvoiceUnitRequest.builder()
- Parameters:
deleteInvoiceUnitRequest
- AConsumer
that will call methods onDeleteInvoiceUnitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInvoiceUnit
default CompletableFuture<GetInvoiceUnitResponse> getInvoiceUnit(GetInvoiceUnitRequest getInvoiceUnitRequest) This retrieves the invoice unit definition.
- Parameters:
getInvoiceUnitRequest
-- Returns:
- A Java Future containing the result of the GetInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInvoiceUnit
default CompletableFuture<GetInvoiceUnitResponse> getInvoiceUnit(Consumer<GetInvoiceUnitRequest.Builder> getInvoiceUnitRequest) This retrieves the invoice unit definition.
This is a convenience which creates an instance of the
GetInvoiceUnitRequest.Builder
avoiding the need to create one manually viaGetInvoiceUnitRequest.builder()
- Parameters:
getInvoiceUnitRequest
- AConsumer
that will call methods onGetInvoiceUnitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceSummaries
default CompletableFuture<ListInvoiceSummariesResponse> listInvoiceSummaries(ListInvoiceSummariesRequest listInvoiceSummariesRequest) Retrieves your invoice details programmatically, without line item details.
- Parameters:
listInvoiceSummariesRequest
-- Returns:
- A Java Future containing the result of the ListInvoiceSummaries 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceSummaries
default CompletableFuture<ListInvoiceSummariesResponse> listInvoiceSummaries(Consumer<ListInvoiceSummariesRequest.Builder> listInvoiceSummariesRequest) Retrieves your invoice details programmatically, without line item details.
This is a convenience which creates an instance of the
ListInvoiceSummariesRequest.Builder
avoiding the need to create one manually viaListInvoiceSummariesRequest.builder()
- Parameters:
listInvoiceSummariesRequest
- AConsumer
that will call methods onListInvoiceSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInvoiceSummaries 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceSummariesPaginator
default ListInvoiceSummariesPublisher listInvoiceSummariesPaginator(ListInvoiceSummariesRequest listInvoiceSummariesRequest) This is a variant of
listInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
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 newSubscription
i.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 methodsoftware.amazon.awssdk.services.invoicing.paginators.ListInvoiceSummariesPublisher publisher = client.listInvoiceSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.invoicing.paginators.ListInvoiceSummariesPublisher publisher = client.listInvoiceSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesResponse 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
listInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
operation.- Parameters:
listInvoiceSummariesRequest
-- 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceSummariesPaginator
default ListInvoiceSummariesPublisher listInvoiceSummariesPaginator(Consumer<ListInvoiceSummariesRequest.Builder> listInvoiceSummariesRequest) This is a variant of
listInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
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 newSubscription
i.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 methodsoftware.amazon.awssdk.services.invoicing.paginators.ListInvoiceSummariesPublisher publisher = client.listInvoiceSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.invoicing.paginators.ListInvoiceSummariesPublisher publisher = client.listInvoiceSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesResponse 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
listInvoiceSummaries(software.amazon.awssdk.services.invoicing.model.ListInvoiceSummariesRequest)
operation.
This is a convenience which creates an instance of the
ListInvoiceSummariesRequest.Builder
avoiding the need to create one manually viaListInvoiceSummariesRequest.builder()
- Parameters:
listInvoiceSummariesRequest
- AConsumer
that will call methods onListInvoiceSummariesRequest.Builder
to 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceUnits
default CompletableFuture<ListInvoiceUnitsResponse> listInvoiceUnits(ListInvoiceUnitsRequest listInvoiceUnitsRequest) This fetches a list of all invoice unit definitions for a given account, as of the provided
AsOf
date.- Parameters:
listInvoiceUnitsRequest
-- Returns:
- A Java Future containing the result of the ListInvoiceUnits 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceUnits
default CompletableFuture<ListInvoiceUnitsResponse> listInvoiceUnits(Consumer<ListInvoiceUnitsRequest.Builder> listInvoiceUnitsRequest) This fetches a list of all invoice unit definitions for a given account, as of the provided
AsOf
date.
This is a convenience which creates an instance of the
ListInvoiceUnitsRequest.Builder
avoiding the need to create one manually viaListInvoiceUnitsRequest.builder()
- Parameters:
listInvoiceUnitsRequest
- AConsumer
that will call methods onListInvoiceUnitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInvoiceUnits 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceUnitsPaginator
default ListInvoiceUnitsPublisher listInvoiceUnitsPaginator(ListInvoiceUnitsRequest listInvoiceUnitsRequest) This is a variant of
listInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
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 newSubscription
i.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 methodsoftware.amazon.awssdk.services.invoicing.paginators.ListInvoiceUnitsPublisher publisher = client.listInvoiceUnitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.invoicing.paginators.ListInvoiceUnitsPublisher publisher = client.listInvoiceUnitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsResponse 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
listInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
operation.- Parameters:
listInvoiceUnitsRequest
-- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInvoiceUnitsPaginator
default ListInvoiceUnitsPublisher listInvoiceUnitsPaginator(Consumer<ListInvoiceUnitsRequest.Builder> listInvoiceUnitsRequest) This is a variant of
listInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
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 newSubscription
i.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 methodsoftware.amazon.awssdk.services.invoicing.paginators.ListInvoiceUnitsPublisher publisher = client.listInvoiceUnitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.invoicing.paginators.ListInvoiceUnitsPublisher publisher = client.listInvoiceUnitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsResponse 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
listInvoiceUnits(software.amazon.awssdk.services.invoicing.model.ListInvoiceUnitsRequest)
operation.
This is a convenience which creates an instance of the
ListInvoiceUnitsRequest.Builder
avoiding the need to create one manually viaListInvoiceUnitsRequest.builder()
- Parameters:
listInvoiceUnitsRequest
- AConsumer
that will call methods onListInvoiceUnitsRequest.Builder
to 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for a 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds a tag 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ServiceQuotaExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ServiceQuotaExceededException The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInvoiceUnit
default CompletableFuture<UpdateInvoiceUnitResponse> updateInvoiceUnit(UpdateInvoiceUnitRequest updateInvoiceUnitRequest) You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.
- Parameters:
updateInvoiceUnitRequest
-- Returns:
- A Java Future containing the result of the UpdateInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInvoiceUnit
default CompletableFuture<UpdateInvoiceUnitResponse> updateInvoiceUnit(Consumer<UpdateInvoiceUnitRequest.Builder> updateInvoiceUnitRequest) You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.
This is a convenience which creates an instance of the
UpdateInvoiceUnitRequest.Builder
avoiding the need to create one manually viaUpdateInvoiceUnitRequest.builder()
- Parameters:
updateInvoiceUnitRequest
- AConsumer
that will call methods onUpdateInvoiceUnitRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateInvoiceUnit 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.- ResourceNotFoundException The resource could not be found.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The processing request failed because of an unknown error, exception, or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this action.
- 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.
- InvoicingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aInvoicingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aInvoicingAsyncClient
.
-