com.amazonaws.services.healthlake

Class AmazonHealthLakeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.healthlake.AmazonHealthLakeClient

All Implemented Interfaces:

AmazonHealthLake

Direct Known Subclasses:

AmazonHealthLakeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonHealthLakeClient
extends AmazonWebServiceClient
implements AmazonHealthLake

Client for accessing HealthLake. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.healthlake.AmazonHealthLake

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonHealthLakeClientBuilder	builder()
CreateFHIRDatastoreResult	createFHIRDatastore(CreateFHIRDatastoreRequest request) Creates a Data Store that can ingest and export FHIR formatted data.
DeleteFHIRDatastoreResult	deleteFHIRDatastore(DeleteFHIRDatastoreRequest request) Deletes a Data Store.
DescribeFHIRDatastoreResult	describeFHIRDatastore(DescribeFHIRDatastoreRequest request) 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.
DescribeFHIRExportJobResult	describeFHIRExportJob(DescribeFHIRExportJobRequest request) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
DescribeFHIRImportJobResult	describeFHIRImportJob(DescribeFHIRImportJobRequest request) Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListFHIRDatastoresResult	listFHIRDatastores(ListFHIRDatastoresRequest request) Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
ListFHIRExportJobsResult	listFHIRExportJobs(ListFHIRExportJobsRequest request) Lists all FHIR export jobs associated with an account and their statuses.
ListFHIRImportJobsResult	listFHIRImportJobs(ListFHIRImportJobsRequest request) Lists all FHIR import jobs associated with an account and their statuses.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of all existing tags associated with a Data Store.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartFHIRExportJobResult	startFHIRExportJob(StartFHIRExportJobRequest request) Begins a FHIR export job.
StartFHIRImportJobResult	startFHIRImportJob(StartFHIRImportJobRequest request) Begins a FHIR Import job.
TagResourceResult	tagResource(TagResourceRequest request) Adds a user specifed key and value tag to a Data Store.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from a Data Store.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonHealthLakeClientBuilder builder()

createFHIRDatastore

public CreateFHIRDatastoreResult createFHIRDatastore(CreateFHIRDatastoreRequest request)

Creates a Data Store that can ingest and export FHIR formatted data.

Specified by:

createFHIRDatastore in interface AmazonHealthLake

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.

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

InternalServerException - Unknown error occurs in the service.

See Also:

AWS API Documentation

deleteFHIRDatastore

public DeleteFHIRDatastoreResult deleteFHIRDatastore(DeleteFHIRDatastoreRequest request)

Deletes a Data Store.

Specified by:

deleteFHIRDatastore in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

describeFHIRDatastore

public DescribeFHIRDatastoreResult describeFHIRDatastore(DescribeFHIRDatastoreRequest request)

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.

Specified by:

describeFHIRDatastore in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

describeFHIRExportJob

public DescribeFHIRExportJobResult describeFHIRExportJob(DescribeFHIRExportJobRequest request)

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

Specified by:

describeFHIRExportJob in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

describeFHIRImportJob

public DescribeFHIRImportJobResult describeFHIRImportJob(DescribeFHIRImportJobRequest request)

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

Specified by:

describeFHIRImportJob in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

listFHIRDatastores

public ListFHIRDatastoresResult listFHIRDatastores(ListFHIRDatastoresRequest request)

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

Specified by:

listFHIRDatastores in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

listFHIRExportJobs

public ListFHIRExportJobsResult listFHIRExportJobs(ListFHIRExportJobsRequest request)

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

Specified by:

listFHIRExportJobs in interface AmazonHealthLake

Parameters:

listFHIRExportJobsRequest -

Returns:

Result of the ListFHIRExportJobs operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

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

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

InternalServerException - Unknown error occurs in the service.

See Also:

AWS API Documentation

listFHIRImportJobs

public ListFHIRImportJobsResult listFHIRImportJobs(ListFHIRImportJobsRequest request)

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

Specified by:

listFHIRImportJobs in interface AmazonHealthLake

Parameters:

listFHIRImportJobsRequest -

Returns:

Result of the ListFHIRImportJobs operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

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

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

InternalServerException - Unknown error occurs in the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of all existing tags associated with a Data Store.

Specified by:

listTagsForResource in interface AmazonHealthLake

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

See Also:

AWS API Documentation

startFHIRExportJob

public StartFHIRExportJobResult startFHIRExportJob(StartFHIRExportJobRequest request)

Begins a FHIR export job.

Specified by:

startFHIRExportJob in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

startFHIRImportJob

public StartFHIRImportJobResult startFHIRImportJob(StartFHIRImportJobRequest request)

Begins a FHIR Import job.

Specified by:

startFHIRImportJob in interface AmazonHealthLake

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds a user specifed key and value tag to a Data Store.

Specified by:

tagResource in interface AmazonHealthLake

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from a Data Store.

Specified by:

untagResource in interface AmazonHealthLake

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The user input parameter was invalid.

ResourceNotFoundException - The requested Data Store was not found.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonHealthLake

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonHealthLake

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonHealthLake

Overrides:

shutdown in class AmazonWebServiceClient