Interface HealthLakeAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
AWS HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic HealthLakeAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aHealthLakeAsyncClient.static HealthLakeAsyncClientcreate()Create aHealthLakeAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest) Creates a data store that can ingest and export FHIR formatted data.createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest) Creates a data store that can ingest and export FHIR formatted data.deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest) Deletes a data store.deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest) Deletes a data store.describeFHIRDatastore(Consumer<DescribeFhirDatastoreRequest.Builder> describeFhirDatastoreRequest) Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.describeFHIRDatastore(DescribeFhirDatastoreRequest describeFhirDatastoreRequest) Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.describeFHIRExportJob(Consumer<DescribeFhirExportJobRequest.Builder> describeFhirExportJobRequest) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.describeFHIRExportJob(DescribeFhirExportJobRequest describeFhirExportJobRequest) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.describeFHIRImportJob(Consumer<DescribeFhirImportJobRequest.Builder> describeFhirImportJobRequest) Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.describeFHIRImportJob(DescribeFhirImportJobRequest describeFhirImportJobRequest) Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.listFHIRDatastores(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest) Lists all FHIR data stores that are in the user’s account, regardless of data store status.listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest) Lists all FHIR data stores that are in the user’s account, regardless of data store status.default ListFHIRDatastoresPublisherlistFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest) This is a variant oflistFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest)operation.default ListFHIRDatastoresPublisherlistFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest) This is a variant oflistFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest)operation.listFHIRExportJobs(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest) Lists all FHIR export jobs associated with an account and their statuses.listFHIRExportJobs(ListFhirExportJobsRequest listFhirExportJobsRequest) Lists all FHIR export jobs associated with an account and their statuses.default ListFHIRExportJobsPublisherlistFHIRExportJobsPaginator(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest) This is a variant oflistFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest)operation.default ListFHIRExportJobsPublisherlistFHIRExportJobsPaginator(ListFhirExportJobsRequest listFhirExportJobsRequest) This is a variant oflistFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest)operation.listFHIRImportJobs(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest) Lists all FHIR import jobs associated with an account and their statuses.listFHIRImportJobs(ListFhirImportJobsRequest listFhirImportJobsRequest) Lists all FHIR import jobs associated with an account and their statuses.default ListFHIRImportJobsPublisherlistFHIRImportJobsPaginator(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest) This is a variant oflistFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest)operation.default ListFHIRImportJobsPublisherlistFHIRImportJobsPaginator(ListFhirImportJobsRequest listFhirImportJobsRequest) This is a variant oflistFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of all existing tags associated with a data store.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of all existing tags associated with a data store.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest) Begins a FHIR export job.startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest) Begins a FHIR export job.startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest) Begins a FHIR Import job.startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest) Begins a FHIR Import job.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a user specified key and value tag to a data store.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds a user specified key and value tag to a data store.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a data store.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a data store.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createFHIRDatastore
default CompletableFuture<CreateFhirDatastoreResponse> createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest) Creates a data store that can ingest and export FHIR formatted data.
- 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 invokeThrowable.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 Unknown error occurs 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) Creates a data store that can ingest and export FHIR formatted data.
This is a convenience which creates an instance of the
CreateFhirDatastoreRequest.Builderavoiding the need to create one manually viaCreateFhirDatastoreRequest.builder()- Parameters:
createFhirDatastoreRequest- AConsumerthat will call methods onCreateFhirDatastoreRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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) Deletes a 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 invokeThrowable.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 can not 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 Unknown error occurs 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) Deletes a data store.
This is a convenience which creates an instance of the
DeleteFhirDatastoreRequest.Builderavoiding the need to create one manually viaDeleteFhirDatastoreRequest.builder()- Parameters:
deleteFhirDatastoreRequest- AConsumerthat will call methods onDeleteFhirDatastoreRequest.Builderto 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 invokeThrowable.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 can not 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 Unknown error occurs 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) Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
- 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 invokeThrowable.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 Unknown error occurs 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) Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
This is a convenience which creates an instance of the
DescribeFhirDatastoreRequest.Builderavoiding the need to create one manually viaDescribeFhirDatastoreRequest.builder()- Parameters:
describeFhirDatastoreRequest- AConsumerthat will call methods onDescribeFhirDatastoreRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
- 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 invokeThrowable.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 Unknown error occurs 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) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
This is a convenience which creates an instance of the
DescribeFhirExportJobRequest.Builderavoiding the need to create one manually viaDescribeFhirExportJobRequest.builder()- Parameters:
describeFhirExportJobRequest- AConsumerthat will call methods onDescribeFhirExportJobRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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) Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
- 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 invokeThrowable.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 Unknown error occurs 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) Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
This is a convenience which creates an instance of the
DescribeFhirImportJobRequest.Builderavoiding the need to create one manually viaDescribeFhirImportJobRequest.builder()- Parameters:
describeFhirImportJobRequest- AConsumerthat will call methods onDescribeFhirImportJobRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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) Lists all FHIR data stores that are in the 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 invokeThrowable.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 Unknown error occurs 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) Lists all FHIR data stores that are in the user’s account, regardless of data store status.
This is a convenience which creates an instance of the
ListFhirDatastoresRequest.Builderavoiding the need to create one manually viaListFhirDatastoresRequest.builder()- Parameters:
listFhirDatastoresRequest- AConsumerthat will call methods onListFhirDatastoresRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresPublisher publisher = client.listFHIRDatastoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresPublisher publisher = client.listFHIRDatastoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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.Builderavoiding the need to create one manually viaListFhirDatastoresRequest.builder()- Parameters:
listFhirDatastoresRequest- AConsumerthat will call methods onListFhirDatastoresRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The user input parameter was invalid.
- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- InternalServerException Unknown error occurs 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 invokeThrowable.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 Unknown error occurs 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.Builderavoiding the need to create one manually viaListFhirExportJobsRequest.builder()- Parameters:
listFhirExportJobsRequest- AConsumerthat will call methods onListFhirExportJobsRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsPublisher publisher = client.listFHIRExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsPublisher publisher = client.listFHIRExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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.Builderavoiding the need to create one manually viaListFhirExportJobsRequest.builder()- Parameters:
listFhirExportJobsRequest- AConsumerthat will call methods onListFhirExportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 Unknown error occurs 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) Lists 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 invokeThrowable.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 Unknown error occurs 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) Lists all FHIR import jobs associated with an account and their statuses.
This is a convenience which creates an instance of the
ListFhirImportJobsRequest.Builderavoiding the need to create one manually viaListFhirImportJobsRequest.builder()- Parameters:
listFhirImportJobsRequest- AConsumerthat will call methods onListFhirImportJobsRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsPublisher publisher = client.listFHIRImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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 invokeThrowable.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 Unknown error occurs 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 newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsPublisher publisher = client.listFHIRImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.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) { //... }; });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.Builderavoiding the need to create one manually viaListFhirImportJobsRequest.builder()- Parameters:
listFhirImportJobsRequest- AConsumerthat will call methods onListFhirImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 Unknown error occurs 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 invokeThrowable.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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Begins 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 invokeThrowable.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 Unknown error occurs 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) Begins a FHIR export job.
This is a convenience which creates an instance of the
StartFhirExportJobRequest.Builderavoiding the need to create one manually viaStartFhirExportJobRequest.builder()- Parameters:
startFhirExportJobRequest- AConsumerthat will call methods onStartFhirExportJobRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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) Begins a FHIR Import job.
- 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 invokeThrowable.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 Unknown error occurs 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) Begins a FHIR Import job.
This is a convenience which creates an instance of the
StartFhirImportJobRequest.Builderavoiding the need to create one manually viaStartFhirImportJobRequest.builder()- Parameters:
startFhirImportJobRequest- AConsumerthat will call methods onStartFhirImportJobRequest.Builderto 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 invokeThrowable.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 Unknown error occurs 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
Adds a user specified 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 invokeThrowable.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) Adds a user specified key and value tag to a data store.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Removes tags 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 invokeThrowable.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) Removes tags from a data store.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aHealthLakeAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aHealthLakeAsyncClient.
-