aws_sdk_connect/client/
get_evaluation_form_validation.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetEvaluationFormValidation`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::set_instance_id):<br>required: **true**<br><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><br>
7    ///   - [`evaluation_form_id(impl Into<String>)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::evaluation_form_id) / [`set_evaluation_form_id(Option<String>)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::set_evaluation_form_id):<br>required: **true**<br><p>The unique identifier for the evaluation form.</p><br>
8    ///   - [`evaluation_form_version(i32)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::evaluation_form_version) / [`set_evaluation_form_version(Option<i32>)`](crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::set_evaluation_form_version):<br>required: **false**<br><p>The version of the evaluation form to retrieve validation results for.</p><br>
9    /// - On success, responds with [`GetEvaluationFormValidationOutput`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput) with field(s):
10    ///   - [`status(EvaluationFormValidationStatus)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::status): <p>The current status of the validation process. Valid values: <code>IN_PROGRESS</code>, <code>COMPLETED</code>, <code>FAILED</code>.</p>
11    ///   - [`failure_reason(Option<String>)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::failure_reason): <p>The reason the validation failed. This field is populated only when the status is <code>FAILED</code>.</p>
12    ///   - [`evaluation_form_id(String)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::evaluation_form_id): <p>The unique identifier for the evaluation form.</p>
13    ///   - [`evaluation_form_version(i32)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::evaluation_form_version): <p>A version of the evaluation form.</p>
14    ///   - [`started_time(DateTime)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::started_time): <p>The timestamp when the validation process was started.</p>
15    ///   - [`findings(Option<Vec::<EvaluationFormValidationFinding>>)`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationOutput::findings): <p>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 <code>COMPLETED</code>.</p>
16    /// - On failure, responds with [`SdkError<GetEvaluationFormValidationError>`](crate::operation::get_evaluation_form_validation::GetEvaluationFormValidationError)
17    pub fn get_evaluation_form_validation(
18        &self,
19    ) -> crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder {
20        crate::operation::get_evaluation_form_validation::builders::GetEvaluationFormValidationFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_connect/client/get_evaluation_form_validation.rs

aws_sdk_connect/client/
get_evaluation_form_validation.rs
