adminUpdateAuthEventFeedback method

Future<void> adminUpdateAuthEventFeedback({ required String eventId, required FeedbackValueType feedbackValue, required String userPoolId, required String username, })

Provides the feedback for an authentication event generated by threat protection features. Your 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.

To train the threat-protection model to recognize trusted and untrusted sign-in characteristics, configure threat protection in audit-only mode and provide a mechanism for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree with.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

May throw InternalErrorException. May throw InvalidParameterException. May throw NotAuthorizedException. May throw OperationNotEnabledException. May throw ResourceNotFoundException. May throw TooManyRequestsException. May throw UserNotFoundException. May throw UserPoolAddOnNotEnabledException.

Parameter eventId : The ID of the threat protection authentication event that you want to update.

Parameter feedbackValue : 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.

Parameter userPoolId : The ID of the user pool where you want to submit authentication-event feedback.

Parameter username : 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.

Implementation

Future<void> adminUpdateAuthEventFeedback({
  required String eventId,
  required FeedbackValueType feedbackValue,
  required String userPoolId,
  required String username,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.AdminUpdateAuthEventFeedback'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'EventId': eventId,
      'FeedbackValue': feedbackValue.value,
      'UserPoolId': userPoolId,
      'Username': username,
    },
  );
}