Skip to content

PopulateIdMappingTableInput

Source code in docs_src/capo_cleanrooms/types/populate_id_mapping_table_input.py
class PopulateIdMappingTableInput(TypedDict, closed=True):
    id_mapping_table_identifier: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique identifier of the ID mapping table that you want to populate.</p>"""
    membership_identifier: (
        "capo_cleanrooms.types.membership_identifier.MembershipIdentifier"
    )
    """<p>The unique identifier of the membership that contains the ID mapping table that you want to populate.</p>"""
    job_type: NotRequired["capo_cleanrooms.types.job_type.JobType"]
    """<p>The job type of the rule-based ID mapping job. Valid values include:</p> <p> <code>INCREMENTAL</code>: 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 <code>incrementalRunConfig</code> specified.</p> <p> <code>BATCH</code>: 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 <code>incrementalRunConfig</code> wasn't specified.</p> <p> <code>DELETE_ONLY</code>: Processes only deletion requests from <code>BatchDeleteUniqueId</code>, which is set in Entity Resolution.</p> <p>For more information about <code>incrementalRunConfig</code> and <code>BatchDeleteUniqueId</code>, see the <a href="https://docs.aws.amazon.com/entityresolution/latest/apireference/Welcome.html">Entity Resolution API Reference</a>.</p>"""

id_mapping_table_identifier instance-attribute

id_mapping_table_identifier: UUID

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

job_type instance-attribute

job_type: NotRequired[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.

membership_identifier instance-attribute

membership_identifier: MembershipIdentifier

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