Network.AWS.CognitoIdentityProvider.ForgotPassword

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

Creating a Request

forgotPassword

Arguments

:: Text

fpClientId

-> Text

fpUsername

-> 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:

• fpAnalyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
• fpUserContextData - 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.
• 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

Eq ForgotPassword

Methods

(==) :: ForgotPassword -> ForgotPassword -> Bool

(/=) :: ForgotPassword -> ForgotPassword -> Bool

Data ForgotPassword

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForgotPassword -> c ForgotPassword

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForgotPassword

toConstr :: ForgotPassword -> Constr

dataTypeOf :: ForgotPassword -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ForgotPassword)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForgotPassword)

gmapT :: (forall b. Data b => b -> b) -> ForgotPassword -> ForgotPassword

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForgotPassword -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForgotPassword -> r

gmapQ :: (forall d. Data d => d -> u) -> ForgotPassword -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForgotPassword -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForgotPassword -> m ForgotPassword

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForgotPassword -> m ForgotPassword

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForgotPassword -> m ForgotPassword

Show ForgotPassword

Methods

showsPrec :: Int -> ForgotPassword -> ShowS

show :: ForgotPassword -> String

showList :: [ForgotPassword] -> ShowS

Generic ForgotPassword

Associated Types

type Rep ForgotPassword :: * -> *

Methods

from :: ForgotPassword -> Rep ForgotPassword x

to :: Rep ForgotPassword x -> ForgotPassword

Hashable ForgotPassword

Methods

hashWithSalt :: Int -> ForgotPassword -> Int

hash :: ForgotPassword -> Int

ToJSON ForgotPassword

Methods

toJSON :: ForgotPassword -> Value

toEncoding :: ForgotPassword -> Encoding

toJSONList :: [ForgotPassword] -> Value

toEncodingList :: [ForgotPassword] -> Encoding

NFData ForgotPassword

Methods

rnf :: ForgotPassword -> ()

AWSRequest ForgotPassword

Associated Types

type Rs ForgotPassword :: *

Methods

request :: ForgotPassword -> Request ForgotPassword

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ForgotPassword -> ClientResponse -> m (Response ForgotPassword)

ToHeaders ForgotPassword

Methods

toHeaders :: ForgotPassword -> [Header]

ToPath ForgotPassword

Methods

toPath :: ForgotPassword -> ByteString

ToQuery ForgotPassword

Methods

toQuery :: ForgotPassword -> QueryString

type Rep ForgotPassword

type Rep ForgotPassword = D1 * (MetaData "ForgotPassword" "Network.AWS.CognitoIdentityProvider.ForgotPassword" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ForgotPassword'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_fpAnalyticsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsMetadataType))) (S1 * (MetaSel (Just Symbol "_fpUserContextData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserContextDataType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_fpSecretHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_fpClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_fpUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text)))))))

type Rs ForgotPassword

type Rs ForgotPassword = ForgotPasswordResponse

Request Lenses

fpAnalyticsMetadata :: Lens' ForgotPassword (Maybe AnalyticsMetadataType)

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

fpUserContextData :: Lens' ForgotPassword (Maybe 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.

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

forgotPasswordResponse

Arguments

:: Int

fprsResponseStatus

-> 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.

Instances

Eq ForgotPasswordResponse

Methods

(==) :: ForgotPasswordResponse -> ForgotPasswordResponse -> Bool

(/=) :: ForgotPasswordResponse -> ForgotPasswordResponse -> Bool

Data ForgotPasswordResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ForgotPasswordResponse -> c ForgotPasswordResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ForgotPasswordResponse

toConstr :: ForgotPasswordResponse -> Constr

dataTypeOf :: ForgotPasswordResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ForgotPasswordResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ForgotPasswordResponse)

gmapT :: (forall b. Data b => b -> b) -> ForgotPasswordResponse -> ForgotPasswordResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ForgotPasswordResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ForgotPasswordResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ForgotPasswordResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ForgotPasswordResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ForgotPasswordResponse -> m ForgotPasswordResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ForgotPasswordResponse -> m ForgotPasswordResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ForgotPasswordResponse -> m ForgotPasswordResponse

Read ForgotPasswordResponse

Methods

readsPrec :: Int -> ReadS ForgotPasswordResponse

readList :: ReadS [ForgotPasswordResponse]

readPrec :: ReadPrec ForgotPasswordResponse

readListPrec :: ReadPrec [ForgotPasswordResponse]

Show ForgotPasswordResponse

Methods

showsPrec :: Int -> ForgotPasswordResponse -> ShowS

show :: ForgotPasswordResponse -> String

showList :: [ForgotPasswordResponse] -> ShowS

Generic ForgotPasswordResponse

Associated Types

type Rep ForgotPasswordResponse :: * -> *

Methods

from :: ForgotPasswordResponse -> Rep ForgotPasswordResponse x

to :: Rep ForgotPasswordResponse x -> ForgotPasswordResponse

NFData ForgotPasswordResponse

Methods

rnf :: ForgotPasswordResponse -> ()

type Rep ForgotPasswordResponse

type Rep ForgotPasswordResponse = D1 * (MetaData "ForgotPasswordResponse" "Network.AWS.CognitoIdentityProvider.ForgotPassword" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ForgotPasswordResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_fprsCodeDeliveryDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CodeDeliveryDetailsType))) (S1 * (MetaSel (Just Symbol "_fprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

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.