GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CognitoIdp::SetRiskConfiguration(3) User Contributed Perl Documentation Paws::CognitoIdp::SetRiskConfiguration(3)

Paws::CognitoIdp::SetRiskConfiguration - Arguments for method SetRiskConfiguration on Paws::CognitoIdp

This class represents the parameters used for calling the method SetRiskConfiguration on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method SetRiskConfiguration.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetRiskConfiguration.

    my $cognito-idp = Paws->service('CognitoIdp');
    my $SetRiskConfigurationResponse = $cognito -idp->SetRiskConfiguration(
      UserPoolId                       => 'MyUserPoolIdType',
      AccountTakeoverRiskConfiguration => {
        Actions => {
          HighAction => {
            EventAction => 'BLOCK'
            ,    # values: BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
            Notify => 1,
          },    # OPTIONAL
          LowAction => {
            EventAction => 'BLOCK'
            ,    # values: BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
            Notify => 1,
          },    # OPTIONAL
          MediumAction => {
            EventAction => 'BLOCK'
            ,    # values: BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
            Notify => 1,
          },    # OPTIONAL
        },
        NotifyConfiguration => {
          SourceArn  => 'MyArnType',    # min: 20, max: 2048
          BlockEmail => {
            Subject  => 'MyEmailNotificationSubjectType',    # min: 1, max: 140
            HtmlBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
            TextBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
          },    # OPTIONAL
          From     => 'MyStringType',    # OPTIONAL
          MfaEmail => {
            Subject  => 'MyEmailNotificationSubjectType',    # min: 1, max: 140
            HtmlBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
            TextBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
          },    # OPTIONAL
          NoActionEmail => {
            Subject  => 'MyEmailNotificationSubjectType',    # min: 1, max: 140
            HtmlBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
            TextBody =>
              'MyEmailNotificationBodyType',    # min: 6, max: 20000; OPTIONAL
          },    # OPTIONAL
          ReplyTo => 'MyStringType',    # OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      ClientId                                => 'MyClientIdType',    # OPTIONAL
      CompromisedCredentialsRiskConfiguration => {
        Actions => {
          EventAction => 'BLOCK',    # values: BLOCK, NO_ACTION
        },
        EventFilter => [
          'SIGN_IN', ...             # values: SIGN_IN, PASSWORD_CHANGE, SIGN_UP
        ],    # OPTIONAL
      },    # OPTIONAL
      RiskExceptionConfiguration => {
        BlockedIPRangeList => [
          'MyStringType', ...    # OPTIONAL
        ],    # max: 20; OPTIONAL
        SkippedIPRangeList => [
          'MyStringType', ...    # OPTIONAL
        ],    # max: 20; OPTIONAL
      },    # OPTIONAL
    );
    # Results:
    my $RiskConfiguration = $SetRiskConfigurationResponse->RiskConfiguration;
    # Returns a L<Paws::CognitoIdp::SetRiskConfigurationResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/SetRiskConfiguration>

The account takeover risk configuration.

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 is not null, the user pool configuration is overridden and the risk configuration for the client is used instead.

The compromised credentials risk configuration.

The configuration to override the risk decision.

REQUIRED UserPoolId => Str

The user pool ID.

This class forms part of Paws, documenting arguments for method SetRiskConfiguration in Paws::CognitoIdp

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.