Struct aws_sdk_cognitoidentityprovider::operation::admin_set_user_mfa_preference::builders::AdminSetUserMFAPreferenceFluentBuilder
source · pub struct AdminSetUserMFAPreferenceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to AdminSetUserMFAPreference
.
The user's multi-factor authentication (MFA) preference, including which MFA options 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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Implementations§
source§impl AdminSetUserMFAPreferenceFluentBuilder
impl AdminSetUserMFAPreferenceFluentBuilder
sourcepub fn as_input(&self) -> &AdminSetUserMfaPreferenceInputBuilder
pub fn as_input(&self) -> &AdminSetUserMfaPreferenceInputBuilder
Access the AdminSetUserMFAPreference as a reference.
sourcepub async fn send(
self,
) -> Result<AdminSetUserMfaPreferenceOutput, SdkError<AdminSetUserMFAPreferenceError, HttpResponse>>
pub async fn send( self, ) -> Result<AdminSetUserMfaPreferenceOutput, SdkError<AdminSetUserMFAPreferenceError, 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.
sourcepub fn customize(
self,
) -> CustomizableOperation<AdminSetUserMfaPreferenceOutput, AdminSetUserMFAPreferenceError, Self>
pub fn customize( self, ) -> CustomizableOperation<AdminSetUserMfaPreferenceOutput, AdminSetUserMFAPreferenceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn sms_mfa_settings(self, input: SmsMfaSettingsType) -> Self
pub fn sms_mfa_settings(self, input: SmsMfaSettingsType) -> Self
The SMS text message MFA settings.
sourcepub fn set_sms_mfa_settings(self, input: Option<SmsMfaSettingsType>) -> Self
pub fn set_sms_mfa_settings(self, input: Option<SmsMfaSettingsType>) -> Self
The SMS text message MFA settings.
sourcepub fn get_sms_mfa_settings(&self) -> &Option<SmsMfaSettingsType>
pub fn get_sms_mfa_settings(&self) -> &Option<SmsMfaSettingsType>
The SMS text message MFA settings.
sourcepub fn software_token_mfa_settings(
self,
input: SoftwareTokenMfaSettingsType,
) -> Self
pub fn software_token_mfa_settings( self, input: SoftwareTokenMfaSettingsType, ) -> Self
The time-based one-time password software token MFA settings.
sourcepub fn set_software_token_mfa_settings(
self,
input: Option<SoftwareTokenMfaSettingsType>,
) -> Self
pub fn set_software_token_mfa_settings( self, input: Option<SoftwareTokenMfaSettingsType>, ) -> Self
The time-based one-time password software token MFA settings.
sourcepub fn get_software_token_mfa_settings(
&self,
) -> &Option<SoftwareTokenMfaSettingsType>
pub fn get_software_token_mfa_settings( &self, ) -> &Option<SoftwareTokenMfaSettingsType>
The time-based one-time password software token MFA settings.
sourcepub fn username(self, input: impl Into<String>) -> Self
pub fn username(self, input: impl Into<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn set_username(self, input: Option<String>) -> Self
pub fn set_username(self, input: Option<String>) -> Self
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn get_username(&self) -> &Option<String>
pub fn get_username(&self) -> &Option<String>
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username
isn't an alias attribute in your user pool, this value must be the sub
of a local user or the username of a user from a third-party IdP.
sourcepub fn user_pool_id(self, input: impl Into<String>) -> Self
pub fn user_pool_id(self, input: impl Into<String>) -> Self
The user pool ID.
sourcepub fn set_user_pool_id(self, input: Option<String>) -> Self
pub fn set_user_pool_id(self, input: Option<String>) -> Self
The user pool ID.
sourcepub fn get_user_pool_id(&self) -> &Option<String>
pub fn get_user_pool_id(&self) -> &Option<String>
The user pool ID.
Trait Implementations§
source§impl Clone for AdminSetUserMFAPreferenceFluentBuilder
impl Clone for AdminSetUserMFAPreferenceFluentBuilder
source§fn clone(&self) -> AdminSetUserMFAPreferenceFluentBuilder
fn clone(&self) -> AdminSetUserMFAPreferenceFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for AdminSetUserMFAPreferenceFluentBuilder
impl !RefUnwindSafe for AdminSetUserMFAPreferenceFluentBuilder
impl Send for AdminSetUserMFAPreferenceFluentBuilder
impl Sync for AdminSetUserMFAPreferenceFluentBuilder
impl Unpin for AdminSetUserMFAPreferenceFluentBuilder
impl !UnwindSafe for AdminSetUserMFAPreferenceFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more