Skip to content

RuleBasedMatchingResponse

Source code in docs_src/capo_customer_profiles/types/rule_based_matching_response.py
class RuleBasedMatchingResponse(TypedDict, closed=True):
    enabled: NotRequired[
        "capo_customer_profiles.types.optional_boolean.optionalBoolean"
    ]
    """<p>The flag that enables the rule-based matching process of duplicate profiles.</p>"""
    matching_rules: NotRequired[
        "capo_customer_profiles.types.matching_rules.MatchingRules"
    ]
    """<p>Configures how the rule-based matching process should match profiles. You can have up to 15 <code>MatchingRule</code> in the <code>MatchingRules</code>.</p>"""
    status: NotRequired[
        "capo_customer_profiles.types.rule_based_matching_status.RuleBasedMatchingStatus"
    ]
    """<p>PENDING</p> <ul> <li> <p>The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the <code>PENDING</code> stage.</p> </li> </ul> <p>IN_PROGRESS</p> <ul> <li> <p>The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.</p> </li> </ul> <p>ACTIVE</p> <ul> <li> <p>The rule is ready to use. You can change the rule a day after the status is in <code>ACTIVE</code>.</p> </li> </ul>"""
    max_allowed_rule_level_for_merging: NotRequired[
        "capo_customer_profiles.types.max_allowed_rule_level_for_merging.MaxAllowedRuleLevelForMerging"
    ]
    """<p> <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a> </p>"""
    max_allowed_rule_level_for_matching: NotRequired[
        "capo_customer_profiles.types.max_allowed_rule_level_for_matching.MaxAllowedRuleLevelForMatching"
    ]
    """<p>Indicates the maximum allowed rule level.</p>"""
    attribute_types_selector: NotRequired[
        "capo_customer_profiles.types.attribute_types_selector.AttributeTypesSelector"
    ]
    """<p>Configures information about the <code>AttributeTypesSelector</code> where the rule-based identity resolution uses to match profiles.</p>"""
    conflict_resolution: NotRequired[
        "capo_customer_profiles.types.conflict_resolution.ConflictResolution"
    ]
    exporting_config: NotRequired[
        "capo_customer_profiles.types.exporting_config.ExportingConfig"
    ]

attribute_types_selector instance-attribute

attribute_types_selector: NotRequired[AttributeTypesSelector]

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

conflict_resolution instance-attribute

conflict_resolution: NotRequired[ConflictResolution]

enabled instance-attribute

enabled: NotRequired[optionalBoolean]

The flag that enables the rule-based matching process of duplicate profiles.

exporting_config instance-attribute

exporting_config: NotRequired[ExportingConfig]

matching_rules instance-attribute

matching_rules: NotRequired[MatchingRules]

Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

max_allowed_rule_level_for_matching instance-attribute

max_allowed_rule_level_for_matching: NotRequired[MaxAllowedRuleLevelForMatching]

Indicates the maximum allowed rule level.

max_allowed_rule_level_for_merging instance-attribute

max_allowed_rule_level_for_merging: NotRequired[MaxAllowedRuleLevelForMerging]

status instance-attribute

status: NotRequired[RuleBasedMatchingStatus]

PENDING

  • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

IN_PROGRESS

  • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

ACTIVE

  • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.