Struct aws_sdk_cognitoidentityprovider::operation::admin_delete_user_attributes::AdminDeleteUserAttributesInput
source · #[non_exhaustive]pub struct AdminDeleteUserAttributesInput {
pub user_pool_id: Option<String>,
pub username: Option<String>,
pub user_attribute_names: Option<Vec<String>>,
}Expand description
Represents the request to delete user attributes as an administrator.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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, you can also use their sub in this request.
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§
source§impl AdminDeleteUserAttributesInput
impl AdminDeleteUserAttributesInput
sourcepub fn user_pool_id(&self) -> Option<&str>
pub fn user_pool_id(&self) -> Option<&str>
The user pool ID for the user pool where you want to delete user attributes.
sourcepub fn username(&self) -> Option<&str>
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, you can also use their sub in this request.
sourcepub fn user_attribute_names(&self) -> &[String]
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().
source§impl AdminDeleteUserAttributesInput
impl AdminDeleteUserAttributesInput
sourcepub fn builder() -> AdminDeleteUserAttributesInputBuilder
pub fn builder() -> AdminDeleteUserAttributesInputBuilder
Creates a new builder-style object to manufacture AdminDeleteUserAttributesInput.
Trait Implementations§
source§impl Clone for AdminDeleteUserAttributesInput
impl Clone for AdminDeleteUserAttributesInput
source§fn clone(&self) -> AdminDeleteUserAttributesInput
fn clone(&self) -> AdminDeleteUserAttributesInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl PartialEq for AdminDeleteUserAttributesInput
impl PartialEq for AdminDeleteUserAttributesInput
source§fn eq(&self, other: &AdminDeleteUserAttributesInput) -> bool
fn eq(&self, other: &AdminDeleteUserAttributesInput) -> bool
self and other values to be equal, and is used
by ==.