| Copyright | (c) 2013-2021 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 |
Amazonka.CognitoIdentityProvider.AdminSetUserSettings
Description
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Synopsis
- data AdminSetUserSettings = AdminSetUserSettings' {
- userPoolId :: Text
- username :: Sensitive Text
- mfaOptions :: [MFAOptionType]
- newAdminSetUserSettings :: Text -> Text -> AdminSetUserSettings
- adminSetUserSettings_userPoolId :: Lens' AdminSetUserSettings Text
- adminSetUserSettings_username :: Lens' AdminSetUserSettings Text
- adminSetUserSettings_mfaOptions :: Lens' AdminSetUserSettings [MFAOptionType]
- data AdminSetUserSettingsResponse = AdminSetUserSettingsResponse' {
- httpStatus :: Int
- newAdminSetUserSettingsResponse :: Int -> AdminSetUserSettingsResponse
- adminSetUserSettingsResponse_httpStatus :: Lens' AdminSetUserSettingsResponse Int
Creating a Request
data AdminSetUserSettings Source #
You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
See: newAdminSetUserSettings smart constructor.
Constructors
| AdminSetUserSettings' | |
Fields
| |
Instances
newAdminSetUserSettings Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminSetUserSettings |
Create a value of AdminSetUserSettings 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:userPoolId:AdminSetUserSettings', adminSetUserSettings_userPoolId - The ID of the user pool that contains the user that you are setting
options for.
$sel:username:AdminSetUserSettings', adminSetUserSettings_username - The user name of the user that you are setting options for.
$sel:mfaOptions:AdminSetUserSettings', adminSetUserSettings_mfaOptions - You can use this parameter only to set an SMS configuration that uses
SMS for delivery.
Request Lenses
adminSetUserSettings_userPoolId :: Lens' AdminSetUserSettings Text Source #
The ID of the user pool that contains the user that you are setting options for.
adminSetUserSettings_username :: Lens' AdminSetUserSettings Text Source #
The user name of the user that you are setting options for.
adminSetUserSettings_mfaOptions :: Lens' AdminSetUserSettings [MFAOptionType] Source #
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
Destructuring the Response
data AdminSetUserSettingsResponse Source #
Represents the response from the server to set user settings as an administrator.
See: newAdminSetUserSettingsResponse smart constructor.
Constructors
| AdminSetUserSettingsResponse' | |
Fields
| |
Instances
newAdminSetUserSettingsResponse Source #
Create a value of AdminSetUserSettingsResponse 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:AdminSetUserSettingsResponse', adminSetUserSettingsResponse_httpStatus - The response's http status code.
Response Lenses
adminSetUserSettingsResponse_httpStatus :: Lens' AdminSetUserSettingsResponse Int Source #
The response's http status code.