aws_sdk_geoplaces/client/

search_nearby.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchNearby`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`query_position(f64)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::query_position) / [`set_query_position(Option<Vec::<f64>>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_query_position):<br>required: **true**<br><p>The position, in <code>\[lng, lat\]</code> for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position</p><br>
    ///   - [`query_radius(i64)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::query_radius) / [`set_query_radius(Option<i64>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_query_radius):<br>required: **false**<br><p>The maximum distance in meters from the QueryPosition from which a result will be returned.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional limit for the number of results returned in a single call.</p><br>
    ///   - [`filter(SearchNearbyFilter)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::filter) / [`set_filter(Option<SearchNearbyFilter>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_filter):<br>required: **false**<br><p>A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.</p><br>
    ///   - [`additional_features(SearchNearbyAdditionalFeature)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::additional_features) / [`set_additional_features(Option<Vec::<SearchNearbyAdditionalFeature>>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_additional_features):<br>required: **false**<br><p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p><br>
    ///   - [`language(impl Into<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::language) / [`set_language(Option<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_language):<br>required: **false**<br><p>A list of <a href="https://en.wikipedia.org/wiki/IETF_language_tag">BCP 47</a> compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.</p><br>
    ///   - [`political_view(impl Into<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::political_view) / [`set_political_view(Option<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_political_view):<br>required: **false**<br><p>The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.</p><br>
    ///   - [`intended_use(SearchNearbyIntendedUse)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::intended_use) / [`set_intended_use(Option<SearchNearbyIntendedUse>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_intended_use):<br>required: **false**<br><p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_next_token):<br>required: **false**<br><p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.</p><br>
    ///   - [`key(impl Into<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::key) / [`set_key(Option<String>)`](crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::set_key):<br>required: **false**<br><p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p><br>
    /// - On success, responds with [`SearchNearbyOutput`](crate::operation::search_nearby::SearchNearbyOutput) with field(s):
    ///   - [`pricing_bucket(String)`](crate::operation::search_nearby::SearchNearbyOutput::pricing_bucket): <p>The pricing bucket for which the query is charged at.</p> <p>For more inforamtion on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
    ///   - [`result_items(Option<Vec::<SearchNearbyResultItem>>)`](crate::operation::search_nearby::SearchNearbyOutput::result_items): <p>List of places or results returned for a query.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_nearby::SearchNearbyOutput::next_token): <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.</p>
    /// - On failure, responds with [`SdkError<SearchNearbyError>`](crate::operation::search_nearby::SearchNearbyError)
    pub fn search_nearby(&self) -> crate::operation::search_nearby::builders::SearchNearbyFluentBuilder {
        crate::operation::search_nearby::builders::SearchNearbyFluentBuilder::new(self.handle.clone())
    }
}