[ aws . cognito-idp ]

set-risk-configuration

Description

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

To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns key``AdvancedSecurityMode`` .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-risk-configuration
--user-pool-id <value>
[--client-id <value>]
[--compromised-credentials-risk-configuration <value>]
[--account-takeover-risk-configuration <value>]
[--risk-exception-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--client-id (string)

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.

--compromised-credentials-risk-configuration (structure)

The compromised credentials risk configuration.

EventFilter -> (list)

Perform the action for these events. The default is to perform all events if no event filter is specified.

(string)

Actions -> (structure)

The compromised credentials risk configuration actions.

EventAction -> (string)

The event action.

Shorthand Syntax:

EventFilter=string,string,Actions={EventAction=string}

JSON Syntax:

{
  "EventFilter": ["SIGN_IN"|"PASSWORD_CHANGE"|"SIGN_UP", ...],
  "Actions": {
    "EventAction": "BLOCK"|"NO_ACTION"
  }
}

--account-takeover-risk-configuration (structure)

The account takeover risk configuration.

NotifyConfiguration -> (structure)

The notify configuration used to construct email notifications.

From -> (string)

The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

ReplyTo -> (string)

The destination to which the receiver of an email should reply to.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter.

BlockEmail -> (structure)

Email template used when a detected risk event is blocked.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

NoActionEmail -> (structure)

The email template used when a detected risk event is allowed.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

MfaEmail -> (structure)

The MFA email template used when MFA is challenged as part of a detected risk.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

Actions -> (structure)

Account takeover risk configuration actions

LowAction -> (structure)

Action to take for a low risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

MediumAction -> (structure)

Action to take for a medium risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

HighAction -> (structure)

Action to take for a high risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

Shorthand Syntax:

NotifyConfiguration={From=string,ReplyTo=string,SourceArn=string,BlockEmail={Subject=string,HtmlBody=string,TextBody=string},NoActionEmail={Subject=string,HtmlBody=string,TextBody=string},MfaEmail={Subject=string,HtmlBody=string,TextBody=string}},Actions={LowAction={Notify=boolean,EventAction=string},MediumAction={Notify=boolean,EventAction=string},HighAction={Notify=boolean,EventAction=string}}

JSON Syntax:

{
  "NotifyConfiguration": {
    "From": "string",
    "ReplyTo": "string",
    "SourceArn": "string",
    "BlockEmail": {
      "Subject": "string",
      "HtmlBody": "string",
      "TextBody": "string"
    },
    "NoActionEmail": {
      "Subject": "string",
      "HtmlBody": "string",
      "TextBody": "string"
    },
    "MfaEmail": {
      "Subject": "string",
      "HtmlBody": "string",
      "TextBody": "string"
    }
  },
  "Actions": {
    "LowAction": {
      "Notify": true|false,
      "EventAction": "BLOCK"|"MFA_IF_CONFIGURED"|"MFA_REQUIRED"|"NO_ACTION"
    },
    "MediumAction": {
      "Notify": true|false,
      "EventAction": "BLOCK"|"MFA_IF_CONFIGURED"|"MFA_REQUIRED"|"NO_ACTION"
    },
    "HighAction": {
      "Notify": true|false,
      "EventAction": "BLOCK"|"MFA_IF_CONFIGURED"|"MFA_REQUIRED"|"NO_ACTION"
    }
  }
}

--risk-exception-configuration (structure)

The configuration to override the risk decision.

BlockedIPRangeList -> (list)

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.

(string)

SkippedIPRangeList -> (list)

Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.

(string)

Shorthand Syntax:

BlockedIPRangeList=string,string,SkippedIPRangeList=string,string

JSON Syntax:

{
  "BlockedIPRangeList": ["string", ...],
  "SkippedIPRangeList": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To set risk configuration

This example sets the risk configuration for a user pool. It sets the sign-up event action to NO_ACTION.

Command:

aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa  --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}

Output:

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_UP"
          ],
          "Actions": {
              "EventAction": "NO_ACTION"
          }
      }
  }
}

Output

RiskConfiguration -> (structure)

The risk configuration.

UserPoolId -> (string)

The user pool ID.

ClientId -> (string)

The app client ID.

CompromisedCredentialsRiskConfiguration -> (structure)

The compromised credentials risk configuration object including the EventFilter and the EventAction

EventFilter -> (list)

Perform the action for these events. The default is to perform all events if no event filter is specified.

(string)

Actions -> (structure)

The compromised credentials risk configuration actions.

EventAction -> (string)

The event action.

AccountTakeoverRiskConfiguration -> (structure)

The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover.

NotifyConfiguration -> (structure)

The notify configuration used to construct email notifications.

From -> (string)

The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

ReplyTo -> (string)

The destination to which the receiver of an email should reply to.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter.

BlockEmail -> (structure)

Email template used when a detected risk event is blocked.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

NoActionEmail -> (structure)

The email template used when a detected risk event is allowed.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

MfaEmail -> (structure)

The MFA email template used when MFA is challenged as part of a detected risk.

Subject -> (string)

The subject.

HtmlBody -> (string)

The HTML body.

TextBody -> (string)

The text body.

Actions -> (structure)

Account takeover risk configuration actions

LowAction -> (structure)

Action to take for a low risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

MediumAction -> (structure)

Action to take for a medium risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

HighAction -> (structure)

Action to take for a high risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The event action.

• BLOCK Choosing this action will block the request.

• MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

• MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

• NO_ACTION Allow the user sign-in.

RiskExceptionConfiguration -> (structure)

The configuration to override the risk decision.

BlockedIPRangeList -> (list)

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.

(string)

SkippedIPRangeList -> (list)

Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.

(string)

LastModifiedDate -> (timestamp)

The last modified date.