// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`SearchPlaceIndexForSuggestions`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`index_name(impl Into<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_index_name): <p>The name of the place index resource you want to use for the search.</p>
/// - [`text(impl Into<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::text) / [`set_text(Option<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_text): <p>The free-form partial text to use to generate place suggestions. For example, <code>eiffel tow</code>.</p>
/// - [`bias_position(Vec<f64>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::bias_position) / [`set_bias_position(Option<Vec<f64>>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_bias_position): <p>An optional parameter that indicates a preference for place suggestions that are closer to a specified position.</p> <p> If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p> <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p> <note> <p> <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error. </p> </note>
/// - [`filter_b_box(Vec<f64>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::filter_b_box) / [`set_filter_b_box(Option<Vec<f64>>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_filter_b_box): <p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p> <p> If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p> <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p> <note> <p> <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error. </p> </note>
/// - [`filter_countries(Vec<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::filter_countries) / [`set_filter_countries(Option<Vec<String>>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_filter_countries): <p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p> <ul> <li> <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country code. For example, Australia uses three upper-case characters: <code>AUS</code>.</p> </li> </ul>
/// - [`max_results(i32)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_max_results): <p>An optional parameter. The maximum number of results returned per request. </p> <p>The default: <code>5</code> </p>
/// - [`language(impl Into<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::language) / [`set_language(Option<String>)`](crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::set_language): <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> for English.</p> <p>This setting affects the languages used in the results. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p> <p>For an example, we'll use the Greek language. You search for <code>Athens, Gr</code> to get suggestions with the <code>language</code> parameter set to <code>en</code>. The results found will most likely be returned as <code>Athens, Greece</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα, Ελλάδα</code>.</p> <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>
/// - On success, responds with [`SearchPlaceIndexForSuggestionsOutput`](crate::operation::search_place_index_for_suggestions::SearchPlaceIndexForSuggestionsOutput) with field(s):
/// - [`summary(Option<SearchPlaceIndexForSuggestionsSummary>)`](crate::operation::search_place_index_for_suggestions::SearchPlaceIndexForSuggestionsOutput::summary): <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>, <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>, and <code>Text</code>. Also includes the <code>DataSource</code> of the place index. </p>
/// - [`results(Option<Vec<SearchForSuggestionsResult>>)`](crate::operation::search_place_index_for_suggestions::SearchPlaceIndexForSuggestionsOutput::results): <p>A list of place suggestions that best match the search text.</p>
/// - On failure, responds with [`SdkError<SearchPlaceIndexForSuggestionsError>`](crate::operation::search_place_index_for_suggestions::SearchPlaceIndexForSuggestionsError)
pub fn search_place_index_for_suggestions(&self) -> crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder{
crate::operation::search_place_index_for_suggestions::builders::SearchPlaceIndexForSuggestionsFluentBuilder::new(self.handle.clone())
}
}