Network.AWS.CognitoIdentityProvider.SignUp

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

Creating a Request

signUp

Arguments

:: Text

suClientId

-> Text

suUsername

-> Text

suPassword

-> SignUp

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. For custom attributes, you must prepend the custom: prefix to the attribute name.
• 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

Represents the request to register a user.

See: signUp smart constructor.

Instances

Eq SignUp

Methods

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

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

Data SignUp

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

Show SignUp

Methods

showsPrec :: Int -> SignUp -> ShowS

show :: SignUp -> String

showList :: [SignUp] -> ShowS

Generic SignUp

Associated Types

type Rep SignUp :: * -> *

Methods

from :: SignUp -> Rep SignUp x

to :: Rep SignUp x -> SignUp

Hashable SignUp

Methods

hashWithSalt :: Int -> SignUp -> Int

hash :: SignUp -> Int

ToJSON SignUp

Methods

toJSON :: SignUp -> Value

toEncoding :: SignUp -> Encoding

toJSONList :: [SignUp] -> Value

toEncodingList :: [SignUp] -> Encoding

NFData SignUp

Methods

rnf :: SignUp -> ()

AWSRequest SignUp

Associated Types

type Rs SignUp :: *

Methods

request :: SignUp -> Request SignUp

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

ToQuery SignUp

Methods

toQuery :: SignUp -> QueryString

ToPath SignUp

Methods

toPath :: SignUp -> ByteString

ToHeaders SignUp

Methods

toHeaders :: SignUp -> [Header]

type Rep SignUp

type Rep SignUp = D1 (MetaData "SignUp" "Network.AWS.CognitoIdentityProvider.SignUp" "amazonka-cognito-idp-1.5.0-6L4ibyApQsq9OINZIpqhIF" False) (C1 (MetaCons "SignUp'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_suUserAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeType]))) ((:*:) (S1 (MetaSel (Just Symbol "_suSecretHash") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_suValidationData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeType]))))) ((:*:) (S1 (MetaSel (Just Symbol "_suClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))) ((:*:) (S1 (MetaSel (Just Symbol "_suUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))) (S1 (MetaSel (Just Symbol "_suPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)))))))

type Rs SignUp

type Rs SignUp = SignUpResponse

Request Lenses

suUserAttributes :: Lens' SignUp [AttributeType]

An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.

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

suValidationData :: Lens' SignUp [AttributeType]

The validation data in the request to register a user.

suClientId :: Lens' SignUp Text

The ID of the client associated with the user pool.

suUsername :: Lens' SignUp Text

The user name of the user you wish to register.

suPassword :: Lens' SignUp Text

The password of the user you wish to register.

Destructuring the Response

signUpResponse

Arguments

:: Int

sursResponseStatus

-> Bool

sursUserConfirmed

-> Text

sursUserSub

-> SignUpResponse

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:

• sursCodeDeliveryDetails - The code delivery details returned by the server response to the user registration request.
• sursResponseStatus - -- | The response status code.
• sursUserConfirmed - A response from the server indicating that a user registration has been confirmed.
• sursUserSub - The UUID of the authenticated user. This is not the same as username .

data SignUpResponse

The response from the server for a registration request.

See: signUpResponse smart constructor.

Instances

Eq SignUpResponse

Methods

(==) :: SignUpResponse -> SignUpResponse -> Bool

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

Data SignUpResponse

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

Methods

readsPrec :: Int -> ReadS SignUpResponse

readList :: ReadS [SignUpResponse]

readPrec :: ReadPrec SignUpResponse

readListPrec :: ReadPrec [SignUpResponse]

Show SignUpResponse

Methods

showsPrec :: Int -> SignUpResponse -> ShowS

show :: SignUpResponse -> String

showList :: [SignUpResponse] -> ShowS

Generic SignUpResponse

Associated Types

type Rep SignUpResponse :: * -> *

Methods

from :: SignUpResponse -> Rep SignUpResponse x

to :: Rep SignUpResponse x -> SignUpResponse

NFData SignUpResponse

Methods

rnf :: SignUpResponse -> ()

type Rep SignUpResponse

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

Response Lenses

sursCodeDeliveryDetails :: Lens' SignUpResponse (Maybe CodeDeliveryDetailsType)

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

sursResponseStatus :: Lens' SignUpResponse Int

• - | The response status code.

sursUserConfirmed :: Lens' SignUpResponse Bool

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

sursUserSub :: Lens' SignUpResponse Text

The UUID of the authenticated user. This is not the same as username .