Package software.amazon.awssdk.services.healthlake

Interface HealthLakeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface HealthLakeClient
extends AwsClient

Service client for accessing HealthLake. This can be created using the static builder() method.

AWS HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static HealthLakeClientBuilder	builder()	Create a builder that can be used to configure and create a HealthLakeClient.
static HealthLakeClient	create()	Create a HealthLakeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateFhirDatastoreResponse	createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest)	Creates a data store that can ingest and export FHIR formatted data.
default CreateFhirDatastoreResponse	createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)	Creates a data store that can ingest and export FHIR formatted data.
default DeleteFhirDatastoreResponse	deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest)	Deletes a data store.
default DeleteFhirDatastoreResponse	deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest)	Deletes a data store.
default DescribeFhirDatastoreResponse	describeFHIRDatastore(Consumer<DescribeFhirDatastoreRequest.Builder> describeFhirDatastoreRequest)	Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
default DescribeFhirDatastoreResponse	describeFHIRDatastore(DescribeFhirDatastoreRequest describeFhirDatastoreRequest)	Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
default DescribeFhirExportJobResponse	describeFHIRExportJob(Consumer<DescribeFhirExportJobRequest.Builder> describeFhirExportJobRequest)	Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
default DescribeFhirExportJobResponse	describeFHIRExportJob(DescribeFhirExportJobRequest describeFhirExportJobRequest)	Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
default DescribeFhirImportJobResponse	describeFHIRImportJob(Consumer<DescribeFhirImportJobRequest.Builder> describeFhirImportJobRequest)	Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
default DescribeFhirImportJobResponse	describeFHIRImportJob(DescribeFhirImportJobRequest describeFhirImportJobRequest)	Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
default ListFhirDatastoresResponse	listFHIRDatastores(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)	Lists all FHIR data stores that are in the user’s account, regardless of data store status.
default ListFhirDatastoresResponse	listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest)	Lists all FHIR data stores that are in the user’s account, regardless of data store status.
default ListFHIRDatastoresIterable	listFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)	This is a variant of listFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest) operation.
default ListFHIRDatastoresIterable	listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest)	This is a variant of listFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest) operation.
default ListFhirExportJobsResponse	listFHIRExportJobs(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)	Lists all FHIR export jobs associated with an account and their statuses.
default ListFhirExportJobsResponse	listFHIRExportJobs(ListFhirExportJobsRequest listFhirExportJobsRequest)	Lists all FHIR export jobs associated with an account and their statuses.
default ListFHIRExportJobsIterable	listFHIRExportJobsPaginator(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)	This is a variant of listFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest) operation.
default ListFHIRExportJobsIterable	listFHIRExportJobsPaginator(ListFhirExportJobsRequest listFhirExportJobsRequest)	This is a variant of listFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest) operation.
default ListFhirImportJobsResponse	listFHIRImportJobs(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)	Lists all FHIR import jobs associated with an account and their statuses.
default ListFhirImportJobsResponse	listFHIRImportJobs(ListFhirImportJobsRequest listFhirImportJobsRequest)	Lists all FHIR import jobs associated with an account and their statuses.
default ListFHIRImportJobsIterable	listFHIRImportJobsPaginator(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)	This is a variant of listFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest) operation.
default ListFHIRImportJobsIterable	listFHIRImportJobsPaginator(ListFhirImportJobsRequest listFhirImportJobsRequest)	This is a variant of listFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of all existing tags associated with a data store.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of all existing tags associated with a data store.
default HealthLakeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartFhirExportJobResponse	startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest)	Begins a FHIR export job.
default StartFhirExportJobResponse	startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest)	Begins a FHIR export job.
default StartFhirImportJobResponse	startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest)	Begins a FHIR Import job.
default StartFhirImportJobResponse	startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest)	Begins a FHIR Import job.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds a user specified key and value tag to a data store.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds a user specified key and value tag to a data store.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a data store.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a data store.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createFHIRDatastore

default CreateFhirDatastoreResponse createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)
                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Creates a data store that can ingest and export FHIR formatted data.

Parameters:

createFhirDatastoreRequest -

Returns:

Result of the CreateFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

createFHIRDatastore

default CreateFhirDatastoreResponse createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest)
                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Creates a data store that can ingest and export FHIR formatted data.

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

Parameters:

createFhirDatastoreRequest - A Consumer that will call methods on CreateFhirDatastoreRequest.Builder to create a request.

Returns:

Result of the CreateFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

deleteFHIRDatastore

default DeleteFhirDatastoreResponse deleteFHIRDatastore(DeleteFhirDatastoreRequest deleteFhirDatastoreRequest)
                                                 throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Deletes a data store.

Parameters:

deleteFhirDatastoreRequest -

Returns:

Result of the DeleteFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

deleteFHIRDatastore

default DeleteFhirDatastoreResponse deleteFHIRDatastore(Consumer<DeleteFhirDatastoreRequest.Builder> deleteFhirDatastoreRequest)
                                                 throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Deletes a data store.

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

Parameters:

deleteFhirDatastoreRequest - A Consumer that will call methods on DeleteFhirDatastoreRequest.Builder to create a request.

Returns:

Result of the DeleteFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRDatastore

default DescribeFhirDatastoreResponse describeFHIRDatastore(DescribeFhirDatastoreRequest describeFhirDatastoreRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

Parameters:

describeFhirDatastoreRequest -

Returns:

Result of the DescribeFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRDatastore

default DescribeFhirDatastoreResponse describeFHIRDatastore(Consumer<DescribeFhirDatastoreRequest.Builder> describeFhirDatastoreRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

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

Parameters:

describeFhirDatastoreRequest - A Consumer that will call methods on DescribeFhirDatastoreRequest.Builder to create a request.

Returns:

Result of the DescribeFHIRDatastore operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRExportJob

default DescribeFhirExportJobResponse describeFHIRExportJob(DescribeFhirExportJobRequest describeFhirExportJobRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

Parameters:

describeFhirExportJobRequest -

Returns:

Result of the DescribeFHIRExportJob operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRExportJob

default DescribeFhirExportJobResponse describeFHIRExportJob(Consumer<DescribeFhirExportJobRequest.Builder> describeFhirExportJobRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

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

Parameters:

describeFhirExportJobRequest - A Consumer that will call methods on DescribeFhirExportJobRequest.Builder to create a request.

Returns:

Result of the DescribeFHIRExportJob operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRImportJob

default DescribeFhirImportJobResponse describeFHIRImportJob(DescribeFhirImportJobRequest describeFhirImportJobRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

Parameters:

describeFhirImportJobRequest -

Returns:

Result of the DescribeFHIRImportJob operation returned by the service.

See Also:

• AWS API Documentation

describeFHIRImportJob

default DescribeFhirImportJobResponse describeFHIRImportJob(Consumer<DescribeFhirImportJobRequest.Builder> describeFhirImportJobRequest)
                                                     throws ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

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

Parameters:

describeFhirImportJobRequest - A Consumer that will call methods on DescribeFhirImportJobRequest.Builder to create a request.

Returns:

Result of the DescribeFHIRImportJob operation returned by the service.

See Also:

• AWS API Documentation

listFHIRDatastores

default ListFhirDatastoresResponse listFHIRDatastores(ListFhirDatastoresRequest listFhirDatastoresRequest)
                                               throws ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Lists all FHIR data stores that are in the user’s account, regardless of data store status.

Parameters:

listFhirDatastoresRequest -

Returns:

Result of the ListFHIRDatastores operation returned by the service.

See Also:

• AWS API Documentation

listFHIRDatastores

default ListFhirDatastoresResponse listFHIRDatastores(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)
                                               throws ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Lists all FHIR data stores that are in the user’s account, regardless of data store status.

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

Parameters:

listFhirDatastoresRequest - A Consumer that will call methods on ListFhirDatastoresRequest.Builder to create a request.

Returns:

Result of the ListFHIRDatastores operation returned by the service.

See Also:

• AWS API Documentation

listFHIRDatastoresPaginator

default ListFHIRDatastoresIterable listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest)
                                                        throws ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client.listFHIRDatastoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client
             .listFHIRDatastoresPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client.listFHIRDatastoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFHIRDatastoresPaginator

default ListFHIRDatastoresIterable listFHIRDatastoresPaginator(Consumer<ListFhirDatastoresRequest.Builder> listFhirDatastoresRequest)
                                                        throws ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client.listFHIRDatastoresPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client
             .listFHIRDatastoresPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRDatastoresIterable responses = client.listFHIRDatastoresPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFHIRDatastores(software.amazon.awssdk.services.healthlake.model.ListFhirDatastoresRequest) operation.

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

Parameters:

listFhirDatastoresRequest - A Consumer that will call methods on ListFhirDatastoresRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFHIRExportJobs

default ListFhirExportJobsResponse listFHIRExportJobs(ListFhirExportJobsRequest listFhirExportJobsRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

Parameters:

listFhirExportJobsRequest -

Returns:

Result of the ListFHIRExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listFHIRExportJobs

default ListFhirExportJobsResponse listFHIRExportJobs(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

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

Parameters:

listFhirExportJobsRequest - A Consumer that will call methods on ListFhirExportJobsRequest.Builder to create a request.

Returns:

Result of the ListFHIRExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listFHIRExportJobsPaginator

default ListFHIRExportJobsIterable listFHIRExportJobsPaginator(ListFhirExportJobsRequest listFhirExportJobsRequest)
                                                        throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client.listFHIRExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client
             .listFHIRExportJobsPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client.listFHIRExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFHIRExportJobsPaginator

default ListFHIRExportJobsIterable listFHIRExportJobsPaginator(Consumer<ListFhirExportJobsRequest.Builder> listFhirExportJobsRequest)
                                                        throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client.listFHIRExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client
             .listFHIRExportJobsPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRExportJobsIterable responses = client.listFHIRExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFHIRExportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirExportJobsRequest) operation.

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

Parameters:

listFhirExportJobsRequest - A Consumer that will call methods on ListFhirExportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFHIRImportJobs

default ListFhirImportJobsResponse listFHIRImportJobs(ListFhirImportJobsRequest listFhirImportJobsRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

Parameters:

listFhirImportJobsRequest -

Returns:

Result of the ListFHIRImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listFHIRImportJobs

default ListFhirImportJobsResponse listFHIRImportJobs(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

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

Parameters:

listFhirImportJobsRequest - A Consumer that will call methods on ListFhirImportJobsRequest.Builder to create a request.

Returns:

Result of the ListFHIRImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listFHIRImportJobsPaginator

default ListFHIRImportJobsIterable listFHIRImportJobsPaginator(ListFhirImportJobsRequest listFhirImportJobsRequest)
                                                        throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client.listFHIRImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client
             .listFHIRImportJobsPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client.listFHIRImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFHIRImportJobsPaginator

default ListFHIRImportJobsIterable listFHIRImportJobsPaginator(Consumer<ListFhirImportJobsRequest.Builder> listFhirImportJobsRequest)
                                                        throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

This is a variant of listFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client.listFHIRImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client
             .listFHIRImportJobsPaginator(request);
     for (software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.healthlake.paginators.ListFHIRImportJobsIterable responses = client.listFHIRImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFHIRImportJobs(software.amazon.awssdk.services.healthlake.model.ListFhirImportJobsRequest) operation.

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

Parameters:

listFhirImportJobsRequest - A Consumer that will call methods on ListFhirImportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

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

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startFHIRExportJob

default StartFhirExportJobResponse startFHIRExportJob(StartFhirExportJobRequest startFhirExportJobRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Begins a FHIR export job.

Parameters:

startFhirExportJobRequest -

Returns:

Result of the StartFHIRExportJob operation returned by the service.

See Also:

• AWS API Documentation

startFHIRExportJob

default StartFhirExportJobResponse startFHIRExportJob(Consumer<StartFhirExportJobRequest.Builder> startFhirExportJobRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Begins a FHIR export job.

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

Parameters:

startFhirExportJobRequest - A Consumer that will call methods on StartFhirExportJobRequest.Builder to create a request.

Returns:

Result of the StartFHIRExportJob operation returned by the service.

See Also:

• AWS API Documentation

startFHIRImportJob

default StartFhirImportJobResponse startFHIRImportJob(StartFhirImportJobRequest startFhirImportJobRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Begins a FHIR Import job.

Parameters:

startFhirImportJobRequest -

Returns:

Result of the StartFHIRImportJob operation returned by the service.

See Also:

• AWS API Documentation

startFHIRImportJob

default StartFhirImportJobResponse startFHIRImportJob(Consumer<StartFhirImportJobRequest.Builder> startFhirImportJobRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
HealthLakeException

Begins a FHIR Import job.

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

Parameters:

startFhirImportJobRequest - A Consumer that will call methods on StartFhirImportJobRequest.Builder to create a request.

Returns:

Result of the StartFHIRImportJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

Adds a user specified key and value tag to a data store.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

Adds a user specified key and value tag to a data store.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

Removes tags from a data store.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
HealthLakeException

Removes tags from a data store.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static HealthLakeClient create()

Create a HealthLakeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static HealthLakeClientBuilder builder()

Create a builder that can be used to configure and create a HealthLakeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default HealthLakeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration