Update Auth Event Feedback

cognitoidentityprovider_update_auth_event_feedback

R Documentation

Provides the feedback for an authentication event generated by threat protection features

Description

Provides the feedback for an authentication event generated by threat protection features. The user's response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier.

This operation requires a FeedbackToken that Amazon Cognito generates and adds to notification emails when users have potentially suspicious authentication events. Users invoke this operation when they select the link that corresponds to {one-click-link-valid} or {one-click-link-invalid} in your notification template. Because FeedbackToken is a required parameter, you can' make requests to update_auth_event_feedback without the contents of the notification email message.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Usage

cognitoidentityprovider_update_auth_event_feedback(UserPoolId, Username,
  EventId, FeedbackToken, FeedbackValue)

Arguments

UserPoolId	[required] The ID of the user pool where you want to update auth event feedback.
Username	[required] The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
EventId	[required] The ID of the authentication event that you want to submit feedback for.
FeedbackToken	[required] The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in the notification email message from the event.
FeedbackValue	[required] Your feedback to the authentication event. When you provide a FeedbackValue value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue value of invalid, you tell Amazon Cognito that you don't trust a user session, or you don't believe that Amazon Cognito evaluated a high-enough risk level.

Value

An empty list.

Request syntax

svc$update_auth_event_feedback(
  UserPoolId = "string",
  Username = "string",
  EventId = "string",
  FeedbackToken = "string",
  FeedbackValue = "Valid"|"Invalid"
)