CleanRoomsService / Client / populate_id_mapping_table
populate_id_mapping_table¶
- CleanRoomsService.Client.populate_id_mapping_table(**kwargs)¶
Defines the information that’s necessary to populate an ID mapping table.
See also: AWS API Documentation
Request Syntax
response = client.populate_id_mapping_table( idMappingTableIdentifier='string', membershipIdentifier='string', jobType='BATCH'|'INCREMENTAL'|'DELETE_ONLY' )
- Parameters:
idMappingTableIdentifier (string) –
[REQUIRED]
The unique identifier of the ID mapping table that you want to populate.
membershipIdentifier (string) –
[REQUIRED]
The unique identifier of the membership that contains the ID mapping table that you want to populate.
jobType (string) –
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 withincrementalRunConfig
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 butincrementalRunConfig
wasn’t specified.DELETE_ONLY
: Processes only deletion requests fromBatchDeleteUniqueId
, which is set in Entity Resolution.For more information about
incrementalRunConfig
andBatchDeleteUniqueId
, see the Entity Resolution API Reference.
- Return type:
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
CleanRoomsService.Client.exceptions.ConflictException
CleanRoomsService.Client.exceptions.ServiceQuotaExceededException
CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException