Struct aws_sdk_cognitoidentityprovider::operation::confirm_forgot_password::ConfirmForgotPasswordInput

#[non_exhaustive]
pub struct ConfirmForgotPasswordInput {
    pub client_id: Option<String>,
    pub secret_hash: Option<String>,
    pub username: Option<String>,
    pub confirmation_code: Option<String>,
    pub password: Option<String>,
    pub analytics_metadata: Option<AnalyticsMetadataType>,
    pub user_context_data: Option<UserContextDataType>,
    pub client_metadata: Option<HashMap<String, String>>,
}

The request representing the confirmation for a password reset.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_id: Option<String>

The app client ID of the app associated with the user pool.

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. For more information about SecretHash, see Computing secret hash values.

username: 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, this value must be the sub of a local user or the username of a user from a third-party IdP.

confirmation_code: Option<String>

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

password: Option<String>

The new password that your user wants to set.

analytics_metadata: Option<AnalyticsMetadataType>

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

user_context_data: Option<UserContextDataType>

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

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 Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmForgotPassword 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.

Implementations

impl ConfirmForgotPasswordInput

pub fn client_id(&self) -> Option<&str>

The app client ID of the app associated with the user pool.

pub fn secret_hash(&self) -> Option<&str>

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. For more information about SecretHash, see Computing secret hash values.

pub fn username(&self) -> Option<&str>

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, this value must be the sub of a local user or the username of a user from a third-party IdP.

pub fn confirmation_code(&self) -> Option<&str>

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

pub fn password(&self) -> Option<&str>

The new password that your user wants to set.

pub fn analytics_metadata(&self) -> Option<&AnalyticsMetadataType>

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

pub fn user_context_data(&self) -> Option<&UserContextDataType>

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

pub fn 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 triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmForgotPassword 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.

impl ConfirmForgotPasswordInput

pub fn builder() -> ConfirmForgotPasswordInputBuilder

Creates a new builder-style object to manufacture ConfirmForgotPasswordInput.

Trait Implementations

impl Clone for ConfirmForgotPasswordInput

fn clone(&self) -> ConfirmForgotPasswordInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfirmForgotPasswordInput

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

Formats the value using the given formatter.

impl PartialEq for ConfirmForgotPasswordInput

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