create_id_mapping_workflow ¶

def create_id_mapping_workflow(
    self,
    workflow_name: "capo_entityresolution.types.entity_name.EntityName",
    input_source_config: "capo_entityresolution.types.id_mapping_workflow_input_source_config.IdMappingWorkflowInputSourceConfig",
    id_mapping_techniques: "capo_entityresolution.types.id_mapping_techniques.IdMappingTechniques",
    *,
    config_overrides: Optional[EntityResolutionClientConfig] = None,
    description: Optional[
        "capo_entityresolution.types.description.Description"
    ] = None,
    output_source_config: Optional[
        "capo_entityresolution.types.id_mapping_workflow_output_source_config.IdMappingWorkflowOutputSourceConfig"
    ] = None,
    incremental_run_config: Optional[
        "capo_entityresolution.types.id_mapping_incremental_run_config.IdMappingIncrementalRunConfig"
    ] = None,
    role_arn: Optional[
        "capo_entityresolution.types.id_mapping_role_arn.IdMappingRoleArn"
    ] = None,
    tags: Optional["capo_entityresolution.types.tag_map.TagMap"] = None,
) -> "capo_entityresolution.types.create_id_mapping_workflow_output.CreateIdMappingWorkflowOutput":
    """<p>Creates an <code>IdMappingWorkflow</code> object which stores the configuration of the data processing job to be run. Each <code>IdMappingWorkflow</code> must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.</p> <important> <p>Incremental processing is not supported for ID mapping workflows. </p> </important>

    Args:
        workflow_name: <p>The name of the workflow. There can't be multiple <code>IdMappingWorkflows</code> with the same name.</p>
        description: <p>A description of the workflow.</p>
        input_source_config: <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and <code>SchemaName</code>.</p>
        output_source_config: <p>A list of <code>IdMappingWorkflowOutputSource</code> objects, each of which contains fields <code>outputS3Path</code> and <code>KMSArn</code>.</p>
        id_mapping_techniques: <p>An object which defines the ID mapping technique and any additional configurations.</p>
        incremental_run_config: <p> The incremental run configuration for the ID mapping workflow.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.</p>
        tags: <p>The tags used to organize, track, or control access for this resource.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </p>
        capo_entityresolution.errors.conflict_exception.ConflictException: <p>The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
        capo_entityresolution.errors.exceeds_limit_exception.ExceedsLimitException: <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. </p>
        capo_entityresolution.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
        capo_entityresolution.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. </p>
        capo_entityresolution.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
        capo_entityresolution.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_entityresolution.types.create_id_mapping_workflow_input.CreateIdMappingWorkflowInput]",
    ) -> OperationResponse[
        "capo_entityresolution.types.create_id_mapping_workflow_output.CreateIdMappingWorkflowOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.create_id_mapping_workflow

        output, http_response = (
            capo_entityresolution._operations.aws_venice_service.create_id_mapping_workflow.create_id_mapping_workflow(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateIdMappingWorkflow")
    )
    input_: capo_entityresolution.types.create_id_mapping_workflow_input.CreateIdMappingWorkflowInput = {
        "workflow_name": workflow_name,
        "input_source_config": input_source_config,
        "id_mapping_techniques": id_mapping_techniques,
    }
    if description is not None:
        input_["description"] = description
    if output_source_config is not None:
        input_["output_source_config"] = output_source_config
    if incremental_run_config is not None:
        input_["incremental_run_config"] = incremental_run_config
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if tags is not None:
        input_["tags"] = tags

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