Struct aws_sdk_cognitoidentityprovider::operation::get_user::GetUserOutput

#[non_exhaustive]
pub struct GetUserOutput {
    pub username: String,
    pub user_attributes: Vec<AttributeType>,
    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 information about the user.

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: Vec<AttributeType>

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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

impl GetUserOutput

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 representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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 setting.

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

impl GetUserOutput

pub fn builder() -> GetUserOutputBuilder

Creates a new builder-style object to manufacture GetUserOutput.

Trait Implementations

impl Clone for GetUserOutput

fn clone(&self) -> GetUserOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetUserOutput

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

Formats the value using the given formatter.

impl PartialEq for GetUserOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for GetUserOutput

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

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

impl StructuralPartialEq for GetUserOutput