Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Registers the user in the specified user pool and creates a user name, password, and user attributes.
- signUp :: Text -> Text -> Text -> SignUp
- data SignUp
- suAnalyticsMetadata :: Lens' SignUp (Maybe AnalyticsMetadataType)
- suUserContextData :: Lens' SignUp (Maybe UserContextDataType)
- suUserAttributes :: Lens' SignUp [AttributeType]
- suSecretHash :: Lens' SignUp (Maybe Text)
- suValidationData :: Lens' SignUp [AttributeType]
- suClientId :: Lens' SignUp Text
- suUsername :: Lens' SignUp Text
- suPassword :: Lens' SignUp Text
- signUpResponse :: Int -> Bool -> Text -> SignUpResponse
- data SignUpResponse
- sursCodeDeliveryDetails :: Lens' SignUpResponse (Maybe CodeDeliveryDetailsType)
- sursResponseStatus :: Lens' SignUpResponse Int
- sursUserConfirmed :: Lens' SignUpResponse Bool
- sursUserSub :: Lens' SignUpResponse Text
Creating a Request
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:
suAnalyticsMetadata
- The Amazon Pinpoint analytics metadata for collecting metrics forSignUp
calls.suUserContextData
- 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.suUserAttributes
- An array of name-value pairs representing user attributes. For custom attributes, you must prepend thecustom:
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.
Represents the request to register a user.
See: signUp
smart constructor.
Eq SignUp Source # | |
Data SignUp Source # | |
Show SignUp Source # | |
Generic SignUp Source # | |
Hashable SignUp Source # | |
ToJSON SignUp Source # | |
NFData SignUp Source # | |
AWSRequest SignUp Source # | |
ToHeaders SignUp Source # | |
ToPath SignUp Source # | |
ToQuery SignUp Source # | |
type Rep SignUp Source # | |
type Rs SignUp Source # | |
Request Lenses
suAnalyticsMetadata :: Lens' SignUp (Maybe AnalyticsMetadataType) Source #
The Amazon Pinpoint analytics metadata for collecting metrics for SignUp
calls.
suUserContextData :: Lens' SignUp (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.
suUserAttributes :: Lens' SignUp [AttributeType] Source #
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) 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.
Destructuring the Response
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 asusername
.
data SignUpResponse Source #
The response from the server for a registration request.
See: signUpResponse
smart constructor.
Response Lenses
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.
sursUserConfirmed :: Lens' SignUpResponse Bool Source #
A response from the server indicating that a user registration has been confirmed.
sursUserSub :: Lens' SignUpResponse Text Source #
The UUID of the authenticated user. This is not the same as username
.