Struct UserType

#[non_exhaustive]
pub struct UserType {
    pub username: Option<String>,
    pub 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>>,
}

A user profile in a Amazon Cognito user pool.

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: Option<String>

The user's username.

attributes: Option<Vec<AttributeType>>

Names and values of a user's attributes, for example email.

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's account is enabled or disabled.

user_status: Option<UserStatusType>

The user status. This can be one of the following:

• UNCONFIRMED: User has been created but not confirmed.

• CONFIRMED: User has been confirmed.

• EXTERNAL_PROVIDER: User signed in with a third-party IdP.

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

The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

mfa_options: Option<Vec<MfaOptionType>>

The user's MFA configuration.

Implementations

impl UserType

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

The user's username.

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

Names and values of a user's attributes, for example email.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .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's account is enabled or disabled.

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

The user status. This can be one of the following:

• UNCONFIRMED: User has been created but not confirmed.

• CONFIRMED: User has been confirmed.

• EXTERNAL_PROVIDER: User signed in with a third-party IdP.

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

The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

pub fn mfa_options(&self) -> &[MfaOptionType]

The user's MFA configuration.

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

impl UserType

pub fn builder() -> UserTypeBuilder

Creates a new builder-style object to manufacture UserType.

Trait Implementations

impl Clone for UserType

fn clone(&self) -> UserType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserType

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

Formats the value using the given formatter.

impl PartialEq for UserType

fn eq(&self, other: &UserType) -> 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 StructuralPartialEq for UserType