Interface HealthLakeAsyncClient

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

This is the AWS HealthLake API Reference. For an introduction to the service, see What is AWS HealthLake? in the AWS HealthLake Developer Guide.

  • Field Details

  • Method Details

    • createFHIRDatastore

      default CompletableFuture<CreateFhirDatastoreResponse> createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)

      Create a FHIR-enabled data store.

      Parameters:
      createFhirDatastoreRequest -
      Returns:
      A Java Future containing the result of the CreateFHIRDatastore 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFHIRDatastore

      default CompletableFuture<CreateFhirDatastoreResponse> createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest)

      Create a FHIR-enabled data store.


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

      Parameters:
      createFhirDatastoreRequest - A Consumer that will call methods on CreateFhirDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFHIRDatastore 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFHIRDatastore

      default CompletableFuture<DeleteFhirDatastoreResponse> deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest)

      Delete a FHIR-enabled data store.

      Parameters:
      deleteFhirDatastoreRequest -
      Returns:
      A Java Future containing the result of the DeleteFHIRDatastore 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.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ConflictException The data store is in a transition state and the user requested action cannot be performed.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFHIRDatastore

      default CompletableFuture<DeleteFhirDatastoreResponse> deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest)

      Delete a FHIR-enabled data store.


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

      Parameters:
      deleteFhirDatastoreRequest - A Consumer that will call methods on DeleteFhirDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFHIRDatastore 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.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ConflictException The data store is in a transition state and the user requested action cannot be performed.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRDatastore

      default CompletableFuture<DescribeFhirDatastoreResponse> describeFHIRDatastore(DescribeFhirDatastoreRequest describeFhirDatastoreRequest)

      Get properties for a FHIR-enabled data store.

      Parameters:
      describeFhirDatastoreRequest -
      Returns:
      A Java Future containing the result of the DescribeFHIRDatastore 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRDatastore

      default CompletableFuture<DescribeFhirDatastoreResponse> describeFHIRDatastore(Consumer<DescribeFhirDatastoreRequest.Builder> describeFhirDatastoreRequest)

      Get properties for a FHIR-enabled data store.


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

      Parameters:
      describeFhirDatastoreRequest - A Consumer that will call methods on DescribeFhirDatastoreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFHIRDatastore 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRExportJob

      default CompletableFuture<DescribeFhirExportJobResponse> describeFHIRExportJob(DescribeFhirExportJobRequest describeFhirExportJobRequest)

      Get FHIR export job properties.

      Parameters:
      describeFhirExportJobRequest -
      Returns:
      A Java Future containing the result of the DescribeFHIRExportJob 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRExportJob

      default CompletableFuture<DescribeFhirExportJobResponse> describeFHIRExportJob(Consumer<DescribeFhirExportJobRequest.Builder> describeFhirExportJobRequest)

      Get FHIR export job properties.


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

      Parameters:
      describeFhirExportJobRequest - A Consumer that will call methods on DescribeFhirExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFHIRExportJob 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRImportJob

      default CompletableFuture<DescribeFhirImportJobResponse> describeFHIRImportJob(DescribeFhirImportJobRequest describeFhirImportJobRequest)

      Get the import job properties to learn more about the job or job progress.

      Parameters:
      describeFhirImportJobRequest -
      Returns:
      A Java Future containing the result of the DescribeFHIRImportJob 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFHIRImportJob

      default CompletableFuture<DescribeFhirImportJobResponse> describeFHIRImportJob(Consumer<DescribeFhirImportJobRequest.Builder> describeFhirImportJobRequest)

      Get the import job properties to learn more about the job or job progress.


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

      Parameters:
      describeFhirImportJobRequest - A Consumer that will call methods on DescribeFhirImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFHIRImportJob 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRDatastores

      default CompletableFuture<ListFhirDatastoresResponse> listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest)

      List all FHIR-enabled data stores in a user’s account, regardless of data store status.

      Parameters:
      listFhirDatastoresRequest -
      Returns:
      A Java Future containing the result of the ListFHIRDatastores 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRDatastores

      default CompletableFuture<ListFhirDatastoresResponse> listFHIRDatastores(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)

      List all FHIR-enabled data stores in a user’s account, regardless of data store status.


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

      Parameters:
      listFhirDatastoresRequest - A Consumer that will call methods on ListFhirDatastoresRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFHIRDatastores 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRDatastoresPaginator

      default ListFHIRDatastoresPublisher listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest)

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

      Parameters:
      listFhirDatastoresRequest -
      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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRDatastoresPaginator

      default ListFHIRDatastoresPublisher listFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)

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


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

      Parameters:
      listFhirDatastoresRequest - A Consumer that will call methods on ListFhirDatastoresRequest.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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRExportJobs

      default CompletableFuture<ListFhirExportJobsResponse> listFHIRExportJobs(ListFhirExportJobsRequest listFhirExportJobsRequest)

      Lists all FHIR export jobs associated with an account and their statuses.

      Parameters:
      listFhirExportJobsRequest -
      Returns:
      A Java Future containing the result of the ListFHIRExportJobs 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRExportJobs

      default CompletableFuture<ListFhirExportJobsResponse> listFHIRExportJobs(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)

      Lists all FHIR export jobs associated with an account and their statuses.


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

      Parameters:
      listFhirExportJobsRequest - A Consumer that will call methods on ListFhirExportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFHIRExportJobs 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRExportJobsPaginator

      default ListFHIRExportJobsPublisher listFHIRExportJobsPaginator(ListFhirExportJobsRequest listFhirExportJobsRequest)

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

      Parameters:
      listFhirExportJobsRequest -
      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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRExportJobsPaginator

      default ListFHIRExportJobsPublisher listFHIRExportJobsPaginator(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)

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


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

      Parameters:
      listFhirExportJobsRequest - A Consumer that will call methods on ListFhirExportJobsRequest.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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRImportJobs

      default CompletableFuture<ListFhirImportJobsResponse> listFHIRImportJobs(ListFhirImportJobsRequest listFhirImportJobsRequest)

      List all FHIR import jobs associated with an account and their statuses.

      Parameters:
      listFhirImportJobsRequest -
      Returns:
      A Java Future containing the result of the ListFHIRImportJobs 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRImportJobs

      default CompletableFuture<ListFhirImportJobsResponse> listFHIRImportJobs(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)

      List all FHIR import jobs associated with an account and their statuses.


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

      Parameters:
      listFhirImportJobsRequest - A Consumer that will call methods on ListFhirImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFHIRImportJobs 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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRImportJobsPaginator

      default ListFHIRImportJobsPublisher listFHIRImportJobsPaginator(ListFhirImportJobsRequest listFhirImportJobsRequest)

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

      Parameters:
      listFhirImportJobsRequest -
      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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFHIRImportJobsPaginator

      default ListFHIRImportJobsPublisher listFHIRImportJobsPaginator(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)

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


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

      Parameters:
      listFhirImportJobsRequest - A Consumer that will call methods on ListFhirImportJobsRequest.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 user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException 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)

      Returns a list of all existing tags associated with a data store.

      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException 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)

      Returns a list of all existing tags associated with a data store.


      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFHIRExportJob

      default CompletableFuture<StartFhirExportJobResponse> startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest)

      Start a FHIR export job.

      Parameters:
      startFhirExportJobRequest -
      Returns:
      A Java Future containing the result of the StartFHIRExportJob 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ResourceNotFoundException The requested data store was not found.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFHIRExportJob

      default CompletableFuture<StartFhirExportJobResponse> startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest)

      Start a FHIR export job.


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

      Parameters:
      startFhirExportJobRequest - A Consumer that will call methods on StartFhirExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartFHIRExportJob 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ResourceNotFoundException The requested data store was not found.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFHIRImportJob

      default CompletableFuture<StartFhirImportJobResponse> startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest)

      Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

      Parameters:
      startFhirImportJobRequest -
      Returns:
      A Java Future containing the result of the StartFHIRImportJob 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ResourceNotFoundException The requested data store was not found.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFHIRImportJob

      default CompletableFuture<StartFhirImportJobResponse> startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest)

      Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.


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

      Parameters:
      startFhirImportJobRequest - A Consumer that will call methods on StartFhirImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartFHIRImportJob 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 user input parameter was invalid.
      • ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
      • AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
      • ResourceNotFoundException The requested data store was not found.
      • InternalServerException An unknown internal error occurred in the 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.
      • HealthLakeException 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)

      Add a user-specifed key and value tag to a data store.

      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException 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)

      Add a user-specifed key and value tag to a data store.


      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException 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)

      Remove a user-specifed key and value tag from a data store.

      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException 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)

      Remove a user-specifed key and value tag from a data store.


      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.
      • ValidationException The user input parameter was invalid.
      • ResourceNotFoundException The requested data store was not found.
      • 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.
      • HealthLakeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default HealthLakeAsyncWaiter waiter()
      Create an instance of HealthLakeAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of HealthLakeAsyncWaiter

    • serviceClientConfiguration

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

    • builder

      static HealthLakeAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a HealthLakeAsyncClient.