Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetEvaluationFormValidation

Retrieves the status and results of a validation process started by StartEvaluationFormValidation. Returns the current execution status (IN_PROGRESS, COMPLETED, or FAILED), the validated form version, and when completed, a list of findings that identify structural issues and quality improvements for the evaluation form, and may include suggested fixes. If the validation failed, a reason is provided indicating the cause of the failure.

Request Syntax


GET /evaluation-forms/InstanceId/EvaluationFormId/validation-results?version=EvaluationFormVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EvaluationFormId

The unique identifier for the evaluation form.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

EvaluationFormVersion

The version of the evaluation form to retrieve validation results for.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormId": "string",
   "EvaluationFormVersion": number,
   "FailureReason": "string",
   "Findings": [ 
      { 
         "Description": "string",
         "IssueCode": "string",
         "Items": [ 
            { 
               "Property": "string",
               "RefId": "string"
            }
         ],
         "Severity": "string",
         "Suggestion": "string"
      }
   ],
   "StartedTime": number,
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EvaluationFormId

The unique identifier for the evaluation form.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

EvaluationFormVersion

A version of the evaluation form.

Type: Integer

FailureReason

The reason the validation failed. This field is populated only when the status is FAILED.

Type: String

Findings

A list of findings from the validation process. Each finding identifies a structural issue or quality improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is COMPLETED.

Type: Array of EvaluationFormValidationFinding objects

StartedTime

The timestamp when the validation process was started.

Type: Timestamp

Status

The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.

Type: String

Valid Values: IN_PROGRESS | COMPLETED | FAILED

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

The following example retrieves validation results for an evaluation form. The request does not have a request body.

Sample Response


{
   "Status": "COMPLETED",
   "EvaluationFormVersion": 1,
   "EvaluationFormId": "[evaluation_form_id]",
   "StartedTime": "2026-04-20T16:00:15.015Z",
   "Findings": [
      {
         "IssueCode": "DUPLICATE_OPTION_TEXT",
         "Description": "All answer options for a question must have unique text",
         "Severity": "ERROR",
         "Items": [
            {
               "RefId": "question_1_1"
            }
         ]
      }
   ]
}