Network.AWS.CognitoIdentityProvider.ConfirmSignUp

Confirms registration of a user and handles the existing alias from a previous user.

Creating a Request

confirmSignUp

Arguments

:: Text

csuClientId

-> Text

csuUsername

-> Text

csuConfirmationCode

-> ConfirmSignUp

Creates a value of ConfirmSignUp with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csuForceAliasCreation - Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False . If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False , the API will throw an AliasExistsException error.
• csuSecretHash - 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.
• csuClientId - The ID of the app client associated with the user pool.
• csuUsername - The user name of the user whose registration you wish to confirm.
• csuConfirmationCode - The confirmation code sent by a user's request to confirm registration.

data ConfirmSignUp

Represents the request to confirm registration of a user.

See: confirmSignUp smart constructor.

Instances

Eq ConfirmSignUp

Methods

(==) :: ConfirmSignUp -> ConfirmSignUp -> Bool

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

Data ConfirmSignUp

Methods

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

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

toConstr :: ConfirmSignUp -> Constr

dataTypeOf :: ConfirmSignUp -> DataType

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

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

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

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

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

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

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

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

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

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

Show ConfirmSignUp

Methods

showsPrec :: Int -> ConfirmSignUp -> ShowS

show :: ConfirmSignUp -> String

showList :: [ConfirmSignUp] -> ShowS

Generic ConfirmSignUp

Associated Types

type Rep ConfirmSignUp :: * -> *

Methods

from :: ConfirmSignUp -> Rep ConfirmSignUp x

to :: Rep ConfirmSignUp x -> ConfirmSignUp

Hashable ConfirmSignUp

Methods

hashWithSalt :: Int -> ConfirmSignUp -> Int

hash :: ConfirmSignUp -> Int

ToJSON ConfirmSignUp

Methods

toJSON :: ConfirmSignUp -> Value

toEncoding :: ConfirmSignUp -> Encoding

toJSONList :: [ConfirmSignUp] -> Value

toEncodingList :: [ConfirmSignUp] -> Encoding

NFData ConfirmSignUp

Methods

rnf :: ConfirmSignUp -> ()

AWSRequest ConfirmSignUp

Associated Types

type Rs ConfirmSignUp :: *

Methods

request :: ConfirmSignUp -> Request ConfirmSignUp

response :: MonadResource m => Logger -> Service -> Proxy * ConfirmSignUp -> ClientResponse -> m (Response ConfirmSignUp)

ToQuery ConfirmSignUp

Methods

toQuery :: ConfirmSignUp -> QueryString

ToPath ConfirmSignUp

Methods

toPath :: ConfirmSignUp -> ByteString

ToHeaders ConfirmSignUp

Methods

toHeaders :: ConfirmSignUp -> [Header]

type Rep ConfirmSignUp

type Rep ConfirmSignUp = D1 (MetaData "ConfirmSignUp" "Network.AWS.CognitoIdentityProvider.ConfirmSignUp" "amazonka-cognito-idp-1.5.0-6L4ibyApQsq9OINZIpqhIF" False) (C1 (MetaCons "ConfirmSignUp'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csuForceAliasCreation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_csuSecretHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_csuClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))) ((:*:) (S1 (MetaSel (Just Symbol "_csuUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))) (S1 (MetaSel (Just Symbol "_csuConfirmationCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs ConfirmSignUp

type Rs ConfirmSignUp = ConfirmSignUpResponse

Request Lenses

csuForceAliasCreation :: Lens' ConfirmSignUp (Maybe Bool)

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False . If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False , the API will throw an AliasExistsException error.

csuSecretHash :: Lens' ConfirmSignUp (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.

csuClientId :: Lens' ConfirmSignUp Text

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

csuUsername :: Lens' ConfirmSignUp Text

The user name of the user whose registration you wish to confirm.

csuConfirmationCode :: Lens' ConfirmSignUp Text

The confirmation code sent by a user's request to confirm registration.

Destructuring the Response

confirmSignUpResponse

Arguments

:: Int

csursResponseStatus

-> ConfirmSignUpResponse

Creates a value of ConfirmSignUpResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csursResponseStatus - -- | The response status code.

data ConfirmSignUpResponse

Represents the response from the server for the registration confirmation.

See: confirmSignUpResponse smart constructor.

Instances

Eq ConfirmSignUpResponse

Methods

(==) :: ConfirmSignUpResponse -> ConfirmSignUpResponse -> Bool

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

Data ConfirmSignUpResponse

Methods

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

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

toConstr :: ConfirmSignUpResponse -> Constr

dataTypeOf :: ConfirmSignUpResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ConfirmSignUpResponse

Methods

readsPrec :: Int -> ReadS ConfirmSignUpResponse

readList :: ReadS [ConfirmSignUpResponse]

readPrec :: ReadPrec ConfirmSignUpResponse

readListPrec :: ReadPrec [ConfirmSignUpResponse]

Show ConfirmSignUpResponse

Methods

showsPrec :: Int -> ConfirmSignUpResponse -> ShowS

show :: ConfirmSignUpResponse -> String

showList :: [ConfirmSignUpResponse] -> ShowS

Generic ConfirmSignUpResponse

Associated Types

type Rep ConfirmSignUpResponse :: * -> *

Methods

from :: ConfirmSignUpResponse -> Rep ConfirmSignUpResponse x

to :: Rep ConfirmSignUpResponse x -> ConfirmSignUpResponse

NFData ConfirmSignUpResponse

Methods

rnf :: ConfirmSignUpResponse -> ()

type Rep ConfirmSignUpResponse

type Rep ConfirmSignUpResponse = D1 (MetaData "ConfirmSignUpResponse" "Network.AWS.CognitoIdentityProvider.ConfirmSignUp" "amazonka-cognito-idp-1.5.0-6L4ibyApQsq9OINZIpqhIF" True) (C1 (MetaCons "ConfirmSignUpResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_csursResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

csursResponseStatus :: Lens' ConfirmSignUpResponse Int

• - | The response status code.