Struct aws_sdk_cognitoidentityprovider::operation::admin_get_user::builders::AdminGetUserOutputBuilder

#[non_exhaustive]
pub struct AdminGetUserOutputBuilder { /* private fields */ }

A builder for AdminGetUserOutput.

Implementations

impl AdminGetUserOutputBuilder

pub fn username(self, input: impl Into<String>) -> Self

The username of the user that you requested.

This field is required.

pub fn set_username(self, input: Option<String>) -> Self

The username of the user that you requested.

pub fn get_username(&self) -> &Option<String>

The username of the user that you requested.

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.

pub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self

An array of name-value pairs representing user attributes.

pub fn get_user_attributes(&self) -> &Option<Vec<AttributeType>>

An array of name-value pairs representing user attributes.

pub fn user_create_date(self, input: DateTime) -> Self

The date the user was created.

pub fn set_user_create_date(self, input: Option<DateTime>) -> Self

The date the user was created.

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

The date the user was created.

pub fn user_last_modified_date(self, input: DateTime) -> Self

The date and time, in ISO 8601 format, when the item was modified.

pub fn set_user_last_modified_date(self, input: Option<DateTime>) -> Self

The date and time, in ISO 8601 format, when the item was modified.

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

The date and time, in ISO 8601 format, when the item was modified.

pub fn enabled(self, input: bool) -> Self

Indicates that the status is enabled.

pub fn set_enabled(self, input: Option<bool>) -> Self

Indicates that the status is enabled.

pub fn get_enabled(&self) -> &Option<bool>

Indicates that the status is enabled.

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.

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.

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.

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.

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.

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.

pub fn preferred_mfa_setting(self, input: impl Into<String>) -> Self

The user's preferred MFA setting.

pub fn set_preferred_mfa_setting(self, input: Option<String>) -> Self

The user's preferred MFA setting.

pub fn get_preferred_mfa_setting(&self) -> &Option<String>

The user's preferred MFA setting.

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.

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.

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.

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:

• username

Trait Implementations

impl Clone for AdminGetUserOutputBuilder

fn clone(&self) -> AdminGetUserOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminGetUserOutputBuilder

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

Formats the value using the given formatter.

impl Default for AdminGetUserOutputBuilder

fn default() -> AdminGetUserOutputBuilder

Returns the “default value” for a type.

impl PartialEq for AdminGetUserOutputBuilder

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