@Generated(value="software.amazon.awssdk:codegen") public interface HealthLakeAsyncClient extends SdkClient
builder()
method.
Amazon 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static HealthLakeAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
HealthLakeAsyncClient. |
static HealthLakeAsyncClient |
create()
Create a
HealthLakeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateFhirDatastoreResponse> |
createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest)
Creates a Data Store that can ingest and export FHIR formatted data.
|
default CompletableFuture<CreateFhirDatastoreResponse> |
createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)
Creates a Data Store that can ingest and export FHIR formatted data.
|
default CompletableFuture<DeleteFhirDatastoreResponse> |
deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest)
Deletes a Data Store.
|
default CompletableFuture<DeleteFhirDatastoreResponse> |
deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest)
Deletes a Data Store.
|
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, created at, Data Store type version, and Data Store endpoint.
|
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, created at, Data Store type version, and Data Store endpoint.
|
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.
|
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.
|
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.
|
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.
|
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.
|
default CompletableFuture<ListFhirDatastoresResponse> |
listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
|
default ListFHIRDatastoresPublisher |
listFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
|
default ListFHIRDatastoresPublisher |
listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
|
default CompletableFuture<StartFhirExportJobResponse> |
startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest)
Begins a FHIR export job.
|
default CompletableFuture<StartFhirExportJobResponse> |
startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest)
Begins a FHIR export job.
|
default CompletableFuture<StartFhirImportJobResponse> |
startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest)
Begins a FHIR Import job.
|
default CompletableFuture<StartFhirImportJobResponse> |
startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest)
Begins a FHIR Import job.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static HealthLakeAsyncClient create()
HealthLakeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static HealthLakeAsyncClientBuilder builder()
HealthLakeAsyncClient.default CompletableFuture<CreateFhirDatastoreResponse> createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)
Creates a Data Store that can ingest and export FHIR formatted data.
createFhirDatastoreRequest - 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.Builder avoiding the
need to create one manually via CreateFhirDatastoreRequest.builder()
createFhirDatastoreRequest - A Consumer that will call methods on CreateFHIRDatastoreRequest.Builder to create a
request.default CompletableFuture<DeleteFhirDatastoreResponse> deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest)
Deletes a Data Store.
deleteFhirDatastoreRequest - default CompletableFuture<DeleteFhirDatastoreResponse> deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest)
Deletes a Data Store.
This is a convenience which creates an instance of the DeleteFhirDatastoreRequest.Builder avoiding the
need to create one manually via DeleteFhirDatastoreRequest.builder()
deleteFhirDatastoreRequest - A Consumer that will call methods on DeleteFHIRDatastoreRequest.Builder to create a
request.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, created at, Data Store type version, and Data Store endpoint.
describeFhirDatastoreRequest - 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, created at, Data Store type version, and Data Store endpoint.
This is a convenience which creates an instance of the DescribeFhirDatastoreRequest.Builder avoiding the
need to create one manually via DescribeFhirDatastoreRequest.builder()
describeFhirDatastoreRequest - A Consumer that will call methods on DescribeFHIRDatastoreRequest.Builder to create a
request.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.
describeFhirExportJobRequest - 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.Builder avoiding the
need to create one manually via DescribeFhirExportJobRequest.builder()
describeFhirExportJobRequest - A Consumer that will call methods on DescribeFHIRExportJobRequest.Builder to create a
request.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.
describeFhirImportJobRequest - 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.Builder avoiding the
need to create one manually via DescribeFhirImportJobRequest.builder()
describeFhirImportJobRequest - A Consumer that will call methods on DescribeFHIRImportJobRequest.Builder to create a
request.default CompletableFuture<ListFhirDatastoresResponse> listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
listFhirDatastoresRequest - 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.Builder avoiding the
need to create one manually via ListFhirDatastoresRequest.builder()
listFhirDatastoresRequest - A Consumer that will call methods on ListFHIRDatastoresRequest.Builder to create a
request.default ListFHIRDatastoresPublisher listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
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.
listFhirDatastoresRequest - default ListFHIRDatastoresPublisher listFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)
Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
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()
listFhirDatastoresRequest - A Consumer that will call methods on ListFHIRDatastoresRequest.Builder to create a
request.default CompletableFuture<StartFhirExportJobResponse> startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest)
Begins a FHIR export job.
startFhirExportJobRequest - default CompletableFuture<StartFhirExportJobResponse> startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest)
Begins 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()
startFhirExportJobRequest - A Consumer that will call methods on StartFHIRExportJobRequest.Builder to create a
request.default CompletableFuture<StartFhirImportJobResponse> startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest)
Begins a FHIR Import job.
startFhirImportJobRequest - default CompletableFuture<StartFhirImportJobResponse> startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest)
Begins a FHIR Import job.
This is a convenience which creates an instance of the StartFhirImportJobRequest.Builder avoiding the
need to create one manually via StartFhirImportJobRequest.builder()
startFhirImportJobRequest - A Consumer that will call methods on StartFHIRImportJobRequest.Builder to create a
request.