Skip to content

Retrieves the status and results of a validation process started by StartEvaluationFormValidation

Description

Retrieves the status and results of a validation process started by start_evaluation_form_validation. 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.

Usage

connect_get_evaluation_form_validation(InstanceId, EvaluationFormId,
  EvaluationFormVersion)

Arguments

  • InstanceId

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

  • EvaluationFormId

[required] The unique identifier for the evaluation form.

  • EvaluationFormVersion

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

Value

A list with the following syntax:

list(
  Status = "IN_PROGRESS"|"COMPLETED"|"FAILED",
  FailureReason = "string",
  EvaluationFormId = "string",
  EvaluationFormVersion = 123,
  StartedTime = as.POSIXct(
    "2015-01-01"
  ),
  Findings = list(
    list(
      IssueCode = "string",
      Items = list(
        list(
          RefId = "string",
          Property = "string"
        )
      ),
      Description = "string",
      Suggestion = "string",
      Severity = "WARNING"|"ERROR"
    )
  )
)

Request syntax

svc$get_evaluation_form_validation(
  InstanceId = "string",
  EvaluationFormId = "string",
  EvaluationFormVersion = 123
)