AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Cognito Identity Provider SetRiskConfiguration API operation.

Syntax

Set-CGIPRiskConfiguration
-UserPoolId <String>
-RiskExceptionConfiguration_BlockedIPRangeList <String[]>
-ClientId <String>
-HighAction_EventAction <AccountTakeoverEventActionType>
-LowAction_EventAction <AccountTakeoverEventActionType>
-MediumAction_EventAction <AccountTakeoverEventActionType>
-Actions_EventAction <CompromisedCredentialsEventActionType>
-CompromisedCredentialsRiskConfiguration_EventFilter <String[]>
-NotifyConfiguration_From <String>
-BlockEmail_HtmlBody <String>
-MfaEmail_HtmlBody <String>
-NoActionEmail_HtmlBody <String>
-HighAction_Notify <Boolean>
-LowAction_Notify <Boolean>
-MediumAction_Notify <Boolean>
-NotifyConfiguration_ReplyTo <String>
-RiskExceptionConfiguration_SkippedIPRangeList <String[]>
-NotifyConfiguration_SourceArn <String>
-BlockEmail_Subject <String>
-MfaEmail_Subject <String>
-NoActionEmail_Subject <String>
-BlockEmail_TextBody <String>
-MfaEmail_TextBody <String>
-NoActionEmail_TextBody <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCognitoIdentityProviderConfig>

Description

Configures threat protection for a user pool or app client. Sets configuration for the following.
  • Responses to risks with adaptive authentication
  • Responses to vulnerable passwords with compromised-credentials detection
  • Notifications to users who have had risky activity detected
  • IP-address denylist and allowlist
To set the risk configuration for the user pool to defaults, send this request with only the UserPoolId parameter. To reset the threat protection settings of an app client to be inherited from the user pool, send UserPoolId and ClientId parameters only. To change threat protection to audit-only or off, update the value of UserPoolAddOns in an UpdateUserPool request. To activate this setting, your user pool must be on the Plus tier.

Parameters

-Actions_EventAction <CompromisedCredentialsEventActionType>
The action that Amazon Cognito takes when it detects compromised credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCompromisedCredentialsRiskConfiguration_Actions_EventAction
-BlockEmail_HtmlBody <String>
The body of an email notification formatted in HTML. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_BlockEmail_HtmlBody
-BlockEmail_Subject <String>
The subject of the threat protection email notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_BlockEmail_Subject
-BlockEmail_TextBody <String>
The body of an email notification formatted in plaintext. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_BlockEmail_TextBody
-ClientConfig <AmazonCognitoIdentityProviderConfig>
Amazon.PowerShell.Cmdlets.CGIP.AmazonCognitoIdentityProviderClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientId <String>
The ID of the app client where you want to set a risk configuration. 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.When you include a ClientId parameter, Amazon Cognito maps the configuration to the app client. When you include both ClientId and UserPoolId, Amazon Cognito maps the configuration to the app client only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompromisedCredentialsRiskConfiguration_EventFilter <String[]>
Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HighAction_EventAction <AccountTakeoverEventActionType>
The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:
  • BLOCK: Block the request.
  • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
  • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
  • NO_ACTION: Take no action. Permit sign-in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_HighAction_EventAction
-HighAction_Notify <Boolean>
Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_HighAction_Notify
-LowAction_EventAction <AccountTakeoverEventActionType>
The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:
  • BLOCK: Block the request.
  • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
  • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
  • NO_ACTION: Take no action. Permit sign-in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_LowAction_EventAction
-LowAction_Notify <Boolean>
Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_LowAction_Notify
-MediumAction_EventAction <AccountTakeoverEventActionType>
The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:
  • BLOCK: Block the request.
  • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.
  • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.
  • NO_ACTION: Take no action. Permit sign-in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_MediumAction_EventAction
-MediumAction_Notify <Boolean>
Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_Actions_MediumAction_Notify
-MfaEmail_HtmlBody <String>
The body of an email notification formatted in HTML. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_MfaEmail_HtmlBody
-MfaEmail_Subject <String>
The subject of the threat protection email notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_MfaEmail_Subject
-MfaEmail_TextBody <String>
The body of an email notification formatted in plaintext. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_MfaEmail_TextBody
-NoActionEmail_HtmlBody <String>
The body of an email notification formatted in HTML. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_NoActionEmail_HtmlBody
-NoActionEmail_Subject <String>
The subject of the threat protection email notification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_NoActionEmail_Subject
-NoActionEmail_TextBody <String>
The body of an email notification formatted in plaintext. Choose an HtmlBody or a TextBody to send an HTML-formatted or plaintext message, respectively.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_NoActionEmail_TextBody
-NotifyConfiguration_From <String>
The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_From
-NotifyConfiguration_ReplyTo <String>
The reply-to email address of an email template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_ReplyTo
-NotifyConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccountTakeoverRiskConfiguration_NotifyConfiguration_SourceArn
-RiskExceptionConfiguration_BlockedIPRangeList <String[]>
An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RiskExceptionConfiguration_SkippedIPRangeList <String[]>
An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RiskConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoIdentityProvider.Model.SetRiskConfigurationResponse). Specifying the name of a property of type Amazon.CognitoIdentityProvider.Model.SetRiskConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserPoolId <String>
The ID of the user pool where you want to set a risk configuration. If you include UserPoolId in your request, don't include ClientId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both ClientId and UserPoolId, Amazon Cognito maps the configuration to the app client only.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CognitoIdentityProvider.Model.RiskConfigurationType or Amazon.CognitoIdentityProvider.Model.SetRiskConfigurationResponse
This cmdlet returns an Amazon.CognitoIdentityProvider.Model.RiskConfigurationType object. The service call response (type Amazon.CognitoIdentityProvider.Model.SetRiskConfigurationResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z