HealthLake / Client / describe_data_transformation_job

describe_data_transformation_job¶

HealthLake.Client.describe_data_transformation_job(**kwargs)¶

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

Request Syntax

response = client.describe_data_transformation_job(
    JobId='string'
)

Parameters:

JobId (string) –

[REQUIRED]

The unique identifier of the data transformation job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'TransformationJobProperties': {
        'JobId': 'string',
        'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
        'InputDataConfig': {
            'S3Uri': 'string',
            'SourceFormat': 'CCDA'|'CSV'
        },
        'OutputDataConfig': {
            'S3Configuration': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            }
        },
        'DataAccessRoleArn': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'JobName': 'string',
        'ProfileId': 'string',
        'ProfileName': 'string',
        'ProfileVersion': 123,
        'EndTime': datetime(2015, 1, 1),
        'DriftDetectionEnabled': True|False,
        'ProvenanceEnabled': True|False,
        'Message': 'string',
        'JobProgressReport': {
            'TotalFilesScanned': 123,
            'TotalFilesConverted': 123,
            'TotalFilesFailed': 123,
            'TotalResourcesGenerated': 123
        }
    }
}

Response Structure

(dict) –

The response from the DescribeDataTransformationJob operation.
- TransformationJobProperties (dict) –
  
  The properties of the data transformation job, including status, configuration, and progress information.
  - JobId (string) –
    
    The unique identifier of the data transformation job.
  - JobStatus (string) –
    
    The current status of the data transformation job.
  - InputDataConfig (dict) –
    
    The Amazon S3 location and format of the source files for this job.
    - S3Uri (string) –
      
      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) –
    
    The Amazon S3 location and encryption configuration for the converted output.
    - S3Configuration (dict) –
      
      The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.
      - S3Uri (string) –
        
        The Amazon S3 URI where AWS HealthLake writes the converted output files.
      - KmsKeyId (string) –
        
        The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.
  - DataAccessRoleArn (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.
  - SubmitTime (datetime) –
    
    The timestamp when the job was submitted.
  - JobName (string) –
    
    The name of the data transformation job.
  - ProfileId (string) –
    
    The unique identifier of the data transformation profile used for this job.
  - ProfileName (string) –
    
    The name of the data transformation profile used for this job.
  - ProfileVersion (integer) –
    
    The version number of the data transformation profile used for this job.
  - EndTime (datetime) –
    
    The timestamp when the job completed or failed.
  - 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.
  - Message (string) –
    
    An informational message about the job, such as an error description if the job failed.
  - JobProgressReport (dict) –
    
    The progress report for the data transformation job, including counts of files processed and resources generated.
    - TotalFilesScanned (integer) –
      
      The total number of source files scanned by the job.
    - TotalFilesConverted (integer) –
      
      The total number of source files successfully converted.
    - TotalFilesFailed (integer) –
      
      The total number of source files that failed conversion.
    - TotalResourcesGenerated (integer) –
      
      The total number of FHIR R4 resources generated across all converted files.

Exceptions

HealthLake.Client.exceptions.ThrottlingException
HealthLake.Client.exceptions.AccessDeniedException
HealthLake.Client.exceptions.ResourceNotFoundException
HealthLake.Client.exceptions.ValidationException
HealthLake.Client.exceptions.InternalServerException