Struct aws_sdk_cognitoidentityprovider::operation::set_user_settings::builders::SetUserSettingsFluentBuilder

pub struct SetUserSettingsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SetUserSettings.

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

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 user pools API and user pool endpoints.

Implementations

impl SetUserSettingsFluentBuilder

pub fn as_input(&self) -> &SetUserSettingsInputBuilder

Access the SetUserSettings as a reference.

pub async fn send( self, ) -> Result<SetUserSettingsOutput, SdkError<SetUserSettingsError, 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<SetUserSettingsOutput, SetUserSettingsError, Self>

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

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

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

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

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

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

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

pub fn mfa_options(self, input: MfaOptionType) -> Self

Appends an item to MFAOptions.

To override the contents of this collection use set_mfa_options.

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

pub fn set_mfa_options(self, input: Option<Vec<MfaOptionType>>) -> Self

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

pub fn get_mfa_options(&self) -> &Option<Vec<MfaOptionType>>

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Trait Implementations

impl Clone for SetUserSettingsFluentBuilder

fn clone(&self) -> SetUserSettingsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetUserSettingsFluentBuilder

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

Formats the value using the given formatter.