2026/07/15 - Amazon HealthLake - 11 new 3 updated api methods
Changes AWS HealthLake now offers data transformation in Preview to convert CSV and C-CDA data to FHIR R4. Customers can maintain reusable mapping profiles, run sync or async jobs with provenance tracking and drift detection, and use an AI agent to build and edit mapping logic from natural language.
Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
See also: AWS API Documentation
Request Syntax
client.update_data_transformation_profile(
ProfileId='string',
ProfileMapping={
'string': 'string'
},
ChangeDescription='string'
)
string
[REQUIRED]
The unique identifier of the profile to update.
dict
[REQUIRED]
The new profile content for the DRAFT version. This is a full replacement of all profile files.
(string) --
(string) --
string
A description of what changed in this update.
dict
Response Syntax
{
'ProfileId': 'string',
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileName': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The response from the UpdateDataTransformationProfile operation.
ProfileId (string) --
The unique identifier of the updated profile.
SourceFormat (string) --
The source data format of the profile.
TargetFormat (string) --
The target output format of the profile.
ProfileName (string) --
The name of the updated profile.
LastUpdatedAt (datetime) --
The timestamp when the profile was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.get_data_transformation_profile(
ProfileId='string',
ProfileVersion=123
)
string
[REQUIRED]
The unique identifier of the profile to retrieve.
integer
The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.
dict
Response Syntax
{
'ProfileId': 'string',
'Version': 123,
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileMapping': {
'string': 'string'
},
'ProfileName': 'string',
'ProfileDescription': 'string',
'ChangeDescription': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The response from the GetDataTransformationProfile operation.
ProfileId (string) --
The unique identifier of the profile.
Version (integer) --
The version number of the retrieved profile.
SourceFormat (string) --
The source data format of the profile.
TargetFormat (string) --
The target output format of the profile.
ProfileMapping (dict) --
The profile content as a map of file paths to content strings.
(string) --
(string) --
ProfileName (string) --
The name of the profile.
ProfileDescription (string) --
The description of the profile.
ChangeDescription (string) --
A description of what changed in this version.
LastUpdatedAt (datetime) --
The timestamp when this version was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.publish_data_transformation_profile(
ProfileId='string',
SourceFormat='CCDA'|'CSV',
FromExistingVersion=123,
ChangeDescription='string'
)
string
[REQUIRED]
The unique identifier of the profile to publish.
string
[REQUIRED]
The source data format of the profile.
integer
The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.
string
A description of what changed or why this version is being published.
dict
Response Syntax
{
'ProfileId': 'string',
'Version': 123,
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileName': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The response from the PublishDataTransformationProfile operation.
ProfileId (string) --
The unique identifier of the published profile.
Version (integer) --
The new version number that was created.
SourceFormat (string) --
The source data format of the profile.
TargetFormat (string) --
The target output format of the profile.
ProfileName (string) --
The name of the published profile.
LastUpdatedAt (datetime) --
The timestamp when the profile was last updated.
Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
See also: AWS API Documentation
Request Syntax
client.delete_data_transformation_profile(
ProfileId='string'
)
string
[REQUIRED]
The unique identifier of the profile to delete.
dict
Response Syntax
{
'ProfileId': 'string',
'ProfileName': 'string',
'DeletionTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The response from the DeleteDataTransformationProfile operation.
ProfileId (string) --
The unique identifier of the deleted profile.
ProfileName (string) --
The name of the deleted profile.
DeletionTime (datetime) --
The timestamp when the profile was deleted.
Describes a data transformation job, including its current status, configuration, and progress information.
See also: AWS API Documentation
Request Syntax
client.describe_data_transformation_job(
JobId='string'
)
string
[REQUIRED]
The unique identifier of the data transformation job to describe.
dict
Response Syntax
{
'TransformationJobProperties': {
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'InputDataConfig': {
'S3Uri': 'string',
'SourceFormat': 'CCDA'|'CSV'
},
'OutputDataConfig': {
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
'DataAccessRoleArn': 'string',
'SubmitTime': datetime(2015, 1, 1),
'JobName': 'string',
'ProfileId': 'string',
'ProfileName': 'string',
'ProfileVersion': 123,
'EndTime': datetime(2015, 1, 1),
'DriftDetectionEnabled': True|False,
'ProvenanceEnabled': True|False,
'Message': 'string',
'JobProgressReport': {
'TotalFilesScanned': 123,
'TotalFilesConverted': 123,
'TotalFilesFailed': 123,
'TotalResourcesGenerated': 123
}
}
}
Response Structure
(dict) --
The response from the DescribeDataTransformationJob operation.
TransformationJobProperties (dict) --
The properties of the data transformation job, including status, configuration, and progress information.
JobId (string) --
The unique identifier of the data transformation job.
JobStatus (string) --
The current status of the data transformation job.
InputDataConfig (dict) --
The Amazon S3 location and format of the source files for this job.
S3Uri (string) --
The Amazon S3 URI of the input data to transform.
SourceFormat (string) --
The format of the source data files (C-CDA or CSV).
OutputDataConfig (dict) --
The Amazon S3 location and encryption configuration for the converted output.
S3Configuration (dict) --
The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
S3Uri (string) --
The Amazon S3 URI where AWS HealthLake writes the converted output files.
KmsKeyId (string) --
The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files.
SubmitTime (datetime) --
The timestamp when the job was submitted.
JobName (string) --
The name of the data transformation job.
ProfileId (string) --
The unique identifier of the data transformation profile used for this job.
ProfileName (string) --
The name of the data transformation profile used for this job.
ProfileVersion (integer) --
The version number of the data transformation profile used for this job.
EndTime (datetime) --
The timestamp when the job completed or failed.
DriftDetectionEnabled (boolean) --
Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.
ProvenanceEnabled (boolean) --
Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.
Message (string) --
An informational message about the job, such as an error description if the job failed.
JobProgressReport (dict) --
The progress report for the data transformation job, including counts of files processed and resources generated.
TotalFilesScanned (integer) --
The total number of source files scanned by the job.
TotalFilesConverted (integer) --
The total number of source files successfully converted.
TotalFilesFailed (integer) --
The total number of source files that failed conversion.
TotalResourcesGenerated (integer) --
The total number of FHIR R4 resources generated across all converted files.
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.
See also: AWS API Documentation
Request Syntax
client.list_data_transformation_jobs(
MaxResults=123,
NextToken='string',
JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
JobName='string',
SubmittedAfter=datetime(2015, 1, 1),
SubmittedBefore=datetime(2015, 1, 1)
)
integer
The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.
string
The pagination token from a previous response. Pass this value to retrieve the next page of results.
string
Filters the results to include only jobs with the specified status.
string
Filters the results to include only jobs with the specified name.
datetime
Filters the results to include only jobs submitted at or after this timestamp.
datetime
Filters the results to include only jobs submitted at or before this timestamp.
dict
Response Syntax
{
'Items': [
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'SubmitTime': datetime(2015, 1, 1),
'JobName': 'string',
'EndTime': datetime(2015, 1, 1),
'SourceFormat': 'CCDA'|'CSV'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from the ListDataTransformationJobs operation.
Items (list) --
The list of data transformation job summaries.
(dict) --
Contains summary information about a data transformation job. To retrieve full job details, call DescribeDataTransformationJob.
JobId (string) --
The unique identifier of the job.
JobStatus (string) --
The current status of the job.
SubmitTime (datetime) --
The timestamp when the job was submitted.
JobName (string) --
The name of the job.
EndTime (datetime) --
The timestamp when the job completed.
SourceFormat (string) --
The source data format for this job.
NextToken (string) --
The pagination token to use in the next request. If this value is null, there are no more results.
Updates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.
See also: AWS API Documentation
Request Syntax
client.update_profile_with_agent(
ProfileId='string',
SourceFormat='CCDA'|'CSV',
InputMessage={
'Body': 'string',
'Type': 'normal'|'confirmation_response'
},
ConversationId='string'
)
string
[REQUIRED]
The unique identifier of the profile to update via the agent.
string
[REQUIRED]
The source data format for the transformation.
dict
[REQUIRED]
The message to send to the agent.
Body (string) -- [REQUIRED]
The text of your message to the agent.
Type (string) -- [REQUIRED]
The type of input message, which determines how the agent processes your request. Valid values:
normal: A regular message to the agent.
confirmation_response: A response to a confirmation request from the agent.
string
The conversation identifier for multi-turn interactions. Omit to start a new conversation.
dict
Response Syntax
{
'AgentResponse': {
'Body': 'string',
'Type': 'INITIAL_GREETING'|'normal'|'confirmation'|'complete'|'error'|'options'|'choices',
'OptionsList': [
'string',
]
},
'ConversationId': 'string'
}
Response Structure
(dict) --
The response from the UpdateProfileWithAgent operation.
AgentResponse (dict) --
The response message from the agent.
Body (string) --
The text of the agent's response.
Type (string) --
The type of output message, which indicates how to interpret the agent's response.
OptionsList (list) --
A list of selectable options presented when the response type is options.
(string) --
ConversationId (string) --
The conversation identifier to use for follow-up messages in this conversation.
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.
See also: AWS API Documentation
Request Syntax
client.create_data_transformation_profile(
SourceFormat='CCDA'|'CSV',
Source={
'StarterProfile': {
'StarterProfileName': 'string'
},
'ExistingVersionedProfileId': {
'ProfileId': 'string',
'Version': 123
},
'ProfileMapping': {
'ProfileMapping': {
'string': 'string'
}
},
'SampleData': {
'S3Uri': 'string'
}
},
KmsKeyId='string',
ProfileDescription='string',
ProfileName='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
string
[REQUIRED]
The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).
dict
[REQUIRED]
The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.
StarterProfile (dict) --
Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).
StarterProfileName (string) -- [REQUIRED]
The name of the built-in starter profile.
ExistingVersionedProfileId (dict) --
Creates the profile by cloning an existing profile at a specific version.
ProfileId (string) -- [REQUIRED]
The unique identifier of the existing profile to clone from.
Version (integer) -- [REQUIRED]
The version number of the existing profile to clone from.
ProfileMapping (dict) --
Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows.
ProfileMapping (dict) -- [REQUIRED]
The content as a map of file paths to profile strings.
(string) --
(string) --
SampleData (dict) --
Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV).
S3Uri (string) -- [REQUIRED]
The Amazon S3 URI of the sample data file.
string
The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.
string
A human-readable description of the profile's purpose.
string
[REQUIRED]
A name for the data transformation profile.
dict
The tags to associate with the profile at creation time.
(string) --
The key of the tag. Tag keys are case-sensitive and must be unique per resource.
(string) --
The value of the tag. Tag values are case-sensitive and can be empty strings.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProfileId': 'string',
'Version': 123,
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileName': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The response from the CreateDataTransformationProfile operation.
ProfileId (string) --
The unique identifier of the created profile.
Version (integer) --
The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.
SourceFormat (string) --
The source data format of the profile.
TargetFormat (string) --
The target output format. Always FHIR_R4.
ProfileName (string) --
The name of the created profile.
LastUpdatedAt (datetime) --
The timestamp when the profile was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.start_data_transformation_job(
InputDataConfig={
'S3Uri': 'string',
'SourceFormat': 'CCDA'|'CSV'
},
OutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DataAccessRoleArn='string',
ClientToken='string',
JobName='string',
ProfileId='string',
DriftDetectionEnabled=True|False,
ProvenanceEnabled=True|False
)
dict
[REQUIRED]
The Amazon S3 location and format of the source files to transform.
S3Uri (string) -- [REQUIRED]
The Amazon S3 URI of the input data to transform.
SourceFormat (string) --
The format of the source data files (C-CDA or CSV).
dict
[REQUIRED]
The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
S3Configuration (dict) -- [REQUIRED]
The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
S3Uri (string) -- [REQUIRED]
The Amazon S3 URI where AWS HealthLake writes the converted output files.
KmsKeyId (string) -- [REQUIRED]
The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.
string
[REQUIRED]
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
string
A descriptive name for the data transformation job.
string
[REQUIRED]
The unique identifier of the data transformation profile to use for conversion.
boolean
Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.
boolean
Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'
}
Response Structure
(dict) --
The response from the StartDataTransformationJob operation.
JobId (string) --
The unique identifier assigned to the data transformation job.
JobStatus (string) --
The initial status of the data transformation job.
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.
See also: AWS API Documentation
Request Syntax
client.list_data_transformation_profiles(
SourceFormat='CCDA'|'CSV',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Filters the results by source data format.
integer
The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.
string
The pagination token from a previous response. Pass this value to retrieve the next page of results.
dict
Response Syntax
{
'Items': [
{
'ProfileId': 'string',
'Version': 123,
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileName': 'string',
'ProfileDescription': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from the ListDataTransformationProfiles operation.
Items (list) --
The list of data transformation profile summaries.
(dict) --
Contains summary information about a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.
ProfileId (string) --
The unique identifier of the profile.
Version (integer) --
The latest version number of the profile.
SourceFormat (string) --
The source data format that this profile converts from.
TargetFormat (string) --
The target output format of the profile.
ProfileName (string) --
The name of the profile.
ProfileDescription (string) --
A description of the profile's purpose.
LastUpdatedAt (datetime) --
The timestamp when the profile was last updated.
NextToken (string) --
The pagination token to use in the next request. If this value is null, there are no more results.
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.
See also: AWS API Documentation
Request Syntax
client.list_data_transformation_profile_versions(
ProfileId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the profile whose versions to list.
integer
The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results.
string
The pagination token from a previous response. Pass this value to retrieve the next page of results.
dict
Response Syntax
{
'Items': [
{
'ProfileId': 'string',
'Version': 123,
'SourceFormat': 'CCDA'|'CSV',
'TargetFormat': 'FHIR_R4',
'ProfileName': 'string',
'ChangeDescription': 'string',
'LastUpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from the ListDataTransformationProfileVersions operation.
Items (list) --
The list of data transformation profile version summaries.
(dict) --
Contains summary information about a specific version of a data transformation profile. To retrieve profile content, call GetDataTransformationProfile.
ProfileId (string) --
The unique identifier of the profile.
Version (integer) --
The version number.
SourceFormat (string) --
The source data format that this profile converts from.
TargetFormat (string) --
The target output format of the profile.
ProfileName (string) --
The name of the profile.
ChangeDescription (string) --
A description of what changed in this version.
LastUpdatedAt (datetime) --
The timestamp when this version was last updated.
NextToken (string) --
The pagination token to use in the next request. If this value is null, there are no more results.
{'ImportJobProperties': {'JobProgressReport': {'TotalFilesConverted': 'long',
'TotalNumberOfImportedNonFhirFiles': 'long',
'TotalNumberOfNonFhirFilesReadWithCustomerError': 'long',
'TotalNumberOfNonFhirResourcesImported': 'long',
'TotalNumberOfNonFhirResourcesScanned': 'long',
'TotalNumberOfNonFhirResourcesWithCustomerError': 'long',
'TotalNumberOfScannedNonFhirFiles': 'long',
'TotalResourcesGenerated': 'long',
'TotalSizeOfScannedNonFhirFilesInMB': 'double'}}}
Get the import job properties to learn more about the job or job progress.
See also: AWS API Documentation
Request Syntax
client.describe_fhir_import_job(
DatastoreId='string',
JobId='string'
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The import job identifier.
dict
Response Syntax
{
'ImportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DatastoreId': 'string',
'InputDataConfig': {
'S3Uri': 'string'
},
'JobOutputDataConfig': {
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
'JobProgressReport': {
'TotalNumberOfScannedFiles': 123,
'TotalSizeOfScannedFilesInMB': 123.0,
'TotalNumberOfImportedFiles': 123,
'TotalNumberOfResourcesScanned': 123,
'TotalNumberOfResourcesImported': 123,
'TotalNumberOfResourcesWithCustomerError': 123,
'TotalNumberOfFilesReadWithCustomerError': 123,
'TotalNumberOfScannedNonFhirFiles': 123,
'TotalSizeOfScannedNonFhirFilesInMB': 123.0,
'TotalNumberOfImportedNonFhirFiles': 123,
'TotalNumberOfNonFhirResourcesScanned': 123,
'TotalNumberOfNonFhirResourcesImported': 123,
'TotalNumberOfNonFhirResourcesWithCustomerError': 123,
'TotalNumberOfNonFhirFilesReadWithCustomerError': 123,
'Throughput': 123.0,
'TotalFilesConverted': 123,
'TotalResourcesGenerated': 123
},
'DataAccessRoleArn': 'string',
'Message': 'string',
'ValidationLevel': 'strict'|'structure-only'|'minimal'
}
}
Response Structure
(dict) --
ImportJobProperties (dict) --
The import job properties.
JobId (string) --
The import job identifier.
JobName (string) --
The import job name.
JobStatus (string) --
The import job status.
SubmitTime (datetime) --
The time the import job was submitted for processing.
EndTime (datetime) --
The time the import job was completed.
DatastoreId (string) --
The data store identifier.
InputDataConfig (dict) --
The input data configuration supplied when the import job was created.
S3Uri (string) --
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
JobOutputDataConfig (dict) --
The output data configuration supplied when the export job was created.
S3Configuration (dict) --
The output data configuration supplied when the export job was created.
S3Uri (string) --
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
KmsKeyId (string) --
The Key Management Service (KMS) key ID used to access the S3 bucket.
JobProgressReport (dict) --
Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.
TotalNumberOfScannedFiles (integer) --
The number of files scanned from the S3 input bucket.
TotalSizeOfScannedFilesInMB (float) --
The size (in MB) of files scanned from the S3 input bucket.
TotalNumberOfImportedFiles (integer) --
The number of files imported.
TotalNumberOfResourcesScanned (integer) --
The number of resources scanned from the S3 input bucket.
TotalNumberOfResourcesImported (integer) --
The number of resources imported.
TotalNumberOfResourcesWithCustomerError (integer) --
The number of resources that failed due to customer error.
TotalNumberOfFilesReadWithCustomerError (integer) --
The number of files that failed to be read from the S3 input bucket due to customer error.
TotalNumberOfScannedNonFhirFiles (integer) --
The number of non-FHIR files scanned from the S3 input bucket.
TotalSizeOfScannedNonFhirFilesInMB (float) --
The size (in MB) of non-FHIR files scanned from the S3 input bucket.
TotalNumberOfImportedNonFhirFiles (integer) --
The number of non-FHIR files imported.
TotalNumberOfNonFhirResourcesScanned (integer) --
The number of non-FHIR resources scanned from the S3 input bucket.
TotalNumberOfNonFhirResourcesImported (integer) --
The number of non-FHIR resources imported.
TotalNumberOfNonFhirResourcesWithCustomerError (integer) --
The number of non-FHIR resources that failed due to customer error.
TotalNumberOfNonFhirFilesReadWithCustomerError (integer) --
The number of non-FHIR files that failed to be read from the S3 input bucket due to customer error.
Throughput (float) --
The transaction rate the import job is processed at.
TotalFilesConverted (integer) --
Number of CCDA files successfully transformed during the import's transformation phase. Populated only for import jobs that use the two-Step-Function (transformation + ingestion) flow; null for legacy single-SF imports and for pure FHIR imports that skip transformation.
TotalResourcesGenerated (integer) --
Number of FHIR resources produced by the transformation phase. Populated only for import jobs that use the two-Step-Function flow; null for legacy single-SF imports and for pure FHIR imports.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.
Message (string) --
An explanation of any errors that might have occurred during the FHIR import job.
ValidationLevel (string) --
The validation level of the import job.
{'ImportJobPropertiesList': {'JobProgressReport': {'TotalFilesConverted': 'long',
'TotalNumberOfImportedNonFhirFiles': 'long',
'TotalNumberOfNonFhirFilesReadWithCustomerError': 'long',
'TotalNumberOfNonFhirResourcesImported': 'long',
'TotalNumberOfNonFhirResourcesScanned': 'long',
'TotalNumberOfNonFhirResourcesWithCustomerError': 'long',
'TotalNumberOfScannedNonFhirFiles': 'long',
'TotalResourcesGenerated': 'long',
'TotalSizeOfScannedNonFhirFilesInMB': 'double'}}}
List all FHIR import jobs associated with an account and their statuses.
See also: AWS API Documentation
Request Syntax
client.list_fhir_import_jobs(
DatastoreId='string',
NextToken='string',
MaxResults=123,
JobName='string',
JobStatus='SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
SubmittedBefore=datetime(2015, 1, 1),
SubmittedAfter=datetime(2015, 1, 1)
)
string
[REQUIRED]
Limits the response to the import job with the specified data store ID.
string
The pagination token used to identify the next page of results to return.
integer
Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.
string
Limits the response to the import job with the specified job name.
string
Limits the response to the import job with the specified job status.
datetime
Limits the response to FHIR import jobs submitted before a user- specified date.
datetime
Limits the response to FHIR import jobs submitted after a user-specified date.
dict
Response Syntax
{
'ImportJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DatastoreId': 'string',
'InputDataConfig': {
'S3Uri': 'string'
},
'JobOutputDataConfig': {
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
'JobProgressReport': {
'TotalNumberOfScannedFiles': 123,
'TotalSizeOfScannedFilesInMB': 123.0,
'TotalNumberOfImportedFiles': 123,
'TotalNumberOfResourcesScanned': 123,
'TotalNumberOfResourcesImported': 123,
'TotalNumberOfResourcesWithCustomerError': 123,
'TotalNumberOfFilesReadWithCustomerError': 123,
'TotalNumberOfScannedNonFhirFiles': 123,
'TotalSizeOfScannedNonFhirFilesInMB': 123.0,
'TotalNumberOfImportedNonFhirFiles': 123,
'TotalNumberOfNonFhirResourcesScanned': 123,
'TotalNumberOfNonFhirResourcesImported': 123,
'TotalNumberOfNonFhirResourcesWithCustomerError': 123,
'TotalNumberOfNonFhirFilesReadWithCustomerError': 123,
'Throughput': 123.0,
'TotalFilesConverted': 123,
'TotalResourcesGenerated': 123
},
'DataAccessRoleArn': 'string',
'Message': 'string',
'ValidationLevel': 'strict'|'structure-only'|'minimal'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ImportJobPropertiesList (list) --
The properties for listed import jobs.
(dict) --
The import job properties.
JobId (string) --
The import job identifier.
JobName (string) --
The import job name.
JobStatus (string) --
The import job status.
SubmitTime (datetime) --
The time the import job was submitted for processing.
EndTime (datetime) --
The time the import job was completed.
DatastoreId (string) --
The data store identifier.
InputDataConfig (dict) --
The input data configuration supplied when the import job was created.
S3Uri (string) --
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
JobOutputDataConfig (dict) --
The output data configuration supplied when the export job was created.
S3Configuration (dict) --
The output data configuration supplied when the export job was created.
S3Uri (string) --
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
KmsKeyId (string) --
The Key Management Service (KMS) key ID used to access the S3 bucket.
JobProgressReport (dict) --
Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.
TotalNumberOfScannedFiles (integer) --
The number of files scanned from the S3 input bucket.
TotalSizeOfScannedFilesInMB (float) --
The size (in MB) of files scanned from the S3 input bucket.
TotalNumberOfImportedFiles (integer) --
The number of files imported.
TotalNumberOfResourcesScanned (integer) --
The number of resources scanned from the S3 input bucket.
TotalNumberOfResourcesImported (integer) --
The number of resources imported.
TotalNumberOfResourcesWithCustomerError (integer) --
The number of resources that failed due to customer error.
TotalNumberOfFilesReadWithCustomerError (integer) --
The number of files that failed to be read from the S3 input bucket due to customer error.
TotalNumberOfScannedNonFhirFiles (integer) --
The number of non-FHIR files scanned from the S3 input bucket.
TotalSizeOfScannedNonFhirFilesInMB (float) --
The size (in MB) of non-FHIR files scanned from the S3 input bucket.
TotalNumberOfImportedNonFhirFiles (integer) --
The number of non-FHIR files imported.
TotalNumberOfNonFhirResourcesScanned (integer) --
The number of non-FHIR resources scanned from the S3 input bucket.
TotalNumberOfNonFhirResourcesImported (integer) --
The number of non-FHIR resources imported.
TotalNumberOfNonFhirResourcesWithCustomerError (integer) --
The number of non-FHIR resources that failed due to customer error.
TotalNumberOfNonFhirFilesReadWithCustomerError (integer) --
The number of non-FHIR files that failed to be read from the S3 input bucket due to customer error.
Throughput (float) --
The transaction rate the import job is processed at.
TotalFilesConverted (integer) --
Number of CCDA files successfully transformed during the import's transformation phase. Populated only for import jobs that use the two-Step-Function (transformation + ingestion) flow; null for legacy single-SF imports and for pure FHIR imports that skip transformation.
TotalResourcesGenerated (integer) --
Number of FHIR resources produced by the transformation phase. Populated only for import jobs that use the two-Step-Function flow; null for legacy single-SF imports and for pure FHIR imports.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.
Message (string) --
An explanation of any errors that might have occurred during the FHIR import job.
ValidationLevel (string) --
The validation level of the import job.
NextToken (string) --
The pagination token used to identify the next page of results to return.
{'DriftDetectionEnabled': 'boolean',
'InputFormat': 'string',
'ProfileId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.start_fhir_import_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string'
},
JobOutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string',
ValidationLevel='strict'|'structure-only'|'minimal',
ProfileId='string',
InputFormat='string',
DriftDetectionEnabled=True|False
)
string
The import job name.
dict
[REQUIRED]
The input properties for the import job request.
S3Uri (string) --
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
dict
[REQUIRED]
The output data configuration supplied when the export job was created.
S3Configuration (dict) --
The output data configuration supplied when the export job was created.
S3Uri (string) -- [REQUIRED]
The S3Uri is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.
KmsKeyId (string) -- [REQUIRED]
The Key Management Service (KMS) key ID used to access the S3 bucket.
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.
string
The optional user-provided token used for ensuring API idempotency.
This field is autopopulated if not provided.
string
The validation level of the import job.
string
A bounded-length string value.
string
A bounded-length string value.
boolean
A boolean value.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
'DatastoreId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The import job identifier.
JobStatus (string) --
The import job status.
DatastoreId (string) --
The data store identifier.