AutocompleteResultItem
A result matching the input query text.
Contents
- PlaceId
-
The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- PlaceType
-
PlaceType describes the type of result entry returned.
Type: String
Valid Values:
Country | Region | SubRegion | Locality | District | SubDistrict | PostalCode | Block | SubBlock | Intersection | Street | PointOfInterest | PointAddress | InterpolatedAddress
Required: Yes
- Title
-
A formatted string for display when presenting this result to an end user.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- Address
-
The address associated with this result.
Type: Address object
Required: No
- Distance
-
The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 4294967295.
Required: No
- Highlights
-
Indicates the starting and ending index of the place in the text query that match the found title.
Type: AutocompleteHighlights object
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
- 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: Fixed length of 3.
Pattern:
[A-Z]{3}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: