Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.CognitoIdentityProvider.ForgotPassword
Description
Retrieves the password for the specified client ID or username.
- forgotPassword :: Text -> Text -> ForgotPassword
- data ForgotPassword
- fpSecretHash :: Lens' ForgotPassword (Maybe Text)
- fpClientId :: Lens' ForgotPassword Text
- fpUsername :: Lens' ForgotPassword Text
- forgotPasswordResponse :: Int -> ForgotPasswordResponse
- data ForgotPasswordResponse
- fprsCodeDeliveryDetails :: Lens' ForgotPasswordResponse (Maybe CodeDeliveryDetailsType)
- fprsResponseStatus :: Lens' ForgotPasswordResponse Int
Creating a Request
Arguments
:: Text | |
-> Text | |
-> ForgotPassword |
Creates a value of ForgotPassword
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fpSecretHash
- 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.fpClientId
- The ID of the client associated with the user pool.fpUsername
- The user name of the user for whom you want to enter a code to reset a forgotten password.
data ForgotPassword #
Represents the request to reset a user's password.
See: forgotPassword
smart constructor.
Instances
Request Lenses
fpSecretHash :: Lens' ForgotPassword (Maybe Text) #
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.
fpClientId :: Lens' ForgotPassword Text #
The ID of the client associated with the user pool.
fpUsername :: Lens' ForgotPassword Text #
The user name of the user for whom you want to enter a code to reset a forgotten password.
Destructuring the Response
Arguments
:: Int | |
-> ForgotPasswordResponse |
Creates a value of ForgotPasswordResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fprsCodeDeliveryDetails
- The code delivery details returned by the server in response to the request to reset a password.fprsResponseStatus
- -- | The response status code.
data ForgotPasswordResponse #
Respresents the response from the server regarding the request to reset a password.
See: forgotPasswordResponse
smart constructor.
Response Lenses
fprsCodeDeliveryDetails :: Lens' ForgotPasswordResponse (Maybe CodeDeliveryDetailsType) #
The code delivery details returned by the server in response to the request to reset a password.
fprsResponseStatus :: Lens' ForgotPasswordResponse Int #
- - | The response status code.