healthlake/aws.sdk.kotlin.services.healthlake

Package-level declarations

Types

HealthLakeClient

interface HealthLakeClient : SdkClient

This is the AWS HealthLake API Reference. For an introduction to the service, see What is AWS HealthLake? in the AWS HealthLake Developer Guide.

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Inherited functions

createFhirDatastore

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

Create a FHIR-enabled data store.

deleteFhirDatastore

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

Delete a FHIR-enabled data store.

describeFhirDatastore

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

Get properties for a FHIR-enabled data store.

describeFhirExportJob

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

Get FHIR export job properties.

describeFhirImportJob

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

Get the import job properties to learn more about the job or job progress.

listFhirDatastores

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

List all FHIR-enabled data stores in a 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

List 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

Start a FHIR export job.

startFhirImportJob

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

Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.

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

Add a user-specifed key and value tag to a data store.

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

Remove a user-specifed key and value tag from a data store.

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.