Struct rusoto_cognito_idp::ForgotPasswordRequest

pub struct ForgotPasswordRequest {
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub client_id: String,
    pub client_metadata: Option<HashMap<String, String>>,
    pub secret_hash: Option<String>,
    pub user_context_data: Option<UserContextDataType>,
    pub username: String,
}

Represents the request to reset a user's password.

Fields

analytics_metadata: Option<AnalyticsMetadataType>

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

client_id: String

The ID of the client associated with the user pool.

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 ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, 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 ForgotPassword 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.

secret_hash: Option<String>

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

user_context_data: Option<UserContextDataType>

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

username: String

The user name of the user for whom you want to enter a code to reset a forgotten password.

Trait Implementations

impl Clone for ForgotPasswordRequest

pub fn clone(&self) -> ForgotPasswordRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForgotPasswordRequest

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

Formats the value using the given formatter.

impl Default for ForgotPasswordRequest

pub fn default() -> ForgotPasswordRequest

Returns the "default value" for a type.

impl PartialEq<ForgotPasswordRequest> for ForgotPasswordRequest

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

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

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

This method tests for !=.

impl Serialize for ForgotPasswordRequest

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 ForgotPasswordRequest