pub struct CreateUserFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateUser
.
Creates a new user in the user pool.
Implementations§
source§impl CreateUserFluentBuilder
impl CreateUserFluentBuilder
sourcepub fn as_input(&self) -> &CreateUserInputBuilder
pub fn as_input(&self) -> &CreateUserInputBuilder
Access the CreateUser as a reference.
sourcepub async fn send(
self
) -> Result<CreateUserOutput, SdkError<CreateUserError, HttpResponse>>
pub async fn send( self ) -> Result<CreateUserOutput, SdkError<CreateUserError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateUserOutput, CreateUserError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateUserOutput, CreateUserError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn user_name(self, input: impl Into<String>) -> Self
pub fn user_name(self, input: impl Into<String>) -> Self
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
sourcepub fn set_user_name(self, input: Option<String>) -> Self
pub fn set_user_name(self, input: Option<String>) -> Self
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &Option<String>
The email address of the user.
Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
sourcepub fn message_action(self, input: MessageAction) -> Self
pub fn message_action(self, input: MessageAction) -> Self
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
sourcepub fn set_message_action(self, input: Option<MessageAction>) -> Self
pub fn set_message_action(self, input: Option<MessageAction>) -> Self
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
sourcepub fn get_message_action(&self) -> &Option<MessageAction>
pub fn get_message_action(&self) -> &Option<MessageAction>
The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
sourcepub fn first_name(self, input: impl Into<String>) -> Self
pub fn first_name(self, input: impl Into<String>) -> Self
The first name, or given name, of the user.
sourcepub fn set_first_name(self, input: Option<String>) -> Self
pub fn set_first_name(self, input: Option<String>) -> Self
The first name, or given name, of the user.
sourcepub fn get_first_name(&self) -> &Option<String>
pub fn get_first_name(&self) -> &Option<String>
The first name, or given name, of the user.
sourcepub fn last_name(self, input: impl Into<String>) -> Self
pub fn last_name(self, input: impl Into<String>) -> Self
The last name, or surname, of the user.
sourcepub fn set_last_name(self, input: Option<String>) -> Self
pub fn set_last_name(self, input: Option<String>) -> Self
The last name, or surname, of the user.
sourcepub fn get_last_name(&self) -> &Option<String>
pub fn get_last_name(&self) -> &Option<String>
The last name, or surname, of the user.
sourcepub fn authentication_type(self, input: AuthenticationType) -> Self
pub fn authentication_type(self, input: AuthenticationType) -> Self
The authentication type for the user. You must specify USERPOOL.
sourcepub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self
pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self
The authentication type for the user. You must specify USERPOOL.
sourcepub fn get_authentication_type(&self) -> &Option<AuthenticationType>
pub fn get_authentication_type(&self) -> &Option<AuthenticationType>
The authentication type for the user. You must specify USERPOOL.
Trait Implementations§
source§impl Clone for CreateUserFluentBuilder
impl Clone for CreateUserFluentBuilder
source§fn clone(&self) -> CreateUserFluentBuilder
fn clone(&self) -> CreateUserFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateUserFluentBuilder
impl !RefUnwindSafe for CreateUserFluentBuilder
impl Send for CreateUserFluentBuilder
impl Sync for CreateUserFluentBuilder
impl Unpin for CreateUserFluentBuilder
impl !UnwindSafe for CreateUserFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more