| 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.VerifyUserAttribute
Description
Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
Synopsis
- data VerifyUserAttribute = VerifyUserAttribute' {
- accessToken :: Sensitive Text
- attributeName :: Text
- code :: Text
- newVerifyUserAttribute :: Text -> Text -> Text -> VerifyUserAttribute
- verifyUserAttribute_accessToken :: Lens' VerifyUserAttribute Text
- verifyUserAttribute_attributeName :: Lens' VerifyUserAttribute Text
- verifyUserAttribute_code :: Lens' VerifyUserAttribute Text
- data VerifyUserAttributeResponse = VerifyUserAttributeResponse' {
- httpStatus :: Int
- newVerifyUserAttributeResponse :: Int -> VerifyUserAttributeResponse
- verifyUserAttributeResponse_httpStatus :: Lens' VerifyUserAttributeResponse Int
Creating a Request
data VerifyUserAttribute Source #
Represents the request to verify user attributes.
See: newVerifyUserAttribute smart constructor.
Constructors
| VerifyUserAttribute' | |
Fields
| |
Instances
newVerifyUserAttribute Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> VerifyUserAttribute |
Create a value of VerifyUserAttribute 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:
VerifyUserAttribute, verifyUserAttribute_accessToken - A valid access token that Amazon Cognito issued to the user whose user
attributes you want to verify.
VerifyUserAttribute, verifyUserAttribute_attributeName - The attribute name in the request to verify user attributes.
$sel:code:VerifyUserAttribute', verifyUserAttribute_code - The verification code in the request to verify user attributes.
Request Lenses
verifyUserAttribute_accessToken :: Lens' VerifyUserAttribute Text Source #
A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.
verifyUserAttribute_attributeName :: Lens' VerifyUserAttribute Text Source #
The attribute name in the request to verify user attributes.
verifyUserAttribute_code :: Lens' VerifyUserAttribute Text Source #
The verification code in the request to verify user attributes.
Destructuring the Response
data VerifyUserAttributeResponse Source #
A container representing the response from the server from the request to verify user attributes.
See: newVerifyUserAttributeResponse smart constructor.
Constructors
| VerifyUserAttributeResponse' | |
Fields
| |
Instances
newVerifyUserAttributeResponse Source #
Create a value of VerifyUserAttributeResponse 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:httpStatus:VerifyUserAttributeResponse', verifyUserAttributeResponse_httpStatus - The response's http status code.
Response Lenses
verifyUserAttributeResponse_httpStatus :: Lens' VerifyUserAttributeResponse Int Source #
The response's http status code.