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.
This public API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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 BeginConfirmSignUp and EndConfirmSignUp.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<ConfirmSignUpResponse> ConfirmSignUpAsync( ConfirmSignUpRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ConfirmSignUp service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AliasExistsException | This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias. |
| CodeMismatchException | This exception is thrown if the provided code doesn't match what the server was expecting. |
| ExpiredCodeException | This exception is thrown if a code has expired. |
| ForbiddenException | This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidLambdaResponseException | This exception is thrown when Amazon Cognito encounters an invalid Lambda response. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| LimitExceededException | This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource. |
| 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. |
| TooManyFailedAttemptsException | This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| UnexpectedLambdaException | This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda. |
| UserLambdaValidationException | This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service. |
| UserNotFoundException | This exception is thrown when a user isn't found. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5