aws_sdk_cloudsearchdomain/client/
suggest.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 [`Suggest`](crate::operation::suggest::builders::SuggestFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`query(impl Into<String>)`](crate::operation::suggest::builders::SuggestFluentBuilder::query) / [`set_query(Option<String>)`](crate::operation::suggest::builders::SuggestFluentBuilder::set_query):<br>required: **true**<br><p>Specifies the string for which you want to get suggestions.</p><br>
7    ///   - [`suggester(impl Into<String>)`](crate::operation::suggest::builders::SuggestFluentBuilder::suggester) / [`set_suggester(Option<String>)`](crate::operation::suggest::builders::SuggestFluentBuilder::set_suggester):<br>required: **true**<br><p>Specifies the name of the suggester to use to find suggested matches.</p><br>
8    ///   - [`size(i64)`](crate::operation::suggest::builders::SuggestFluentBuilder::size) / [`set_size(Option<i64>)`](crate::operation::suggest::builders::SuggestFluentBuilder::set_size):<br>required: **false**<br><p>Specifies the maximum number of suggestions to return.</p><br>
9    /// - On success, responds with [`SuggestOutput`](crate::operation::suggest::SuggestOutput) with field(s):
10    ///   - [`status(Option<SuggestStatus>)`](crate::operation::suggest::SuggestOutput::status): <p>The status of a <code>SuggestRequest</code>. Contains the resource ID (<code>rid</code>) and how long it took to process the request (<code>timems</code>).</p>
11    ///   - [`suggest(Option<SuggestModel>)`](crate::operation::suggest::SuggestOutput::suggest): <p>Container for the matching search suggestion information.</p>
12    /// - On failure, responds with [`SdkError<SuggestError>`](crate::operation::suggest::SuggestError)
13    pub fn suggest(&self) -> crate::operation::suggest::builders::SuggestFluentBuilder {
14        crate::operation::suggest::builders::SuggestFluentBuilder::new(self.handle.clone())
15    }
16}