/AWS1/CL_LOC=>SRCHPLACEINDEXFORSUGGESTIONS()¶
About SearchPlaceIndexForSuggestions¶
Generates suggestions for addresses and points of interest based on partial or misspelled free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy matching.
Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.
You can search for suggested place names near a specified position by using
BiasPosition, or filter results within a bounding box by using
FilterBBox. These parameters are mutually exclusive; using both
BiasPosition and FilterBBox in the same command
returns an error.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_INDEXNAME TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME¶
The name of the place index resource you want to use for the search.
IV_TEXT TYPE /AWS1/LOCSENSITIVESTRING /AWS1/LOCSENSITIVESTRING¶
The free-form partial text to use to generate place suggestions. For example,
eiffel tow.
Optional arguments:¶
IT_BIASPOSITION TYPE /AWS1/CL_LOCPOSITION_W=>TT_POSITION TT_POSITION¶
An optional parameter that indicates a preference for place suggestions that are closer to a specified position.
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.
For example,
[-123.1174, 49.2847]represents the position with longitude-123.1174and latitude49.2847.
BiasPositionandFilterBBoxare mutually exclusive. Specifying both options results in an error.
IT_FILTERBBOX TYPE /AWS1/CL_LOCBOUNDINGBOX_W=>TT_BOUNDINGBOX TT_BOUNDINGBOX¶
An optional parameter that limits the search results by returning only suggestions within a specified bounding box.
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.
For example,
[-12.7935, -37.4835, -12.0684, -36.9542]represents a bounding box where the southwest corner has longitude-12.7935and latitude-37.4835, and the northeast corner has longitude-12.0684and latitude-36.9542.
FilterBBoxandBiasPositionare mutually exclusive. Specifying both options results in an error.
IT_FILTERCOUNTRIES TYPE /AWS1/CL_LOCCOUNTRYCODELIST_W=>TT_COUNTRYCODELIST TT_COUNTRYCODELIST¶
An optional parameter that limits the search results by returning only suggestions within the provided list of countries.
Use the ISO 3166 3-digit country code. For example, Australia uses three upper-case characters:
AUS.
IV_MAXRESULTS TYPE /AWS1/LOCINTEGER /AWS1/LOCINTEGER¶
An optional parameter. The maximum number of results returned per request.
The default:
5
IV_LANGUAGE TYPE /AWS1/LOCLANGUAGETAG /AWS1/LOCLANGUAGETAG¶
The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,
enfor English.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.
For an example, we'll use the Greek language. You search for
Athens, Grto get suggestions with thelanguageparameter set toen. The results found will most likely be returned asAthens, Greece.If you set the
languageparameter toel, for Greek, then the result found will more likely be returned asΑθήνα, Ελλάδα.If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
IT_FILTERCATEGORIES TYPE /AWS1/CL_LOCFILTPLACECATLIST_W=>TT_FILTERPLACECATEGORYLIST TT_FILTERPLACECATEGORYLIST¶
A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
IV_KEY TYPE /AWS1/LOCAPIKEY /AWS1/LOCAPIKEY¶
The optional API key to authorize the request.