HealthLake / Client / publish_data_transformation_profile

publish_data_transformation_profile

HealthLake.Client.publish_data_transformation_profile(**kwargs)

Promotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a previously published version.

See also: AWS API Documentation

Request Syntax

response = client.publish_data_transformation_profile(
    ProfileId='string',
    SourceFormat='CCDA'|'CSV',
    FromExistingVersion=123,
    ChangeDescription='string'
)
Parameters:

  • ProfileId (string) –

    [REQUIRED]

    The unique identifier of the profile to publish.

  • SourceFormat (string) –

    [REQUIRED]

    The source data format of the profile.

  • FromExistingVersion (integer) – The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.

  • ChangeDescription (string) – A description of what changed or why this version is being published.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    The response from the PublishDataTransformationProfile operation.

    • ProfileId (string) –

      The unique identifier of the published profile.

    • Version (integer) –

      The new version number that was created.

    • SourceFormat (string) –

      The source data format of the profile.

    • TargetFormat (string) –

      The target output format of the profile.

    • ProfileName (string) –

      The name of the published profile.

    • LastUpdatedAt (datetime) –

      The timestamp when the profile was last updated.

Exceptions

  • HealthLake.Client.exceptions.ServiceQuotaExceededException

  • HealthLake.Client.exceptions.ThrottlingException

  • HealthLake.Client.exceptions.AccessDeniedException

  • HealthLake.Client.exceptions.ResourceNotFoundException

  • HealthLake.Client.exceptions.ValidationException

  • HealthLake.Client.exceptions.InternalServerException