Skip to content

TransformationJobProperties

Source code in docs_src/capo_healthlake/types/transformation_job_properties.py
class TransformationJobProperties(TypedDict, closed=True):
    job_id: "capo_healthlake.types.data_transformation_job_id.DataTransformationJobId"
    """<p>The unique identifier of the data transformation job.</p>"""
    job_status: (
        "capo_healthlake.types.transformation_job_status.TransformationJobStatus"
    )
    """<p>The current status of the data transformation job.</p>"""
    input_data_config: "capo_healthlake.types.transformation_input_data_config.TransformationInputDataConfig"
    """<p>The Amazon S3 location and format of the source files for this job.</p>"""
    output_data_config: "capo_healthlake.types.transformation_output_data_config.TransformationOutputDataConfig"
    """<p>The Amazon S3 location and encryption configuration for the converted output.</p>"""
    data_access_role_arn: "capo_healthlake.types.data_transformation_iam_role_arn.DataTransformationIamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants HealthLake access to the specified Amazon S3 locations. HealthLake assumes this role to read input files and write output files.</p>"""
    submit_time: "capo_healthlake.types.date_time.DateTime"
    """<p>The timestamp when the job was submitted.</p>"""
    job_name: NotRequired[
        "capo_healthlake.types.data_transformation_job_name.DataTransformationJobName"
    ]
    """<p>The name of the data transformation job.</p>"""
    profile_id: NotRequired["capo_healthlake.types.profile_id_string.ProfileIdString"]
    """<p>The unique identifier of the data transformation profile used for this job.</p>"""
    profile_name: NotRequired[
        "capo_healthlake.types.profile_name_string.ProfileNameString"
    ]
    """<p>The name of the data transformation profile used for this job.</p>"""
    profile_version: NotRequired["int"]
    """<p>The version number of the data transformation profile used for this job.</p>"""
    end_time: NotRequired["capo_healthlake.types.date_time.DateTime"]
    """<p>The timestamp when the job completed or failed.</p>"""
    drift_detection_enabled: NotRequired["bool"]
    """<p>Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.</p>"""
    provenance_enabled: NotRequired["bool"]
    """<p>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.</p>"""
    message: NotRequired["capo_healthlake.types.bounded_string.BoundedString"]
    """<p>An informational message about the job, such as an error description if the job failed.</p>"""
    job_progress_report: NotRequired[
        "capo_healthlake.types.transformation_job_progress_report.TransformationJobProgressReport"
    ]
    """<p>The progress report for the data transformation job, including counts of files processed and resources generated.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: DataTransformationIamRoleArn

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants HealthLake access to the specified Amazon S3 locations. HealthLake assumes this role to read input files and write output files.

drift_detection_enabled instance-attribute

drift_detection_enabled: NotRequired[bool]

Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.

end_time instance-attribute

end_time: NotRequired[DateTime]

The timestamp when the job completed or failed.

input_data_config instance-attribute

input_data_config: TransformationInputDataConfig

The Amazon S3 location and format of the source files for this job.

job_id instance-attribute

The unique identifier of the data transformation job.

job_name instance-attribute

job_name: NotRequired[DataTransformationJobName]

The name of the data transformation job.

job_progress_report instance-attribute

job_progress_report: NotRequired[TransformationJobProgressReport]

The progress report for the data transformation job, including counts of files processed and resources generated.

job_status instance-attribute

The current status of the data transformation job.

message instance-attribute

message: NotRequired[BoundedString]

An informational message about the job, such as an error description if the job failed.

output_data_config instance-attribute

output_data_config: TransformationOutputDataConfig

The Amazon S3 location and encryption configuration for the converted output.

profile_id instance-attribute

profile_id: NotRequired[ProfileIdString]

The unique identifier of the data transformation profile used for this job.

profile_name instance-attribute

profile_name: NotRequired[ProfileNameString]

The name of the data transformation profile used for this job.

profile_version instance-attribute

profile_version: NotRequired[int]

The version number of the data transformation profile used for this job.

provenance_enabled instance-attribute

provenance_enabled: NotRequired[bool]

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 instance-attribute

submit_time: DateTime

The timestamp when the job was submitted.