Struct rusoto_cognito_idp::UpdateUserAttributesRequest

pub struct UpdateUserAttributesRequest {
    pub access_token: String,
    pub client_metadata: Option<HashMap<String, String>>,
    pub user_attributes: Vec<AttributeType>,
}

Represents the request to update user attributes.

Fields

access_token: String

The access token for the request to update user attributes.

client_metadata: Option<HashMap<String, String>>

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

You create custom workflows by assigning AWS 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

• Amazon Cognito does not validate the ClientMetadata value.

• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

user_attributes: Vec<AttributeType>

An array of name-value pairs representing user attributes.

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

Trait Implementations

impl Clone for UpdateUserAttributesRequest

fn clone(&self) -> UpdateUserAttributesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserAttributesRequest

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

Formats the value using the given formatter.

impl Default for UpdateUserAttributesRequest

fn default() -> UpdateUserAttributesRequest

Returns the “default value” for a type.

impl PartialEq<UpdateUserAttributesRequest> for UpdateUserAttributesRequest

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

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

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

This method tests for !=.

impl Serialize for UpdateUserAttributesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateUserAttributesRequest