aws_sdk_cognitoidentityprovider/client/
admin_delete_user_attributes.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`AdminDeleteUserAttributes`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to delete user attributes.</p><br>
7    ///   - [`username(impl Into<String>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::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>
8    ///   - [`user_attribute_names(impl Into<String>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::user_attribute_names) / [`set_user_attribute_names(Option<Vec::<String>>)`](crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::set_user_attribute_names):<br>required: **true**<br><p>An array of strings representing the user attribute names you want to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p><br>
9    /// - On success, responds with [`AdminDeleteUserAttributesOutput`](crate::operation::admin_delete_user_attributes::AdminDeleteUserAttributesOutput)
10    /// - On failure, responds with [`SdkError<AdminDeleteUserAttributesError>`](crate::operation::admin_delete_user_attributes::AdminDeleteUserAttributesError)
11    pub fn admin_delete_user_attributes(&self) -> crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder {
12        crate::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder::new(self.handle.clone())
13    }
14}