libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.SetUserSettings

Description

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

Synopsis

Creating a Request

data SetUserSettings Source #

Represents the request to set user settings.

See: newSetUserSettings smart constructor.

Constructors

SetUserSettings' 

Fields

Instances

Instances details
Eq SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Show SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Generic SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type Rep SetUserSettings :: Type -> Type #

NFData SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

rnf :: SetUserSettings -> () #

Hashable SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

ToJSON SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

AWSRequest SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type AWSResponse SetUserSettings #

ToHeaders SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

ToPath SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

ToQuery SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

type Rep SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

type Rep SetUserSettings = D1 ('MetaData "SetUserSettings" "Amazonka.CognitoIdentityProvider.SetUserSettings" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" '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])))
type AWSResponse SetUserSettings Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

newSetUserSettings Source #

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:

$sel:accessToken:SetUserSettings', setUserSettings_accessToken - The access token for the set user settings request.

$sel:mfaOptions: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 Source #

The access token for the set user settings request.

setUserSettings_mfaOptions :: Lens' SetUserSettings [MFAOptionType] Source #

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

Destructuring the Response

data SetUserSettingsResponse Source #

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

See: newSetUserSettingsResponse smart constructor.

Constructors

SetUserSettingsResponse' 

Fields

Instances

Instances details
Eq SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Read SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Show SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Generic SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Associated Types

type Rep SetUserSettingsResponse :: Type -> Type #

NFData SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

Methods

rnf :: SetUserSettingsResponse -> () #

type Rep SetUserSettingsResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetUserSettings

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

newSetUserSettingsResponse Source #

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