Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-idp ]

describe-risk-configuration

Description

Describes the risk configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-risk-configuration
--user-pool-id <value>
[--client-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--client-id (string)

The app client ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe a risk configuration

This example describes the risk configuration associated with pool us-west-2_aaaaaaaaa.

Command:

aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa

Output:

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_IN",
              "SIGN_UP",
              "PASSWORD_CHANGE"
          ],
          "Actions": {
              "EventAction": "BLOCK"
          }
      },
      "AccountTakeoverRiskConfiguration": {
          "NotifyConfiguration": {
              "From": "diego@example.com",
              "ReplyTo": "diego@example.com",
              "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com",
              "BlockEmail": {
                  "Subject": "Blocked sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "NoActionEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "MfaEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              }
          },
          "Actions": {
              "LowAction": {
                  "Notify": true,
                  "EventAction": "NO_ACTION"
              },
              "MediumAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              },
              "HighAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              }
          }
      }
  }
}

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 if there is an account takeover.

NotifyConfiguration -> (structure)

The notify configuration used to construct email notifications.

From -> (string)

The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, 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. This identity 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 email subject.

HtmlBody -> (string)

The email HTML body.

TextBody -> (string)

The email text body.

NoActionEmail -> (structure)

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

Subject -> (string)

The email subject.

HtmlBody -> (string)

The email HTML body.

TextBody -> (string)

The email text body.

MfaEmail -> (structure)

The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.

Subject -> (string)

The email subject.

HtmlBody -> (string)

The email HTML body.

TextBody -> (string)

The email 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 action to take in response to the account takeover action. Valid values are as follows:

  • BLOCK Choosing this action will block the request.
  • MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
  • MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
  • NO_ACTION Allow the user to sign in.

MediumAction -> (structure)

Action to take for a medium risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The action to take in response to the account takeover action. Valid values are as follows:

  • BLOCK Choosing this action will block the request.
  • MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
  • MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
  • NO_ACTION Allow the user to sign in.

HighAction -> (structure)

Action to take for a high risk.

Notify -> (boolean)

Flag specifying whether to send a notification.

EventAction -> (string)

The action to take in response to the account takeover action. Valid values are as follows:

  • BLOCK Choosing this action will block the request.
  • MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
  • MFA_REQUIRED Present an MFA challenge if user has configured it, else block the request.
  • NO_ACTION Allow the user to 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 routing prefix.

(string)

SkippedIPRangeList -> (list)

Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.

(string)

LastModifiedDate -> (timestamp)

The last modified date.