HealthLake class

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

Constructors

HealthLake({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false, bool disableHostPrefix = false})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDataTransformationProfile({required String profileName, required CreateDataTransformationProfileSource source, required SourceFormat sourceFormat, String? clientToken, String? kmsKeyId, String? profileDescription, Map<String, String>? tags}) → Future<CreateDataTransformationProfileResponse>
Creates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data file as the source.
createFHIRDatastore({required FHIRVersion datastoreTypeVersion, AnalyticsConfiguration? analyticsConfiguration, String? clientToken, String? datastoreName, IdentityProviderConfiguration? identityProviderConfiguration, NlpConfiguration? nlpConfiguration, PreloadDataConfig? preloadDataConfig, ProfileConfiguration? profileConfiguration, SseConfiguration? sseConfiguration, List<Tag>? tags}) → Future<CreateFHIRDatastoreResponse>
Create a FHIR-enabled data store.
deleteDataTransformationProfile({required String profileId}) → Future<DeleteDataTransformationProfileResponse>
Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
deleteFHIRDatastore({required String datastoreId}) → Future<DeleteFHIRDatastoreResponse>
Delete a FHIR-enabled data store.
describeDataTransformationJob({required String jobId}) → Future<DescribeDataTransformationJobResponse>
Describes a data transformation job, including its current status, configuration, and progress information.
describeFHIRDatastore({required String datastoreId}) → Future<DescribeFHIRDatastoreResponse>
Get properties for a FHIR-enabled data store.
describeFHIRExportJob({required String datastoreId, required String jobId}) → Future<DescribeFHIRExportJobResponse>
Get FHIR export job properties.
describeFHIRImportJob({required String datastoreId, required String jobId}) → Future<DescribeFHIRImportJobResponse>
Get the import job properties to learn more about the job or job progress.
getDataTransformationProfile({required String profileId, int? profileVersion}) → Future<GetDataTransformationProfileResponse>
Retrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.
listDataTransformationJobs({String? jobName, TransformationJobStatus? jobStatus, int? maxResults, String? nextToken, DateTime? submittedAfter, DateTime? submittedBefore}) → Future<ListDataTransformationJobsResponse>
Lists data transformation jobs for your AWS account. Results can be filtered by status, job name, and submit time window. Results are paginated. Use the NextToken parameter to retrieve additional results.
listDataTransformationProfiles({required SourceFormat sourceFormat, int? maxResults, String? nextToken}) → Future<ListDataTransformationProfilesResponse>
Lists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.
listDataTransformationProfileVersions({required String profileId, int? maxResults, String? nextToken}) → Future<ListDataTransformationProfileVersionsResponse>
Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use GetDataTransformationProfile to retrieve profile content. Results are paginated. Use the NextToken parameter to retrieve additional results.
listFHIRDatastores({DatastoreFilter? filter, int? maxResults, String? nextToken}) → Future<ListFHIRDatastoresResponse>
List all FHIR-enabled data stores in a user’s account, regardless of data store status.
listFHIRExportJobs({required String datastoreId, String? jobName, JobStatus? jobStatus, int? maxResults, String? nextToken, DateTime? submittedAfter, DateTime? submittedBefore}) → Future<ListFHIRExportJobsResponse>
Lists all FHIR export jobs associated with an account and their statuses.
listFHIRImportJobs({required String datastoreId, String? jobName, JobStatus? jobStatus, int? maxResults, String? nextToken, DateTime? submittedAfter, DateTime? submittedBefore}) → Future<ListFHIRImportJobsResponse>
List all FHIR import jobs associated with an account and their statuses.
listTagsForResource({required String resourceARN}) → Future<ListTagsForResourceResponse>
Returns a list of all existing tags associated with a data store.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
publishDataTransformationProfile({required String profileId, required SourceFormat sourceFormat, String? changeDescription, int? fromExistingVersion}) → Future<PublishDataTransformationProfileResponse>
Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.
startDataTransformationJob({required String clientToken, required String dataAccessRoleArn, required TransformationInputDataConfig inputDataConfig, required TransformationOutputDataConfig outputDataConfig, required String profileId, bool? driftDetectionEnabled, String? jobName, bool? provenanceEnabled}) → Future<StartDataTransformationJobResponse>
Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.
startFHIRExportJob({required String dataAccessRoleArn, required String datastoreId, required OutputDataConfig outputDataConfig, String? clientToken, String? jobName}) → Future<StartFHIRExportJobResponse>
Start a FHIR export job.
startFHIRImportJob({required String dataAccessRoleArn, required String datastoreId, required InputDataConfig inputDataConfig, required OutputDataConfig jobOutputDataConfig, String? clientToken, bool? driftDetectionEnabled, String? inputFormat, String? jobName, String? profileId, bool? provenanceEnabled, ValidationLevel? validationLevel}) → Future<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.
tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
Add a user-specifed key and value tag to a data store.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeys}) → Future<void>
Remove a user-specifed key and value tag from a data store.
updateDataTransformationProfile({required String profileId, required Map<String, String> profileMapping, String? changeDescription}) → Future<UpdateDataTransformationProfileResponse>
Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
updateFHIRDatastore({required String datastoreId, AnalyticsConfiguration? analyticsConfiguration, String? datastoreName, IdentityProviderConfiguration? identityProviderConfiguration, NlpConfiguration? nlpConfiguration, ProfileConfiguration? profileConfiguration}) → Future<UpdateFHIRDatastoreResponse>
Update the properties of a FHIR-enabled data store.
updateProfileWithAgent({required AgentInputMessage inputMessage, required String profileId, required SourceFormat sourceFormat, String? conversationId}) → Future<UpdateProfileWithAgentResponse>
Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.

Operators

operator ==(Object other) → bool
The equality operator.
inherited