Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Documentation

data UserAttributeUpdateSettingsType

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

See: newUserAttributeUpdateSettingsType smart constructor.

Constructors

UserAttributeUpdateSettingsType'

Fields

• attributesRequireVerificationBeforeUpdate :: Maybe [VerifiedAttributeType]

  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.

  You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

  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.

Instances

FromJSON UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

parseJSON :: Value -> Parser UserAttributeUpdateSettingsType

parseJSONList :: Value -> Parser [UserAttributeUpdateSettingsType]

ToJSON UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

toJSON :: UserAttributeUpdateSettingsType -> Value

toEncoding :: UserAttributeUpdateSettingsType -> Encoding

toJSONList :: [UserAttributeUpdateSettingsType] -> Value

toEncodingList :: [UserAttributeUpdateSettingsType] -> Encoding

Generic UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Associated Types

type Rep UserAttributeUpdateSettingsType :: Type -> Type

Methods

from :: UserAttributeUpdateSettingsType -> Rep UserAttributeUpdateSettingsType x

to :: Rep UserAttributeUpdateSettingsType x -> UserAttributeUpdateSettingsType

Read UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

readsPrec :: Int -> ReadS UserAttributeUpdateSettingsType

readList :: ReadS [UserAttributeUpdateSettingsType]

readPrec :: ReadPrec UserAttributeUpdateSettingsType

readListPrec :: ReadPrec [UserAttributeUpdateSettingsType]

Show UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

showsPrec :: Int -> UserAttributeUpdateSettingsType -> ShowS

show :: UserAttributeUpdateSettingsType -> String

showList :: [UserAttributeUpdateSettingsType] -> ShowS

NFData UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

rnf :: UserAttributeUpdateSettingsType -> ()

Eq UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

(==) :: UserAttributeUpdateSettingsType -> UserAttributeUpdateSettingsType -> Bool

(/=) :: UserAttributeUpdateSettingsType -> UserAttributeUpdateSettingsType -> Bool

Hashable UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

Methods

hashWithSalt :: Int -> UserAttributeUpdateSettingsType -> Int

hash :: UserAttributeUpdateSettingsType -> Int

type Rep UserAttributeUpdateSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType

type Rep UserAttributeUpdateSettingsType = D1 ('MetaData "UserAttributeUpdateSettingsType" "Amazonka.CognitoIdentityProvider.Types.UserAttributeUpdateSettingsType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UserAttributeUpdateSettingsType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributesRequireVerificationBeforeUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VerifiedAttributeType]))))

newUserAttributeUpdateSettingsType :: UserAttributeUpdateSettingsType

Create a value of UserAttributeUpdateSettingsType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributesRequireVerificationBeforeUpdate:UserAttributeUpdateSettingsType', userAttributeUpdateSettingsType_attributesRequireVerificationBeforeUpdate - 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.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

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.

userAttributeUpdateSettingsType_attributesRequireVerificationBeforeUpdate :: Lens' UserAttributeUpdateSettingsType (Maybe [VerifiedAttributeType])

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.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

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.