Struct aws_sdk_cognitoidentityprovider::operation::update_user_attributes::builders::UpdateUserAttributesInputBuilder

#[non_exhaustive]
pub struct UpdateUserAttributesInputBuilder { /* private fields */ }

A builder for UpdateUserAttributesInput.

Implementations

impl UpdateUserAttributesInputBuilder

pub fn user_attributes(self, input: AttributeType) -> Self

Appends an item to user_attributes.

To override the contents of this collection use set_user_attributes.

An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

pub fn set_user_attributes(self, input: Option<Vec<AttributeType>>) -> Self

An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

pub fn get_user_attributes(&self) -> &Option<Vec<AttributeType>>

An array of name-value pairs representing user attributes.

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

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

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

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

This field is required.

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

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

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

A valid access token that Amazon Cognito issued to the user whose user attributes you want to update.

pub fn client_metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to client_metadata.

To override the contents of this collection use set_client_metadata.

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

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

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

pub fn get_client_metadata(&self) -> &Option<HashMap<String, String>>

A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

pub fn build(self) -> Result<UpdateUserAttributesInput, BuildError>

Consumes the builder and constructs a UpdateUserAttributesInput.

impl UpdateUserAttributesInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<UpdateUserAttributesOutput, SdkError<UpdateUserAttributesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for UpdateUserAttributesInputBuilder

fn clone(&self) -> UpdateUserAttributesInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserAttributesInputBuilder

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

Formats the value using the given formatter.

impl Default for UpdateUserAttributesInputBuilder

fn default() -> UpdateUserAttributesInputBuilder

Returns the “default value” for a type.

impl PartialEq for UpdateUserAttributesInputBuilder

fn eq(&self, other: &UpdateUserAttributesInputBuilder) -> 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 UpdateUserAttributesInputBuilder