Skip to content

UserAttributeUpdateSettingsType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/user_attribute_update_settings_type.py 
11
12
13
14
15
class UserAttributeUpdateSettingsType(TypedDict, closed=True):
    attributes_require_verification_before_update: NotRequired[
        "capo_cognito_identity_provider.types.attributes_require_verification_before_update_type.AttributesRequireVerificationBeforeUpdateType"
    ]
    """<p>Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.</p> <p>When <code>AttributesRequireVerificationBeforeUpdate</code> is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where <code>AttributesRequireVerificationBeforeUpdate</code> is false, API operations that change attribute values can immediately update a user’s <code>email</code> or <code>phone_number</code> attribute.</p>"""

attributes_require_verification_before_update instance-attribute 

attributes_require_verification_before_update: NotRequired[
    AttributesRequireVerificationBeforeUpdateType
]

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.