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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data GetUserPoolMfaConfig Source #

See: newGetUserPoolMfaConfig smart constructor.

Constructors

GetUserPoolMfaConfig'
Fields userPoolId :: Text The user pool ID.

Instances

Instances details

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

newGetUserPoolMfaConfig Source #

Arguments

:: Text	`GetUserPoolMfaConfig`
-> GetUserPoolMfaConfig

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

GetUserPoolMfaConfig, getUserPoolMfaConfig_userPoolId - The user pool ID.

Request Lenses

getUserPoolMfaConfig_userPoolId :: Lens' GetUserPoolMfaConfig Text Source #

The user pool ID.

Destructuring the Response

data GetUserPoolMfaConfigResponse Source #

See: newGetUserPoolMfaConfigResponse smart constructor.

Constructors

GetUserPoolMfaConfigResponse'

Fields

mfaConfiguration :: Maybe UserPoolMfaType
The multi-factor authentication (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 activated.
smsMfaConfiguration :: Maybe SmsMfaConfigType
The SMS text message multi-factor authentication (MFA) configuration.
softwareTokenMfaConfiguration :: Maybe SoftwareTokenMfaConfigType
The software token multi-factor authentication (MFA) configuration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig Associated Types type Rep GetUserPoolMfaConfigResponse :: Type -> Type # Methods from :: GetUserPoolMfaConfigResponse -> Rep GetUserPoolMfaConfigResponse x # to :: Rep GetUserPoolMfaConfigResponse x -> GetUserPoolMfaConfigResponse #
Read GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig Methods readsPrec :: Int -> ReadS GetUserPoolMfaConfigResponse # readList :: ReadS [GetUserPoolMfaConfigResponse] # readPrec :: ReadPrec GetUserPoolMfaConfigResponse # readListPrec :: ReadPrec [GetUserPoolMfaConfigResponse] #
Show GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig Methods showsPrec :: Int -> GetUserPoolMfaConfigResponse -> ShowS # show :: GetUserPoolMfaConfigResponse -> String # showList :: [GetUserPoolMfaConfigResponse] -> ShowS #
NFData GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig Methods rnf :: GetUserPoolMfaConfigResponse -> () #
Eq GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig Methods (==) :: GetUserPoolMfaConfigResponse -> GetUserPoolMfaConfigResponse -> Bool # (/=) :: GetUserPoolMfaConfigResponse -> GetUserPoolMfaConfigResponse -> Bool #
type Rep GetUserPoolMfaConfigResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig type Rep GetUserPoolMfaConfigResponse = D1 ('MetaData "GetUserPoolMfaConfigResponse" "Amazonka.CognitoIdentityProvider.GetUserPoolMfaConfig" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GetUserPoolMfaConfigResponse'" '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))))

newGetUserPoolMfaConfigResponse Source #

Arguments

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

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

GetUserPoolMfaConfigResponse, getUserPoolMfaConfigResponse_mfaConfiguration - The multi-factor authentication (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 activated.

$sel:smsMfaConfiguration:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_smsMfaConfiguration - The SMS text message multi-factor authentication (MFA) configuration.

$sel:softwareTokenMfaConfiguration:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_softwareTokenMfaConfiguration - The software token multi-factor authentication (MFA) configuration.

$sel:httpStatus:GetUserPoolMfaConfigResponse', getUserPoolMfaConfigResponse_httpStatus - The response's http status code.

Response Lenses

getUserPoolMfaConfigResponse_mfaConfiguration :: Lens' GetUserPoolMfaConfigResponse (Maybe UserPoolMfaType) Source #

The multi-factor authentication (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 activated.

getUserPoolMfaConfigResponse_smsMfaConfiguration :: Lens' GetUserPoolMfaConfigResponse (Maybe SmsMfaConfigType) Source #

The SMS text message multi-factor authentication (MFA) configuration.

getUserPoolMfaConfigResponse_softwareTokenMfaConfiguration :: Lens' GetUserPoolMfaConfigResponse (Maybe SoftwareTokenMfaConfigType) Source #

The software token multi-factor authentication (MFA) configuration.

getUserPoolMfaConfigResponse_httpStatus :: Lens' GetUserPoolMfaConfigResponse Int Source #

The response's http status code.