Struct aws_sdk_cognitoidentityprovider::operation::admin_delete_user_attributes::builders::AdminDeleteUserAttributesFluentBuilder

pub struct AdminDeleteUserAttributesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AdminDeleteUserAttributes.

Deletes the user attributes in a user pool as an administrator. Works on any user.

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 AdminDeleteUserAttributesFluentBuilder

pub fn as_input(&self) -> &AdminDeleteUserAttributesInputBuilder

Access the AdminDeleteUserAttributes as a reference.

pub async fn send( self ) -> Result<AdminDeleteUserAttributesOutput, SdkError<AdminDeleteUserAttributesError, 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<AdminDeleteUserAttributesOutput, AdminDeleteUserAttributesError, 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 user pool ID for the user pool where you want to delete user attributes.

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

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

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

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

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, you can also use their sub in this request.

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, you can also use their sub in this request.

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, you can also use their sub in this request.

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

Appends an item to UserAttributeNames.

To override the contents of this collection use set_user_attribute_names.

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.

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

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.

pub fn get_user_attribute_names(&self) -> &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.

Trait Implementations

impl Clone for AdminDeleteUserAttributesFluentBuilder

fn clone(&self) -> AdminDeleteUserAttributesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminDeleteUserAttributesFluentBuilder

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

Formats the value using the given formatter.