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.
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 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.createDataTransformationProfile(Consumer<CreateDataTransformationProfileRequest.Builder> createDataTransformationProfileRequest) Creates a data transformation profile in DRAFT state.createDataTransformationProfile(CreateDataTransformationProfileRequest createDataTransformationProfileRequest) Creates a data transformation profile in DRAFT state.createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest) Create a FHIR-enabled data store.createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest) Create a FHIR-enabled data store.deleteDataTransformationProfile(Consumer<DeleteDataTransformationProfileRequest.Builder> deleteDataTransformationProfileRequest) Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.deleteDataTransformationProfile(DeleteDataTransformationProfileRequest deleteDataTransformationProfileRequest) Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest) Delete a FHIR-enabled data store.deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest) Delete a FHIR-enabled data store.describeDataTransformationJob(Consumer<DescribeDataTransformationJobRequest.Builder> describeDataTransformationJobRequest) Describes a data transformation job, including its current status, configuration, and progress information.describeDataTransformationJob(DescribeDataTransformationJobRequest describeDataTransformationJobRequest) Describes a data transformation job, including its current status, configuration, and progress information.describeFHIRDatastore(Consumer<DescribeFhirDatastoreRequest.Builder> describeFhirDatastoreRequest) Get properties for a FHIR-enabled data store.describeFHIRDatastore(DescribeFhirDatastoreRequest describeFhirDatastoreRequest) Get properties for a FHIR-enabled data store.describeFHIRExportJob(Consumer<DescribeFhirExportJobRequest.Builder> describeFhirExportJobRequest) Get FHIR export job properties.describeFHIRExportJob(DescribeFhirExportJobRequest describeFhirExportJobRequest) Get FHIR export job properties.describeFHIRImportJob(Consumer<DescribeFhirImportJobRequest.Builder> describeFhirImportJobRequest) Get the import job properties to learn more about the job or job progress.describeFHIRImportJob(DescribeFhirImportJobRequest describeFhirImportJobRequest) Get the import job properties to learn more about the job or job progress.getDataTransformationProfile(Consumer<GetDataTransformationProfileRequest.Builder> getDataTransformationProfileRequest) Retrieves a data transformation profile's metadata and profile content at a specific version.getDataTransformationProfile(GetDataTransformationProfileRequest getDataTransformationProfileRequest) Retrieves a data transformation profile's metadata and profile content at a specific version.listDataTransformationJobs(Consumer<ListDataTransformationJobsRequest.Builder> listDataTransformationJobsRequest) Lists data transformation jobs for your AWS account.listDataTransformationJobs(ListDataTransformationJobsRequest listDataTransformationJobsRequest) Lists data transformation jobs for your AWS account.listDataTransformationJobsPaginator(Consumer<ListDataTransformationJobsRequest.Builder> listDataTransformationJobsRequest) This is a variant oflistDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)operation.listDataTransformationJobsPaginator(ListDataTransformationJobsRequest listDataTransformationJobsRequest) This is a variant oflistDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)operation.listDataTransformationProfiles(Consumer<ListDataTransformationProfilesRequest.Builder> listDataTransformationProfilesRequest) Lists all data transformation profiles in your account, returning the latest version summary for each.listDataTransformationProfiles(ListDataTransformationProfilesRequest listDataTransformationProfilesRequest) Lists all data transformation profiles in your account, returning the latest version summary for each.listDataTransformationProfilesPaginator(Consumer<ListDataTransformationProfilesRequest.Builder> listDataTransformationProfilesRequest) This is a variant oflistDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)operation.listDataTransformationProfilesPaginator(ListDataTransformationProfilesRequest listDataTransformationProfilesRequest) This is a variant oflistDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)operation.listDataTransformationProfileVersions(Consumer<ListDataTransformationProfileVersionsRequest.Builder> listDataTransformationProfileVersionsRequest) Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first).listDataTransformationProfileVersions(ListDataTransformationProfileVersionsRequest listDataTransformationProfileVersionsRequest) Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first).listDataTransformationProfileVersionsPaginator(Consumer<ListDataTransformationProfileVersionsRequest.Builder> listDataTransformationProfileVersionsRequest) listDataTransformationProfileVersionsPaginator(ListDataTransformationProfileVersionsRequest listDataTransformationProfileVersionsRequest) listFHIRDatastores(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest) List all FHIR-enabled data stores in a user’s account, regardless of data store status.listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest) List all FHIR-enabled data stores in a 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) List all FHIR import jobs associated with an account and their statuses.listFHIRImportJobs(ListFhirImportJobsRequest listFhirImportJobsRequest) List 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.publishDataTransformationProfile(Consumer<PublishDataTransformationProfileRequest.Builder> publishDataTransformationProfileRequest) Promotes the current DRAFT version of a data transformation profile to a new immutable published version.publishDataTransformationProfile(PublishDataTransformationProfileRequest publishDataTransformationProfileRequest) Promotes the current DRAFT version of a data transformation profile to a new immutable published version.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartDataTransformationJob(Consumer<StartDataTransformationJobRequest.Builder> startDataTransformationJobRequest) Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.startDataTransformationJob(StartDataTransformationJobRequest startDataTransformationJobRequest) Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest) Start a FHIR export job.startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest) Start a FHIR export job.startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest) Start importing bulk FHIR data into an ACTIVE data store.startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest) Start importing bulk FHIR data into an ACTIVE data store.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Add a user-specifed key and value tag to a data store.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Add a user-specifed key and value tag to a data store.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove a user-specifed key and value tag from a data store.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove a user-specifed key and value tag from a data store.updateDataTransformationProfile(Consumer<UpdateDataTransformationProfileRequest.Builder> updateDataTransformationProfileRequest) Updates the DRAFT version (version 0) of a data transformation profile with new profile content.updateDataTransformationProfile(UpdateDataTransformationProfileRequest updateDataTransformationProfileRequest) Updates the DRAFT version (version 0) of a data transformation profile with new profile content.updateFHIRDatastore(Consumer<UpdateFhirDatastoreRequest.Builder> updateFhirDatastoreRequest) Update the properties of a FHIR-enabled data store.updateFHIRDatastore(UpdateFhirDatastoreRequest updateFhirDatastoreRequest) Update the properties of a FHIR-enabled data store.updateProfileWithAgent(Consumer<UpdateProfileWithAgentRequest.Builder> updateProfileWithAgentRequest) Updates a data transformation profile using chat-based interaction with an agent.updateProfileWithAgent(UpdateProfileWithAgentRequest updateProfileWithAgentRequest) Updates a data transformation profile using chat-based interaction with an agent.default HealthLakeAsyncWaiterwaiter()Create an instance ofHealthLakeAsyncWaiterusing this client.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
-
createDataTransformationProfile
default CompletableFuture<CreateDataTransformationProfileResponse> createDataTransformationProfile(CreateDataTransformationProfileRequest createDataTransformationProfileRequest) Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.
- Parameters:
createDataTransformationProfileRequest- The request parameters for theCreateDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the CreateDataTransformationProfile 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.- ServiceQuotaExceededException The request exceeds the service quota.
- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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:
-
createDataTransformationProfile
default CompletableFuture<CreateDataTransformationProfileResponse> createDataTransformationProfile(Consumer<CreateDataTransformationProfileRequest.Builder> createDataTransformationProfileRequest) Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.
This is a convenience which creates an instance of the
CreateDataTransformationProfileRequest.Builderavoiding the need to create one manually viaCreateDataTransformationProfileRequest.builder()- Parameters:
createDataTransformationProfileRequest- AConsumerthat will call methods onCreateDataTransformationProfileRequest.Builderto create a request. The request parameters for theCreateDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the CreateDataTransformationProfile 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.- ServiceQuotaExceededException The request exceeds the service quota.
- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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(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 invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- ValidationException The user input parameter was invalid.
- 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.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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
deleteDataTransformationProfile
default CompletableFuture<DeleteDataTransformationProfileResponse> deleteDataTransformationProfile(DeleteDataTransformationProfileRequest deleteDataTransformationProfileRequest) Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
- Parameters:
deleteDataTransformationProfileRequest- The request parameters for theDeleteDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the DeleteDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
deleteDataTransformationProfile
default CompletableFuture<DeleteDataTransformationProfileResponse> deleteDataTransformationProfile(Consumer<DeleteDataTransformationProfileRequest.Builder> deleteDataTransformationProfileRequest) Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
This is a convenience which creates an instance of the
DeleteDataTransformationProfileRequest.Builderavoiding the need to create one manually viaDeleteDataTransformationProfileRequest.builder()- Parameters:
deleteDataTransformationProfileRequest- AConsumerthat will call methods onDeleteDataTransformationProfileRequest.Builderto create a request. The request parameters for theDeleteDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the DeleteDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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.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.- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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:
-
describeDataTransformationJob
default CompletableFuture<DescribeDataTransformationJobResponse> describeDataTransformationJob(DescribeDataTransformationJobRequest describeDataTransformationJobRequest) Describes a data transformation job, including its current status, configuration, and progress information.
- Parameters:
describeDataTransformationJobRequest- The request parameters for theDescribeDataTransformationJoboperation.- Returns:
- A Java Future containing the result of the DescribeDataTransformationJob 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
describeDataTransformationJob
default CompletableFuture<DescribeDataTransformationJobResponse> describeDataTransformationJob(Consumer<DescribeDataTransformationJobRequest.Builder> describeDataTransformationJobRequest) Describes a data transformation job, including its current status, configuration, and progress information.
This is a convenience which creates an instance of the
DescribeDataTransformationJobRequest.Builderavoiding the need to create one manually viaDescribeDataTransformationJobRequest.builder()- Parameters:
describeDataTransformationJobRequest- AConsumerthat will call methods onDescribeDataTransformationJobRequest.Builderto create a request. The request parameters for theDescribeDataTransformationJoboperation.- Returns:
- A Java Future containing the result of the DescribeDataTransformationJob 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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:
-
getDataTransformationProfile
default CompletableFuture<GetDataTransformationProfileResponse> getDataTransformationProfile(GetDataTransformationProfileRequest getDataTransformationProfileRequest) Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.
- Parameters:
getDataTransformationProfileRequest- The request parameters for theGetDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the GetDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
getDataTransformationProfile
default CompletableFuture<GetDataTransformationProfileResponse> getDataTransformationProfile(Consumer<GetDataTransformationProfileRequest.Builder> getDataTransformationProfileRequest) Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.
This is a convenience which creates an instance of the
GetDataTransformationProfileRequest.Builderavoiding the need to create one manually viaGetDataTransformationProfileRequest.builder()- Parameters:
getDataTransformationProfileRequest- AConsumerthat will call methods onGetDataTransformationProfileRequest.Builderto create a request. The request parameters for theGetDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the GetDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationJobs
default CompletableFuture<ListDataTransformationJobsResponse> listDataTransformationJobs(ListDataTransformationJobsRequest listDataTransformationJobsRequest) Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the
NextTokenparameter to retrieve additional results.- Parameters:
listDataTransformationJobsRequest- The request parameters for theListDataTransformationJobsoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationJobs 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationJobs
default CompletableFuture<ListDataTransformationJobsResponse> listDataTransformationJobs(Consumer<ListDataTransformationJobsRequest.Builder> listDataTransformationJobsRequest) Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the
NextTokenparameter to retrieve additional results.
This is a convenience which creates an instance of the
ListDataTransformationJobsRequest.Builderavoiding the need to create one manually viaListDataTransformationJobsRequest.builder()- Parameters:
listDataTransformationJobsRequest- AConsumerthat will call methods onListDataTransformationJobsRequest.Builderto create a request. The request parameters for theListDataTransformationJobsoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationJobs 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationJobsPaginator
default ListDataTransformationJobsPublisher listDataTransformationJobsPaginator(ListDataTransformationJobsRequest listDataTransformationJobsRequest) This is a variant of
listDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)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.ListDataTransformationJobsPublisher publisher = client.listDataTransformationJobsPaginator(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.ListDataTransformationJobsPublisher publisher = client.listDataTransformationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsResponse 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
listDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)operation.- Parameters:
listDataTransformationJobsRequest- The request parameters for theListDataTransformationJobsoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationJobsPaginator
default ListDataTransformationJobsPublisher listDataTransformationJobsPaginator(Consumer<ListDataTransformationJobsRequest.Builder> listDataTransformationJobsRequest) This is a variant of
listDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)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.ListDataTransformationJobsPublisher publisher = client.listDataTransformationJobsPaginator(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.ListDataTransformationJobsPublisher publisher = client.listDataTransformationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsResponse 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
listDataTransformationJobs(software.amazon.awssdk.services.healthlake.model.ListDataTransformationJobsRequest)operation.
This is a convenience which creates an instance of the
ListDataTransformationJobsRequest.Builderavoiding the need to create one manually viaListDataTransformationJobsRequest.builder()- Parameters:
listDataTransformationJobsRequest- AConsumerthat will call methods onListDataTransformationJobsRequest.Builderto create a request. The request parameters for theListDataTransformationJobsoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfileVersions
default CompletableFuture<ListDataTransformationProfileVersionsResponse> listDataTransformationProfileVersions(ListDataTransformationProfileVersionsRequest listDataTransformationProfileVersionsRequest) Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use
GetDataTransformationProfileto retrieve profile content. Results are paginated. Use theNextTokenparameter to retrieve additional results.- Parameters:
listDataTransformationProfileVersionsRequest- The request parameters for theListDataTransformationProfileVersionsoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationProfileVersions 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfileVersions
default CompletableFuture<ListDataTransformationProfileVersionsResponse> listDataTransformationProfileVersions(Consumer<ListDataTransformationProfileVersionsRequest.Builder> listDataTransformationProfileVersionsRequest) Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use
GetDataTransformationProfileto retrieve profile content. Results are paginated. Use theNextTokenparameter to retrieve additional results.
This is a convenience which creates an instance of the
ListDataTransformationProfileVersionsRequest.Builderavoiding the need to create one manually viaListDataTransformationProfileVersionsRequest.builder()- Parameters:
listDataTransformationProfileVersionsRequest- AConsumerthat will call methods onListDataTransformationProfileVersionsRequest.Builderto create a request. The request parameters for theListDataTransformationProfileVersionsoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationProfileVersions 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfileVersionsPaginator
default ListDataTransformationProfileVersionsPublisher listDataTransformationProfileVersionsPaginator(ListDataTransformationProfileVersionsRequest listDataTransformationProfileVersionsRequest) This is a variant of
listDataTransformationProfileVersions(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsRequest)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.ListDataTransformationProfileVersionsPublisher publisher = client.listDataTransformationProfileVersionsPaginator(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.ListDataTransformationProfileVersionsPublisher publisher = client.listDataTransformationProfileVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsResponse 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
listDataTransformationProfileVersions(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsRequest)operation.- Parameters:
listDataTransformationProfileVersionsRequest- The request parameters for theListDataTransformationProfileVersionsoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfileVersionsPaginator
default ListDataTransformationProfileVersionsPublisher listDataTransformationProfileVersionsPaginator(Consumer<ListDataTransformationProfileVersionsRequest.Builder> listDataTransformationProfileVersionsRequest) This is a variant of
listDataTransformationProfileVersions(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsRequest)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.ListDataTransformationProfileVersionsPublisher publisher = client.listDataTransformationProfileVersionsPaginator(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.ListDataTransformationProfileVersionsPublisher publisher = client.listDataTransformationProfileVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsResponse 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
listDataTransformationProfileVersions(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfileVersionsRequest)operation.
This is a convenience which creates an instance of the
ListDataTransformationProfileVersionsRequest.Builderavoiding the need to create one manually viaListDataTransformationProfileVersionsRequest.builder()- Parameters:
listDataTransformationProfileVersionsRequest- AConsumerthat will call methods onListDataTransformationProfileVersionsRequest.Builderto create a request. The request parameters for theListDataTransformationProfileVersionsoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfiles
default CompletableFuture<ListDataTransformationProfilesResponse> listDataTransformationProfiles(ListDataTransformationProfilesRequest listDataTransformationProfilesRequest) Lists all data transformation profiles in your account, returning the latest version summary for each. Use
GetDataTransformationProfileto retrieve profile content. Results are paginated. Use theNextTokenparameter to retrieve additional results.- Parameters:
listDataTransformationProfilesRequest- The request parameters for theListDataTransformationProfilesoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationProfiles 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfiles
default CompletableFuture<ListDataTransformationProfilesResponse> listDataTransformationProfiles(Consumer<ListDataTransformationProfilesRequest.Builder> listDataTransformationProfilesRequest) Lists all data transformation profiles in your account, returning the latest version summary for each. Use
GetDataTransformationProfileto retrieve profile content. Results are paginated. Use theNextTokenparameter to retrieve additional results.
This is a convenience which creates an instance of the
ListDataTransformationProfilesRequest.Builderavoiding the need to create one manually viaListDataTransformationProfilesRequest.builder()- Parameters:
listDataTransformationProfilesRequest- AConsumerthat will call methods onListDataTransformationProfilesRequest.Builderto create a request. The request parameters for theListDataTransformationProfilesoperation.- Returns:
- A Java Future containing the result of the ListDataTransformationProfiles 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfilesPaginator
default ListDataTransformationProfilesPublisher listDataTransformationProfilesPaginator(ListDataTransformationProfilesRequest listDataTransformationProfilesRequest) This is a variant of
listDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)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.ListDataTransformationProfilesPublisher publisher = client.listDataTransformationProfilesPaginator(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.ListDataTransformationProfilesPublisher publisher = client.listDataTransformationProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesResponse 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
listDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)operation.- Parameters:
listDataTransformationProfilesRequest- The request parameters for theListDataTransformationProfilesoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
listDataTransformationProfilesPaginator
default ListDataTransformationProfilesPublisher listDataTransformationProfilesPaginator(Consumer<ListDataTransformationProfilesRequest.Builder> listDataTransformationProfilesRequest) This is a variant of
listDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)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.ListDataTransformationProfilesPublisher publisher = client.listDataTransformationProfilesPaginator(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.ListDataTransformationProfilesPublisher publisher = client.listDataTransformationProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesResponse 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
listDataTransformationProfiles(software.amazon.awssdk.services.healthlake.model.ListDataTransformationProfilesRequest)operation.
This is a convenience which creates an instance of the
ListDataTransformationProfilesRequest.Builderavoiding the need to create one manually viaListDataTransformationProfilesRequest.builder()- Parameters:
listDataTransformationProfilesRequest- AConsumerthat will call methods onListDataTransformationProfilesRequest.Builderto create a request. The request parameters for theListDataTransformationProfilesoperation.- 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ValidationException The user input parameter was invalid.
- 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.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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ValidationException The user input parameter was invalid.
- 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 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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ValidationException The user input parameter was invalid.
- 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 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.- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- ValidationException The user input parameter was invalid.
- 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.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.- 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.
- ValidationException The user input parameter was invalid.
- 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 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- ValidationException The user input parameter was invalid.
- 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.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.- 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.
- ValidationException The user input parameter was invalid.
- 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 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 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.- 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.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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:
-
publishDataTransformationProfile
default CompletableFuture<PublishDataTransformationProfileResponse> publishDataTransformationProfile(PublishDataTransformationProfileRequest publishDataTransformationProfileRequest) Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.
- Parameters:
publishDataTransformationProfileRequest- The request parameters for thePublishDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the PublishDataTransformationProfile 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.- ServiceQuotaExceededException The request exceeds the service quota.
- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
publishDataTransformationProfile
default CompletableFuture<PublishDataTransformationProfileResponse> publishDataTransformationProfile(Consumer<PublishDataTransformationProfileRequest.Builder> publishDataTransformationProfileRequest) Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.
This is a convenience which creates an instance of the
PublishDataTransformationProfileRequest.Builderavoiding the need to create one manually viaPublishDataTransformationProfileRequest.builder()- Parameters:
publishDataTransformationProfileRequest- AConsumerthat will call methods onPublishDataTransformationProfileRequest.Builderto create a request. The request parameters for thePublishDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the PublishDataTransformationProfile 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.- ServiceQuotaExceededException The request exceeds the service quota.
- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
startDataTransformationJob
default CompletableFuture<StartDataTransformationJobResponse> startDataTransformationJob(StartDataTransformationJobRequest startDataTransformationJobRequest) Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.
- Parameters:
startDataTransformationJobRequest- The request parameters for theStartDataTransformationJoboperation.- Returns:
- A Java Future containing the result of the StartDataTransformationJob 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
startDataTransformationJob
default CompletableFuture<StartDataTransformationJobResponse> startDataTransformationJob(Consumer<StartDataTransformationJobRequest.Builder> startDataTransformationJobRequest) Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.
This is a convenience which creates an instance of the
StartDataTransformationJobRequest.Builderavoiding the need to create one manually viaStartDataTransformationJobRequest.builder()- Parameters:
startDataTransformationJobRequest- AConsumerthat will call methods onStartDataTransformationJobRequest.Builderto create a request. The request parameters for theStartDataTransformationJoboperation.- Returns:
- A Java Future containing the result of the StartDataTransformationJob 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.- 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.
- ValidationException The user input parameter was invalid.
- 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(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 invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- FailedDependencyException A dependent service failed to fulfill the request.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- 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.
- FailedDependencyException A dependent service failed to fulfill the request.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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
InputDataConfigobject and stores processing results in theJobOutputDataConfigobject.- 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.- 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.
- FailedDependencyException A dependent service failed to fulfill the request.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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
InputDataConfigobject and stores processing results in theJobOutputDataConfigobject.
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.- 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.
- FailedDependencyException A dependent service failed to fulfill the request.
- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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
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 invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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.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.- ResourceNotFoundException The requested data store was not found.
- ValidationException The user input parameter was invalid.
- 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:
-
updateDataTransformationProfile
default CompletableFuture<UpdateDataTransformationProfileResponse> updateDataTransformationProfile(UpdateDataTransformationProfileRequest updateDataTransformationProfileRequest) Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
- Parameters:
updateDataTransformationProfileRequest- The request parameters for theUpdateDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the UpdateDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
updateDataTransformationProfile
default CompletableFuture<UpdateDataTransformationProfileResponse> updateDataTransformationProfile(Consumer<UpdateDataTransformationProfileRequest.Builder> updateDataTransformationProfileRequest) Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
This is a convenience which creates an instance of the
UpdateDataTransformationProfileRequest.Builderavoiding the need to create one manually viaUpdateDataTransformationProfileRequest.builder()- Parameters:
updateDataTransformationProfileRequest- AConsumerthat will call methods onUpdateDataTransformationProfileRequest.Builderto create a request. The request parameters for theUpdateDataTransformationProfileoperation.- Returns:
- A Java Future containing the result of the UpdateDataTransformationProfile 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.- 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.
- ValidationException The user input parameter was invalid.
- 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:
-
updateFHIRDatastore
default CompletableFuture<UpdateFhirDatastoreResponse> updateFHIRDatastore(UpdateFhirDatastoreRequest updateFhirDatastoreRequest) Update the properties of a FHIR-enabled data store.
- Parameters:
updateFhirDatastoreRequest-- Returns:
- A Java Future containing the result of the UpdateFHIRDatastore 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.- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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:
-
updateFHIRDatastore
default CompletableFuture<UpdateFhirDatastoreResponse> updateFHIRDatastore(Consumer<UpdateFhirDatastoreRequest.Builder> updateFhirDatastoreRequest) Update the properties of a FHIR-enabled data store.
This is a convenience which creates an instance of the
UpdateFhirDatastoreRequest.Builderavoiding the need to create one manually viaUpdateFhirDatastoreRequest.builder()- Parameters:
updateFhirDatastoreRequest- AConsumerthat will call methods onUpdateFhirDatastoreRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFHIRDatastore 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.- 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.
- ConflictException The data store is in a transition state and the user requested action cannot be performed.
- ValidationException The user input parameter was invalid.
- 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:
-
updateProfileWithAgent
default CompletableFuture<UpdateProfileWithAgentResponse> updateProfileWithAgent(UpdateProfileWithAgentRequest updateProfileWithAgentRequest) Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.
- Parameters:
updateProfileWithAgentRequest- The request parameters for theUpdateProfileWithAgentoperation.- Returns:
- A Java Future containing the result of the UpdateProfileWithAgent 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.- NotImplementedOperationException The requested operation is not yet available. Check the service documentation for a list of supported operations.
- ConversationNotFoundException The specified conversation identifier does not exist. Verify the conversation ID or omit it to start a new conversation.
- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- AgentMessageOutOfContextException The agent message does not fit within the current conversation context. Start a new conversation or provide a message that relates to the current profile customization session.
- AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
- ResourceNotFoundException The requested data store was not found.
- UnsupportedMimeTypeException The content type in your request is not supported. Use a supported content type for this operation.
- ValidationException The user input parameter was invalid.
- InternalServerException An unknown internal error occurred in the service.
- UnauthorizedException You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.
- 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:
-
updateProfileWithAgent
default CompletableFuture<UpdateProfileWithAgentResponse> updateProfileWithAgent(Consumer<UpdateProfileWithAgentRequest.Builder> updateProfileWithAgentRequest) Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.
This is a convenience which creates an instance of the
UpdateProfileWithAgentRequest.Builderavoiding the need to create one manually viaUpdateProfileWithAgentRequest.builder()- Parameters:
updateProfileWithAgentRequest- AConsumerthat will call methods onUpdateProfileWithAgentRequest.Builderto create a request. The request parameters for theUpdateProfileWithAgentoperation.- Returns:
- A Java Future containing the result of the UpdateProfileWithAgent 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.- NotImplementedOperationException The requested operation is not yet available. Check the service documentation for a list of supported operations.
- ConversationNotFoundException The specified conversation identifier does not exist. Verify the conversation ID or omit it to start a new conversation.
- ThrottlingException The user has exceeded their maximum number of allowed calls to the given API.
- AgentMessageOutOfContextException The agent message does not fit within the current conversation context. Start a new conversation or provide a message that relates to the current profile customization session.
- AccessDeniedException Access is denied. Your account is not authorized to perform this operation.
- ResourceNotFoundException The requested data store was not found.
- UnsupportedMimeTypeException The content type in your request is not supported. Use a supported content type for this operation.
- ValidationException The user input parameter was invalid.
- InternalServerException An unknown internal error occurred in the service.
- UnauthorizedException You are not authorized to make this request. Verify that your AWS credentials are valid and that you have the required permissions.
- 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
Create an instance ofHealthLakeAsyncWaiterusing 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
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.
-