Interface BcmDataExportsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BcmDataExportsAsyncClient extends AwsClient
Service client for accessing AWS Billing and Cost Management Data Exports asynchronously. This can be created using the static 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.

You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost optimization recommendations.

The Data Exports API provides the following endpoint:

  • https://bcm-data-exports.us-east-1.api.aws

  • Field Details

  • Method Details

    • createExport

      default CompletableFuture<CreateExportResponse> createExport(CreateExportRequest createExportRequest)

      Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

      A DataQuery consists of both a QueryStatement and TableConfigurations.

      The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

      The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

      Parameters:
      createExportRequest -
      Returns:
      A Java Future containing the result of the CreateExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExport

      default CompletableFuture<CreateExportResponse> createExport(Consumer<CreateExportRequest.Builder> createExportRequest)

      Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

      A DataQuery consists of both a QueryStatement and TableConfigurations.

      The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

      The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.


      This is a convenience which creates an instance of the CreateExportRequest.Builder avoiding the need to create one manually via CreateExportRequest.builder()

      Parameters:
      createExportRequest - A Consumer that will call methods on CreateExportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExport

      default CompletableFuture<DeleteExportResponse> deleteExport(DeleteExportRequest deleteExportRequest)

      Deletes an existing data export.

      Parameters:
      deleteExportRequest -
      Returns:
      A Java Future containing the result of the DeleteExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteExport

      default CompletableFuture<DeleteExportResponse> deleteExport(Consumer<DeleteExportRequest.Builder> deleteExportRequest)

      Deletes an existing data export.


      This is a convenience which creates an instance of the DeleteExportRequest.Builder avoiding the need to create one manually via DeleteExportRequest.builder()

      Parameters:
      deleteExportRequest - A Consumer that will call methods on DeleteExportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecution

      default CompletableFuture<GetExecutionResponse> getExecution(GetExecutionRequest getExecutionRequest)

      Exports data based on the source data update.

      Parameters:
      getExecutionRequest -
      Returns:
      A Java Future containing the result of the GetExecution 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecution

      default CompletableFuture<GetExecutionResponse> getExecution(Consumer<GetExecutionRequest.Builder> getExecutionRequest)

      Exports data based on the source data update.


      This is a convenience which creates an instance of the GetExecutionRequest.Builder avoiding the need to create one manually via GetExecutionRequest.builder()

      Parameters:
      getExecutionRequest - A Consumer that will call methods on GetExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetExecution 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExport

      default CompletableFuture<GetExportResponse> getExport(GetExportRequest getExportRequest)

      Views the definition of an existing data export.

      Parameters:
      getExportRequest -
      Returns:
      A Java Future containing the result of the GetExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExport

      default CompletableFuture<GetExportResponse> getExport(Consumer<GetExportRequest.Builder> getExportRequest)

      Views the definition of an existing data export.


      This is a convenience which creates an instance of the GetExportRequest.Builder avoiding the need to create one manually via GetExportRequest.builder()

      Parameters:
      getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTable

      default CompletableFuture<GetTableResponse> getTable(GetTableRequest getTableRequest)

      Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

      Parameters:
      getTableRequest -
      Returns:
      A Java Future containing the result of the GetTable 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTable

      default CompletableFuture<GetTableResponse> getTable(Consumer<GetTableRequest.Builder> getTableRequest)

      Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.


      This is a convenience which creates an instance of the GetTableRequest.Builder avoiding the need to create one manually via GetTableRequest.builder()

      Parameters:
      getTableRequest - A Consumer that will call methods on GetTableRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTable 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

      Lists the historical executions for the export.

      Parameters:
      listExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListExecutions 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      Lists the historical executions for the export.


      This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to create one manually via ListExecutionsRequest.builder()

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExecutions 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.

      Parameters:
      listExecutionsRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listExecutions(software.amazon.awssdk.services.bcmdataexports.model.ListExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to create one manually via ListExecutionsRequest.builder()

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExports

      default CompletableFuture<ListExportsResponse> listExports(ListExportsRequest listExportsRequest)

      Lists all data export definitions.

      Parameters:
      listExportsRequest -
      Returns:
      A Java Future containing the result of the ListExports 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExports

      default CompletableFuture<ListExportsResponse> listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)

      Lists all data export definitions.


      This is a convenience which creates an instance of the ListExportsRequest.Builder avoiding the need to create one manually via ListExportsRequest.builder()

      Parameters:
      listExportsRequest - A Consumer that will call methods on ListExportsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExports 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExportsPaginator

      default ListExportsPublisher listExportsPaginator(ListExportsRequest listExportsRequest)

      This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.

      Parameters:
      listExportsRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExportsPaginator

      default ListExportsPublisher listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)

      This is a variant of listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListExportsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listExports(software.amazon.awssdk.services.bcmdataexports.model.ListExportsRequest) operation.


      This is a convenience which creates an instance of the ListExportsRequest.Builder avoiding the need to create one manually via ListExportsRequest.builder()

      Parameters:
      listExportsRequest - A Consumer that will call methods on ListExportsRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTables

      default CompletableFuture<ListTablesResponse> listTables(ListTablesRequest listTablesRequest)

      Lists all available tables in data exports.

      Parameters:
      listTablesRequest -
      Returns:
      A Java Future containing the result of the ListTables 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTables

      default CompletableFuture<ListTablesResponse> listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)

      Lists all available tables in data exports.


      This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to create one manually via ListTablesRequest.builder()

      Parameters:
      listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTables 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTablesPaginator

      default ListTablesPublisher listTablesPaginator(ListTablesRequest listTablesRequest)

      This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.

      Parameters:
      listTablesRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTablesPaginator

      default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)

      This is a variant of listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) 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 new Subscription 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 method 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bcmdataexports.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bcmdataexports.model.ListTablesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listTables(software.amazon.awssdk.services.bcmdataexports.model.ListTablesRequest) operation.


      This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to create one manually via ListTablesRequest.builder()

      Parameters:
      listTablesRequest - A Consumer that will call methods on ListTablesRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException 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)

      List tags associated with an existing data export.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException 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)

      List tags associated with an existing data export.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds tags for an existing data export definition.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException 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 tags for an existing data export definition.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException 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)

      Deletes tags associated with an existing data export definition.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException 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)

      Deletes tags associated with an existing data export definition.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExport

      default CompletableFuture<UpdateExportResponse> updateExport(UpdateExportRequest updateExportRequest)

      Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

      Parameters:
      updateExportRequest -
      Returns:
      A Java Future containing the result of the UpdateExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateExport

      default CompletableFuture<UpdateExportResponse> updateExport(Consumer<UpdateExportRequest.Builder> updateExportRequest)

      Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.


      This is a convenience which creates an instance of the UpdateExportRequest.Builder avoiding the need to create one manually via UpdateExportRequest.builder()

      Parameters:
      updateExportRequest - A Consumer that will call methods on UpdateExportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateExport 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException An error on the server occurred during the processing of your request. Try again later.
      • ResourceNotFoundException The specified Amazon Resource Name (ARN) in the request doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • BcmDataExportsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BcmDataExportsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static BcmDataExportsAsyncClient create()
      Create a BcmDataExportsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BcmDataExportsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BcmDataExportsAsyncClient.