:doc:`EntityResolution <../../entityresolution>` / Client / get_match_id

************
get_match_id
************



.. py:method:: EntityResolution.Client.get_match_id(**kwargs)

  

  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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetMatchId>`_  


  **Request Syntax**
  ::

    response = client.get_match_id(
        workflowName='string',
        record={
            'string': 'string'
        },
        applyNormalization=True|False
    )
    
  :type workflowName: string
  :param workflowName: **[REQUIRED]** 

    The name of the workflow.

    

  
  :type record: dict
  :param record: **[REQUIRED]** 

    The record to fetch the Match ID for.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type applyNormalization: boolean
  :param applyNormalization: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'matchId': 'string',
          'matchRule': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **matchId** *(string) --* 

        The unique identifiers for this group of match records.

        
      

      - **matchRule** *(string) --* 

        The rule the record matched on.

        
  
  **Exceptions**
  
  *   :py:class:`EntityResolution.Client.exceptions.ThrottlingException`

  
  *   :py:class:`EntityResolution.Client.exceptions.InternalServerException`

  
  *   :py:class:`EntityResolution.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`EntityResolution.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`EntityResolution.Client.exceptions.ValidationException`

  