#[non_exhaustive]pub struct AdminGetUserOutput {
pub username: String,
pub user_attributes: Option<Vec<AttributeType>>,
pub user_create_date: Option<DateTime>,
pub user_last_modified_date: Option<DateTime>,
pub enabled: bool,
pub user_status: Option<UserStatusType>,
pub mfa_options: Option<Vec<MfaOptionType>>,
pub preferred_mfa_setting: Option<String>,
pub user_mfa_setting_list: Option<Vec<String>>,
/* private fields */
}
Expand description
Represents the response from the server from the request to get the specified user as an administrator.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.username: String
The username of the user that you requested.
user_attributes: Option<Vec<AttributeType>>
An array of name-value pairs representing user attributes.
user_create_date: Option<DateTime>
The date the user was created.
user_last_modified_date: 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.
enabled: bool
Indicates that the status is enabled
.
user_status: 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.
mfa_options: 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.
preferred_mfa_setting: Option<String>
The user's preferred MFA setting.
user_mfa_setting_list: 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
.
Implementations§
source§impl AdminGetUserOutput
impl AdminGetUserOutput
sourcepub fn user_attributes(&self) -> &[AttributeType]
pub fn user_attributes(&self) -> &[AttributeType]
An array of name-value pairs representing user attributes.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_attributes.is_none()
.
sourcepub fn user_create_date(&self) -> Option<&DateTime>
pub fn user_create_date(&self) -> Option<&DateTime>
The date the user was created.
sourcepub fn user_last_modified_date(&self) -> Option<&DateTime>
pub fn 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 user_status(&self) -> Option<&UserStatusType>
pub fn 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) -> &[MfaOptionType]
pub fn mfa_options(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mfa_options.is_none()
.
sourcepub fn preferred_mfa_setting(&self) -> Option<&str>
pub fn preferred_mfa_setting(&self) -> Option<&str>
The user's preferred MFA setting.
sourcepub fn user_mfa_setting_list(&self) -> &[String]
pub fn user_mfa_setting_list(&self) -> &[String]
The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_mfa_setting_list.is_none()
.
source§impl AdminGetUserOutput
impl AdminGetUserOutput
sourcepub fn builder() -> AdminGetUserOutputBuilder
pub fn builder() -> AdminGetUserOutputBuilder
Creates a new builder-style object to manufacture AdminGetUserOutput
.
Trait Implementations§
source§impl Clone for AdminGetUserOutput
impl Clone for AdminGetUserOutput
source§fn clone(&self) -> AdminGetUserOutput
fn clone(&self) -> AdminGetUserOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AdminGetUserOutput
impl Debug for AdminGetUserOutput
source§impl PartialEq for AdminGetUserOutput
impl PartialEq for AdminGetUserOutput
source§fn eq(&self, other: &AdminGetUserOutput) -> bool
fn eq(&self, other: &AdminGetUserOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for AdminGetUserOutput
impl RequestId for AdminGetUserOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for AdminGetUserOutput
Auto Trait Implementations§
impl Freeze for AdminGetUserOutput
impl RefUnwindSafe for AdminGetUserOutput
impl Send for AdminGetUserOutput
impl Sync for AdminGetUserOutput
impl Unpin for AdminGetUserOutput
impl UnwindSafe for AdminGetUserOutput
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