Skip to content

get_match_id async

get_match_id(
    workflow_name: EntityName,
    record: RecordAttributeMap,
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    apply_normalization: Optional[bool] = None,
) -> GetMatchIdOutput

Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow.

You can call this API as a dry run of an incremental load on the rule-based matching workflow.

Parameters:

  • workflow_name (EntityName) –

    The name of the workflow.

  • record (RecordAttributeMap) –

    The record to fetch the Match ID for.

  • apply_normalization (Optional[bool], default: None ) –

    Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

Raises:

Source code in docs_src/capo_entityresolution/_services/async_entity_resolution.py
async def get_match_id(
    self,
    workflow_name: "capo_entityresolution.types.entity_name.EntityName",
    record: "capo_entityresolution.types.record_attribute_map.RecordAttributeMap",
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    apply_normalization: Optional[bool] = None,
) -> "capo_entityresolution.types.get_match_id_output.GetMatchIdOutput":
    """<p>Returns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow.</p> <p>You can call this API as a dry run of an incremental load on the rule-based matching workflow.</p>

    Args:
        workflow_name: <p>The name of the workflow.</p>
        record: <p>The record to fetch the Match ID for.</p>
        apply_normalization: <p>Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_entityresolution.types.get_match_id_input.GetMatchIdInput]",
    ) -> AsyncOperationResponse[
        "capo_entityresolution.types.get_match_id_output.GetMatchIdOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.get_match_id

        (
            output,
            http_response,
        ) = await capo_entityresolution._operations.aws_venice_service.get_match_id.async_get_match_id(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_entityresolution.types.get_match_id_input.GetMatchIdInput",
    ) -> dict[str, Any]:
        import capo_entityresolution.types.get_match_id_input

        return capo_entityresolution.types.get_match_id_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMatchId", redact_input=_redact_input)
    )
    input_: capo_entityresolution.types.get_match_id_input.GetMatchIdInput = {
        "workflow_name": workflow_name,
        "record": record,
    }
    if apply_normalization is not None:
        input_["apply_normalization"] = apply_normalization

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output