Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.CognitoIdentityProvider.SetUserSettings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

Creating a Request

setUserSettings Source #

Arguments

:: Text	`susAccessToken`
-> SetUserSettings

Creates a value of SetUserSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

susAccessToken - The access token for the set user settings request.
susMFAOptions - Specifies the options for MFA (e.g., email or phone number).

data SetUserSettings Source #

Represents the request to set user settings.

See: setUserSettings smart constructor.

Instances

Eq SetUserSettings Source #
Methods (==) :: SetUserSettings -> SetUserSettings -> Bool # (/=) :: SetUserSettings -> SetUserSettings -> Bool #
Data SetUserSettings Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetUserSettings -> c SetUserSettings # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetUserSettings # toConstr :: SetUserSettings -> Constr # dataTypeOf :: SetUserSettings -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SetUserSettings) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetUserSettings) # gmapT :: (forall b. Data b => b -> b) -> SetUserSettings -> SetUserSettings # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetUserSettings -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetUserSettings -> r # gmapQ :: (forall d. Data d => d -> u) -> SetUserSettings -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SetUserSettings -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetUserSettings -> m SetUserSettings # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetUserSettings -> m SetUserSettings # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetUserSettings -> m SetUserSettings #
Show SetUserSettings Source #
Methods showsPrec :: Int -> SetUserSettings -> ShowS # show :: SetUserSettings -> String # showList :: [SetUserSettings] -> ShowS #
Generic SetUserSettings Source #
Associated Types type Rep SetUserSettings :: * -> * # Methods from :: SetUserSettings -> Rep SetUserSettings x # to :: Rep SetUserSettings x -> SetUserSettings #
Hashable SetUserSettings Source #
Methods hashWithSalt :: Int -> SetUserSettings -> Int # hash :: SetUserSettings -> Int #
ToJSON SetUserSettings Source #
Methods toJSON :: SetUserSettings -> Value # toEncoding :: SetUserSettings -> Encoding # toJSONList :: [SetUserSettings] -> Value # toEncodingList :: [SetUserSettings] -> Encoding #
NFData SetUserSettings Source #
Methods rnf :: SetUserSettings -> () #
AWSRequest SetUserSettings Source #
Associated Types type Rs SetUserSettings :: * # Methods request :: SetUserSettings -> Request SetUserSettings # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SetUserSettings -> ClientResponse -> m (Response SetUserSettings) #
ToHeaders SetUserSettings Source #
Methods toHeaders :: SetUserSettings -> [Header] #
ToPath SetUserSettings Source #
Methods toPath :: SetUserSettings -> ByteString #
ToQuery SetUserSettings Source #
Methods toQuery :: SetUserSettings -> QueryString #
type Rep SetUserSettings Source #
type Rep SetUserSettings = D1 * (MetaData "SetUserSettings" "Network.AWS.CognitoIdentityProvider.SetUserSettings" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "SetUserSettings'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_susAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_susMFAOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [MFAOptionType]))))
type Rs SetUserSettings Source #
type Rs SetUserSettings = SetUserSettingsResponse

Request Lenses

susAccessToken :: Lens' SetUserSettings Text Source #

The access token for the set user settings request.

susMFAOptions :: Lens' SetUserSettings [MFAOptionType] Source #

Specifies the options for MFA (e.g., email or phone number).

Destructuring the Response

setUserSettingsResponse Source #

Arguments

:: Int	`susrsResponseStatus`
-> SetUserSettingsResponse

Creates a value of SetUserSettingsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

susrsResponseStatus - -- | The response status code.

data SetUserSettingsResponse Source #

The response from the server for a set user settings request.

See: setUserSettingsResponse smart constructor.

Instances

Eq SetUserSettingsResponse Source #
Methods (==) :: SetUserSettingsResponse -> SetUserSettingsResponse -> Bool # (/=) :: SetUserSettingsResponse -> SetUserSettingsResponse -> Bool #
Data SetUserSettingsResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetUserSettingsResponse -> c SetUserSettingsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetUserSettingsResponse # toConstr :: SetUserSettingsResponse -> Constr # dataTypeOf :: SetUserSettingsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SetUserSettingsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetUserSettingsResponse) # gmapT :: (forall b. Data b => b -> b) -> SetUserSettingsResponse -> SetUserSettingsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetUserSettingsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetUserSettingsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> SetUserSettingsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SetUserSettingsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetUserSettingsResponse -> m SetUserSettingsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetUserSettingsResponse -> m SetUserSettingsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetUserSettingsResponse -> m SetUserSettingsResponse #
Read SetUserSettingsResponse Source #
Methods readsPrec :: Int -> ReadS SetUserSettingsResponse # readList :: ReadS [SetUserSettingsResponse] # readPrec :: ReadPrec SetUserSettingsResponse # readListPrec :: ReadPrec [SetUserSettingsResponse] #
Show SetUserSettingsResponse Source #
Methods showsPrec :: Int -> SetUserSettingsResponse -> ShowS # show :: SetUserSettingsResponse -> String # showList :: [SetUserSettingsResponse] -> ShowS #
Generic SetUserSettingsResponse Source #
Associated Types type Rep SetUserSettingsResponse :: * -> * # Methods from :: SetUserSettingsResponse -> Rep SetUserSettingsResponse x # to :: Rep SetUserSettingsResponse x -> SetUserSettingsResponse #
NFData SetUserSettingsResponse Source #
Methods rnf :: SetUserSettingsResponse -> () #
type Rep SetUserSettingsResponse Source #
type Rep SetUserSettingsResponse = D1 * (MetaData "SetUserSettingsResponse" "Network.AWS.CognitoIdentityProvider.SetUserSettings" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" True) (C1 * (MetaCons "SetUserSettingsResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_susrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

susrsResponseStatus :: Lens' SetUserSettingsResponse Int Source #

- | The response status code.