populate_id_mapping_table ¶

populate_id_mapping_table(
    id_mapping_table_identifier: UUID,
    membership_identifier: MembershipIdentifier,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    job_type: Optional[JobType] = None,
) -> PopulateIdMappingTableOutput

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

Parameters:

id_mapping_table_identifier (UUID) –

The unique identifier of the ID mapping table that you want to populate.
membership_identifier (MembershipIdentifier) –

The unique identifier of the membership that contains the ID mapping table that you want to populate.
job_type (Optional[JobType], default: None ) –

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.

Raises:

AccessDeniedException –

Caller does not have sufficient access to perform this action.
ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalServerException –

Unexpected error during processing of request.
ResourceNotFoundException –

Request references a resource which does not exist.
ServiceQuotaExceededException –

Request denied because service quota has been exceeded.
ThrottlingException –

Request was denied due to request throttling.
ValidationException –

The input fails to satisfy the specified constraints.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py

def populate_id_mapping_table(
    self,
    id_mapping_table_identifier: "capo_cleanrooms.types.uuid.UUID",
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    job_type: Optional["capo_cleanrooms.types.job_type.JobType"] = None,
) -> "capo_cleanrooms.types.populate_id_mapping_table_output.PopulateIdMappingTableOutput":
    """<p>Defines the information that's necessary to populate an ID mapping table.</p>

    Args:
        id_mapping_table_identifier: <p>The unique identifier of the ID mapping table that you want to populate.</p>
        membership_identifier: <p>The unique identifier of the membership that contains the ID mapping table that you want to populate.</p>
        job_type: <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>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request denied because service quota has been exceeded.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.populate_id_mapping_table_input.PopulateIdMappingTableInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.populate_id_mapping_table_output.PopulateIdMappingTableOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.populate_id_mapping_table

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.populate_id_mapping_table.populate_id_mapping_table(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PopulateIdMappingTable")
    )
    input_: capo_cleanrooms.types.populate_id_mapping_table_input.PopulateIdMappingTableInput = {
        "id_mapping_table_identifier": id_mapping_table_identifier,
        "membership_identifier": membership_identifier,
    }
    if job_type is not None:
        input_["job_type"] = job_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output