:doc:`CleanRoomsService <../../cleanrooms>` / Client / populate_id_mapping_table

*************************
populate_id_mapping_table
*************************



.. py:method:: CleanRoomsService.Client.populate_id_mapping_table(**kwargs)

  

  Defines the information that's necessary to populate an ID mapping table.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/PopulateIdMappingTable>`_  


  **Request Syntax**
  ::

    response = client.populate_id_mapping_table(
        idMappingTableIdentifier='string',
        membershipIdentifier='string',
        jobType='BATCH'|'INCREMENTAL'|'DELETE_ONLY'
    )
    
  :type idMappingTableIdentifier: string
  :param idMappingTableIdentifier: **[REQUIRED]** 

    The unique identifier of the ID mapping table that you want to populate.

    

  
  :type membershipIdentifier: string
  :param membershipIdentifier: **[REQUIRED]** 

    The unique identifier of the membership that contains the ID mapping table that you want to populate.

    

  
  :type jobType: string
  :param jobType: 

    The job type of the rule-based ID mapping job. Valid values include:

     

    ``INCREMENTAL``: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution with ``incrementalRunConfig`` specified.

     

    ``BATCH``: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution but ``incrementalRunConfig`` wasn't specified.

     

    ``DELETE_ONLY``: Processes only deletion requests from ``BatchDeleteUniqueId``, which is set in Entity Resolution.

     

    For more information about ``incrementalRunConfig`` and ``BatchDeleteUniqueId``, see the `Entity Resolution API Reference <https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html>`__.

    

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

    
    ::

      {
          'idMappingJobId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **idMappingJobId** *(string) --* 

        The unique identifier of the mapping job that will populate the ID mapping table.

        
  
  **Exceptions**
  
  *   :py:class:`CleanRoomsService.Client.exceptions.ConflictException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ServiceQuotaExceededException`

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

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

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

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ThrottlingException`

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

  