Struct aws_sdk_cognitoidentityprovider::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder

pub struct AdminSetUserSettingsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AdminSetUserSettings.

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 AdminSetUserMFAPreference instead.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl AdminSetUserSettingsFluentBuilder

pub fn as_input(&self) -> &AdminSetUserSettingsInputBuilder

Access the AdminSetUserSettings as a reference.

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

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

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

The ID of the user pool that contains the user whose options you're setting.

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

The ID of the user pool that contains the user whose options you're setting.

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

The ID of the user pool that contains the user whose options you're setting.

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.

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.

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.

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 AdminSetUserSettingsFluentBuilder

fn clone(&self) -> AdminSetUserSettingsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminSetUserSettingsFluentBuilder

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

Formats the value using the given formatter.