healthlake/aws.sdk.kotlin.services.healthlake

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createFhirDatastore

inline suspend fun HealthLakeClient.createFhirDatastore(crossinline block: CreateFhirDatastoreRequest.Builder.() -> Unit): CreateFhirDatastoreResponse

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

deleteFhirDatastore

inline suspend fun HealthLakeClient.deleteFhirDatastore(crossinline block: DeleteFhirDatastoreRequest.Builder.() -> Unit): DeleteFhirDatastoreResponse

Deletes a data store.

describeFhirDatastore

inline suspend fun HealthLakeClient.describeFhirDatastore(crossinline block: DescribeFhirDatastoreRequest.Builder.() -> Unit): DescribeFhirDatastoreResponse

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.

describeFhirExportJob

inline suspend fun HealthLakeClient.describeFhirExportJob(crossinline block: DescribeFhirExportJobRequest.Builder.() -> Unit): DescribeFhirExportJobResponse

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

describeFhirImportJob

inline suspend fun HealthLakeClient.describeFhirImportJob(crossinline block: DescribeFhirImportJobRequest.Builder.() -> Unit): DescribeFhirImportJobResponse

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

listFhirDatastores

inline suspend fun HealthLakeClient.listFhirDatastores(crossinline block: ListFhirDatastoresRequest.Builder.() -> Unit): ListFhirDatastoresResponse

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

listFhirExportJobs

inline suspend fun HealthLakeClient.listFhirExportJobs(crossinline block: ListFhirExportJobsRequest.Builder.() -> Unit): ListFhirExportJobsResponse

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

listFhirImportJobs

inline suspend fun HealthLakeClient.listFhirImportJobs(crossinline block: ListFhirImportJobsRequest.Builder.() -> Unit): ListFhirImportJobsResponse

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

listTagsForResource

inline suspend fun HealthLakeClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

startFhirExportJob

inline suspend fun HealthLakeClient.startFhirExportJob(crossinline block: StartFhirExportJobRequest.Builder.() -> Unit): StartFhirExportJobResponse

Begins a FHIR export job.

startFhirImportJob

inline suspend fun HealthLakeClient.startFhirImportJob(crossinline block: StartFhirImportJobRequest.Builder.() -> Unit): StartFhirImportJobResponse

Begins a FHIR Import job.

tagResource

inline suspend fun HealthLakeClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun HealthLakeClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a data store.

withConfig

fun HealthLakeClient.withConfig(block: HealthLakeClient.Config.Builder.() -> Unit): HealthLakeClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.