Network.AWS.CognitoIdentityProvider.ConfirmForgotPassword

Allows a user to enter a confirmation code to reset a forgotten password.

Creating a Request

confirmForgotPassword

Arguments

:: Text

cfpClientId

-> Text

cfpUsername

-> Text

cfpConfirmationCode

-> Text

cfpPassword

-> 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 for ConfirmForgotPassword 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, see
• cfpPassword - The password sent by a user's request to retrieve a forgotten password.

data ConfirmForgotPassword

The request representing the confirmation for a password reset.

See: confirmForgotPassword smart constructor.

Instances

Eq ConfirmForgotPassword

Methods

(==) :: ConfirmForgotPassword -> ConfirmForgotPassword -> Bool

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

Data ConfirmForgotPassword

Methods

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

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

toConstr :: ConfirmForgotPassword -> Constr

dataTypeOf :: ConfirmForgotPassword -> DataType

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

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

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

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

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

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

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

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

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

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

Show ConfirmForgotPassword

Methods

showsPrec :: Int -> ConfirmForgotPassword -> ShowS

show :: ConfirmForgotPassword -> String

showList :: [ConfirmForgotPassword] -> ShowS

Generic ConfirmForgotPassword

Associated Types

type Rep ConfirmForgotPassword :: * -> *

Methods

from :: ConfirmForgotPassword -> Rep ConfirmForgotPassword x

to :: Rep ConfirmForgotPassword x -> ConfirmForgotPassword

Hashable ConfirmForgotPassword

Methods

hashWithSalt :: Int -> ConfirmForgotPassword -> Int

hash :: ConfirmForgotPassword -> Int

ToJSON ConfirmForgotPassword

Methods

toJSON :: ConfirmForgotPassword -> Value

toEncoding :: ConfirmForgotPassword -> Encoding

toJSONList :: [ConfirmForgotPassword] -> Value

toEncodingList :: [ConfirmForgotPassword] -> Encoding

NFData ConfirmForgotPassword

Methods

rnf :: ConfirmForgotPassword -> ()

AWSRequest ConfirmForgotPassword

Associated Types

type Rs ConfirmForgotPassword :: *

Methods

request :: ConfirmForgotPassword -> Request ConfirmForgotPassword

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

ToHeaders ConfirmForgotPassword

Methods

toHeaders :: ConfirmForgotPassword -> [Header]

ToPath ConfirmForgotPassword

Methods

toPath :: ConfirmForgotPassword -> ByteString

ToQuery ConfirmForgotPassword

Methods

toQuery :: ConfirmForgotPassword -> QueryString

type Rep ConfirmForgotPassword

type Rep ConfirmForgotPassword = D1 * (MetaData "ConfirmForgotPassword" "Network.AWS.CognitoIdentityProvider.ConfirmForgotPassword" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ConfirmForgotPassword'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cfpAnalyticsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsMetadataType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cfpUserContextData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserContextDataType))) (S1 * (MetaSel (Just Symbol "_cfpSecretHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cfpClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_cfpUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cfpConfirmationCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cfpPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text)))))))

type Rs ConfirmForgotPassword

type Rs ConfirmForgotPassword = ConfirmForgotPasswordResponse

Request Lenses

cfpAnalyticsMetadata :: Lens' ConfirmForgotPassword (Maybe AnalyticsMetadataType)

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

cfpUserContextData :: Lens' ConfirmForgotPassword (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.

cfpSecretHash :: Lens' ConfirmForgotPassword (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.

cfpClientId :: Lens' ConfirmForgotPassword Text

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

cfpUsername :: Lens' ConfirmForgotPassword Text

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

cfpConfirmationCode :: Lens' ConfirmForgotPassword Text

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

cfpPassword :: Lens' ConfirmForgotPassword Text

The password sent by a user's request to retrieve a forgotten password.

Destructuring the Response

confirmForgotPasswordResponse

Arguments

:: Int

cfprsResponseStatus

-> ConfirmForgotPasswordResponse

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

The response from the server that results from a user's request to retrieve a forgotten password.

See: confirmForgotPasswordResponse smart constructor.

Instances

Eq ConfirmForgotPasswordResponse

Methods

(==) :: ConfirmForgotPasswordResponse -> ConfirmForgotPasswordResponse -> Bool

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

Data ConfirmForgotPasswordResponse

Methods

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

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

toConstr :: ConfirmForgotPasswordResponse -> Constr

dataTypeOf :: ConfirmForgotPasswordResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ConfirmForgotPasswordResponse

Methods

readsPrec :: Int -> ReadS ConfirmForgotPasswordResponse

readList :: ReadS [ConfirmForgotPasswordResponse]

readPrec :: ReadPrec ConfirmForgotPasswordResponse

readListPrec :: ReadPrec [ConfirmForgotPasswordResponse]

Show ConfirmForgotPasswordResponse

Methods

showsPrec :: Int -> ConfirmForgotPasswordResponse -> ShowS

show :: ConfirmForgotPasswordResponse -> String

showList :: [ConfirmForgotPasswordResponse] -> ShowS

Generic ConfirmForgotPasswordResponse

Associated Types

type Rep ConfirmForgotPasswordResponse :: * -> *

Methods

from :: ConfirmForgotPasswordResponse -> Rep ConfirmForgotPasswordResponse x

to :: Rep ConfirmForgotPasswordResponse x -> ConfirmForgotPasswordResponse

NFData ConfirmForgotPasswordResponse

Methods

rnf :: ConfirmForgotPasswordResponse -> ()

type Rep ConfirmForgotPasswordResponse

type Rep ConfirmForgotPasswordResponse = D1 * (MetaData "ConfirmForgotPasswordResponse" "Network.AWS.CognitoIdentityProvider.ConfirmForgotPassword" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" True) (C1 * (MetaCons "ConfirmForgotPasswordResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_cfprsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

cfprsResponseStatus :: Lens' ConfirmForgotPasswordResponse Int

• - | The response status code.