amazonka-cognito-idp-2.0: Amazon Cognito Identity Provider SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Description

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

Synopsis

Creating a Request

data SetRiskConfiguration Source #

See: newSetRiskConfiguration smart constructor.

Constructors

SetRiskConfiguration' 

Fields

Instances

Instances details
ToJSON SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

toJSON :: SetRiskConfiguration -> Value #

toEncoding :: SetRiskConfiguration -> Encoding #

toJSONList :: [SetRiskConfiguration] -> Value #

toEncodingList :: [SetRiskConfiguration] -> Encoding #

ToHeaders SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

toHeaders :: SetRiskConfiguration -> [Header] #

ToPath SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

toPath :: SetRiskConfiguration -> ByteString #

ToQuery SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

toQuery :: SetRiskConfiguration -> QueryString #

AWSRequest SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Associated Types

type AWSResponse SetRiskConfiguration #

Methods

request :: (Service -> Service) -> SetRiskConfiguration -> Request SetRiskConfiguration #

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

Generic SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Associated Types

type Rep SetRiskConfiguration :: Type -> Type #

Methods

from :: SetRiskConfiguration -> Rep SetRiskConfiguration x #

to :: Rep SetRiskConfiguration x -> SetRiskConfiguration #

Show SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

showsPrec :: Int -> SetRiskConfiguration -> ShowS #

show :: SetRiskConfiguration -> String #

showList :: [SetRiskConfiguration] -> ShowS #

NFData SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

rnf :: SetRiskConfiguration -> () #

Eq SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

(==) :: SetRiskConfiguration -> SetRiskConfiguration -> Bool #

(/=) :: SetRiskConfiguration -> SetRiskConfiguration -> Bool #

Hashable SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

hashWithSalt :: Int -> SetRiskConfiguration -> Int #

hash :: SetRiskConfiguration -> Int #

type AWSResponse SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

type AWSResponse SetRiskConfiguration = SetRiskConfigurationResponse
type Rep SetRiskConfiguration Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

type Rep SetRiskConfiguration = D1 ('MetaData "SetRiskConfiguration" "Amazonka.CognitoIdentityProvider.SetRiskConfiguration" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SetRiskConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountTakeoverRiskConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountTakeoverRiskConfigurationType)) :*: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "compromisedCredentialsRiskConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompromisedCredentialsRiskConfigurationType)) :*: (S1 ('MetaSel ('Just "riskExceptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RiskExceptionConfigurationType)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSetRiskConfiguration Source #

Arguments

:: Text

SetRiskConfiguration

-> SetRiskConfiguration 

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

SetRiskConfiguration, setRiskConfiguration_accountTakeoverRiskConfiguration - The account takeover risk configuration.

SetRiskConfiguration, setRiskConfiguration_clientId - The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

SetRiskConfiguration, setRiskConfiguration_compromisedCredentialsRiskConfiguration - The compromised credentials risk configuration.

SetRiskConfiguration, setRiskConfiguration_riskExceptionConfiguration - The configuration to override the risk decision.

SetRiskConfiguration, setRiskConfiguration_userPoolId - The user pool ID.

Request Lenses

setRiskConfiguration_accountTakeoverRiskConfiguration :: Lens' SetRiskConfiguration (Maybe AccountTakeoverRiskConfigurationType) Source #

The account takeover risk configuration.

setRiskConfiguration_clientId :: Lens' SetRiskConfiguration (Maybe Text) Source #

The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.

setRiskConfiguration_compromisedCredentialsRiskConfiguration :: Lens' SetRiskConfiguration (Maybe CompromisedCredentialsRiskConfigurationType) Source #

The compromised credentials risk configuration.

setRiskConfiguration_riskExceptionConfiguration :: Lens' SetRiskConfiguration (Maybe RiskExceptionConfigurationType) Source #

The configuration to override the risk decision.

setRiskConfiguration_userPoolId :: Lens' SetRiskConfiguration Text Source #

The user pool ID.

Destructuring the Response

data SetRiskConfigurationResponse Source #

See: newSetRiskConfigurationResponse smart constructor.

Constructors

SetRiskConfigurationResponse' 

Fields

Instances

Instances details
Generic SetRiskConfigurationResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Associated Types

type Rep SetRiskConfigurationResponse :: Type -> Type #

Methods

from :: SetRiskConfigurationResponse -> Rep SetRiskConfigurationResponse x #

to :: Rep SetRiskConfigurationResponse x -> SetRiskConfigurationResponse #

Show SetRiskConfigurationResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

showsPrec :: Int -> SetRiskConfigurationResponse -> ShowS #

show :: SetRiskConfigurationResponse -> String #

showList :: [SetRiskConfigurationResponse] -> ShowS #

NFData SetRiskConfigurationResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

rnf :: SetRiskConfigurationResponse -> () #

Eq SetRiskConfigurationResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

Methods

(==) :: SetRiskConfigurationResponse -> SetRiskConfigurationResponse -> Bool #

(/=) :: SetRiskConfigurationResponse -> SetRiskConfigurationResponse -> Bool #

type Rep SetRiskConfigurationResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.SetRiskConfiguration

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

newSetRiskConfigurationResponse Source #

Arguments

:: Int

$sel:httpStatus:SetRiskConfigurationResponse'

-> RiskConfigurationType

$sel:riskConfiguration:SetRiskConfigurationResponse'

-> SetRiskConfigurationResponse 

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

$sel:riskConfiguration:SetRiskConfigurationResponse', setRiskConfigurationResponse_riskConfiguration - The risk configuration.

Response Lenses

setRiskConfigurationResponse_httpStatus :: Lens' SetRiskConfigurationResponse Int Source #

The response's http status code.

setRiskConfigurationResponse_riskConfiguration :: Lens' SetRiskConfigurationResponse RiskConfigurationType Source #

The risk configuration.