aws_sdk_connect/client/
search_predefined_attributes.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchPredefinedAttributes`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::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_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::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_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`search_criteria(PredefinedAttributeSearchCriteria)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::search_criteria) / [`set_search_criteria(Option<PredefinedAttributeSearchCriteria>)`](crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to be used to return predefined attributes.</p><br>
    /// - On success, responds with [`SearchPredefinedAttributesOutput`](crate::operation::search_predefined_attributes::SearchPredefinedAttributesOutput) with field(s):
    ///   - [`predefined_attributes(Option<Vec::<PredefinedAttribute>>)`](crate::operation::search_predefined_attributes::SearchPredefinedAttributesOutput::predefined_attributes): <p>Predefined attributes matched by the search criteria.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_predefined_attributes::SearchPredefinedAttributesOutput::next_token): <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>
    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_predefined_attributes::SearchPredefinedAttributesOutput::approximate_total_count): <p>The approximate number of predefined attributes which matched your search query.</p>
    /// - On failure, responds with [`SdkError<SearchPredefinedAttributesError>`](crate::operation::search_predefined_attributes::SearchPredefinedAttributesError)
    pub fn search_predefined_attributes(&self) -> crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder {
        crate::operation::search_predefined_attributes::builders::SearchPredefinedAttributesFluentBuilder::new(self.handle.clone())
    }
}