Suggest - Amazon Location Service
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

Suggest

Suggest provides intelligent predictions or recommendations based on the user’s input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.

Request Syntax

POST /suggest?key=Key HTTP/1.1
Content-type: application/json

{
   "AdditionalFeatures": [ "string" ],
   "BiasPosition": [ number ],
   "Filter": { 
      "BoundingBox": [ number ],
      "Circle": { 
         "Center": [ number ],
         "Radius": number
      },
      "IncludeCountries": [ "string" ]
   },
   "IntendedUse": "string",
   "Language": "string",
   "MaxQueryRefinements": number,
   "MaxResults": number,
   "PoliticalView": "string",
   "QueryText": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Key

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

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

Request Body

The request accepts the following data in JSON format.

AdditionalFeatures

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

Type: Array of strings

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

Valid Values: Core | TimeZone | Phonemes | Access

Required: No

BiasPosition

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.

Note

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

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

Filter

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

Type: SuggestFilter object

Required: No

IntendedUse

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

Type: String

Valid Values: SingleUse

Required: No

Language

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.

Type: String

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

Required: No

MaxQueryRefinements

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

Type: Integer

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

Required: No

MaxResults

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

Type: Integer

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

Required: No

PoliticalView

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.

Type: String

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

Pattern: ([A-Z]{2}|[A-Z]{3})

Required: No

QueryText

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.

Note

The fields QueryText, and QueryID are mutually exclusive.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200
x-amz-geo-pricing-bucket: PricingBucket
Content-type: application/json

{
   "QueryRefinements": [ 
      { 
         "EndIndex": number,
         "OriginalTerm": "string",
         "RefinedTerm": "string",
         "StartIndex": number
      }
   ],
   "ResultItems": [ 
      { 
         "Highlights": { 
            "Address": { 
               "Label": [ 
                  { 
                     "EndIndex": number,
                     "StartIndex": number,
                     "Value": "string"
                  }
               ]
            },
            "Title": [ 
               { 
                  "EndIndex": number,
                  "StartIndex": number,
                  "Value": "string"
               }
            ]
         },
         "Place": { 
            "AccessPoints": [ 
               { 
                  "Position": [ number ]
               }
            ],
            "AccessRestrictions": [ 
               { 
                  "Categories": [ 
                     { 
                        "Id": "string",
                        "LocalizedName": "string",
                        "Name": "string",
                        "Primary": boolean
                     }
                  ],
                  "Restricted": boolean
               }
            ],
            "Address": { 
               "AddressNumber": "string",
               "Block": "string",
               "Building": "string",
               "Country": { 
                  "Code2": "string",
                  "Code3": "string",
                  "Name": "string"
               },
               "District": "string",
               "Intersection": [ "string" ],
               "Label": "string",
               "Locality": "string",
               "PostalCode": "string",
               "Region": { 
                  "Code": "string",
                  "Name": "string"
               },
               "Street": "string",
               "StreetComponents": [ 
                  { 
                     "BaseName": "string",
                     "Direction": "string",
                     "Language": "string",
                     "Prefix": "string",
                     "Suffix": "string",
                     "Type": "string",
                     "TypePlacement": "string",
                     "TypeSeparator": "string"
                  }
               ],
               "SubBlock": "string",
               "SubDistrict": "string",
               "SubRegion": { 
                  "Code": "string",
                  "Name": "string"
               }
            },
            "BusinessChains": [ 
               { 
                  "Id": "string",
                  "Name": "string"
               }
            ],
            "Categories": [ 
               { 
                  "Id": "string",
                  "LocalizedName": "string",
                  "Name": "string",
                  "Primary": boolean
               }
            ],
            "Distance": number,
            "FoodTypes": [ 
               { 
                  "Id": "string",
                  "LocalizedName": "string",
                  "Primary": boolean
               }
            ],
            "MapView": [ number ],
            "Phonemes": { 
               "Address": { 
                  "Block": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "Country": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "District": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "Locality": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "Region": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "Street": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "SubBlock": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "SubDistrict": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ],
                  "SubRegion": [ 
                     { 
                        "Language": "string",
                        "Preferred": boolean,
                        "Value": "string"
                     }
                  ]
               },
               "Title": [ 
                  { 
                     "Language": "string",
                     "Preferred": boolean,
                     "Value": "string"
                  }
               ]
            },
            "PlaceId": "string",
            "PlaceType": "string",
            "PoliticalView": "string",
            "Position": [ number ],
            "TimeZone": { 
               "Name": "string",
               "Offset": "string",
               "OffsetSeconds": number
            }
         },
         "Query": { 
            "QueryId": "string",
            "QueryType": "string"
         },
         "SuggestResultItemType": "string",
         "Title": "string"
      }
   ]
}

Response Elements

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

The response returns the following HTTP headers.

PricingBucket

The pricing bucket for which the query is charged at.

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

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

QueryRefinements

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

Type: Array of QueryRefinement objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

ResultItems

List of places or results returned for a query.

Type: Array of SuggestResultItem objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: