AWS CLI Command Reference

[ 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 activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns key``AdvancedSecurityMode`` .

See also: AWS API Documentation

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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 isn’t 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. 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.

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

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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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 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 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 date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
© Copyright 2018, Amazon Web Services. Created using Sphinx.