software.amazon.awssdk.services.healthlake

Interface HealthLakeClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface HealthLakeClient
extends SdkClient

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

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and 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, created at, Data Store type version, and Data Store 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, created at, Data Store type version, and Data Store 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) Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
default ListFHIRDatastoresIterable	listFHIRDatastoresPaginator(ListFhirDatastoresRequest listFhirDatastoresRequest) Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
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.

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

serviceName

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

close

Field Detail

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 Detail

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.

createFHIRDatastore

default CreateFhirDatastoreResponse createFHIRDatastore(CreateFhirDatastoreRequest createFhirDatastoreRequest)
                                                 throws ValidationException,
                                                        ThrottlingException,
                                                        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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createFHIRDatastore

default CreateFhirDatastoreResponse createFHIRDatastore(Consumer<CreateFhirDatastoreRequest.Builder> createFhirDatastoreRequest)
                                                 throws ValidationException,
                                                        ThrottlingException,
                                                        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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ConflictException - The Data Store is in a transition state and the user requested action can not be performed.

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ConflictException - The Data Store is in a transition state and the user requested action can not be performed.

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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, created at, Data Store type version, and Data Store endpoint.

Parameters:

describeFhirDatastoreRequest -

Returns:

Result of the DescribeFHIRDatastore operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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, created at, Data Store type version, and Data Store endpoint.

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

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.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listFHIRDatastoresPaginator

default ListFHIRDatastoresIterable listFHIRDatastoresPaginator(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.

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listFHIRDatastoresPaginator

default ListFHIRDatastoresIterable listFHIRDatastoresPaginator(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 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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException - The requested Data Store was not found.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException - The requested Data Store was not found.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException - The requested Data Store was not found.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

Throws:

ValidationException - The user input parameter was invalid.

ThrottlingException - The user has exceeded their maximum number of allowed calls to the given API.

AccessDeniedException - Access is denied. Your account is not authorized to perform this operation.

ResourceNotFoundException - The requested Data Store was not found.

InternalServerException - Unknown error occurs in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

HealthLakeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()