Struct aws_sdk_cognitoidentityprovider::operation::set_user_mfa_preference::builders::SetUserMFAPreferenceFluentBuilder

pub struct SetUserMFAPreferenceFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SetUserMFAPreference.

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

Implementations

impl SetUserMFAPreferenceFluentBuilder

pub fn as_input(&self) -> &SetUserMfaPreferenceInputBuilder

Access the SetUserMFAPreference as a reference.

pub async fn send( self ) -> Result<SetUserMfaPreferenceOutput, SdkError<SetUserMFAPreferenceError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<SetUserMfaPreferenceOutput, SetUserMFAPreferenceError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn sms_mfa_settings(self, input: SmsMfaSettingsType) -> Self

The SMS text message multi-factor authentication (MFA) settings.

pub fn set_sms_mfa_settings(self, input: Option<SmsMfaSettingsType>) -> Self

The SMS text message multi-factor authentication (MFA) settings.

pub fn get_sms_mfa_settings(&self) -> &Option<SmsMfaSettingsType>

The SMS text message multi-factor authentication (MFA) settings.

pub fn software_token_mfa_settings( self, input: SoftwareTokenMfaSettingsType ) -> Self

The time-based one-time password (TOTP) software token MFA settings.

pub fn set_software_token_mfa_settings( self, input: Option<SoftwareTokenMfaSettingsType> ) -> Self

The time-based one-time password (TOTP) software token MFA settings.

pub fn get_software_token_mfa_settings( &self ) -> &Option<SoftwareTokenMfaSettingsType>

The time-based one-time password (TOTP) software token MFA settings.

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

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

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

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

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

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Trait Implementations

impl Clone for SetUserMFAPreferenceFluentBuilder

fn clone(&self) -> SetUserMFAPreferenceFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetUserMFAPreferenceFluentBuilder

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

Formats the value using the given formatter.