start_data_transformation_job
async
¶
start_data_transformation_job(
input_data_config: TransformationInputDataConfig,
output_data_config: TransformationOutputDataConfig,
data_access_role_arn: DataTransformationIamRoleArn,
client_token: ClientToken,
profile_id: ProfileIdString,
*,
config_overrides: Optional[AsyncHealthLakeClientConfig] = None,
job_name: Optional[DataTransformationJobName] = None,
drift_detection_enabled: Optional[bool] = None,
provenance_enabled: Optional[bool] = None,
) -> StartDataTransformationJobResponse
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 HealthLake.
Parameters:
-
input_data_config(TransformationInputDataConfig) –The Amazon S3 location and format of the source files to transform.
-
output_data_config(TransformationOutputDataConfig) –The Amazon S3 output location and Amazon Web Services Key Management Service (Amazon Web Services KMS) encryption configuration.
-
data_access_role_arn(DataTransformationIamRoleArn) –The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that HealthLake assumes to read from and write to the specified Amazon S3 locations.
-
client_token(ClientToken) –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.
-
job_name(Optional[DataTransformationJobName], default:None) –A descriptive name for the data transformation job.
-
profile_id(ProfileIdString) –The unique identifier of the data transformation profile to use for conversion.
-
drift_detection_enabled(Optional[bool], default:None) –Specifies whether drift detection is enabled for this job. When enabled, HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.
-
provenance_enabled(Optional[bool], default:None) –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 tofalse.
Raises:
-
AccessDeniedException–Access is denied. Your account is not authorized to perform this operation.
-
InternalServerException–An unknown internal error occurred in the service.
-
ResourceNotFoundException–The requested data store was not found.
-
ThrottlingException–The user has exceeded their maximum number of allowed calls to the given API.
-
ValidationException–The user input parameter was invalid.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_healthlake/_services/async_health_lake.py
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 | |