AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateUserPool and EndUpdateUserPool.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<UpdateUserPoolResponse> UpdateUserPoolAsync( UpdateUserPoolRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the UpdateUserPool service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ConcurrentModificationException | This exception is thrown if two or more modifications are happening concurrently. |
| FeatureUnavailableInTierException | This exception is thrown when a feature you attempted to configure isn't available in your current feature plan. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidEmailRoleAccessPolicyException | This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| InvalidSmsRoleAccessPolicyException | This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS. |
| 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. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TierChangeNotAllowedException | This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| 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. |
| UserPoolTaggingException | This exception is thrown when a user pool tag can't be set or updated. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer