Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Allows a user to enter a confirmation code to reset a forgotten password.
Synopsis
- confirmForgotPassword :: Text -> Text -> Text -> Text -> ConfirmForgotPassword
- data ConfirmForgotPassword
- cfpAnalyticsMetadata :: Lens' ConfirmForgotPassword (Maybe AnalyticsMetadataType)
- cfpUserContextData :: Lens' ConfirmForgotPassword (Maybe UserContextDataType)
- cfpSecretHash :: Lens' ConfirmForgotPassword (Maybe Text)
- cfpClientId :: Lens' ConfirmForgotPassword Text
- cfpUsername :: Lens' ConfirmForgotPassword Text
- cfpConfirmationCode :: Lens' ConfirmForgotPassword Text
- cfpPassword :: Lens' ConfirmForgotPassword Text
- confirmForgotPasswordResponse :: Int -> ConfirmForgotPasswordResponse
- data ConfirmForgotPasswordResponse
- cfprsResponseStatus :: Lens' ConfirmForgotPasswordResponse Int
Creating a Request
confirmForgotPassword Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> ConfirmForgotPassword |
Creates a value of ConfirmForgotPassword
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfpAnalyticsMetadata
- The Amazon Pinpoint analytics metadata for collecting metrics forConfirmForgotPassword
calls.cfpUserContextData
- 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.cfpSecretHash
- 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.cfpClientId
- The app client ID of the app associated with the user pool.cfpUsername
- The user name of the user for whom you want to enter a code to retrieve a forgotten password.cfpConfirmationCode
- The confirmation code sent by a user's request to retrieve a forgotten password. For more information, seecfpPassword
- The password sent by a user's request to retrieve a forgotten password.
data ConfirmForgotPassword Source #
The request representing the confirmation for a password reset.
See: confirmForgotPassword
smart constructor.
Instances
Request Lenses
cfpAnalyticsMetadata :: Lens' ConfirmForgotPassword (Maybe AnalyticsMetadataType) Source #
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword
calls.
cfpUserContextData :: Lens' ConfirmForgotPassword (Maybe UserContextDataType) Source #
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.
cfpSecretHash :: Lens' ConfirmForgotPassword (Maybe Text) Source #
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.
cfpClientId :: Lens' ConfirmForgotPassword Text Source #
The app client ID of the app associated with the user pool.
cfpUsername :: Lens' ConfirmForgotPassword Text Source #
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
cfpConfirmationCode :: Lens' ConfirmForgotPassword Text Source #
The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
cfpPassword :: Lens' ConfirmForgotPassword Text Source #
The password sent by a user's request to retrieve a forgotten password.
Destructuring the Response
confirmForgotPasswordResponse Source #
Creates a value of ConfirmForgotPasswordResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfprsResponseStatus
- -- | The response status code.
data ConfirmForgotPasswordResponse Source #
The response from the server that results from a user's request to retrieve a forgotten password.
See: confirmForgotPasswordResponse
smart constructor.
Instances
Response Lenses
cfprsResponseStatus :: Lens' ConfirmForgotPasswordResponse Int Source #
- - | The response status code.