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

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

Network.AWS.CognitoIdentityProvider.SignUp

Contents

Description

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Synopsis

Creating a Request

signUp Source #

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

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

  • suUserAttributes - An array of name-value pairs representing user attributes.
  • suSecretHash - 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.
  • suValidationData - The validation data in the request to register a user.
  • suClientId - The ID of the client associated with the user pool.
  • suUsername - The user name of the user you wish to register.
  • suPassword - The password of the user you wish to register.

data SignUp Source #

Represents the request to register a user.

See: signUp smart constructor.

Instances

Eq SignUp Source # 

Methods

(==) :: SignUp -> SignUp -> Bool #

(/=) :: SignUp -> SignUp -> Bool #

Data SignUp Source # 

Methods

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

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

toConstr :: SignUp -> Constr #

dataTypeOf :: SignUp -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SignUp -> SignUp #

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

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

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

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

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

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

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

Read SignUp Source # 
Show SignUp Source # 
Generic SignUp Source # 

Associated Types

type Rep SignUp :: * -> * #

Methods

from :: SignUp -> Rep SignUp x #

to :: Rep SignUp x -> SignUp #

Hashable SignUp Source # 

Methods

hashWithSalt :: Int -> SignUp -> Int #

hash :: SignUp -> Int #

ToJSON SignUp Source # 
NFData SignUp Source # 

Methods

rnf :: SignUp -> () #

AWSRequest SignUp Source # 

Associated Types

type Rs SignUp :: * #

ToPath SignUp Source # 

Methods

toPath :: SignUp -> ByteString #

ToHeaders SignUp Source # 

Methods

toHeaders :: SignUp -> [Header] #

ToQuery SignUp Source # 
type Rep SignUp Source # 
type Rs SignUp Source # 

Request Lenses

suUserAttributes :: Lens' SignUp [AttributeType] Source #

An array of name-value pairs representing user attributes.

suSecretHash :: Lens' SignUp (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.

suValidationData :: Lens' SignUp [AttributeType] Source #

The validation data in the request to register a user.

suClientId :: Lens' SignUp Text Source #

The ID of the client associated with the user pool.

suUsername :: Lens' SignUp Text Source #

The user name of the user you wish to register.

suPassword :: Lens' SignUp Text Source #

The password of the user you wish to register.

Destructuring the Response

signUpResponse Source #

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

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

data SignUpResponse Source #

The response from the server for a registration request.

See: signUpResponse smart constructor.

Instances

Eq SignUpResponse Source # 
Data SignUpResponse Source # 

Methods

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

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

toConstr :: SignUpResponse -> Constr #

dataTypeOf :: SignUpResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> SignUpResponse -> SignUpResponse #

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

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

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

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

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

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

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

Read SignUpResponse Source # 
Show SignUpResponse Source # 
Generic SignUpResponse Source # 

Associated Types

type Rep SignUpResponse :: * -> * #

NFData SignUpResponse Source # 

Methods

rnf :: SignUpResponse -> () #

type Rep SignUpResponse Source # 
type Rep SignUpResponse = D1 (MetaData "SignUpResponse" "Network.AWS.CognitoIdentityProvider.SignUp" "amazonka-cognito-idp-1.4.5-GXmpY7qnFXp3lLWwYVX1Gb" False) (C1 (MetaCons "SignUpResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_sursUserConfirmed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_sursCodeDeliveryDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CodeDeliveryDetailsType))) (S1 (MetaSel (Just Symbol "_sursResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

sursUserConfirmed :: Lens' SignUpResponse (Maybe Bool) Source #

A response from the server indicating that a user registration has been confirmed.

sursCodeDeliveryDetails :: Lens' SignUpResponse (Maybe CodeDeliveryDetailsType) Source #

The code delivery details returned by the server response to the user registration request.

sursResponseStatus :: Lens' SignUpResponse Int Source #

  • - | The response status code.