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.SetUserPoolMfaConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the user pool multi-factor authentication (MFA) configuration.

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

Creating a Request

data SetUserPoolMfaConfig Source #

See: newSetUserPoolMfaConfig smart constructor.

Constructors

SetUserPoolMfaConfig'

Fields

mfaConfiguration :: Maybe UserPoolMfaType
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
- OFF MFA won't be used for any users.
- ON MFA is required for all users to sign in.
- OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
smsMfaConfiguration :: Maybe SmsMfaConfigType
The SMS text message MFA configuration.
softwareTokenMfaConfiguration :: Maybe SoftwareTokenMfaConfigType
The software token MFA configuration.
userPoolId :: Text
The user pool ID.

Instances

Instances details

ToJSON SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods toJSON :: SetUserPoolMfaConfig -> Value # toEncoding :: SetUserPoolMfaConfig -> Encoding # toJSONList :: [SetUserPoolMfaConfig] -> Value # toEncodingList :: [SetUserPoolMfaConfig] -> Encoding #
ToHeaders SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods toHeaders :: SetUserPoolMfaConfig -> [Header] #
ToPath SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods toPath :: SetUserPoolMfaConfig -> ByteString #
ToQuery SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods toQuery :: SetUserPoolMfaConfig -> QueryString #
AWSRequest SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Associated Types type AWSResponse SetUserPoolMfaConfig # Methods request :: (Service -> Service) -> SetUserPoolMfaConfig -> Request SetUserPoolMfaConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetUserPoolMfaConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetUserPoolMfaConfig))) #
Generic SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Associated Types type Rep SetUserPoolMfaConfig :: Type -> Type # Methods from :: SetUserPoolMfaConfig -> Rep SetUserPoolMfaConfig x # to :: Rep SetUserPoolMfaConfig x -> SetUserPoolMfaConfig #
Read SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods readsPrec :: Int -> ReadS SetUserPoolMfaConfig # readList :: ReadS [SetUserPoolMfaConfig] # readPrec :: ReadPrec SetUserPoolMfaConfig # readListPrec :: ReadPrec [SetUserPoolMfaConfig] #
Show SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods showsPrec :: Int -> SetUserPoolMfaConfig -> ShowS # show :: SetUserPoolMfaConfig -> String # showList :: [SetUserPoolMfaConfig] -> ShowS #
NFData SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods rnf :: SetUserPoolMfaConfig -> () #
Eq SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods (==) :: SetUserPoolMfaConfig -> SetUserPoolMfaConfig -> Bool # (/=) :: SetUserPoolMfaConfig -> SetUserPoolMfaConfig -> Bool #
Hashable SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods hashWithSalt :: Int -> SetUserPoolMfaConfig -> Int # hash :: SetUserPoolMfaConfig -> Int #
type AWSResponse SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig type AWSResponse SetUserPoolMfaConfig = SetUserPoolMfaConfigResponse
type Rep SetUserPoolMfaConfig Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig type Rep SetUserPoolMfaConfig = D1 ('MetaData "SetUserPoolMfaConfig" "Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SetUserPoolMfaConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolMfaType)) :: S1 ('MetaSel ('Just "smsMfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmsMfaConfigType))) :: (S1 ('MetaSel ('Just "softwareTokenMfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SoftwareTokenMfaConfigType)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSetUserPoolMfaConfig Source #

Arguments

:: Text	`SetUserPoolMfaConfig`
-> SetUserPoolMfaConfig

Create a value of SetUserPoolMfaConfig 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:

SetUserPoolMfaConfig, setUserPoolMfaConfig_mfaConfiguration - The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

SetUserPoolMfaConfig, setUserPoolMfaConfig_smsMfaConfiguration - The SMS text message MFA configuration.

SetUserPoolMfaConfig, setUserPoolMfaConfig_softwareTokenMfaConfiguration - The software token MFA configuration.

SetUserPoolMfaConfig, setUserPoolMfaConfig_userPoolId - The user pool ID.

Request Lenses

setUserPoolMfaConfig_mfaConfiguration :: Lens' SetUserPoolMfaConfig (Maybe UserPoolMfaType) Source #

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

setUserPoolMfaConfig_smsMfaConfiguration :: Lens' SetUserPoolMfaConfig (Maybe SmsMfaConfigType) Source #

The SMS text message MFA configuration.

setUserPoolMfaConfig_softwareTokenMfaConfiguration :: Lens' SetUserPoolMfaConfig (Maybe SoftwareTokenMfaConfigType) Source #

The software token MFA configuration.

setUserPoolMfaConfig_userPoolId :: Lens' SetUserPoolMfaConfig Text Source #

The user pool ID.

Destructuring the Response

data SetUserPoolMfaConfigResponse Source #

See: newSetUserPoolMfaConfigResponse smart constructor.

Constructors

SetUserPoolMfaConfigResponse'

Fields

mfaConfiguration :: Maybe UserPoolMfaType
The MFA configuration. Valid values include:
- OFF MFA won't be used for any users.
- ON MFA is required for all users to sign in.
- OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
smsMfaConfiguration :: Maybe SmsMfaConfigType
The SMS text message MFA configuration.
softwareTokenMfaConfiguration :: Maybe SoftwareTokenMfaConfigType
The software token MFA configuration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Associated Types type Rep SetUserPoolMfaConfigResponse :: Type -> Type # Methods from :: SetUserPoolMfaConfigResponse -> Rep SetUserPoolMfaConfigResponse x # to :: Rep SetUserPoolMfaConfigResponse x -> SetUserPoolMfaConfigResponse #
Read SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods readsPrec :: Int -> ReadS SetUserPoolMfaConfigResponse # readList :: ReadS [SetUserPoolMfaConfigResponse] # readPrec :: ReadPrec SetUserPoolMfaConfigResponse # readListPrec :: ReadPrec [SetUserPoolMfaConfigResponse] #
Show SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods showsPrec :: Int -> SetUserPoolMfaConfigResponse -> ShowS # show :: SetUserPoolMfaConfigResponse -> String # showList :: [SetUserPoolMfaConfigResponse] -> ShowS #
NFData SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods rnf :: SetUserPoolMfaConfigResponse -> () #
Eq SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig Methods (==) :: SetUserPoolMfaConfigResponse -> SetUserPoolMfaConfigResponse -> Bool # (/=) :: SetUserPoolMfaConfigResponse -> SetUserPoolMfaConfigResponse -> Bool #
type Rep SetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig type Rep SetUserPoolMfaConfigResponse = D1 ('MetaData "SetUserPoolMfaConfigResponse" "Amazonka.CognitoIdentityProvider.SetUserPoolMfaConfig" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SetUserPoolMfaConfigResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolMfaType)) :: S1 ('MetaSel ('Just "smsMfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmsMfaConfigType))) :: (S1 ('MetaSel ('Just "softwareTokenMfaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SoftwareTokenMfaConfigType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSetUserPoolMfaConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:SetUserPoolMfaConfigResponse'`
-> SetUserPoolMfaConfigResponse

Create a value of SetUserPoolMfaConfigResponse 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:

SetUserPoolMfaConfig, setUserPoolMfaConfigResponse_mfaConfiguration - The MFA configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

SetUserPoolMfaConfig, setUserPoolMfaConfigResponse_smsMfaConfiguration - The SMS text message MFA configuration.

SetUserPoolMfaConfig, setUserPoolMfaConfigResponse_softwareTokenMfaConfiguration - The software token MFA configuration.

$sel:httpStatus:SetUserPoolMfaConfigResponse', setUserPoolMfaConfigResponse_httpStatus - The response's http status code.

Response Lenses

setUserPoolMfaConfigResponse_mfaConfiguration :: Lens' SetUserPoolMfaConfigResponse (Maybe UserPoolMfaType) Source #

The MFA configuration. Valid values include:

OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

setUserPoolMfaConfigResponse_smsMfaConfiguration :: Lens' SetUserPoolMfaConfigResponse (Maybe SmsMfaConfigType) Source #

The SMS text message MFA configuration.

setUserPoolMfaConfigResponse_softwareTokenMfaConfiguration :: Lens' SetUserPoolMfaConfigResponse (Maybe SoftwareTokenMfaConfigType) Source #

The software token MFA configuration.

setUserPoolMfaConfigResponse_httpStatus :: Lens' SetUserPoolMfaConfigResponse Int Source #

The response's http status code.