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.
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
For .NET Core and PCL this operation is only available in asynchronous form. Please refer to AdminResetUserPasswordAsync.
public virtual AdminResetUserPasswordResponse AdminResetUserPassword( AdminResetUserPasswordRequest request )
Container for the necessary parameters to execute the AdminResetUserPassword service method.
|InternalErrorException||This exception is thrown when Amazon Cognito encounters an internal error.|
|InvalidEmailRoleAccessPolicyException||This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.|
|InvalidLambdaResponseException||This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.|
|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 does not have permission to publish using Amazon SNS.|
|InvalidSmsRoleTrustRelationshipException||This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not 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.|
|LimitExceededException||This exception is thrown when a user exceeds the limit for a requested AWS resource.|
|NotAuthorizedException||This exception is thrown when a user is not authorized.|
|ResourceNotFoundException||This exception is thrown when the Amazon Cognito service cannot find the requested resource.|
|TooManyRequestsException||This exception is thrown when the user has made too many requests for a given operation.|
|UnexpectedLambdaException||This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.|
|UserLambdaValidationException||This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.|
|UserNotFoundException||This exception is thrown when a user is not found.|
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms