TransformationJobProperties
Contains the properties of a data transformation job, including its status,
configuration, and progress information. You retrieve this structure by calling
DescribeDataTransformationJob.
Contents
- DataAccessRoleArn
-
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.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+Required: Yes
- InputDataConfig
-
The Amazon S3 location and format of the source files for this job.
Type: TransformationInputDataConfig object
Required: Yes
- JobId
-
The unique identifier of the data transformation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- JobStatus
-
The current status of the data transformation job.
Type: String
Valid Values:
SUBMITTED | QUEUED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILEDRequired: Yes
- OutputDataConfig
-
The Amazon S3 location and encryption configuration for the converted output.
Type: TransformationOutputDataConfig object
Required: Yes
- SubmitTime
-
The timestamp when the job was submitted.
Type: Timestamp
Required: Yes
- DriftDetectionEnabled
-
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.
Type: Boolean
Required: No
- EndTime
-
The timestamp when the job completed or failed.
Type: Timestamp
Required: No
- JobName
-
The name of the data transformation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\p{L}\p{Z}\p{N}_.:/=+\-%@]*Required: No
- JobProgressReport
-
The progress report for the data transformation job, including counts of files processed and resources generated.
Type: TransformationJobProgressReport object
Required: No
- Message
-
An informational message about the job, such as an error description if the job failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- ProfileId
-
The unique identifier of the data transformation profile used for this job.
Type: String
Length Constraints: Fixed length of 32.
Pattern:
[a-f0-9]{32}Required: No
- ProfileName
-
The name of the data transformation profile used for this job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- ProfileVersion
-
The version number of the data transformation profile used for this job.
Type: Integer
Required: No
- ProvenanceEnabled
-
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.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: