public class AdminCreateUserRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
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 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
| Constructor and Description |
|---|
AdminCreateUserRequest() |
| Modifier and Type | Method and Description |
|---|---|
AdminCreateUserRequest |
addClientMetadataEntry(java.lang.String key,
java.lang.String value)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
AdminCreateUserRequest |
clearClientMetadataEntries()
Removes all the entries added into ClientMetadata.
|
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.lang.String> |
getClientMetadata()
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
java.util.List<java.lang.String> |
getDesiredDeliveryMediums()
Specify
"EMAIL" if email will be used to send the welcome
message. |
java.lang.Boolean |
getForceAliasCreation()
This parameter is used only if the
phone_number_verified or
email_verified attribute is set to True. |
java.lang.String |
getMessageAction()
Set to
RESEND to resend the invitation message to a user
that already exists and reset the expiration limit on the user's account. |
java.lang.String |
getTemporaryPassword()
The user's temporary password.
|
java.util.List<AttributeType> |
getUserAttributes()
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created.
|
java.lang.String |
getUsername()
The username for the user.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool where the user will be created.
|
java.util.List<AttributeType> |
getValidationData()
The user's validation data.
|
int |
hashCode() |
java.lang.Boolean |
isForceAliasCreation()
This parameter is used only if the
phone_number_verified or
email_verified attribute is set to True. |
void |
setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
void |
setDesiredDeliveryMediums(java.util.Collection<java.lang.String> desiredDeliveryMediums)
Specify
"EMAIL" if email will be used to send the welcome
message. |
void |
setForceAliasCreation(java.lang.Boolean forceAliasCreation)
This parameter is used only if the
phone_number_verified or
email_verified attribute is set to True. |
void |
setMessageAction(MessageActionType messageAction)
Set to
RESEND to resend the invitation message to a user
that already exists and reset the expiration limit on the user's account. |
void |
setMessageAction(java.lang.String messageAction)
Set to
RESEND to resend the invitation message to a user
that already exists and reset the expiration limit on the user's account. |
void |
setTemporaryPassword(java.lang.String temporaryPassword)
The user's temporary password.
|
void |
setUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created.
|
void |
setUsername(java.lang.String username)
The username for the user.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where the user will be created.
|
void |
setValidationData(java.util.Collection<AttributeType> validationData)
The user's validation data.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
AdminCreateUserRequest |
withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
|
AdminCreateUserRequest |
withDesiredDeliveryMediums(java.util.Collection<java.lang.String> desiredDeliveryMediums)
Specify
"EMAIL" if email will be used to send the welcome
message. |
AdminCreateUserRequest |
withDesiredDeliveryMediums(java.lang.String... desiredDeliveryMediums)
Specify
"EMAIL" if email will be used to send the welcome
message. |
AdminCreateUserRequest |
withForceAliasCreation(java.lang.Boolean forceAliasCreation)
This parameter is used only if the
phone_number_verified or
email_verified attribute is set to True. |
AdminCreateUserRequest |
withMessageAction(MessageActionType messageAction)
Set to
RESEND to resend the invitation message to a user
that already exists and reset the expiration limit on the user's account. |
AdminCreateUserRequest |
withMessageAction(java.lang.String messageAction)
Set to
RESEND to resend the invitation message to a user
that already exists and reset the expiration limit on the user's account. |
AdminCreateUserRequest |
withTemporaryPassword(java.lang.String temporaryPassword)
The user's temporary password.
|
AdminCreateUserRequest |
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created.
|
AdminCreateUserRequest |
withUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created.
|
AdminCreateUserRequest |
withUsername(java.lang.String username)
The username for the user.
|
AdminCreateUserRequest |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where the user will be created.
|
AdminCreateUserRequest |
withValidationData(AttributeType... validationData)
The user's validation data.
|
AdminCreateUserRequest |
withValidationData(java.util.Collection<AttributeType> validationData)
The user's validation data.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getUserPoolId()
The user pool ID for the user pool where the user will be created.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool where the user will be created.
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where the user will be created.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where the user will be created.
public AdminCreateUserRequest withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where the user will be created.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where the user will be created.
public java.lang.String getUsername()
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
public void setUsername(java.lang.String username)
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
username - The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
public AdminCreateUserRequest withUsername(java.lang.String username)
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
username - The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
public java.util.List<AttributeType> getUserAttributes()
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created. You can create a user
without specifying any attributes other than 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: The email address of the user to whom the message that
contains the code and username will be sent. Required if the
email_verified attribute is set to True, or if
"EMAIL" is specified in the
DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message
that contains the code and username will be sent. Required if the
phone_number_verified attribute is set to True,
or if "SMS" is specified in the
DesiredDeliveryMediums parameter.
An array of name-value pairs that contain user attributes and
attribute values to be set for the user to be created. You can
create a user without specifying any attributes other than
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: The email address of the user to whom the message
that contains the code and username will be sent. Required if the
email_verified attribute is set to True
, or if "EMAIL" is specified in the
DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the
message that contains the code and username will be sent.
Required if the phone_number_verified attribute is
set to True, or if "SMS" is specified
in the DesiredDeliveryMediums parameter.
public void setUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created. You can create a user
without specifying any attributes other than 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: The email address of the user to whom the message that
contains the code and username will be sent. Required if the
email_verified attribute is set to True, or if
"EMAIL" is specified in the
DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message
that contains the code and username will be sent. Required if the
phone_number_verified attribute is set to True,
or if "SMS" is specified in the
DesiredDeliveryMediums parameter.
userAttributes -
An array of name-value pairs that contain user attributes and
attribute values to be set for the user to be created. You can
create a user without specifying any attributes other than
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: The email address of the user to whom the
message that contains the code and username will be sent.
Required if the email_verified attribute is set
to True, or if "EMAIL" is specified
in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the
message that contains the code and username will be sent.
Required if the phone_number_verified attribute
is set to True, or if "SMS" is
specified in the DesiredDeliveryMediums
parameter.
public AdminCreateUserRequest withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created. You can create a user
without specifying any attributes other than 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: The email address of the user to whom the message that
contains the code and username will be sent. Required if the
email_verified attribute is set to True, or if
"EMAIL" is specified in the
DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message
that contains the code and username will be sent. Required if the
phone_number_verified attribute is set to True,
or if "SMS" is specified in the
DesiredDeliveryMediums parameter.
Returns a reference to this object so that method calls can be chained together.
userAttributes -
An array of name-value pairs that contain user attributes and
attribute values to be set for the user to be created. You can
create a user without specifying any attributes other than
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: The email address of the user to whom the
message that contains the code and username will be sent.
Required if the email_verified attribute is set
to True, or if "EMAIL" is specified
in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the
message that contains the code and username will be sent.
Required if the phone_number_verified attribute
is set to True, or if "SMS" is
specified in the DesiredDeliveryMediums
parameter.
public AdminCreateUserRequest withUserAttributes(java.util.Collection<AttributeType> userAttributes)
An array of name-value pairs that contain user attributes and attribute
values to be set for the user to be created. You can create a user
without specifying any attributes other than 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: The email address of the user to whom the message that
contains the code and username will be sent. Required if the
email_verified attribute is set to True, or if
"EMAIL" is specified in the
DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the message
that contains the code and username will be sent. Required if the
phone_number_verified attribute is set to True,
or if "SMS" is specified in the
DesiredDeliveryMediums parameter.
Returns a reference to this object so that method calls can be chained together.
userAttributes -
An array of name-value pairs that contain user attributes and
attribute values to be set for the user to be created. You can
create a user without specifying any attributes other than
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: The email address of the user to whom the
message that contains the code and username will be sent.
Required if the email_verified attribute is set
to True, or if "EMAIL" is specified
in the DesiredDeliveryMediums parameter.
phone_number: The phone number of the user to whom the
message that contains the code and username will be sent.
Required if the phone_number_verified attribute
is set to True, or if "SMS" is
specified in the DesiredDeliveryMediums
parameter.
public java.util.List<AttributeType> getValidationData()
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
public void setValidationData(java.util.Collection<AttributeType> validationData)
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
public AdminCreateUserRequest withValidationData(AttributeType... validationData)
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
Returns a reference to this object so that method calls can be chained together.
validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
public AdminCreateUserRequest withValidationData(java.util.Collection<AttributeType> validationData)
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
Returns a reference to this object so that method calls can be chained together.
validationData - The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
public java.lang.String getTemporaryPassword()
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration
limit that you set for your user pool. To reset the account after that
time limit, you must call AdminCreateUser again and specify
RESEND for the MessageAction parameter.
Constraints:
Length: - 256
Pattern: [\S]+
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account
expiration limit that you set for your user pool. To reset the
account after that time limit, you must call
AdminCreateUser again and specify
RESEND for the MessageAction parameter.
public void setTemporaryPassword(java.lang.String temporaryPassword)
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration
limit that you set for your user pool. To reset the account after that
time limit, you must call AdminCreateUser again and specify
RESEND for the MessageAction parameter.
Constraints:
Length: - 256
Pattern: [\S]+
temporaryPassword - The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account
expiration limit that you set for your user pool. To reset the
account after that time limit, you must call
AdminCreateUser again and specify
RESEND for the MessageAction
parameter.
public AdminCreateUserRequest withTemporaryPassword(java.lang.String temporaryPassword)
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration
limit that you set for your user pool. To reset the account after that
time limit, you must call AdminCreateUser again and specify
RESEND for the MessageAction parameter.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 256
Pattern: [\S]+
temporaryPassword - The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account
expiration limit that you set for your user pool. To reset the
account after that time limit, you must call
AdminCreateUser again and specify
RESEND for the MessageAction
parameter.
public java.lang.Boolean isForceAliasCreation()
This parameter is used only if the 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.
This parameter is used only if the
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.
public java.lang.Boolean getForceAliasCreation()
This parameter is used only if the 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.
This parameter is used only if the
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.
public void setForceAliasCreation(java.lang.Boolean forceAliasCreation)
This parameter is used only if the 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.
forceAliasCreation -
This parameter is used only if the
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.
public AdminCreateUserRequest withForceAliasCreation(java.lang.Boolean forceAliasCreation)
This parameter is used only if the 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.
Returns a reference to this object so that method calls can be chained together.
forceAliasCreation -
This parameter is used only if the
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.
public java.lang.String getMessageAction()
Set to 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.
Constraints:
Allowed Values: RESEND, SUPPRESS
Set to 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.
MessageActionTypepublic void setMessageAction(java.lang.String messageAction)
Set to 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.
Constraints:
Allowed Values: RESEND, SUPPRESS
messageAction -
Set to 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.
MessageActionTypepublic AdminCreateUserRequest withMessageAction(java.lang.String messageAction)
Set to 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RESEND, SUPPRESS
messageAction -
Set to 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.
MessageActionTypepublic void setMessageAction(MessageActionType messageAction)
Set to 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.
Constraints:
Allowed Values: RESEND, SUPPRESS
messageAction -
Set to 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.
MessageActionTypepublic AdminCreateUserRequest withMessageAction(MessageActionType messageAction)
Set to 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RESEND, SUPPRESS
messageAction -
Set to 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.
MessageActionTypepublic java.util.List<java.lang.String> getDesiredDeliveryMediums()
Specify "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.
Specify "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.
public void setDesiredDeliveryMediums(java.util.Collection<java.lang.String> desiredDeliveryMediums)
Specify "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.
desiredDeliveryMediums -
Specify "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.
public AdminCreateUserRequest withDesiredDeliveryMediums(java.lang.String... desiredDeliveryMediums)
Specify "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.
Returns a reference to this object so that method calls can be chained together.
desiredDeliveryMediums -
Specify "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.
public AdminCreateUserRequest withDesiredDeliveryMediums(java.util.Collection<java.lang.String> desiredDeliveryMediums)
Specify "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.
Returns a reference to this object so that method calls can be chained together.
desiredDeliveryMediums -
Specify "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.
public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminCreateUser API action, Amazon Cognito
invokes the function that is assigned to the pre sign-up trigger.
When Amazon Cognito invokes this function, it passes a JSON payload,
which the function receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user
pool triggers. When you use the AdminCreateUser API action,
Amazon Cognito invokes the function that is assigned to the
pre sign-up trigger. When Amazon Cognito invokes this
function, it passes a JSON payload, which the function receives
as input. This payload contains a 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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminCreateUser API action, Amazon Cognito
invokes the function that is assigned to the pre sign-up trigger.
When Amazon Cognito invokes this function, it passes a JSON payload,
which the function receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to
user pool triggers. When you use the AdminCreateUser API
action, Amazon Cognito invokes the function that is assigned
to the pre sign-up trigger. When Amazon Cognito invokes
this function, it passes a JSON payload, which the function
receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
public AdminCreateUserRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminCreateUser API action, Amazon Cognito
invokes the function that is assigned to the pre sign-up trigger.
When Amazon Cognito invokes this function, it passes a JSON payload,
which the function receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
Returns a reference to this object so that method calls can be chained together.
clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to
user pool triggers. When you use the AdminCreateUser API
action, Amazon Cognito invokes the function that is assigned
to the pre sign-up trigger. When Amazon Cognito invokes
this function, it passes a JSON payload, which the function
receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
public AdminCreateUserRequest addClientMetadataEntry(java.lang.String key, java.lang.String value)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminCreateUser API action, Amazon Cognito
invokes the function that is assigned to the pre sign-up trigger.
When Amazon Cognito invokes this function, it passes a JSON payload,
which the function receives as input. This payload contains a
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:
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into ClientMetadata.value - The corresponding value of the entry to be added into
ClientMetadata.public AdminCreateUserRequest clearClientMetadataEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object