aws_sdk_iot/client/
search_index.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 [`SearchIndex`](crate::operation::search_index::builders::SearchIndexFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`index_name(impl Into<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::set_index_name):<br>required: **false**<br><p>The search index name.</p><br>
7    ///   - [`query_string(impl Into<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::query_string) / [`set_query_string(Option<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::set_query_string):<br>required: **true**<br><p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::set_next_token):<br>required: **false**<br><p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p><br>
10    ///   - [`query_version(impl Into<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::query_version) / [`set_query_version(Option<String>)`](crate::operation::search_index::builders::SearchIndexFluentBuilder::set_query_version):<br>required: **false**<br><p>The query version.</p><br>
11    /// - On success, responds with [`SearchIndexOutput`](crate::operation::search_index::SearchIndexOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::search_index::SearchIndexOutput::next_token): <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
13    ///   - [`things(Option<Vec::<ThingDocument>>)`](crate::operation::search_index::SearchIndexOutput::things): <p>The things that match the search query.</p>
14    ///   - [`thing_groups(Option<Vec::<ThingGroupDocument>>)`](crate::operation::search_index::SearchIndexOutput::thing_groups): <p>The thing groups that match the search query.</p>
15    /// - On failure, responds with [`SdkError<SearchIndexError>`](crate::operation::search_index::SearchIndexError)
16    pub fn search_index(&self) -> crate::operation::search_index::builders::SearchIndexFluentBuilder {
17        crate::operation::search_index::builders::SearchIndexFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_iot/client/search_index.rs

aws_sdk_iot/client/
search_index.rs
