Struct aws_sdk_cognitoidentityprovider::operation::admin_get_user::builders::AdminGetUserOutputBuilder
source · #[non_exhaustive]pub struct AdminGetUserOutputBuilder { /* private fields */ }
Expand description
A builder for AdminGetUserOutput
.
Implementations§
source§impl AdminGetUserOutputBuilder
impl AdminGetUserOutputBuilder
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The username of the user that you requested.
This field is required.sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The username of the user that you requested.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The username of the user that you requested.
sourcepub fn user_attributes(self, input: AttributeType) -> Self
pub fn user_attributes(self, input: AttributeType) -> Self
Appends an item to user_attributes
.
To override the contents of this collection use set_user_attributes
.
An array of name-value pairs representing user attributes.
sourcepub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self
pub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self
An array of name-value pairs representing user attributes.
sourcepub fn get_user_attributes(&self) -> &Option<Vec<AttributeType>>
pub fn get_user_attributes(&self) -> &Option<Vec<AttributeType>>
An array of name-value pairs representing user attributes.
sourcepub fn user_create_date(self, input: DateTime) -> Self
pub fn user_create_date(self, input: DateTime) -> Self
The date the user was created.
sourcepub fn set_user_create_date(self, input: Option<DateTime>) -> Self
pub fn set_user_create_date(self, input: Option<DateTime>) -> Self
The date the user was created.
sourcepub fn get_user_create_date(&self) -> &Option<DateTime>
pub fn get_user_create_date(&self) -> &Option<DateTime>
The date the user was created.
sourcepub fn user_last_modified_date(self, input: DateTime) -> Self
pub fn user_last_modified_date(self, input: DateTime) -> Self
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
sourcepub fn set_user_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_user_last_modified_date(self, input: Option<DateTime>) -> Self
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
sourcepub fn get_user_last_modified_date(&self) -> &Option<DateTime>
pub fn get_user_last_modified_date(&self) -> &Option<DateTime>
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
sourcepub fn set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
Indicates that the status is enabled
.
sourcepub fn get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<bool>
Indicates that the status is enabled
.
sourcepub fn user_status(self, input: UserStatusType) -> Self
pub fn user_status(self, input: UserStatusType) -> Self
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
sourcepub fn set_user_status(self, input: Option<UserStatusType>) -> Self
pub fn set_user_status(self, input: Option<UserStatusType>) -> Self
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
sourcepub fn get_user_status(&self) -> &Option<UserStatusType>
pub fn get_user_status(&self) -> &Option<UserStatusType>
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
sourcepub fn mfa_options(self, input: MfaOptionType) -> Self
pub fn mfa_options(self, input: MfaOptionType) -> Self
Appends an item to mfa_options
.
To override the contents of this collection use set_mfa_options
.
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
sourcepub fn set_mfa_options(self, input: Option<Vec<MfaOptionType>>) -> Self
pub fn set_mfa_options(self, input: Option<Vec<MfaOptionType>>) -> Self
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
sourcepub fn get_mfa_options(&self) -> &Option<Vec<MfaOptionType>>
pub fn get_mfa_options(&self) -> &Option<Vec<MfaOptionType>>
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
sourcepub fn preferred_mfa_setting(self, input: impl Into<String>) -> Self
pub fn preferred_mfa_setting(self, input: impl Into<String>) -> Self
The user's preferred MFA setting.
sourcepub fn set_preferred_mfa_setting(self, input: Option<String>) -> Self
pub fn set_preferred_mfa_setting(self, input: Option<String>) -> Self
The user's preferred MFA setting.
sourcepub fn get_preferred_mfa_setting(&self) -> &Option<String>
pub fn get_preferred_mfa_setting(&self) -> &Option<String>
The user's preferred MFA setting.
sourcepub fn user_mfa_setting_list(self, input: impl Into<String>) -> Self
pub fn user_mfa_setting_list(self, input: impl Into<String>) -> Self
Appends an item to user_mfa_setting_list
.
To override the contents of this collection use set_user_mfa_setting_list
.
The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
sourcepub fn set_user_mfa_setting_list(self, input: Option<Vec<String>>) -> Self
pub fn set_user_mfa_setting_list(self, input: Option<Vec<String>>) -> Self
The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
sourcepub fn get_user_mfa_setting_list(&self) -> &Option<Vec<String>>
pub fn get_user_mfa_setting_list(&self) -> &Option<Vec<String>>
The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
sourcepub fn build(self) -> Result<AdminGetUserOutput, BuildError>
pub fn build(self) -> Result<AdminGetUserOutput, BuildError>
Consumes the builder and constructs a AdminGetUserOutput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for AdminGetUserOutputBuilder
impl Clone for AdminGetUserOutputBuilder
source§fn clone(&self) -> AdminGetUserOutputBuilder
fn clone(&self) -> AdminGetUserOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AdminGetUserOutputBuilder
impl Debug for AdminGetUserOutputBuilder
source§impl Default for AdminGetUserOutputBuilder
impl Default for AdminGetUserOutputBuilder
source§fn default() -> AdminGetUserOutputBuilder
fn default() -> AdminGetUserOutputBuilder
source§impl PartialEq for AdminGetUserOutputBuilder
impl PartialEq for AdminGetUserOutputBuilder
source§fn eq(&self, other: &AdminGetUserOutputBuilder) -> bool
fn eq(&self, other: &AdminGetUserOutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AdminGetUserOutputBuilder
Auto Trait Implementations§
impl Freeze for AdminGetUserOutputBuilder
impl RefUnwindSafe for AdminGetUserOutputBuilder
impl Send for AdminGetUserOutputBuilder
impl Sync for AdminGetUserOutputBuilder
impl Unpin for AdminGetUserOutputBuilder
impl UnwindSafe for AdminGetUserOutputBuilder
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