Amazonka.CognitoIdentityProvider.SetUserSettings

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

Creating a Request

data SetUserSettings

Represents the request to set user settings.

See: newSetUserSettings smart constructor.

Constructors

SetUserSettings'

Fields

• accessToken :: Sensitive Text

  A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

• mfaOptions :: [MFAOptionType]

  You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Instances

ToJSON SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

toJSON :: SetUserSettings -> Value

toEncoding :: SetUserSettings -> Encoding

toJSONList :: [SetUserSettings] -> Value

toEncodingList :: [SetUserSettings] -> Encoding

ToHeaders SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

toHeaders :: SetUserSettings -> [Header]

ToPath SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

toPath :: SetUserSettings -> ByteString

ToQuery SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

toQuery :: SetUserSettings -> QueryString

AWSRequest SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type AWSResponse SetUserSettings

Methods

request :: (Service -> Service) -> SetUserSettings -> Request SetUserSettings

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetUserSettings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetUserSettings)))

Generic SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type Rep SetUserSettings :: Type -> Type

Methods

from :: SetUserSettings -> Rep SetUserSettings x

to :: Rep SetUserSettings x -> SetUserSettings

Show SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

showsPrec :: Int -> SetUserSettings -> ShowS

show :: SetUserSettings -> String

showList :: [SetUserSettings] -> ShowS

NFData SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

rnf :: SetUserSettings -> ()

Eq SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

(==) :: SetUserSettings -> SetUserSettings -> Bool

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

Hashable SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

hashWithSalt :: Int -> SetUserSettings -> Int

hash :: SetUserSettings -> Int

type AWSResponse SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

type AWSResponse SetUserSettings = SetUserSettingsResponse

type Rep SetUserSettings

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

type Rep SetUserSettings = D1 ('MetaData "SetUserSettings" "Amazonka.CognitoIdentityProvider.SetUserSettings" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SetUserSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MFAOptionType])))

newSetUserSettings

Arguments

:: Text

SetUserSettings

-> SetUserSettings

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

SetUserSettings, setUserSettings_accessToken - A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

SetUserSettings, setUserSettings_mfaOptions - You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Request Lenses

setUserSettings_accessToken :: Lens' SetUserSettings Text

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

setUserSettings_mfaOptions :: Lens' SetUserSettings [MFAOptionType]

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Destructuring the Response

data SetUserSettingsResponse

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

See: newSetUserSettingsResponse smart constructor.

Constructors

SetUserSettingsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type Rep SetUserSettingsResponse :: Type -> Type

Methods

from :: SetUserSettingsResponse -> Rep SetUserSettingsResponse x

to :: Rep SetUserSettingsResponse x -> SetUserSettingsResponse

Read SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

readsPrec :: Int -> ReadS SetUserSettingsResponse

readList :: ReadS [SetUserSettingsResponse]

readPrec :: ReadPrec SetUserSettingsResponse

readListPrec :: ReadPrec [SetUserSettingsResponse]

Show SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

showsPrec :: Int -> SetUserSettingsResponse -> ShowS

show :: SetUserSettingsResponse -> String

showList :: [SetUserSettingsResponse] -> ShowS

NFData SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

rnf :: SetUserSettingsResponse -> ()

Eq SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

(==) :: SetUserSettingsResponse -> SetUserSettingsResponse -> Bool

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

type Rep SetUserSettingsResponse

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

type Rep SetUserSettingsResponse = D1 ('MetaData "SetUserSettingsResponse" "Amazonka.CognitoIdentityProvider.SetUserSettings" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SetUserSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetUserSettingsResponse

Arguments

:: Int

$sel:httpStatus:SetUserSettingsResponse'

-> SetUserSettingsResponse

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

Response Lenses

setUserSettingsResponse_httpStatus :: Lens' SetUserSettingsResponse Int

The response's http status code.