data_transformation_jobs

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

Overview

Name	data_transformation_jobs
Type	Resource
Id	aws.healthlake.data_transformation_jobs

Fields

The following fields are returned by SELECT queries:

describe_data_transformation_job

Name	Datatype	Description
data_access_role_arn	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. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
drift_detection_enabled	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.
end_time	string (date-time)	The timestamp when the job completed or failed.
input_data_config	object	The Amazon S3 location and format of the source files for this job.
job_id	string	The unique identifier of the data transformation job. (pattern: <code>[a-zA-Z0-9-]+</code>)
job_name	string	The name of the data transformation job. (pattern: <code>[\p{L}\p{Z}\p{N}_.:/=+-%@]*</code>)
job_progress_report	object	The progress report for the data transformation job, including counts of files processed and resources generated.
job_status	string	The current status of the data transformation job. (SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)
message	string	An informational message about the job, such as an error description if the job failed.
output_data_config	object	The Amazon S3 location and encryption configuration for the converted output.
profile_id	string	The unique identifier of the data transformation profile used for this job. (pattern: <code>[a-f0-9]{32}</code>)
profile_name	string	The name of the data transformation profile used for this job.
profile_version	integer	The version number of the data transformation profile used for this job.
provenance_enabled	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.
submit_time	string (date-time)	The timestamp when the job was submitted.

list_data_transformation_jobs

Name	Datatype	Description
end_time	string (date-time)	The timestamp when the job completed.
job_id	string	The unique identifier of the job. (pattern: <code>[a-zA-Z0-9-]+</code>)
job_name	string	The name of the job. (pattern: <code>[\p{L}\p{Z}\p{N}_.:/=+-%@]*</code>)
job_status	string	The current status of the job. (SUBMITTED, QUEUED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)
source_format	string	The source data format for this job. (CCDA, CSV)
submit_time	string (date-time)	The timestamp when the job was submitted.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_transformation_job	select	region		Describes a data transformation job, including its current status, configuration, and progress information.
list_data_transformation_jobs	select	region		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.

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

describe_data_transformation_job

Describes a data transformation job, including its current status, configuration, and progress information.

SELECT
data_access_role_arn,
drift_detection_enabled,
end_time,
input_data_config,
job_id,
job_name,
job_progress_report,
job_status,
message,
output_data_config,
profile_id,
profile_name,
profile_version,
provenance_enabled,
submit_time
FROM aws.healthlake.data_transformation_jobs
WHERE region = '{{ region }}' -- required
;

list_data_transformation_jobs

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.

SELECT
end_time,
job_id,
job_name,
job_status,
source_format,
submit_time
FROM aws.healthlake.data_transformation_jobs
WHERE region = '{{ region }}' -- required
;