Struct aws_sdk_cognitoidentityprovider::operation::admin_delete_user_attributes::AdminDeleteUserAttributesInput

#[non_exhaustive]
pub struct AdminDeleteUserAttributesInput {
    pub user_pool_id: Option<String>,
    pub username: Option<String>,
    pub user_attribute_names: Option<Vec<String>>,
}

Represents the request to delete user attributes as an administrator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_pool_id: Option<String>

The user pool ID for the user pool where you want to delete user attributes.

username: 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.

user_attribute_names: Option<Vec<String>>

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Implementations

impl AdminDeleteUserAttributesInput

pub fn user_pool_id(&self) -> Option<&str>

The user pool ID for the user pool where you want to delete user attributes.

pub fn username(&self) -> Option<&str>

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 user_attribute_names(&self) -> &[String]

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_attribute_names.is_none().

impl AdminDeleteUserAttributesInput

pub fn builder() -> AdminDeleteUserAttributesInputBuilder

Creates a new builder-style object to manufacture AdminDeleteUserAttributesInput.

Trait Implementations

impl Clone for AdminDeleteUserAttributesInput

fn clone(&self) -> AdminDeleteUserAttributesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminDeleteUserAttributesInput

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

Formats the value using the given formatter.

impl PartialEq for AdminDeleteUserAttributesInput

fn eq(&self, other: &AdminDeleteUserAttributesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AdminDeleteUserAttributesInput