| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CognitoIdentityProvider.GetUserAttributeVerificationCode
Description
Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Synopsis
- data GetUserAttributeVerificationCode = GetUserAttributeVerificationCode' {}
- newGetUserAttributeVerificationCode :: Text -> Text -> GetUserAttributeVerificationCode
- getUserAttributeVerificationCode_clientMetadata :: Lens' GetUserAttributeVerificationCode (Maybe (HashMap Text Text))
- getUserAttributeVerificationCode_accessToken :: Lens' GetUserAttributeVerificationCode Text
- getUserAttributeVerificationCode_attributeName :: Lens' GetUserAttributeVerificationCode Text
- data GetUserAttributeVerificationCodeResponse = GetUserAttributeVerificationCodeResponse' {}
- newGetUserAttributeVerificationCodeResponse :: Int -> GetUserAttributeVerificationCodeResponse
- getUserAttributeVerificationCodeResponse_codeDeliveryDetails :: Lens' GetUserAttributeVerificationCodeResponse (Maybe CodeDeliveryDetailsType)
- getUserAttributeVerificationCodeResponse_httpStatus :: Lens' GetUserAttributeVerificationCodeResponse Int
Creating a Request
data GetUserAttributeVerificationCode Source #
Represents the request to get user attribute verification.
See: newGetUserAttributeVerificationCode smart constructor.
Constructors
| GetUserAttributeVerificationCode' | |
Fields
| |
Instances
newGetUserAttributeVerificationCode Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetUserAttributeVerificationCode |
Create a value of GetUserAttributeVerificationCode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:GetUserAttributeVerificationCode', getUserAttributeVerificationCode_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the GetUserAttributeVerificationCode API action,
Amazon Cognito invokes the function that is assigned to the /custom
message/ trigger. When Amazon Cognito invokes this function, it passes a
JSON payload, which the function receives as input. This payload
contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your
GetUserAttributeVerificationCode request. In your function code in
Lambda, you can process the clientMetadata value to enhance your
workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
GetUserAttributeVerificationCode, getUserAttributeVerificationCode_accessToken - A non-expired access token for the user whose attribute verification
code you want to generate.
GetUserAttributeVerificationCode, getUserAttributeVerificationCode_attributeName - The attribute name returned by the server response to get the user
attribute verification code.
Request Lenses
getUserAttributeVerificationCode_clientMetadata :: Lens' GetUserAttributeVerificationCode (Maybe (HashMap Text Text)) Source #
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the GetUserAttributeVerificationCode API action,
Amazon Cognito invokes the function that is assigned to the /custom
message/ trigger. When Amazon Cognito invokes this function, it passes a
JSON payload, which the function receives as input. This payload
contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your
GetUserAttributeVerificationCode request. In your function code in
Lambda, you can process the clientMetadata value to enhance your
workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
getUserAttributeVerificationCode_accessToken :: Lens' GetUserAttributeVerificationCode Text Source #
A non-expired access token for the user whose attribute verification code you want to generate.
getUserAttributeVerificationCode_attributeName :: Lens' GetUserAttributeVerificationCode Text Source #
The attribute name returned by the server response to get the user attribute verification code.
Destructuring the Response
data GetUserAttributeVerificationCodeResponse Source #
The verification code response returned by the server response to get the user attribute verification code.
See: newGetUserAttributeVerificationCodeResponse smart constructor.
Constructors
| GetUserAttributeVerificationCodeResponse' | |
Fields
| |
Instances
newGetUserAttributeVerificationCodeResponse Source #
Arguments
| :: Int | |
| -> GetUserAttributeVerificationCodeResponse |
Create a value of GetUserAttributeVerificationCodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:codeDeliveryDetails:GetUserAttributeVerificationCodeResponse', getUserAttributeVerificationCodeResponse_codeDeliveryDetails - The code delivery details returned by the server in response to the
request to get the user attribute verification code.
$sel:httpStatus:GetUserAttributeVerificationCodeResponse', getUserAttributeVerificationCodeResponse_httpStatus - The response's http status code.
Response Lenses
getUserAttributeVerificationCodeResponse_codeDeliveryDetails :: Lens' GetUserAttributeVerificationCodeResponse (Maybe CodeDeliveryDetailsType) Source #
The code delivery details returned by the server in response to the request to get the user attribute verification code.
getUserAttributeVerificationCodeResponse_httpStatus :: Lens' GetUserAttributeVerificationCodeResponse Int Source #
The response's http status code.