Represents the request to update the user pool.

See: newUpdateUserPool smart constructor.

Create a value of UpdateUserPool 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:

UpdateUserPool, updateUserPool_accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

UpdateUserPool, updateUserPool_adminCreateUserConfig - The configuration for AdminCreateUser requests.

UpdateUserPool, updateUserPool_autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.

UpdateUserPool, updateUserPool_deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

UpdateUserPool, updateUserPool_deviceConfiguration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

UpdateUserPool, updateUserPool_emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.

UpdateUserPool, updateUserPool_emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.

UpdateUserPool, updateUserPool_emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.

UpdateUserPool, updateUserPool_lambdaConfig - The Lambda configuration information from the request to update the user pool.

UpdateUserPool, updateUserPool_mfaConfiguration - Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.
• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
• OPTIONAL - Users have the option when registering to create an MFA token.

UpdateUserPool, updateUserPool_policies - A container with the policies you want to update in a user pool.

UpdateUserPool, updateUserPool_smsAuthenticationMessage - The contents of the SMS authentication message.

UpdateUserPool, updateUserPool_smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

UpdateUserPool, updateUserPool_smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.

UpdateUserPool, updateUserPool_userAttributeUpdateSettings - 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.

UpdateUserPool, updateUserPool_userPoolAddOns - Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

UpdateUserPool, updateUserPool_userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

UpdateUserPool, updateUserPool_verificationMessageTemplate - The template for verification messages.

UpdateUserPool, updateUserPool_userPoolId - The user pool ID for the user pool you want to update.

The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

The configuration for AdminCreateUser requests.

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.

This parameter is no longer used. See VerificationMessageTemplateType.

This parameter is no longer used. See VerificationMessageTemplateType.

The Lambda configuration information from the request to update the user pool.

Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.
• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
• OPTIONAL - Users have the option when registering to create an MFA token.

A container with the policies you want to update in a user pool.

The contents of the SMS authentication message.

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

This parameter is no longer used. See VerificationMessageTemplateType.

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.

Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

The template for verification messages.

The user pool ID for the user pool you want to update.

Represents the response from the server when you make a request to update the user pool.

See: newUpdateUserPoolResponse smart constructor.

Create a value of UpdateUserPoolResponse 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:httpStatus:UpdateUserPoolResponse', updateUserPoolResponse_httpStatus - The response's http status code.

The response's http status code.