aws_sdk_cognitoidentityprovider/client/

admin_set_user_settings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminSetUserSettings`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that contains the user whose options you're setting.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::set_username):<br>required: **true**<br><p>The name 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 <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p><br>
    ///   - [`mfa_options(MfaOptionType)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::mfa_options) / [`set_mfa_options(Option<Vec::<MfaOptionType>>)`](crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::set_mfa_options):<br>required: **true**<br><p>You can use this parameter only to set an SMS configuration that uses SMS for delivery.</p><br>
    /// - On success, responds with [`AdminSetUserSettingsOutput`](crate::operation::admin_set_user_settings::AdminSetUserSettingsOutput)
    /// - On failure, responds with [`SdkError<AdminSetUserSettingsError>`](crate::operation::admin_set_user_settings::AdminSetUserSettingsError)
    pub fn admin_set_user_settings(&self) -> crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder {
        crate::operation::admin_set_user_settings::builders::AdminSetUserSettingsFluentBuilder::new(self.handle.clone())
    }
}