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 |
Confirms registration of a user and handles the existing alias from a previous user.
- confirmSignUp :: Text -> Text -> Text -> ConfirmSignUp
- data ConfirmSignUp
- csuForceAliasCreation :: Lens' ConfirmSignUp (Maybe Bool)
- csuAnalyticsMetadata :: Lens' ConfirmSignUp (Maybe AnalyticsMetadataType)
- csuUserContextData :: Lens' ConfirmSignUp (Maybe UserContextDataType)
- csuSecretHash :: Lens' ConfirmSignUp (Maybe Text)
- csuClientId :: Lens' ConfirmSignUp Text
- csuUsername :: Lens' ConfirmSignUp Text
- csuConfirmationCode :: Lens' ConfirmSignUp Text
- confirmSignUpResponse :: Int -> ConfirmSignUpResponse
- data ConfirmSignUpResponse
- csursResponseStatus :: Lens' ConfirmSignUpResponse Int
Creating a Request
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 toFalse
. If this parameter is set toTrue
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 toFalse
, the API will throw an AliasExistsException error.csuAnalyticsMetadata
- The Amazon Pinpoint analytics metadata for collecting metrics forConfirmSignUp
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.
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:
csursResponseStatus
- -- | The response status code.
data ConfirmSignUpResponse Source #
Represents the response from the server for the registration confirmation.
See: confirmSignUpResponse
smart constructor.
Response Lenses
csursResponseStatus :: Lens' ConfirmSignUpResponse Int Source #
- - | The response status code.