get_evaluation_form_validation ¶

def get_evaluation_form_validation(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    evaluation_form_version: Optional[
        "capo_connect.types.version_number.VersionNumber"
    ] = None,
) -> "capo_connect.types.get_evaluation_form_validation_response.GetEvaluationFormValidationResponse":
    """<p>Retrieves the status and results of a validation process started by <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartEvaluationFormValidation.html">StartEvaluationFormValidation</a>. Returns the current execution status (<code>IN_PROGRESS</code>, <code>COMPLETED</code>, or <code>FAILED</code>), 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.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        evaluation_form_id: <p>The unique identifier for the evaluation form.</p>
        evaluation_form_version: <p>The version of the evaluation form to retrieve validation results for.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.get_evaluation_form_validation_request.GetEvaluationFormValidationRequest]",
    ) -> OperationResponse[
        "capo_connect.types.get_evaluation_form_validation_response.GetEvaluationFormValidationResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.get_evaluation_form_validation

        output, http_response = (
            capo_connect._operations.amazon_connect_service.get_evaluation_form_validation.get_evaluation_form_validation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEvaluationFormValidation")
    )
    input_: capo_connect.types.get_evaluation_form_validation_request.GetEvaluationFormValidationRequest = {
        "instance_id": instance_id,
        "evaluation_form_id": evaluation_form_id,
    }
    if evaluation_form_version is not None:
        input_["evaluation_form_version"] = evaluation_form_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output