Network.AWS.CognitoIdentityProvider.AdminSetUserSettings

Sets all the user settings for a specified user name. Works on any user.

Requires developer credentials.

Creating a Request

adminSetUserSettings

Arguments

:: Text

asusUserPoolId

-> Text

asusUsername

-> AdminSetUserSettings

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

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

• asusUserPoolId - The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
• asusUsername - The user name of the user for whom you wish to set user settings.
• asusMFAOptions - Specifies the options for MFA (e.g., email or phone number).

data AdminSetUserSettings

Represents the request to set user settings as an administrator.

See: adminSetUserSettings smart constructor.

Instances

Eq AdminSetUserSettings

Methods

(==) :: AdminSetUserSettings -> AdminSetUserSettings -> Bool

(/=) :: AdminSetUserSettings -> AdminSetUserSettings -> Bool

Data AdminSetUserSettings

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminSetUserSettings -> c AdminSetUserSettings

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminSetUserSettings

toConstr :: AdminSetUserSettings -> Constr

dataTypeOf :: AdminSetUserSettings -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminSetUserSettings)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminSetUserSettings)

gmapT :: (forall b. Data b => b -> b) -> AdminSetUserSettings -> AdminSetUserSettings

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminSetUserSettings -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminSetUserSettings -> r

gmapQ :: (forall d. Data d => d -> u) -> AdminSetUserSettings -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminSetUserSettings -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminSetUserSettings -> m AdminSetUserSettings

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminSetUserSettings -> m AdminSetUserSettings

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminSetUserSettings -> m AdminSetUserSettings

Show AdminSetUserSettings

Methods

showsPrec :: Int -> AdminSetUserSettings -> ShowS

show :: AdminSetUserSettings -> String

showList :: [AdminSetUserSettings] -> ShowS

Generic AdminSetUserSettings

Associated Types

type Rep AdminSetUserSettings :: * -> *

Methods

from :: AdminSetUserSettings -> Rep AdminSetUserSettings x

to :: Rep AdminSetUserSettings x -> AdminSetUserSettings

Hashable AdminSetUserSettings

Methods

hashWithSalt :: Int -> AdminSetUserSettings -> Int

hash :: AdminSetUserSettings -> Int

ToJSON AdminSetUserSettings

Methods

toJSON :: AdminSetUserSettings -> Value

toEncoding :: AdminSetUserSettings -> Encoding

toJSONList :: [AdminSetUserSettings] -> Value

toEncodingList :: [AdminSetUserSettings] -> Encoding

NFData AdminSetUserSettings

Methods

rnf :: AdminSetUserSettings -> ()

AWSRequest AdminSetUserSettings

Associated Types

type Rs AdminSetUserSettings :: *

Methods

request :: AdminSetUserSettings -> Request AdminSetUserSettings

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * AdminSetUserSettings -> ClientResponse -> m (Response AdminSetUserSettings)

ToHeaders AdminSetUserSettings

Methods

toHeaders :: AdminSetUserSettings -> [Header]

ToPath AdminSetUserSettings

Methods

toPath :: AdminSetUserSettings -> ByteString

ToQuery AdminSetUserSettings

Methods

toQuery :: AdminSetUserSettings -> QueryString

type Rep AdminSetUserSettings

type Rep AdminSetUserSettings = D1 * (MetaData "AdminSetUserSettings" "Network.AWS.CognitoIdentityProvider.AdminSetUserSettings" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "AdminSetUserSettings'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_asusUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_asusUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_asusMFAOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [MFAOptionType])))))

type Rs AdminSetUserSettings

type Rs AdminSetUserSettings = AdminSetUserSettingsResponse

Request Lenses

asusUserPoolId :: Lens' AdminSetUserSettings Text

The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

asusUsername :: Lens' AdminSetUserSettings Text

The user name of the user for whom you wish to set user settings.

asusMFAOptions :: Lens' AdminSetUserSettings [MFAOptionType]

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

Destructuring the Response

adminSetUserSettingsResponse

Arguments

:: Int

asusrsResponseStatus

-> AdminSetUserSettingsResponse

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

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

• asusrsResponseStatus - -- | The response status code.

data AdminSetUserSettingsResponse

Represents the response from the server to set user settings as an administrator.

See: adminSetUserSettingsResponse smart constructor.

Instances

Eq AdminSetUserSettingsResponse

Methods

(==) :: AdminSetUserSettingsResponse -> AdminSetUserSettingsResponse -> Bool

(/=) :: AdminSetUserSettingsResponse -> AdminSetUserSettingsResponse -> Bool

Data AdminSetUserSettingsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminSetUserSettingsResponse -> c AdminSetUserSettingsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminSetUserSettingsResponse

toConstr :: AdminSetUserSettingsResponse -> Constr

dataTypeOf :: AdminSetUserSettingsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminSetUserSettingsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminSetUserSettingsResponse)

gmapT :: (forall b. Data b => b -> b) -> AdminSetUserSettingsResponse -> AdminSetUserSettingsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminSetUserSettingsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminSetUserSettingsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> AdminSetUserSettingsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminSetUserSettingsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminSetUserSettingsResponse -> m AdminSetUserSettingsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminSetUserSettingsResponse -> m AdminSetUserSettingsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminSetUserSettingsResponse -> m AdminSetUserSettingsResponse

Read AdminSetUserSettingsResponse

Methods

readsPrec :: Int -> ReadS AdminSetUserSettingsResponse

readList :: ReadS [AdminSetUserSettingsResponse]

readPrec :: ReadPrec AdminSetUserSettingsResponse

readListPrec :: ReadPrec [AdminSetUserSettingsResponse]

Show AdminSetUserSettingsResponse

Methods

showsPrec :: Int -> AdminSetUserSettingsResponse -> ShowS

show :: AdminSetUserSettingsResponse -> String

showList :: [AdminSetUserSettingsResponse] -> ShowS

Generic AdminSetUserSettingsResponse

Associated Types

type Rep AdminSetUserSettingsResponse :: * -> *

Methods

from :: AdminSetUserSettingsResponse -> Rep AdminSetUserSettingsResponse x

to :: Rep AdminSetUserSettingsResponse x -> AdminSetUserSettingsResponse

NFData AdminSetUserSettingsResponse

Methods

rnf :: AdminSetUserSettingsResponse -> ()

type Rep AdminSetUserSettingsResponse

type Rep AdminSetUserSettingsResponse = D1 * (MetaData "AdminSetUserSettingsResponse" "Network.AWS.CognitoIdentityProvider.AdminSetUserSettings" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" True) (C1 * (MetaCons "AdminSetUserSettingsResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_asusrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

asusrsResponseStatus :: Lens' AdminSetUserSettingsResponse Int

• - | The response status code.