data_transformation_profiles

Creates, updates, deletes, gets or lists a data_transformation_profiles resource.

Overview

Name	data_transformation_profiles
Type	Resource
Id	aws.healthlake.data_transformation_profiles

Fields

The following fields are returned by SELECT queries:

get_data_transformation_profile

Name	Datatype	Description
change_description	string	A description of what changed in this version.
last_updated_at	string (date-time)	The timestamp when this version was last updated.
profile_description	string	The description of the profile.
profile_id	string	The unique identifier of the profile. (pattern: <code>[a-f0-9]{32}</code>)
profile_mapping	object	The profile content as a map of file paths to content strings.
profile_name	string	The name of the profile.
source_format	string	The source data format of the profile. (CCDA, CSV)
target_format	string	The target output format of the profile. (FHIR_R4)
version	integer	The version number of the retrieved profile.

list_data_transformation_profiles

Name	Datatype	Description
last_updated_at	string (date-time)	The timestamp when the profile was last updated.
profile_description	string	A description of the profile's purpose.
profile_id	string	The unique identifier of the profile. (pattern: <code>[a-f0-9]{32}</code>)
profile_name	string	The name of the profile.
source_format	string	The source data format that this profile converts from. (CCDA, CSV)
target_format	string	The target output format of the profile. (FHIR_R4)
version	integer	The latest version number of the profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_transformation_profile	select	region		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.
list_data_transformation_profiles	select	region		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.
create_data_transformation_profile	insert	region, SourceFormat, Source, ProfileName		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.
update_data_transformation_profile	update	region, ProfileId, ProfileMapping		Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
delete_data_transformation_profile	delete	region		Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_data_transformation_profile

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.

SELECT
change_description,
last_updated_at,
profile_description,
profile_id,
profile_mapping,
profile_name,
source_format,
target_format,
version
FROM aws.healthlake.data_transformation_profiles
WHERE region = '{{ region }}' -- required
;

list_data_transformation_profiles

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.

SELECT
last_updated_at,
profile_description,
profile_id,
profile_name,
source_format,
target_format,
version
FROM aws.healthlake.data_transformation_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_transformation_profile

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.

INSERT INTO aws.healthlake.data_transformation_profiles (
SourceFormat,
Source,
KmsKeyId,
ProfileDescription,
ProfileName,
Tags,
ClientToken,
region
)
SELECT 
'{{ SourceFormat }}' /* required */,
'{{ Source }}' /* required */,
'{{ KmsKeyId }}',
'{{ ProfileDescription }}',
'{{ ProfileName }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
last_updated_at,
profile_id,
profile_name,
source_format,
target_format,
version
;

Manifest

# Description fields are for documentation purposes
- name: data_transformation_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_transformation_profiles resource.
  - name: SourceFormat
    value: "{{ SourceFormat }}"
    description: |
      The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).
    valid_values: ['CCDA', 'CSV']
  - name: Source
    description: |
      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.
    value:
      StarterProfile:
        StarterProfileName: "{{ StarterProfileName }}"
      ExistingVersionedProfileId:
        ProfileId: "{{ ProfileId }}"
        Version: {{ Version }}
      ProfileMapping:
        ProfileMapping: "{{ ProfileMapping }}"
      SampleData:
        S3Uri: "{{ S3Uri }}"
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.
  - name: ProfileDescription
    value: "{{ ProfileDescription }}"
    description: |
      A human-readable description of the profile's purpose.
  - name: ProfileName
    value: "{{ ProfileName }}"
    description: |
      A name for the data transformation profile.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags to associate with the profile at creation time.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      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.

UPDATE examples

update_data_transformation_profile

Updates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.

UPDATE aws.healthlake.data_transformation_profiles
SET 
ProfileId = '{{ ProfileId }}',
ProfileMapping = '{{ ProfileMapping }}',
ChangeDescription = '{{ ChangeDescription }}'
WHERE 
region = '{{ region }}' --required
AND ProfileId = '{{ ProfileId }}' --required
AND ProfileMapping = '{{ ProfileMapping }}' --required
RETURNING
last_updated_at,
profile_id,
profile_name,
source_format,
target_format;

DELETE examples

delete_data_transformation_profile

Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.

DELETE FROM aws.healthlake.data_transformation_profiles
WHERE region = '{{ region }}' --required
;