aws_sdk_connect/client/
search_contact_evaluations.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 [`SearchContactEvaluations`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect 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    ///   - [`next_token(impl Into<String>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
9    ///   - [`search_criteria(EvaluationSearchCriteria)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::search_criteria) / [`set_search_criteria(Option<EvaluationSearchCriteria>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to be used to return contact evaluations.</p><br>
10    ///   - [`search_filter(EvaluationSearchFilter)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::search_filter) / [`set_search_filter(Option<EvaluationSearchFilter>)`](crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to be applied to search results.</p><br>
11    /// - On success, responds with [`SearchContactEvaluationsOutput`](crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput) with field(s):
12    ///   - [`evaluation_search_summary_list(Option<Vec::<EvaluationSearchSummary>>)`](crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput::evaluation_search_summary_list): <p>Contains information about contact evaluations.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
14    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput::approximate_total_count): <p>The total number of contact evaluations that matched your search query.</p>
15    /// - On failure, responds with [`SdkError<SearchContactEvaluationsError>`](crate::operation::search_contact_evaluations::SearchContactEvaluationsError)
16    pub fn search_contact_evaluations(&self) -> crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder {
17        crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsFluentBuilder::new(self.handle.clone())
18    }
19}