SearchForSuggestionsResult
Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.
Contents
- Text
-
The text of the place suggestion, typically formatted as an address string.
Type: String
Required: Yes
- Categories
-
The Amazon Location categories that describe the Place.
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 10 items.
Length Constraints: Minimum length of 0. Maximum length of 35.
Required: No
- PlaceId
-
The unique identifier of the Place. You can use this with the
GetPlaceoperation to find the place again later, or to get full information for the Place.The
GetPlacerequest must use the samePlaceIndexresource as theSearchPlaceIndexForSuggestionsthat generated the Place ID.Note
For
SearchPlaceIndexForSuggestionsoperations, thePlaceIdis returned by place indexes that use Esri, Grab, or HERE as data providers.Type: String
Required: No
- SupplementalCategories
-
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 0. Maximum length of 35.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
