aws_sdk_connect/client/
search_contacts.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchContacts`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`time_range(SearchContactsTimeRange)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::time_range) / [`set_time_range(Option<SearchContactsTimeRange>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::set_time_range):<br>required: **true**<br><p>Time range that you want to search results.</p><br>
    ///   - [`search_criteria(SearchCriteria)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::search_criteria) / [`set_search_criteria(Option<SearchCriteria>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to be used to return contacts.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::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>
    ///   - [`sort(Sort)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::sort) / [`set_sort(Option<Sort>)`](crate::operation::search_contacts::builders::SearchContactsFluentBuilder::set_sort):<br>required: **false**<br><p>Specifies a field to sort by and a sort order.</p><br>
    /// - On success, responds with [`SearchContactsOutput`](crate::operation::search_contacts::SearchContactsOutput) with field(s):
    ///   - [`contacts(Vec::<ContactSearchSummary>)`](crate::operation::search_contacts::SearchContactsOutput::contacts): <p>Information about the contacts.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_contacts::SearchContactsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
    ///   - [`total_count(Option<i64>)`](crate::operation::search_contacts::SearchContactsOutput::total_count): <p>The total number of contacts which matched your search query.</p>
    /// - On failure, responds with [`SdkError<SearchContactsError>`](crate::operation::search_contacts::SearchContactsError)
    pub fn search_contacts(&self) -> crate::operation::search_contacts::builders::SearchContactsFluentBuilder {
        crate::operation::search_contacts::builders::SearchContactsFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_connect/client/search_contacts.rs

aws_sdk_connect/client/
search_contacts.rs
