Connect / Client / get_evaluation_form_validation

get_evaluation_form_validation

Connect.Client.get_evaluation_form_validation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_evaluation_form_validation(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • EvaluationFormId (string) –

    [REQUIRED]

    The unique identifier for the evaluation form.

  • EvaluationFormVersion (integer) – The version of the evaluation form to retrieve validation results for.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'FailureReason': 'string',
    'EvaluationFormId': 'string',
    'EvaluationFormVersion': 123,
    'StartedTime': datetime(2015, 1, 1),
    'Findings': [
        {
            'IssueCode': 'string',
            'Items': [
                {
                    'RefId': 'string',
                    'Property': 'string'
                },
            ],
            'Description': 'string',
            'Suggestion': 'string',
            'Severity': 'WARNING'|'ERROR'
        },
    ]
}

Response Structure

  • (dict) –

    • Status (string) –

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

    • FailureReason (string) –

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

    • EvaluationFormId (string) –

      The unique identifier for the evaluation form.

    • EvaluationFormVersion (integer) –

      A version of the evaluation form.

    • StartedTime (datetime) –

      The timestamp when the validation process was started.

    • Findings (list) –

      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.

      • (dict) –

        Information about a finding from the evaluation form validation process. Each finding identifies a structural issue or quality improvement opportunity for the evaluation form.

        • IssueCode (string) –

          A code that identifies the type of validation issue found.

        • Items (list) –

          A list of evaluation form items affected by this finding.

          • (dict) –

            Information about an evaluation form item affected by a validation finding.

            • RefId (string) –

              The identifier of the evaluation form item (question or section) affected by the finding.

            • Property (string) –

              The specific property of the evaluation form item that the finding relates to.

        • Description (string) –

          A description of the validation issue.

        • Suggestion (string) –

          A suggested fix for the validation issue.

        • Severity (string) –

          The severity of the finding. Valid values: WARNING, ERROR.

Exceptions