Package software.amazon.awssdk.services.timestreaminfluxdb

Interface TimestreamInfluxDbAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TimestreamInfluxDbAsyncClient extends AwsClient
Service client for accessing Timestream InfluxDB 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.

Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.

  • Field Details

  • Method Details

    • createDbInstance

      default CompletableFuture<CreateDbInstanceResponse> createDbInstance(CreateDbInstanceRequest createDbInstanceRequest)

      Creates a new Timestream for InfluxDB DB instance.

      Parameters:
      createDbInstanceRequest -
      Returns:
      A Java Future containing the result of the CreateDbInstance 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 The request exceeds the service quota.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDbInstance

      default CompletableFuture<CreateDbInstanceResponse> createDbInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)

      Creates a new Timestream for InfluxDB DB instance.


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

      Parameters:
      createDbInstanceRequest - A Consumer that will call methods on CreateDbInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDbInstance 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 The request exceeds the service quota.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDbParameterGroup

      default CompletableFuture<CreateDbParameterGroupResponse> createDbParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)

      Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

      Parameters:
      createDbParameterGroupRequest -
      Returns:
      A Java Future containing the result of the CreateDbParameterGroup 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 The request exceeds the service quota.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDbParameterGroup

      default CompletableFuture<CreateDbParameterGroupResponse> createDbParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)

      Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.


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

      Parameters:
      createDbParameterGroupRequest - A Consumer that will call methods on CreateDbParameterGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDbParameterGroup 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 The request exceeds the service quota.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDbInstance

      default CompletableFuture<DeleteDbInstanceResponse> deleteDbInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)

      Deletes a Timestream for InfluxDB DB instance.

      Parameters:
      deleteDbInstanceRequest -
      Returns:
      A Java Future containing the result of the DeleteDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDbInstance

      default CompletableFuture<DeleteDbInstanceResponse> deleteDbInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)

      Deletes a Timestream for InfluxDB DB instance.


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

      Parameters:
      deleteDbInstanceRequest - A Consumer that will call methods on DeleteDbInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDbInstance

      default CompletableFuture<GetDbInstanceResponse> getDbInstance(GetDbInstanceRequest getDbInstanceRequest)

      Returns a Timestream for InfluxDB DB instance.

      Parameters:
      getDbInstanceRequest -
      Returns:
      A Java Future containing the result of the GetDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDbInstance

      default CompletableFuture<GetDbInstanceResponse> getDbInstance(Consumer<GetDbInstanceRequest.Builder> getDbInstanceRequest)

      Returns a Timestream for InfluxDB DB instance.


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

      Parameters:
      getDbInstanceRequest - A Consumer that will call methods on GetDbInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDbParameterGroup

      default CompletableFuture<GetDbParameterGroupResponse> getDbParameterGroup(GetDbParameterGroupRequest getDbParameterGroupRequest)

      Returns a Timestream for InfluxDB DB parameter group.

      Parameters:
      getDbParameterGroupRequest -
      Returns:
      A Java Future containing the result of the GetDbParameterGroup 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDbParameterGroup

      default CompletableFuture<GetDbParameterGroupResponse> getDbParameterGroup(Consumer<GetDbParameterGroupRequest.Builder> getDbParameterGroupRequest)

      Returns a Timestream for InfluxDB DB parameter group.


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

      Parameters:
      getDbParameterGroupRequest - A Consumer that will call methods on GetDbParameterGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDbParameterGroup 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbInstances

      default CompletableFuture<ListDbInstancesResponse> listDbInstances(ListDbInstancesRequest listDbInstancesRequest)

      Returns a list of Timestream for InfluxDB DB instances.

      Parameters:
      listDbInstancesRequest -
      Returns:
      A Java Future containing the result of the ListDbInstances 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbInstances

      default CompletableFuture<ListDbInstancesResponse> listDbInstances(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)

      Returns a list of Timestream for InfluxDB DB instances.


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

      Parameters:
      listDbInstancesRequest - A Consumer that will call methods on ListDbInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDbInstances 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbInstancesPaginator

      default ListDbInstancesPublisher listDbInstancesPaginator(ListDbInstancesRequest listDbInstancesRequest)

      This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) 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.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse 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 listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.

      Parameters:
      listDbInstancesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbInstancesPaginator

      default ListDbInstancesPublisher listDbInstancesPaginator(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)

      This is a variant of listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) 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.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse 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 listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest) operation.


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

      Parameters:
      listDbInstancesRequest - A Consumer that will call methods on ListDbInstancesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbParameterGroups

      default CompletableFuture<ListDbParameterGroupsResponse> listDbParameterGroups(ListDbParameterGroupsRequest listDbParameterGroupsRequest)

      Returns a list of Timestream for InfluxDB DB parameter groups.

      Parameters:
      listDbParameterGroupsRequest -
      Returns:
      A Java Future containing the result of the ListDbParameterGroups 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbParameterGroups

      default CompletableFuture<ListDbParameterGroupsResponse> listDbParameterGroups(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)

      Returns a list of Timestream for InfluxDB DB parameter groups.


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

      Parameters:
      listDbParameterGroupsRequest - A Consumer that will call methods on ListDbParameterGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDbParameterGroups 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbParameterGroupsPaginator

      default ListDbParameterGroupsPublisher listDbParameterGroupsPaginator(ListDbParameterGroupsRequest listDbParameterGroupsRequest)

      This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) 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.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse 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 listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.

      Parameters:
      listDbParameterGroupsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDbParameterGroupsPaginator

      default ListDbParameterGroupsPublisher listDbParameterGroupsPaginator(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)

      This is a variant of listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) 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.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse 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 listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest) operation.


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

      Parameters:
      listDbParameterGroupsRequest - A Consumer that will call methods on ListDbParameterGroupsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException 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)

      A list of tags applied to the 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException 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)

      A list of tags applied to the resource.


      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.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException 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)

      Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

      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.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException 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)

      Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.


      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.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException 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 the tag from the specified 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException 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 the tag from the specified resource.


      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.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDbInstance

      default CompletableFuture<UpdateDbInstanceResponse> updateDbInstance(UpdateDbInstanceRequest updateDbInstanceRequest)

      Updates a Timestream for InfluxDB DB instance.

      Parameters:
      updateDbInstanceRequest -
      Returns:
      A Java Future containing the result of the UpdateDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDbInstance

      default CompletableFuture<UpdateDbInstanceResponse> updateDbInstance(Consumer<UpdateDbInstanceRequest.Builder> updateDbInstanceRequest)

      Updates a Timestream for InfluxDB DB instance.


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

      Parameters:
      updateDbInstanceRequest - A Consumer that will call methods on UpdateDbInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDbInstance 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.
      • ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException The request processing has failed because of an unknown error, exception or failure.
      • ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
      • ResourceNotFoundException The requested resource was not found or does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default TimestreamInfluxDbServiceClientConfiguration 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 TimestreamInfluxDbAsyncClient create()
      Create a TimestreamInfluxDbAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static TimestreamInfluxDbAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a TimestreamInfluxDbAsyncClient.