com.amazonaws.services.healthlake

Interface AmazonHealthLake

All Known Subinterfaces:

AmazonHealthLakeAsync

All Known Implementing Classes:

AbstractAmazonHealthLake, AbstractAmazonHealthLakeAsync, AmazonHealthLakeAsyncClient, AmazonHealthLakeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonHealthLake

Interface for accessing HealthLake.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonHealthLake instead.

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	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateFHIRDatastoreResult	createFHIRDatastore(CreateFHIRDatastoreRequest createFHIRDatastoreRequest) Creates a Data Store that can ingest and export FHIR formatted data.
DeleteFHIRDatastoreResult	deleteFHIRDatastore(DeleteFHIRDatastoreRequest deleteFHIRDatastoreRequest) Deletes a Data Store.
DescribeFHIRDatastoreResult	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.
DescribeFHIRExportJobResult	describeFHIRExportJob(DescribeFHIRExportJobRequest describeFHIRExportJobRequest) Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
DescribeFHIRImportJobResult	describeFHIRImportJob(DescribeFHIRImportJobRequest describeFHIRImportJobRequest) 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 listFHIRDatastoresRequest) Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
ListFHIRExportJobsResult	listFHIRExportJobs(ListFHIRExportJobsRequest listFHIRExportJobsRequest) Lists all FHIR export jobs associated with an account and their statuses.
ListFHIRImportJobsResult	listFHIRImportJobs(ListFHIRImportJobsRequest listFHIRImportJobsRequest) Lists all FHIR import jobs associated with an account and their statuses.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 startFHIRExportJobRequest) Begins a FHIR export job.
StartFHIRImportJobResult	startFHIRImportJob(StartFHIRImportJobRequest startFHIRImportJobRequest) Begins a FHIR Import job.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds a user specifed key and value tag to a Data Store.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a Data Store.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createFHIRDatastore

CreateFHIRDatastoreResult createFHIRDatastore(CreateFHIRDatastoreRequest createFHIRDatastoreRequest)

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.

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

DeleteFHIRDatastoreResult deleteFHIRDatastore(DeleteFHIRDatastoreRequest deleteFHIRDatastoreRequest)

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.

See Also:

AWS API Documentation

describeFHIRDatastore

DescribeFHIRDatastoreResult 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.

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

DescribeFHIRExportJobResult describeFHIRExportJob(DescribeFHIRExportJobRequest describeFHIRExportJobRequest)

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.

See Also:

AWS API Documentation

describeFHIRImportJob

DescribeFHIRImportJobResult describeFHIRImportJob(DescribeFHIRImportJobRequest describeFHIRImportJobRequest)

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.

See Also:

AWS API Documentation

listFHIRDatastores

ListFHIRDatastoresResult listFHIRDatastores(ListFHIRDatastoresRequest listFHIRDatastoresRequest)

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.

See Also:

AWS API Documentation

listFHIRExportJobs

ListFHIRExportJobsResult listFHIRExportJobs(ListFHIRExportJobsRequest listFHIRExportJobsRequest)

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

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

ListFHIRImportJobsResult listFHIRImportJobs(ListFHIRImportJobsRequest listFHIRImportJobsRequest)

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

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

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

StartFHIRExportJobResult startFHIRExportJob(StartFHIRExportJobRequest startFHIRExportJobRequest)

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.

See Also:

AWS API Documentation

startFHIRImportJob

StartFHIRImportJobResult startFHIRImportJob(StartFHIRImportJobRequest startFHIRImportJobRequest)

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a Data Store.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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