startEvaluationFormValidation method

Future<StartEvaluationFormValidationResponse> startEvaluationFormValidation({
  1. required String evaluationFormId,
  2. required int evaluationFormVersion,
  3. required String instanceId,
})

Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes.

May throw InternalServiceException. May throw InvalidParameterException. May throw ResourceConflictException. May throw ResourceNotFoundException. May throw ServiceQuotaExceededException. May throw ThrottlingException.

Parameter evaluationFormId : The unique identifier for the evaluation form.

Parameter evaluationFormVersion : The version of the evaluation form to validate.

Parameter instanceId : The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Implementation

Future<StartEvaluationFormValidationResponse> startEvaluationFormValidation({
  required String evaluationFormId,
  required int evaluationFormVersion,
  required String instanceId,
}) async {
  final $payload = <String, dynamic>{
    'EvaluationFormVersion': evaluationFormVersion,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/evaluation-forms/${Uri.encodeComponent(instanceId)}/${Uri.encodeComponent(evaluationFormId)}/validate',
    exceptionFnMap: _exceptionFns,
  );
  return StartEvaluationFormValidationResponse.fromJson(response);
}