amazonka-cognito-idp-1.6.0: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.ConfirmSignUp

Contents

Description

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

Synopsis

Creating a Request

confirmSignUp Source #

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.
  • csuAnalyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
  • csuUserContextData - 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.
  • 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 Source #

Represents the request to confirm registration of a user.

See: confirmSignUp smart constructor.

Instances

Eq ConfirmSignUp Source # 
Data ConfirmSignUp Source # 

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 Source # 
Generic ConfirmSignUp Source # 

Associated Types

type Rep ConfirmSignUp :: * -> * #

Hashable ConfirmSignUp Source # 
ToJSON ConfirmSignUp Source # 
NFData ConfirmSignUp Source # 

Methods

rnf :: ConfirmSignUp -> () #

AWSRequest ConfirmSignUp Source # 
ToHeaders ConfirmSignUp Source # 
ToPath ConfirmSignUp Source # 
ToQuery ConfirmSignUp Source # 
type Rep ConfirmSignUp Source # 
type Rep ConfirmSignUp = D1 * (MetaData "ConfirmSignUp" "Network.AWS.CognitoIdentityProvider.ConfirmSignUp" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ConfirmSignUp'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csuForceAliasCreation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csuAnalyticsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsMetadataType))) (S1 * (MetaSel (Just Symbol "_csuUserContextData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserContextDataType))))) ((:*:) * ((:*:) * (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 Source # 

Request Lenses

csuForceAliasCreation :: Lens' ConfirmSignUp (Maybe Bool) Source #

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.

csuAnalyticsMetadata :: Lens' ConfirmSignUp (Maybe AnalyticsMetadataType) Source #

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

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

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

csuClientId :: Lens' ConfirmSignUp Text Source #

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

csuUsername :: Lens' ConfirmSignUp Text Source #

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

csuConfirmationCode :: Lens' ConfirmSignUp Text Source #

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

Destructuring the Response

confirmSignUpResponse Source #

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:

data ConfirmSignUpResponse Source #

Represents the response from the server for the registration confirmation.

See: confirmSignUpResponse smart constructor.

Instances

Eq ConfirmSignUpResponse Source # 
Data ConfirmSignUpResponse Source # 

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 Source # 
Show ConfirmSignUpResponse Source # 
Generic ConfirmSignUpResponse Source # 
NFData ConfirmSignUpResponse Source # 

Methods

rnf :: ConfirmSignUpResponse -> () #

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

Response Lenses

csursResponseStatus :: Lens' ConfirmSignUpResponse Int Source #

  • - | The response status code.