pub struct ConfirmForgotPasswordRequest {
pub analytics_metadata: Option<AnalyticsMetadataType>,
pub client_id: String,
pub client_metadata: Option<HashMap<String, String>>,
pub confirmation_code: String,
pub password: String,
pub secret_hash: Option<String>,
pub user_context_data: Option<UserContextDataType>,
pub username: String,
}
Expand description
The request representing the confirmation for a password reset.
Fields
analytics_metadata: Option<AnalyticsMetadataType>
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword
calls.
client_id: String
The app client ID of the app 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 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 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.
confirmation_code: String
The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.
password: String
The password sent by a user's request to retrieve a forgotten password.
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 retrieve a forgotten password.
Trait Implementations
sourceimpl Clone for ConfirmForgotPasswordRequest
impl Clone for ConfirmForgotPasswordRequest
sourcefn clone(&self) -> ConfirmForgotPasswordRequest
fn clone(&self) -> ConfirmForgotPasswordRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ConfirmForgotPasswordRequest
impl Debug for ConfirmForgotPasswordRequest
sourceimpl Default for ConfirmForgotPasswordRequest
impl Default for ConfirmForgotPasswordRequest
sourcefn default() -> ConfirmForgotPasswordRequest
fn default() -> ConfirmForgotPasswordRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ConfirmForgotPasswordRequest> for ConfirmForgotPasswordRequest
impl PartialEq<ConfirmForgotPasswordRequest> for ConfirmForgotPasswordRequest
sourcefn eq(&self, other: &ConfirmForgotPasswordRequest) -> bool
fn eq(&self, other: &ConfirmForgotPasswordRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ConfirmForgotPasswordRequest) -> bool
fn ne(&self, other: &ConfirmForgotPasswordRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for ConfirmForgotPasswordRequest
Auto Trait Implementations
impl RefUnwindSafe for ConfirmForgotPasswordRequest
impl Send for ConfirmForgotPasswordRequest
impl Sync for ConfirmForgotPasswordRequest
impl Unpin for ConfirmForgotPasswordRequest
impl UnwindSafe for ConfirmForgotPasswordRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more