Skip to content

get_data_transformation_profile

get_data_transformation_profile(
    profile_id: ProfileIdString,
    *,
    config_overrides: Optional[HealthLakeClientConfig] = None,
    profile_version: Optional[ProfileVersion] = None,
) -> GetDataTransformationProfileResponse

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.

Parameters:

  • profile_id (ProfileIdString) –

    The unique identifier of the profile to retrieve.

  • profile_version (Optional[ProfileVersion], default: None ) –

    The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.

Raises:

Source code in docs_src/capo_healthlake/_services/health_lake.py
def get_data_transformation_profile(
    self,
    profile_id: "capo_healthlake.types.profile_id_string.ProfileIdString",
    *,
    config_overrides: Optional[HealthLakeClientConfig] = None,
    profile_version: Optional[
        "capo_healthlake.types.profile_version.ProfileVersion"
    ] = None,
) -> "capo_healthlake.types.get_data_transformation_profile_response.GetDataTransformationProfileResponse":
    """<p>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.</p>

    Args:
        profile_id: <p>The unique identifier of the profile to retrieve.</p>
        profile_version: <p>The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.</p>

    Raises:
        capo_healthlake.errors.access_denied_exception.AccessDeniedException: <p>Access is denied. Your account is not authorized to perform this operation.</p>
        capo_healthlake.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred in the service.</p>
        capo_healthlake.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested data store was not found.</p>
        capo_healthlake.errors.throttling_exception.ThrottlingException: <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
        capo_healthlake.errors.validation_exception.ValidationException: <p>The user input parameter was invalid.</p>
        capo_healthlake.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_healthlake.types.get_data_transformation_profile_request.GetDataTransformationProfileRequest]",
    ) -> OperationResponse[
        "capo_healthlake.types.get_data_transformation_profile_response.GetDataTransformationProfileResponse"
    ]:
        import capo_healthlake._operations.health_lake.get_data_transformation_profile

        output, http_response = (
            capo_healthlake._operations.health_lake.get_data_transformation_profile.get_data_transformation_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_healthlake.types.get_data_transformation_profile_response.GetDataTransformationProfileResponse",
    ) -> dict[str, Any]:
        import capo_healthlake.types.get_data_transformation_profile_response

        return capo_healthlake.types.get_data_transformation_profile_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetDataTransformationProfile", redact_output=_redact_output
        ),
    )
    input_: capo_healthlake.types.get_data_transformation_profile_request.GetDataTransformationProfileRequest = {
        "profile_id": profile_id
    }
    if profile_version is not None:
        input_["profile_version"] = profile_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output