Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartDataTransformationJob

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.

Request Syntax


{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DriftDetectionEnabled": boolean,
   "InputDataConfig": { 
      "S3Uri": "string",
      "SourceFormat": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "S3Configuration": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      }
   },
   "ProfileId": "string",
   "ProvenanceEnabled": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: Yes

DataAccessRoleArn

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

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

InputDataConfig

The Amazon S3 location and format of the source files to transform.

Type: TransformationInputDataConfig object

Required: Yes

JobName

A descriptive name for 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

OutputDataConfig

The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.

Type: TransformationOutputDataConfig object

Required: Yes

ProfileId

The unique identifier of the data transformation profile to use for conversion.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [a-f0-9]{32}

Required: Yes

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. If you don't specify a value, the default is true. To disable provenance output, set this parameter to false.

Type: Boolean

Required: No

Response Syntax


{
   "JobId": "string",
   "JobStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobId

The unique identifier assigned to the data transformation job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [a-zA-Z0-9-]+

JobStatus

The initial status of the data transformation job.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied. Your account is not authorized to perform this operation.

HTTP Status Code: 400

InternalServerException

An unknown internal error occurred in the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested data store was not found.

HTTP Status Code: 400

ThrottlingException

The user has exceeded their maximum number of allowed calls to the given API.

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400