Skip to content

SearchForSuggestionsResult

Source code in docs_src/capo_location/types/search_for_suggestions_result.py 
16
17
18
19
20
21
22
23
24
25
26
class SearchForSuggestionsResult(TypedDict, closed=True):
    text: "capo_location.types.sensitive_string.SensitiveString"
    """<p>The text of the place suggestion, typically formatted as an address string.</p>"""
    place_id: NotRequired["capo_location.types.place_id.PlaceId"]
    """<p>The unique identifier of the Place. You can use this with the <code>GetPlace</code> operation to find the place again later, or to get full information for the Place.</p> <p>The <code>GetPlace</code> request must use the same <code>PlaceIndex</code> resource as the <code>SearchPlaceIndexForSuggestions</code> that generated the Place ID.</p> <note> <p>For <code>SearchPlaceIndexForSuggestions</code> operations, the <code>PlaceId</code> is returned by place indexes that use Esri, Grab, or HERE as data providers.</p> </note>"""
    categories: NotRequired["capo_location.types.place_category_list.PlaceCategoryList"]
    """<p>The Amazon Location categories that describe the Place.</p> <p>For more information about using categories, including a list of Amazon Location categories, see <a href="https://docs.aws.amazon.com/location/previous/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service developer guide</i>.</p>"""
    supplemental_categories: NotRequired[
        "capo_location.types.place_supplemental_category_list.PlaceSupplementalCategoryList"
    ]
    """<p>Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.</p>"""

categories instance-attribute 

categories: NotRequired[PlaceCategoryList]

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.

place_id instance-attribute 

place_id: NotRequired[PlaceId]

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.

supplemental_categories instance-attribute 

supplemental_categories: NotRequired[PlaceSupplementalCategoryList]

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

text instance-attribute 

text: SensitiveString

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