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.
New-CGIPUserAdmin-UserPoolId <String>-ClientMetadata <Hashtable>-DesiredDeliveryMedium <String[]>-ForceAliasCreation <Boolean>-MessageAction <MessageActionType>-TemporaryPassword <String>-UserAttribute <AttributeType[]>-Username <String>-ValidationData <AttributeType[]>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>-ClientConfig <AmazonCognitoIdentityProviderConfig>
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 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.
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 Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"EMAIL"
if email will be used to send the welcome message. Specify "SMS"
if the phone number will be used. The default value is "SMS"
. You can specify more than one value. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DesiredDeliveryMediums |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
phone_number_verified
or email_verified
attribute is set to True
. Otherwise, it is ignored.If this parameter is set to True
and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.If this parameter is set to False
, the API throws an AliasExistsException
error if the alias already exists. The default value is False
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
RESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS
to suppress sending the message. You can specify only one value. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
AdminCreateUser
again and specify RESEND
for the MessageAction
parameter. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Username
. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to AdminCreateUser
) or the user should supply (when they sign up in response to your welcome message).For custom attributes, you must prepend the custom:
prefix to the attribute name.To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.In your call to AdminCreateUser
, you can set the email_verified
attribute to True
, and you can set the phone_number_verified
attribute to True
. You can also do this by calling AdminUpdateUserAttributes.email_verified
attribute is set to True
, or if "EMAIL"
is specified in the DesiredDeliveryMediums
parameter.phone_number_verified
attribute is set to True
, or if "SMS"
is specified in the DesiredDeliveryMediums
parameter.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | UserAttributes |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z