aws_sdk_connect/client/
search_contact_flows.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchContactFlows`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::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>
    ///   - [`max_results(i32)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`search_filter(ContactFlowSearchFilter)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::search_filter) / [`set_search_filter(Option<ContactFlowSearchFilter>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to be applied to search results.</p><br>
    ///   - [`search_criteria(ContactFlowSearchCriteria)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::search_criteria) / [`set_search_criteria(Option<ContactFlowSearchCriteria>)`](crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to be used to return flows.</p><note>  <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.</p> </note><br>
    /// - On success, responds with [`SearchContactFlowsOutput`](crate::operation::search_contact_flows::SearchContactFlowsOutput) with field(s):
    ///   - [`contact_flows(Option<Vec::<ContactFlow>>)`](crate::operation::search_contact_flows::SearchContactFlowsOutput::contact_flows): <p>Information about the flows.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_contact_flows::SearchContactFlowsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_contact_flows::SearchContactFlowsOutput::approximate_total_count): <p>The total number of flows which matched your search query.</p>
    /// - On failure, responds with [`SdkError<SearchContactFlowsError>`](crate::operation::search_contact_flows::SearchContactFlowsError)
    pub fn search_contact_flows(&self) -> crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder {
        crate::operation::search_contact_flows::builders::SearchContactFlowsFluentBuilder::new(self.handle.clone())
    }
}