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.
Creates a new user in the specified user pool.
If MessageAction
isn't set, the default is to send a welcome message via email
or phone (SMS).
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 Servicesservice, 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.
This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser
with SUPPRESS
for the MessageAction
parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until they
sign in and change their password.
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
For .NET Core this operation is only available in asynchronous form. Please refer to AdminCreateUserAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public abstract AdminCreateUserResponse AdminCreateUser( AdminCreateUserRequest request )
Container for the necessary parameters to execute the AdminCreateUser service method.
Exception | Condition |
---|---|
CodeDeliveryFailureException | This exception is thrown when a verification code fails to deliver successfully. |
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. |
InvalidPasswordException | This exception is thrown when Amazon Cognito encounters an invalid password. |
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. |
PreconditionNotMetException | This exception is thrown when a precondition is not met. |
ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't 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 Amazon Cognito encounters an unexpected exception with Lambda. |
UnsupportedUserStateException | The request failed because the user is in an unsupported state. |
UserLambdaValidationException | This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service. |
UsernameExistsException | This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool. |
UserNotFoundException | This exception is thrown when a user isn't found. |
This request submits a value for all possible parameters for AdminCreateUser.
var client = new AmazonCognitoIdentityProviderClient(); var response = client.AdminCreateUser(new AdminCreateUserRequest { DesiredDeliveryMediums = new List<string> { "SMS" }, MessageAction = "SUPPRESS", TemporaryPassword = "This-is-my-test-99!", UserAttributes = new List<AttributeType> { new AttributeType { Name = "name", Value = "John" }, new AttributeType { Name = "phone_number", Value = "+12065551212" }, new AttributeType { Name = "email", Value = "testuser@example.com" } }, UserPoolId = "us-east-1_EXAMPLE", Username = "testuser" }); UserType user = response.User;
.NET Framework:
Supported in: 4.5 and newer, 3.5