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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.

Synopsis

Creating a Request

data AdminSetUserMFAPreference Source #

See: newAdminSetUserMFAPreference smart constructor.

Constructors

AdminSetUserMFAPreference'
Fields sMSMfaSettings :: Maybe SMSMfaSettingsType The SMS text message MFA settings. softwareTokenMfaSettings :: Maybe SoftwareTokenMfaSettingsType The time-based one-time password software token MFA settings. username :: Sensitive Text The user pool username or alias. userPoolId :: Text The user pool ID.

Instances

Instances details

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

newAdminSetUserMFAPreference Source #

Arguments

:: Text	`AdminSetUserMFAPreference`
-> Text	`AdminSetUserMFAPreference`
-> AdminSetUserMFAPreference

Create a value of AdminSetUserMFAPreference 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:sMSMfaSettings:AdminSetUserMFAPreference', adminSetUserMFAPreference_sMSMfaSettings - The SMS text message MFA settings.

$sel:softwareTokenMfaSettings:AdminSetUserMFAPreference', adminSetUserMFAPreference_softwareTokenMfaSettings - The time-based one-time password software token MFA settings.

AdminSetUserMFAPreference, adminSetUserMFAPreference_username - The user pool username or alias.

AdminSetUserMFAPreference, adminSetUserMFAPreference_userPoolId - The user pool ID.

Request Lenses

adminSetUserMFAPreference_sMSMfaSettings :: Lens' AdminSetUserMFAPreference (Maybe SMSMfaSettingsType) Source #

The SMS text message MFA settings.

adminSetUserMFAPreference_softwareTokenMfaSettings :: Lens' AdminSetUserMFAPreference (Maybe SoftwareTokenMfaSettingsType) Source #

The time-based one-time password software token MFA settings.

adminSetUserMFAPreference_username :: Lens' AdminSetUserMFAPreference Text Source #

The user pool username or alias.

adminSetUserMFAPreference_userPoolId :: Lens' AdminSetUserMFAPreference Text Source #

The user pool ID.

Destructuring the Response

data AdminSetUserMFAPreferenceResponse Source #

See: newAdminSetUserMFAPreferenceResponse smart constructor.

Constructors

AdminSetUserMFAPreferenceResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAdminSetUserMFAPreferenceResponse Source #

Arguments

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

Create a value of AdminSetUserMFAPreferenceResponse 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:AdminSetUserMFAPreferenceResponse', adminSetUserMFAPreferenceResponse_httpStatus - The response's http status code.

Response Lenses

adminSetUserMFAPreferenceResponse_httpStatus :: Lens' AdminSetUserMFAPreferenceResponse Int Source #

The response's http status code.