com.amazonaws.services.healthlake.AmazonHealthLake Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-healthlake Show documentation
Show all versions of aws-java-sdk-healthlake Show documentation
The AWS Java SDK for Amazon HealthLake module holds the client classes that are used for communicating with Amazon HealthLake Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.healthlake;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.healthlake.model.*;
/**
* Interface for accessing HealthLake.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.healthlake.AbstractAmazonHealthLake} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonHealthLake {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "healthlake";
/**
*
* Creates a data store that can ingest and export FHIR formatted data.
*
*
* @param createFHIRDatastoreRequest
* @return Result of the CreateFHIRDatastore operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.CreateFHIRDatastore
* @see AWS
* API Documentation
*/
CreateFHIRDatastoreResult createFHIRDatastore(CreateFHIRDatastoreRequest createFHIRDatastoreRequest);
/**
*
* Deletes a data store.
*
*
* @param deleteFHIRDatastoreRequest
* @return Result of the DeleteFHIRDatastore operation returned by the service.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws ConflictException
* The data store is in a transition state and the user requested action can not be performed.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.DeleteFHIRDatastore
* @see AWS
* API Documentation
*/
DeleteFHIRDatastoreResult deleteFHIRDatastore(DeleteFHIRDatastoreRequest deleteFHIRDatastoreRequest);
/**
*
* 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.
*
*
* @param describeFHIRDatastoreRequest
* @return Result of the DescribeFHIRDatastore operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.DescribeFHIRDatastore
* @see AWS API Documentation
*/
DescribeFHIRDatastoreResult describeFHIRDatastore(DescribeFHIRDatastoreRequest describeFHIRDatastoreRequest);
/**
*
* Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
*
*
* @param describeFHIRExportJobRequest
* @return Result of the DescribeFHIRExportJob operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.DescribeFHIRExportJob
* @see AWS API Documentation
*/
DescribeFHIRExportJobResult describeFHIRExportJob(DescribeFHIRExportJobRequest describeFHIRExportJobRequest);
/**
*
* Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
*
*
* @param describeFHIRImportJobRequest
* @return Result of the DescribeFHIRImportJob operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.DescribeFHIRImportJob
* @see AWS API Documentation
*/
DescribeFHIRImportJobResult describeFHIRImportJob(DescribeFHIRImportJobRequest describeFHIRImportJobRequest);
/**
*
* Lists all FHIR data stores that are in the user’s account, regardless of data store status.
*
*
* @param listFHIRDatastoresRequest
* @return Result of the ListFHIRDatastores operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.ListFHIRDatastores
* @see AWS
* API Documentation
*/
ListFHIRDatastoresResult listFHIRDatastores(ListFHIRDatastoresRequest listFHIRDatastoresRequest);
/**
*
* Lists all FHIR export jobs associated with an account and their statuses.
*
*
* @param listFHIRExportJobsRequest
* @return Result of the ListFHIRExportJobs operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.ListFHIRExportJobs
* @see AWS
* API Documentation
*/
ListFHIRExportJobsResult listFHIRExportJobs(ListFHIRExportJobsRequest listFHIRExportJobsRequest);
/**
*
* Lists all FHIR import jobs associated with an account and their statuses.
*
*
* @param listFHIRImportJobsRequest
* @return Result of the ListFHIRImportJobs operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.ListFHIRImportJobs
* @see AWS
* API Documentation
*/
ListFHIRImportJobsResult listFHIRImportJobs(ListFHIRImportJobsRequest listFHIRImportJobsRequest);
/**
*
* Returns a list of all existing tags associated with a data store.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @sample AmazonHealthLake.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Begins a FHIR export job.
*
*
* @param startFHIRExportJobRequest
* @return Result of the StartFHIRExportJob operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.StartFHIRExportJob
* @see AWS
* API Documentation
*/
StartFHIRExportJobResult startFHIRExportJob(StartFHIRExportJobRequest startFHIRExportJobRequest);
/**
*
* Begins a FHIR Import job.
*
*
* @param startFHIRImportJobRequest
* @return Result of the StartFHIRImportJob operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ThrottlingException
* The user has exceeded their maximum number of allowed calls to the given API.
* @throws AccessDeniedException
* Access is denied. Your account is not authorized to perform this operation.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @throws InternalServerException
* Unknown error occurs in the service.
* @sample AmazonHealthLake.StartFHIRImportJob
* @see AWS
* API Documentation
*/
StartFHIRImportJobResult startFHIRImportJob(StartFHIRImportJobRequest startFHIRImportJobRequest);
/**
*
* Adds a user specified key and value tag to a data store.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @sample AmazonHealthLake.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from a data store.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The user input parameter was invalid.
* @throws ResourceNotFoundException
* The requested data store was not found.
* @sample AmazonHealthLake.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy