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 [`SearchPlaceIndexForPosition`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_name(impl Into<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::set_index_name):<br>required: **true**<br><p>The name of the place index resource you want to use for the search.</p><br>
    ///   - [`position(f64)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::position) / [`set_position(Option<Vec::<f64>>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::set_position):<br>required: **true**<br><p>Specifies the longitude and latitude of the position to query.</p> <p>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 a position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter. The maximum number of results returned per request.</p> <p>Default value: <code>50</code></p><br>
    ///   - [`language(impl Into<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::language) / [`set_language(Option<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::set_language):<br>required: **false**<br><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, but not the results themselves. 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 a location around Athens, Greece, with the <code>language</code> parameter set to <code>en</code>. The <code>city</code> in the results will most likely be returned as <code>Athens</code>.</p> <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the <code>city</code> in the results 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><br>
    ///   - [`key(impl Into<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::set_key):<br>required: **false**<br><p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p><br>
    /// - On success, responds with [`SearchPlaceIndexForPositionOutput`](crate::operation::search_place_index_for_position::SearchPlaceIndexForPositionOutput) with field(s):
    ///   - [`summary(Option<SearchPlaceIndexForPositionSummary>)`](crate::operation::search_place_index_for_position::SearchPlaceIndexForPositionOutput::summary): <p>Contains a summary of the request. Echoes the input values for <code>Position</code>, <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of the place index.</p>
    ///   - [`results(Vec::<SearchForPositionResult>)`](crate::operation::search_place_index_for_position::SearchPlaceIndexForPositionOutput::results): <p>Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.</p>
    /// - On failure, responds with [`SdkError<SearchPlaceIndexForPositionError>`](crate::operation::search_place_index_for_position::SearchPlaceIndexForPositionError)
    pub fn search_place_index_for_position(
        &self,
    ) -> crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder {
        crate::operation::search_place_index_for_position::builders::SearchPlaceIndexForPositionFluentBuilder::new(self.handle.clone())
    }
}