Struct AdminGetUserOutput

#[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 */
}

Represents the response from the server from the request to get the specified user as an administrator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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 of user attributes and their values, for example "email": "testuser@example.com".

user_create_date: Option<DateTime>

The date and time when the item was created. 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.

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 whether the user is activated for sign-in.

user_status: Option<UserStatusType>

The user's 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.

• EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

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. Users can prefer SMS message, email message, or TOTP MFA.

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, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Implementations

impl AdminGetUserOutput

pub fn username(&self) -> &str

The username of the user that you requested.

pub fn user_attributes(&self) -> &[AttributeType]

An array of name-value pairs of user attributes and their values, for example "email": "testuser@example.com".

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().

pub fn user_create_date(&self) -> Option<&DateTime>

The date and time when the item was created. 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.

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.

pub fn enabled(&self) -> bool

Indicates whether the user is activated for sign-in.

pub fn user_status(&self) -> Option<&UserStatusType>

The user's 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.

• EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

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().

pub fn preferred_mfa_setting(&self) -> Option<&str>

The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

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, EMAIL_OTP, 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().

impl AdminGetUserOutput

pub fn builder() -> AdminGetUserOutputBuilder

Creates a new builder-style object to manufacture AdminGetUserOutput.

Trait Implementations

impl Clone for AdminGetUserOutput

fn clone(&self) -> AdminGetUserOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AdminGetUserOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AdminGetUserOutput

fn eq(&self, other: &AdminGetUserOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for AdminGetUserOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for AdminGetUserOutput