evaluation_form_validations

Creates, updates, deletes, gets or lists an evaluation_form_validations resource.

Overview

Name	evaluation_form_validations
Type	Resource
Id	aws.connect.evaluation_form_validations

Fields

The following fields are returned by SELECT queries:

get_evaluation_form_validation

Name	Datatype	Description
evaluation_form_id	string	The unique identifier for the evaluation form.
evaluation_form_version	integer	A version of the evaluation form.
failure_reason	string	The reason the validation failed. This field is populated only when the status is FAILED.
findings	array	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.
started_time	string (date-time)	The timestamp when the validation process was started.
status	string	The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED. (IN_PROGRESS, COMPLETED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_evaluation_form_validation	select	instance_id, evaluation_form_id, region	version	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
evaluation_form_id	string	The unique identifier for the evaluation form.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
version	integer	The version of the evaluation form to retrieve validation results for.

SELECT examples

get_evaluation_form_validation

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.

SELECT
evaluation_form_id,
evaluation_form_version,
failure_reason,
findings,
started_time,
status
FROM aws.connect.evaluation_form_validations
WHERE instance_id = '{{ instance_id }}' -- required
AND evaluation_form_id = '{{ evaluation_form_id }}' -- required
AND region = '{{ region }}' -- required
AND version = '{{ version }}'
;