UpdateUserPoolCommand

Suggest an Edit

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.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

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 . 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 Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode  , 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  in the Amazon Cognito Developer Guide.

Amazon Cognito evaluates 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.

Learn more

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CognitoIdentityProviderClient, UpdateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
// const { CognitoIdentityProviderClient, UpdateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
const client = new CognitoIdentityProviderClient(config);
const input = { // UpdateUserPoolRequest
  UserPoolId: "STRING_VALUE", // required
  Policies: { // UserPoolPolicyType
    PasswordPolicy: { // PasswordPolicyType
      MinimumLength: Number("int"),
      RequireUppercase: true || false,
      RequireLowercase: true || false,
      RequireNumbers: true || false,
      RequireSymbols: true || false,
      PasswordHistorySize: Number("int"),
      TemporaryPasswordValidityDays: Number("int"),
    },
    SignInPolicy: { // SignInPolicyType
      AllowedFirstAuthFactors: [ // AllowedFirstAuthFactorsListType
        "PASSWORD" || "EMAIL_OTP" || "SMS_OTP" || "WEB_AUTHN",
      ],
    },
  },
  DeletionProtection: "ACTIVE" || "INACTIVE",
  LambdaConfig: { // LambdaConfigType
    PreSignUp: "STRING_VALUE",
    CustomMessage: "STRING_VALUE",
    PostConfirmation: "STRING_VALUE",
    PreAuthentication: "STRING_VALUE",
    PostAuthentication: "STRING_VALUE",
    DefineAuthChallenge: "STRING_VALUE",
    CreateAuthChallenge: "STRING_VALUE",
    VerifyAuthChallengeResponse: "STRING_VALUE",
    PreTokenGeneration: "STRING_VALUE",
    UserMigration: "STRING_VALUE",
    PreTokenGenerationConfig: { // PreTokenGenerationVersionConfigType
      LambdaVersion: "V1_0" || "V2_0" || "V3_0", // required
      LambdaArn: "STRING_VALUE", // required
    },
    CustomSMSSender: { // CustomSMSLambdaVersionConfigType
      LambdaVersion: "V1_0", // required
      LambdaArn: "STRING_VALUE", // required
    },
    CustomEmailSender: { // CustomEmailLambdaVersionConfigType
      LambdaVersion: "V1_0", // required
      LambdaArn: "STRING_VALUE", // required
    },
    KMSKeyID: "STRING_VALUE",
  },
  AutoVerifiedAttributes: [ // VerifiedAttributesListType
    "phone_number" || "email",
  ],
  SmsVerificationMessage: "STRING_VALUE",
  EmailVerificationMessage: "STRING_VALUE",
  EmailVerificationSubject: "STRING_VALUE",
  VerificationMessageTemplate: { // VerificationMessageTemplateType
    SmsMessage: "STRING_VALUE",
    EmailMessage: "STRING_VALUE",
    EmailSubject: "STRING_VALUE",
    EmailMessageByLink: "STRING_VALUE",
    EmailSubjectByLink: "STRING_VALUE",
    DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE",
  },
  SmsAuthenticationMessage: "STRING_VALUE",
  UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType
    AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType
      "phone_number" || "email",
    ],
  },
  MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
  DeviceConfiguration: { // DeviceConfigurationType
    ChallengeRequiredOnNewDevice: true || false,
    DeviceOnlyRememberedOnUserPrompt: true || false,
  },
  EmailConfiguration: { // EmailConfigurationType
    SourceArn: "STRING_VALUE",
    ReplyToEmailAddress: "STRING_VALUE",
    EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER",
    From: "STRING_VALUE",
    ConfigurationSet: "STRING_VALUE",
  },
  SmsConfiguration: { // SmsConfigurationType
    SnsCallerArn: "STRING_VALUE", // required
    ExternalId: "STRING_VALUE",
    SnsRegion: "STRING_VALUE",
  },
  UserPoolTags: { // UserPoolTagsType
    "<keys>": "STRING_VALUE",
  },
  AdminCreateUserConfig: { // AdminCreateUserConfigType
    AllowAdminCreateUserOnly: true || false,
    UnusedAccountValidityDays: Number("int"),
    InviteMessageTemplate: { // MessageTemplateType
      SMSMessage: "STRING_VALUE",
      EmailMessage: "STRING_VALUE",
      EmailSubject: "STRING_VALUE",
    },
  },
  UserPoolAddOns: { // UserPoolAddOnsType
    AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required
    AdvancedSecurityAdditionalFlows: { // AdvancedSecurityAdditionalFlowsType
      CustomAuthMode: "AUDIT" || "ENFORCED",
    },
  },
  AccountRecoverySetting: { // AccountRecoverySettingType
    RecoveryMechanisms: [ // RecoveryMechanismsType
      { // RecoveryOptionType
        Priority: Number("int"), // required
        Name: "verified_email" || "verified_phone_number" || "admin_only", // required
      },
    ],
  },
  PoolName: "STRING_VALUE",
  UserPoolTier: "LITE" || "ESSENTIALS" || "PLUS",
};
const command = new UpdateUserPoolCommand(input);
const response = await client.send(command);
// {};

UpdateUserPoolCommand Input

See UpdateUserPoolCommandInput for more details

Parameter
Type
Description
UserPoolId
Required
string | undefined

The ID of the user pool you want to update.

AccountRecoverySetting
AccountRecoverySettingType | undefined

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.

AdminCreateUserConfig
AdminCreateUserConfigType | undefined

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.

AutoVerifiedAttributes
VerifiedAttributeType[] | undefined

The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see Verifying contact information at sign-up .

DeletionProtection
DeletionProtectionType | undefined

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.

DeviceConfiguration
DeviceConfigurationType | undefined

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 . 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 .

EmailConfiguration
EmailConfigurationType | undefined

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.

EmailVerificationMessage
string | undefined

This parameter is no longer used.

EmailVerificationSubject
string | undefined

This parameter is no longer used.

LambdaConfig
LambdaConfigType | undefined

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.

MfaConfiguration
UserPoolMfaType | undefined

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.

Policies
UserPoolPolicyType | undefined

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 .

PoolName
string | undefined

The updated name of your user pool.

SmsAuthenticationMessage
string | undefined

The contents of the SMS message that your user pool sends to users in SMS authentication.

SmsConfiguration
SmsConfigurationType | undefined

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 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. For more information see SMS message settings .

SmsVerificationMessage
string | undefined

This parameter is no longer used.

UserAttributeUpdateSettings
UserAttributeUpdateSettingsType | undefined

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 .

UserPoolAddOns
UserPoolAddOnsType | undefined

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 . To activate this setting, your user pool must be on the Plus tier .

UserPoolTags
Record<string, string> | undefined

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.

UserPoolTier
UserPoolTierType | undefined

The user pool feature plan , 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.

VerificationMessageTemplate
VerificationMessageTemplateType | undefined

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.

UpdateUserPoolCommand Output

See UpdateUserPoolCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConcurrentModificationException
client

This exception is thrown if two or more modifications are happening concurrently.

FeatureUnavailableInTierException
client

This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.

InternalErrorException
server

This exception is thrown when Amazon Cognito encounters an internal error.

InvalidEmailRoleAccessPolicyException
client

This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.

InvalidParameterException
client

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

InvalidSmsRoleAccessPolicyException
client

This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.

InvalidSmsRoleTrustRelationshipException
client

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.

NotAuthorizedException
client

This exception is thrown when a user isn't authorized.

ResourceNotFoundException
client

This exception is thrown when the Amazon Cognito service can't find the requested resource.

TierChangeNotAllowedException
client

This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.

TooManyRequestsException
client

This exception is thrown when the user has made too many requests for a given operation.

UserImportInProgressException
client

This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.

UserPoolTaggingException
client

This exception is thrown when a user pool tag can't be set or updated.

CognitoIdentityProviderServiceException
Base exception class for all service exceptions from CognitoIdentityProvider service.