start_evaluation_form_validation ¶

def start_evaluation_form_validation(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId",
    evaluation_form_version: "capo_connect.types.version_number.VersionNumber",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.start_evaluation_form_validation_response.StartEvaluationFormValidationResponse":
    """<p>Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetEvaluationFormValidation.html">GetEvaluationFormValidation</a> to retrieve the status and results once the validation completes.</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 validate.</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_conflict_exception.ResourceConflictException: <p>A resource already has that name.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota has been exceeded.</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.start_evaluation_form_validation_request.StartEvaluationFormValidationRequest]",
    ) -> OperationResponse[
        "capo_connect.types.start_evaluation_form_validation_response.StartEvaluationFormValidationResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.start_evaluation_form_validation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartEvaluationFormValidation")
    )
    input_: capo_connect.types.start_evaluation_form_validation_request.StartEvaluationFormValidationRequest = {
        "instance_id": instance_id,
        "evaluation_form_id": evaluation_form_id,
        "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