AWSLocationSearchForSuggestionsResult

Objective-C

@interface AWSLocationSearchForSuggestionsResult

Swift

class AWSLocationSearchForSuggestionsResult

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

Required parameters: [Text]

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable categories;

    Swift

    var categories: [String]? { get set }

  • The unique identifier of the Place. You can use this with the GetPlace operation to find the place again later, or to get full information for the Place.

    The GetPlace request must use the same PlaceIndex resource as the SearchPlaceIndexForSuggestions that generated the Place ID.

    For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place indexes that use Esri, Grab, or HERE as data providers.

    While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:

    • Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.

    • HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.

    • Grab: Place IDs can expire or become invalid in the following situations.

      • Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.

      • Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable placeId;

    Swift

    var placeId: String? { get set }

  • Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable supplementalCategories;

    Swift

    var supplementalCategories: [String]? { get set }

  • The text of the place suggestion, typically formatted as an address string.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable text;

    Swift

    var text: String? { get set }