Skip to content

UpdateDomainRequest

Source code in docs_src/capo_customer_profiles/types/update_domain_request.py
class UpdateDomainRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    default_expiration_days: NotRequired[
        "capo_customer_profiles.types.expiration_days_integer.expirationDaysInteger"
    ]
    """<p>The default number of days until the data within the domain expires.</p>"""
    default_encryption_key: NotRequired[
        "capo_customer_profiles.types.encryption_key.encryptionKey"
    ]
    """<p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.</p>"""
    dead_letter_queue_url: NotRequired[
        "capo_customer_profiles.types.sqs_queue_url.sqsQueueUrl"
    ]
    """<p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p>"""
    matching: NotRequired[
        "capo_customer_profiles.types.matching_request.MatchingRequest"
    ]
    """<p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. </p> <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>"""
    rule_based_matching: NotRequired[
        "capo_customer_profiles.types.rule_based_matching_request.RuleBasedMatchingRequest"
    ]
    """<p>The process of matching duplicate profiles using the rule-Based matching. If <code>RuleBasedMatching</code> = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>"""
    data_store: NotRequired[
        "capo_customer_profiles.types.data_store_request.DataStoreRequest"
    ]
    """<p>Set to true to enabled data store for this domain.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

data_store instance-attribute

data_store: NotRequired[DataStoreRequest]

Set to true to enabled data store for this domain.

dead_letter_queue_url instance-attribute

dead_letter_queue_url: NotRequired[sqsQueueUrl]

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

default_encryption_key instance-attribute

default_encryption_key: NotRequired[encryptionKey]

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

default_expiration_days instance-attribute

default_expiration_days: NotRequired[expirationDaysInteger]

The default number of days until the data within the domain expires.

domain_name instance-attribute

domain_name: name

The unique name of the domain.

matching instance-attribute

matching: NotRequired[MatchingRequest]

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

rule_based_matching instance-attribute

rule_based_matching: NotRequired[RuleBasedMatchingRequest]

The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Connect Customer Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource.