Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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.

Note

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.

Request Syntax


POST /places/v0/indexes/IndexName/search/suggestions?key=Key HTTP/1.1
Content-type: application/json

{
   "BiasPosition": [ number ],
   "FilterBBox": [ number ],
   "FilterCategories": [ "string" ],
   "FilterCountries": [ "string" ],
   "Language": "string",
   "MaxResults": number,
   "Text": "string"
}

URI Request Parameters

The request uses the following URI parameters.

IndexName

The name of the place index resource you want to use for the search.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

Request Body

The request accepts the following data in JSON format.

BiasPosition

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.1174 and latitude 49.2847.

Note

BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

FilterBBox

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.7935 and latitude -37.4835, and the northeast corner has longitude -12.0684 and latitude -36.9542.

Note

FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

FilterCategories

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 0. Maximum length of 35.

Required: No

FilterCountries

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Fixed length of 3.

Pattern: [A-Z]{3}

Required: No

Language

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for 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, Gr to get suggestions with the language parameter set to en. The results found will most likely be returned as Athens, Greece.

If you set the language parameter to el, 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.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 35.

Required: No

MaxResults

An optional parameter. The maximum number of results returned per request.

The default: 5

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 15.

Required: No

Text

The free-form partial text to use to generate place suggestions. For example, eiffel tow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Results": [ 
      { 
         "Categories": [ "string" ],
         "PlaceId": "string",
         "SupplementalCategories": [ "string" ],
         "Text": "string"
      }
   ],
   "Summary": { 
      "BiasPosition": [ number ],
      "DataSource": "string",
      "FilterBBox": [ number ],
      "FilterCategories": [ "string" ],
      "FilterCountries": [ "string" ],
      "Language": "string",
      "MaxResults": number,
      "Text": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Results

A list of place suggestions that best match the search text.

Type: Array of SearchForSuggestionsResult objects

Summary

Contains a summary of the request. Echoes the input values for BiasPosition, FilterBBox, FilterCountries, Language, MaxResults, and Text. Also includes the DataSource of the place index.

Type: SearchPlaceIndexForSuggestionsSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400