Struct rusoto_cognito_idp::AdminResetUserPasswordRequest

pub struct AdminResetUserPasswordRequest {
    pub client_metadata: Option<HashMap<String, String>>,
    pub user_pool_id: String,
    pub username: String,
}

Represents the request to reset a user's password as an administrator.

Fields

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 AdminResetUserPassword 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 AdminResetUserPassword 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_pool_id: String

The user pool ID for the user pool where you want to reset the user's password.

username: String

The user name of the user whose password you wish to reset.

Trait Implementations

impl Clone for AdminResetUserPasswordRequest

pub fn clone(&self) -> AdminResetUserPasswordRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminResetUserPasswordRequest

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

Formats the value using the given formatter.

impl Default for AdminResetUserPasswordRequest

pub fn default() -> AdminResetUserPasswordRequest

Returns the "default value" for a type.

impl PartialEq<AdminResetUserPasswordRequest> for AdminResetUserPasswordRequest

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

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

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

This method tests for !=.

impl Serialize for AdminResetUserPasswordRequest

pub 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 AdminResetUserPasswordRequest