HealthLake / Client / get_data_transformation_profile

get_data_transformation_profile

HealthLake.Client.get_data_transformation_profile(**kwargs)

Retrieves a data transformation profile’s metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number between 1 and 99 to retrieve a specific published version, or omit the version to retrieve the latest published version.

See also: AWS API Documentation

Request Syntax

response = client.get_data_transformation_profile(
    ProfileId='string',
    ProfileVersion=123
)

Parameters:

• ProfileId (string) –

  [REQUIRED]

  The unique identifier of the profile to retrieve.

• ProfileVersion (integer) – The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileId': 'string',
    'Version': 123,
    'SourceFormat': 'CCDA'|'CSV',
    'TargetFormat': 'FHIR_R4',
    'ProfileMapping': {
        'string': 'string'
    },
    'ProfileName': 'string',
    'ProfileDescription': 'string',
    'ChangeDescription': 'string',
    'LastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  The response from the GetDataTransformationProfile operation.

  • ProfileId (string) –

    The unique identifier of the profile.

  • Version (integer) –

    The version number of the retrieved profile.

  • SourceFormat (string) –

    The source data format of the profile.

  • TargetFormat (string) –

    The target output format of the profile.

  • ProfileMapping (dict) –

    The profile content as a map of file paths to content strings.

    • (string) –

      • (string) –

  • ProfileName (string) –

    The name of the profile.

  • ProfileDescription (string) –

    The description of the profile.

  • ChangeDescription (string) –

    A description of what changed in this version.

  • LastUpdatedAt (datetime) –

    The timestamp when this version was last updated.

Exceptions

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.AccessDeniedException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.InternalServerException