HealthLake / Client / start_data_transformation_job

start_data_transformation_job

HealthLake.Client.start_data_transformation_job(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_data_transformation_job(
    InputDataConfig={
        'S3Uri': 'string',
        'SourceFormat': 'CCDA'|'CSV'
    },
    OutputDataConfig={
        'S3Configuration': {
            'S3Uri': 'string',
            'KmsKeyId': 'string'
        }
    },
    DataAccessRoleArn='string',
    ClientToken='string',
    JobName='string',
    ProfileId='string',
    DriftDetectionEnabled=True|False,
    ProvenanceEnabled=True|False
)

Parameters:

• InputDataConfig (dict) –

  [REQUIRED]

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

  • S3Uri (string) – [REQUIRED]

    The Amazon S3 URI of the input data to transform.

  • SourceFormat (string) –

    The format of the source data files (C-CDA or CSV).

• OutputDataConfig (dict) –

  [REQUIRED]

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

  • S3Configuration (dict) – [REQUIRED]

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

    • S3Uri (string) – [REQUIRED]

      The Amazon S3 URI where AWS HealthLake writes the converted output files.

    • KmsKeyId (string) – [REQUIRED]

      The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.

• DataAccessRoleArn (string) –

  [REQUIRED]

  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.

• ClientToken (string) –

  [REQUIRED]

  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.

• JobName (string) – A descriptive name for the data transformation job.

• ProfileId (string) –

  [REQUIRED]

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

• DriftDetectionEnabled (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.

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

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'
}

Response Structure

• (dict) –

  The response from the StartDataTransformationJob operation.

  • JobId (string) –

    The unique identifier assigned to the data transformation job.

  • JobStatus (string) –

    The initial status of the data transformation job.

Exceptions

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.AccessDeniedException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.InternalServerException