Skip to content

get_id_mapping_workflow

get_id_mapping_workflow(
    workflow_name: EntityName,
    *,
    config_overrides: Optional[EntityResolutionClientConfig] = None,
) -> GetIdMappingWorkflowOutput

Returns the IdMappingWorkflow with a given name, if it exists.

Parameters:

  • workflow_name (EntityName) –

    The name of the workflow.

Raises:

Source code in docs_src/capo_entityresolution/_services/entity_resolution.py
def get_id_mapping_workflow(
    self,
    workflow_name: "capo_entityresolution.types.entity_name.EntityName",
    *,
    config_overrides: Optional[EntityResolutionClientConfig] = None,
) -> "capo_entityresolution.types.get_id_mapping_workflow_output.GetIdMappingWorkflowOutput":
    """<p>Returns the <code>IdMappingWorkflow</code> with a given name, if it exists.</p>

    Args:
        workflow_name: <p>The name of the workflow.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </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.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found. </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.get_id_mapping_workflow_input.GetIdMappingWorkflowInput]",
    ) -> OperationResponse[
        "capo_entityresolution.types.get_id_mapping_workflow_output.GetIdMappingWorkflowOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.get_id_mapping_workflow

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIdMappingWorkflow")
    )
    input_: capo_entityresolution.types.get_id_mapping_workflow_input.GetIdMappingWorkflowInput = {
        "workflow_name": workflow_name
    }

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