# UpdateUserPool Updates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your user pool, modified to include the changes that you want to make. **Important** With the exception of `UserPoolTier`, if you don't provide a value for an attribute, Amazon Cognito sets it to its default value. You can get a list of the current user pool settings using [DescribeUserPool](API_DescribeUserPool.md). **Note** This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint](https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other AWS service, Amazon Simple Notification Service might place your account in the SMS sandbox. In * [sandbox mode](https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) *, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see [ SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) in the *Amazon Cognito Developer Guide*. **Note** Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) ## Request Syntax ``` { "AccountRecoverySetting": { "RecoveryMechanisms": [ { "Name": "string", "Priority": number } ] }, "AdminCreateUserConfig": { "AllowAdminCreateUserOnly": boolean, "InviteMessageTemplate": { "EmailMessage": "string", "EmailSubject": "string", "SMSMessage": "string" }, "UnusedAccountValidityDays": number }, "AutoVerifiedAttributes": [ "string" ], "DeletionProtection": "string", "DeviceConfiguration": { "ChallengeRequiredOnNewDevice": boolean, "DeviceOnlyRememberedOnUserPrompt": boolean }, "EmailConfiguration": { "ConfigurationSet": "string", "EmailSendingAccount": "string", "From": "string", "ReplyToEmailAddress": "string", "SourceArn": "string" }, "EmailVerificationMessage": "string", "EmailVerificationSubject": "string", "LambdaConfig": { "CreateAuthChallenge": "string", "CustomEmailSender": { "LambdaArn": "string", "LambdaVersion": "string" }, "CustomMessage": "string", "CustomSMSSender": { "LambdaArn": "string", "LambdaVersion": "string" }, "DefineAuthChallenge": "string", "InboundFederation": { "LambdaArn": "string", "LambdaVersion": "string" }, "KMSKeyID": "string", "PostAuthentication": "string", "PostConfirmation": "string", "PreAuthentication": "string", "PreSignUp": "string", "PreTokenGeneration": "string", "PreTokenGenerationConfig": { "LambdaArn": "string", "LambdaVersion": "string" }, "UserMigration": "string", "VerifyAuthChallengeResponse": "string" }, "MfaConfiguration": "string", "Policies": { "PasswordPolicy": { "MinimumLength": number, "PasswordHistorySize": number, "RequireLowercase": boolean, "RequireNumbers": boolean, "RequireSymbols": boolean, "RequireUppercase": boolean, "TemporaryPasswordValidityDays": number }, "SignInPolicy": { "AllowedFirstAuthFactors": [ "string" ] } }, "PoolName": "string", "SmsAuthenticationMessage": "string", "SmsConfiguration": { "ExternalId": "string", "SnsCallerArn": "string", "SnsRegion": "string" }, "SmsVerificationMessage": "string", "UserAttributeUpdateSettings": { "AttributesRequireVerificationBeforeUpdate": [ "string" ] }, "UserPoolAddOns": { "AdvancedSecurityAdditionalFlows": { "CustomAuthMode": "string" }, "AdvancedSecurityMode": "string" }, "UserPoolId": "string", "UserPoolTags": { "string" : "string" }, "UserPoolTier": "string", "VerificationMessageTemplate": { "DefaultEmailOption": "string", "EmailMessage": "string", "EmailMessageByLink": "string", "EmailSubject": "string", "EmailSubjectByLink": "string", "SmsMessage": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccountRecoverySetting](#API_UpdateUserPool_RequestSyntax) ** 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. Type: [AccountRecoverySettingType](API_AccountRecoverySettingType.md) object Required: No ** [AdminCreateUserConfig](#API_UpdateUserPool_RequestSyntax) ** The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up. Type: [AdminCreateUserConfigType](API_AdminCreateUserConfigType.md) object Required: No ** [AutoVerifiedAttributes](#API_UpdateUserPool_RequestSyntax) ** The attributes that you want your user pool to automatically verify. Possible values: **email**, **phone\$1number**. For more information see [Verifying contact information at sign-up](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves). Type: Array of strings Valid Values: `phone_number | email` Required: No ** [DeletionProtection](#API_UpdateUserPool_RequestSyntax) ** 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. Type: String Valid Values: `ACTIVE | INACTIVE` Required: No ** [DeviceConfiguration](#API_UpdateUserPool_RequestSyntax) ** The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see [Working with user devices in your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html). 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. For more information, see [Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html). Type: [DeviceConfigurationType](API_DeviceConfigurationType.md) object Required: No ** [EmailConfiguration](#API_UpdateUserPool_RequestSyntax) ** The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for email invitation and verification messages from your user pool. Type: [EmailConfigurationType](API_EmailConfigurationType.md) object Required: No ** [EmailVerificationMessage](#API_UpdateUserPool_RequestSyntax) ** This parameter is no longer used. See [VerificationMessageTemplateType](API_VerificationMessageTemplateType.md). This parameter is no longer used. Type: String Length Constraints: Minimum length of 6. Maximum length of 20000. Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*` Required: No ** [EmailVerificationSubject](#API_UpdateUserPool_RequestSyntax) ** This parameter is no longer used. See [VerificationMessageTemplateType](API_VerificationMessageTemplateType.md). This parameter is no longer used. Type: String Length Constraints: Minimum length of 1. Maximum length of 140. Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+` Required: No ** [LambdaConfig](#API_UpdateUserPool_RequestSyntax) ** A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them. Type: [LambdaConfigType](API_LambdaConfigType.md) object Required: No ** [MfaConfiguration](#API_UpdateUserPool_RequestSyntax) ** Sets multi-factor authentication (MFA) to be on, off, or optional. When `ON`, all users must set up MFA before they can sign in. When `OPTIONAL`, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL`. When `MfaConfiguration` is `OPTIONAL`, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor. Type: String Valid Values: `OFF | ON | OPTIONAL` Required: No ** [Policies](#API_UpdateUserPool_RequestSyntax) ** The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in [choice-based authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice). Type: [UserPoolPolicyType](API_UserPoolPolicyType.md) object Required: No ** [PoolName](#API_UpdateUserPool_RequestSyntax) ** The updated name of your user pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[\w\s+=,.@-]+` Required: No ** [SmsAuthenticationMessage](#API_UpdateUserPool_RequestSyntax) ** The contents of the SMS message that your user pool sends to users in SMS authentication. Type: String Length Constraints: Minimum length of 6. Maximum length of 140. Pattern: `.*\{####\}.*` Required: No ** [SmsConfiguration](#API_UpdateUserPool_RequestSyntax) ** The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account. For more information see [SMS message settings](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html). Type: [SmsConfigurationType](API_SmsConfigurationType.md) object Required: No ** [SmsVerificationMessage](#API_UpdateUserPool_RequestSyntax) ** This parameter is no longer used. See [VerificationMessageTemplateType](API_VerificationMessageTemplateType.md). This parameter is no longer used. Type: String Length Constraints: Minimum length of 6. Maximum length of 140. Pattern: `.*\{####\}.*` Required: No ** [UserAttributeUpdateSettings](#API_UpdateUserPool_RequestSyntax) ** 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](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). Type: [UserAttributeUpdateSettingsType](API_UserAttributeUpdateSettingsType.md) object Required: No ** [UserPoolAddOns](#API_UpdateUserPool_RequestSyntax) ** Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to `AUDIT`. To configure automatic security responses to potentially unwanted traffic to your user pool, set to `ENFORCED`. For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). To activate this setting, your user pool must be on the [ Plus tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html). Type: [UserPoolAddOnsType](API_UserPoolAddOnsType.md) object Required: No ** [UserPoolId](#API_UpdateUserPool_RequestSyntax) ** The ID of the user pool you want to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 55. Pattern: `[\w-]+_[0-9a-zA-Z]+` Required: Yes ** [UserPoolTags](#API_UpdateUserPool_RequestSyntax) ** 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. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No ** [UserPoolTier](#API_UpdateUserPool_RequestSyntax) ** The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html), or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS`. Type: String Valid Values: `LITE | ESSENTIALS | PLUS` Required: No ** [VerificationMessageTemplate](#API_UpdateUserPool_RequestSyntax) ** The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. Set the email message type that corresponds to your `DefaultEmailOption` selection. For `CONFIRM_WITH_LINK`, specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE`, specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error. Type: [VerificationMessageTemplateType](API_VerificationMessageTemplateType.md) object Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ConcurrentModificationException ** This exception is thrown if two or more modifications are happening concurrently. ** message ** The message provided when the concurrent exception is thrown. HTTP Status Code: 400 ** FeatureUnavailableInTierException ** This exception is thrown when a feature you attempted to configure isn't available in your current feature plan. HTTP Status Code: 400 ** InternalErrorException ** This exception is thrown when Amazon Cognito encounters an internal error. ** message ** The message returned when Amazon Cognito throws an internal error exception. HTTP Status Code: 500 ** InvalidEmailRoleAccessPolicyException ** This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400. ** message ** The message returned when you have an unverified email address or the identity policy isn't set on an email address that Amazon Cognito can access. HTTP Status Code: 400 ** InvalidParameterException ** This exception is thrown when the Amazon Cognito service encounters an invalid parameter. ** message ** The message returned when the Amazon Cognito service throws an invalid parameter exception. ** reasonCode ** The reason code of the exception. HTTP Status Code: 400 ** InvalidSmsRoleAccessPolicyException ** This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS. ** message ** The message returned when the invalid SMS role access policy exception is thrown. HTTP Status Code: 400 ** InvalidSmsRoleTrustRelationshipException ** This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust `cognito-idp.amazonaws.com` or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool. ** message ** The message returned when the role trust relationship for the SMS message is not valid. HTTP Status Code: 400 ** NotAuthorizedException ** This exception is thrown when a user isn't authorized. ** message ** The message returned when the Amazon Cognito service returns a not authorized exception. HTTP Status Code: 400 ** ResourceNotFoundException ** This exception is thrown when the Amazon Cognito service can't find the requested resource. ** message ** The message returned when the Amazon Cognito service returns a resource not found exception. HTTP Status Code: 400 ** TierChangeNotAllowedException ** This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted. HTTP Status Code: 400 ** TooManyRequestsException ** This exception is thrown when the user has made too many requests for a given operation. ** message ** The message returned when the Amazon Cognito service returns a too many requests exception. HTTP Status Code: 400 ** UserImportInProgressException ** This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool. ** message ** The message returned when the user pool has an import job running. HTTP Status Code: 400 ** UserPoolTaggingException ** This exception is thrown when a user pool tag can't be set or updated. HTTP Status Code: 400 ## Examples ### Example The following `UpdateUserPool` request updates some common features of the target user pool. #### Sample Request ``` POST HTTP/1.1 Host: cognito-idp.ca-central-1.amazonaws.com X-Amz-Date: 20230613T200059Z Accept-Encoding: gzip, deflate, br X-Amz-Target: AWSCognitoIdentityProviderService.UpdateUserPool User-Agent: Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature= Content-Length: { "AccountRecoverySetting": { "RecoveryMechanisms": [ { "Name": "verified_email", "Priority": 1 }, { "Name": "verified_phone_number", "Priority": 2 } ] }, "AdminCreateUserConfig": { "AllowAdminCreateUserOnly": false, "UnusedAccountValidityDays": 7 }, "AliasAttributes": [ "email", "phone_number", "preferred_username" ], "Arn": "arn:aws:cognito-idp:ca-central-1:123456789012:userpool/ca-central-1_EXAMPLE", "AutoVerifiedAttributes": [ "email" ], "DeletionProtection": "ACTIVE", "Domain": "cognitoexample", "EmailConfiguration": { "ConfigurationSet": "my-sesconfigset", "EmailSendingAccount": "DEVELOPER", "SourceArn": "arn:aws:ses:us-east-1:123456789012:identity/admin@example.com" }, "LambdaConfig": { "PreSignUp": "arn:aws:lambda:ca-central-1:123456789012:function:my-function" }, "MfaConfiguration": "OPTIONAL", "Name": "my-test-user-pool", "Policies": { "PasswordPolicy": { "MinimumLength": 8, "RequireLowercase": true, "RequireNumbers": true, "RequireSymbols": true, "RequireUppercase": true, "TemporaryPasswordValidityDays": 7 }, "SignInPolicy": { "AllowedFirstAuthFactors": [ "PASSWORD", "EMAIL_OTP", "WEB_AUTHN" ] } }, "SmsConfiguration": { "ExternalId": "ALPHA-BRAVO", "SnsCallerArn": "arn:aws:iam::123456789012:role/My-SMS-Role", "SnsRegion": "us-east-1" }, "UserAttributeUpdateSettings": { "AttributesRequireVerificationBeforeUpdate": [ "email" ] }, "UsernameConfiguration": { "CaseSensitive": false }, "UserPoolAddOns": { "AdvancedSecurityAdditionalFlows": { }, "AdvancedSecurityMode": "OFF" }, "UserPoolId": "ca-central-1_EXAMPLE", "UserPoolTags": { }, "UserPoolTier": "PLUS", "VerificationMessageTemplate": { "DefaultEmailOption": "CONFIRM_WITH_CODE" } } ``` #### Sample Response ``` HTTP/1.1 200 OK Date: Tue, 13 Jun 2023 20:00:59 GMT Content-Type: application/x-amz-json-1.0 Content-Length: x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111 Connection: keep-alive ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cognito-idp-2016-04-18/UpdateUserPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cognito-idp-2016-04-18/UpdateUserPool)