Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Location Service Places V2

Client for invoking operations on Amazon Location Service Places V2. Each operation on Amazon Location Service Places V2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_geoplaces::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_geoplaces::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the Autocomplete operation has a Client::autocomplete, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.autocomplete()
    .query_text("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn autocomplete(&self) -> AutocompleteFluentBuilder

Constructs a fluent builder for the Autocomplete operation.

• The fluent builder is configurable:
  • query_text(impl Into<String>) / set_query_text(Option<String>):
    required: true
    

    The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

    The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

    
    
  • filter(AutocompleteFilter) / set_filter(Option<AutocompleteFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • postal_code_mode(PostalCodeMode) / set_postal_code_mode(Option<PostalCodeMode>):
    required: false
    

    The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it’s populated with the value cityLookup, all cities in that postal code are returned.

    
    
  • additional_features(AutocompleteAdditionalFeature) / set_additional_features(Option<Vec::<AutocompleteAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(AutocompleteIntendedUse) / set_intended_use(Option<AutocompleteIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with AutocompleteOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<AutocompleteResultItem>>):

    List of places or results returned for a query.

• On failure, responds with SdkError<AutocompleteError>

impl Client

pub fn geocode(&self) -> GeocodeFluentBuilder

Constructs a fluent builder for the Geocode operation.

• The fluent builder is configurable:
  • query_text(impl Into<String>) / set_query_text(Option<String>):
    required: false
    

    The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

    
    
  • query_components(GeocodeQueryComponents) / set_query_components(Option<GeocodeQueryComponents>):
    required: false
    

    A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

    The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

    
    
  • filter(GeocodeFilter) / set_filter(Option<GeocodeFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • additional_features(GeocodeAdditionalFeature) / set_additional_features(Option<Vec::<GeocodeAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters, such as time zone, that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(GeocodeIntendedUse) / set_intended_use(Option<GeocodeIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with GeocodeOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<GeocodeResultItem>>):

    List of places or results returned for a query.

• On failure, responds with SdkError<GeocodeError>

impl Client

pub fn get_place(&self) -> GetPlaceFluentBuilder

Constructs a fluent builder for the GetPlace operation.

• The fluent builder is configurable:
  • place_id(impl Into<String>) / set_place_id(Option<String>):
    required: true
    

    The PlaceId of the place you wish to receive the information for.

    
    
  • additional_features(GetPlaceAdditionalFeature) / set_additional_features(Option<Vec::<GetPlaceAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters such as time zone that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(GetPlaceIntendedUse) / set_intended_use(Option<GetPlaceIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with GetPlaceOutput with field(s):
  • place_id(String):

    The PlaceId of the place you wish to receive the information for.

  • place_type(PlaceType):

    A PlaceType is a category that the result place must belong to.

  • title(String):

    The localized display name of this result item based on request parameter language.

  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • address(Option<Address>):

    The place’s address.

  • address_number_corrected(Option<bool>):

    Boolean indicating if the address provided has been corrected.

  • postal_code_details(Option<Vec::<PostalCodeDetails>>):

    Contains details about the postal code of the place/result.

  • position(Option<Vec::<f64>>):

    The position, in longitude and latitude.

  • map_view(Option<Vec::<f64>>):

    The bounding box enclosing the geometric shape (area or line) that an individual result covers.

    The bounding box formed is defined as a set of four coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

  • categories(Option<Vec::<Category>>):

    Categories of results that results must belong to.

  • food_types(Option<Vec::<FoodType>>):

    List of food types offered by this result.

  • business_chains(Option<Vec::<BusinessChain>>):

    The Business Chains associated with the place.

  • contacts(Option<Contacts>):

    List of potential contact methods for the result/place.

  • opening_hours(Option<Vec::<OpeningHours>>):

    List of opening hours objects.

  • access_points(Option<Vec::<AccessPoint>>):

    Position of the access point in (lng,lat).

  • access_restrictions(Option<Vec::<AccessRestriction>>):

    Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

  • time_zone(Option<TimeZone>):

    The time zone in which the place is located.

  • political_view(Option<String>):

    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.

  • phonemes(Option<PhonemeDetails>):

    How the various components of the result’s address are pronounced in various languages.

• On failure, responds with SdkError<GetPlaceError>

impl Client

pub fn reverse_geocode(&self) -> ReverseGeocodeFluentBuilder

Constructs a fluent builder for the ReverseGeocode operation.

• The fluent builder is configurable:
  • query_position(f64) / set_query_position(Option<Vec::<f64>>):
    required: true
    

    The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

    
    
  • query_radius(i64) / set_query_radius(Option<i64>):
    required: false
    

    The maximum distance in meters from the QueryPosition from which a result will be returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • filter(ReverseGeocodeFilter) / set_filter(Option<ReverseGeocodeFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • additional_features(ReverseGeocodeAdditionalFeature) / set_additional_features(Option<Vec::<ReverseGeocodeAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters, such as time zone that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(ReverseGeocodeIntendedUse) / set_intended_use(Option<ReverseGeocodeIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with ReverseGeocodeOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<ReverseGeocodeResultItem>>):

    List of places or results returned for a query.

• On failure, responds with SdkError<ReverseGeocodeError>

impl Client

pub fn search_nearby(&self) -> SearchNearbyFluentBuilder

Constructs a fluent builder for the SearchNearby operation.

• The fluent builder is configurable:
  • query_position(f64) / set_query_position(Option<Vec::<f64>>):
    required: true
    

    The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

    
    
  • query_radius(i64) / set_query_radius(Option<i64>):
    required: false
    

    The maximum distance in meters from the QueryPosition from which a result will be returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • filter(SearchNearbyFilter) / set_filter(Option<SearchNearbyFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • additional_features(SearchNearbyAdditionalFeature) / set_additional_features(Option<Vec::<SearchNearbyAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters, such as time zone, that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(SearchNearbyIntendedUse) / set_intended_use(Option<SearchNearbyIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with SearchNearbyOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<SearchNearbyResultItem>>):

    List of places or results returned for a query.

  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

• On failure, responds with SdkError<SearchNearbyError>

impl Client

pub fn search_text(&self) -> SearchTextFluentBuilder

Constructs a fluent builder for the SearchText operation.

• The fluent builder is configurable:
  • query_text(impl Into<String>) / set_query_text(Option<String>):
    required: false
    

    The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: false
    

    The query Id.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

    The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

    
    
  • filter(SearchTextFilter) / set_filter(Option<SearchTextFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • additional_features(SearchTextAdditionalFeature) / set_additional_features(Option<Vec::<SearchTextAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters, such as time zone, that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(SearchTextIntendedUse) / set_intended_use(Option<SearchTextIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with SearchTextOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<SearchTextResultItem>>):

    List of places or results returned for a query.

  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

• On failure, responds with SdkError<SearchTextError>

impl Client

pub fn suggest(&self) -> SuggestFluentBuilder

Constructs a fluent builder for the Suggest operation.

• The fluent builder is configurable:
  • query_text(impl Into<String>) / set_query_text(Option<String>):
    required: true
    

    The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional limit for the number of results returned in a single call.

    
    
  • max_query_refinements(i32) / set_max_query_refinements(Option<i32>):
    required: false
    

    Maximum number of query terms to be returned for use with a search text query.

    
    
  • bias_position(f64) / set_bias_position(Option<Vec::<f64>>):
    required: false
    

    The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

    The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

    
    
  • filter(SuggestFilter) / set_filter(Option<SuggestFilter>):
    required: false
    

    A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

    
    
  • additional_features(SuggestAdditionalFeature) / set_additional_features(Option<Vec::<SuggestAdditionalFeature>>):
    required: false
    

    A list of optional additional parameters, such as time zone, that can be requested for each result.

    
    
  • language(impl Into<String>) / set_language(Option<String>):
    required: false
    

    A list of BCP 47 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.

    
    
  • political_view(impl Into<String>) / set_political_view(Option<String>):
    required: false
    

    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.

    
    
  • intended_use(SuggestIntendedUse) / set_intended_use(Option<SuggestIntendedUse>):
    required: false
    

    Indicates if the results will be stored. Defaults to SingleUse, if left empty.

    
    
  • key(impl Into<String>) / set_key(Option<String>):
    required: false
    

    Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    
    
• On success, responds with SuggestOutput with field(s):
  • pricing_bucket(String):

    The pricing bucket for which the query is charged at.

    For more inforamtion on pricing, please visit Amazon Location Service Pricing.

  • result_items(Option<Vec::<SuggestResultItem>>):

    List of places or results returned for a query.

  • query_refinements(Option<Vec::<QueryRefinement>>):

    Maximum number of query terms to be returned for use with a search text query.

• On failure, responds with SdkError<SuggestError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.