Post x amz targetawscognitoidentityproviderservice.updateuserpool

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14101465558.4 KB

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the 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 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.

post/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPool

Headers

X-Amz-Target'AWSCognitoIdentityProviderService.UpdateUserPool' required

Request body

UserPoolIdstring required

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

DeletionProtection'ACTIVE' | 'INACTIVE'

When active, <code>DeletionProtection</code> 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 <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.

AutoVerifiedAttributesVerifiedAttributeType[]

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

SmsVerificationMessagestring

This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.

EmailVerificationMessagestring

EmailVerificationSubjectstring

SmsAuthenticationMessagestring

The contents of the SMS authentication message.

MfaConfiguration'OFF' | 'ON' | 'OPTIONAL'

Possible values include: <ul> <li> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration. </li> <li> <code>ON</code> - 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 <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </li> <li> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token. </li> </ul>

UserPoolTagsobject

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.

Response

Success

UpdateUserPoolResponse required

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