AWS location: Adds Places (V1) concepts deprecation notice and V2 guidance
Summary
Retitles page to 'Places (V1) concepts', replaces the note with an Important V1 deprecation notice, documents the newer `geo-places` operations, and repoints API reference links to the previous-version path.
Security assessment
Documentation-only change clarifying older vs. newer Places API versions; nothing addresses a vulnerability, secret handling, or access control.
Evidence
+**This page documents the previous Places API (V1). Use it only for existing applications.** The Places V2 API is the latest version. Use it for all new applications; see the latest [Amazon Location Service Places](https://docs.aws.amazon.com/location/latest/developerguide/places.html) developer guide.
Diff
diff --git a/location/previous/developerguide/places-concepts.md b/location/previous/developerguide/places-concepts.md index 3035fc0e3..f3142098e 100644 --- a//location/previous/developerguide/places-concepts.md +++ b//location/previous/developerguide/places-concepts.md @@ -9 +9 @@ Geocoding conceptsSearch resultsMultiple results and relevanceAddress resultsSto -# Learn about Places search in Amazon Location Service +# Places (V1) concepts @@ -11 +11,3 @@ Geocoding conceptsSearch resultsMultiple results and relevanceAddress resultsSto -###### Note +###### Important + +**This page documents the previous Places API (V1). Use it only for existing applications.** The Places V2 API is the latest version. Use it for all new applications; see the latest [Amazon Location Service Places](https://docs.aws.amazon.com/location/latest/developerguide/places.html) developer guide. @@ -13 +15,3 @@ Geocoding conceptsSearch resultsMultiple results and relevanceAddress resultsSto -We released a new version of the Places API, see the updated [Places Developer Guide](https://docs.aws.amazon.com/location/latest/developerguide/places.html) for revised information. +The latest operations are `Geocode`, `ReverseGeocode`, `SearchText`, `SearchNearby`, `Suggest`, `Autocomplete`, and `GetPlace`. These operations are under the `geo-places` namespace. They are exposed as `@aws-sdk/client-geo-places` for JavaScript and `boto3.client('geo-places')` for Python. + +The `SearchPlaceIndexForText`, `SearchPlaceIndexForPosition`, `SearchPlaceIndexForSuggestions`, and `PlaceIndex` resources described below are previous-generation. Use them only for existing applications. @@ -19 +23 @@ A key function of Amazon Location Service is the ability to search the geolocati -For information about how to use place index resources to search in practice, see [Searching place and geolocation data using Amazon Location](./searching-for-places.html). +For information about how to use place index resources to search in practice, see [Searching place and geolocation data with Places (V1)](./searching-for-places.html). @@ -57 +61 @@ The following shows you how to create and use place index resources: -An Amazon Location place index provides an action called [`SearchPlaceIndexForText`](https://docs.aws.amazon.com/location-places/latest/APIReference/API_SearchPlaceIndexForText.html) that allows you to specify text to search. For example, you can search for: +An Amazon Location place index provides an action called [`SearchPlaceIndexForText`](https://docs.aws.amazon.com/location/previous/APIReference/API_SearchPlaceIndexForText.html) that allows you to specify text to search. For example, you can search for: @@ -70 +74,5 @@ Searching for text in this way is generally referred to as **geocoding** , which -Amazon Location Service also provides a **reverse geocoding** action called [`SearchPlaceIndexForPosition`](https://docs.aws.amazon.com/location-places/latest/APIReference/API_SearchPlaceIndexForPosition.html). This takes a geographic location and returns the address, business, or other information about what is at that location. +Amazon Location Service also provides a **reverse geocoding** action called [`SearchPlaceIndexForPosition`](https://docs.aws.amazon.com/location/previous/APIReference/API_SearchPlaceIndexForPosition.html). This takes a geographic location and returns the address, business, or other information about what is at that location. + +###### Note + +For new code, use the latest [`Geocode`](https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Geocode.html) and [`SearchText`](https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html) operations for text search, and [`ReverseGeocode`](https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_ReverseGeocode.html) for reverse geocoding, under `geo-places`. These do not require a place index resource. See the latest [Amazon Location Service Places](https://docs.aws.amazon.com/location/latest/developerguide/places.html) developer guide. @@ -92 +100 @@ In an interactive application, you can use relevance to help decide whether to a -You can search for addresses with Amazon Location Service using the same [`SearchPlaceIndexForText`](https://docs.aws.amazon.com/location-places/latest/APIReference/API_SearchPlaceIndexForText.html) action. The more information that you provide, the more likely the address returned will match the one given. For example, `123 Main St` is less likely to find a correct result than `123 Main St, Anytown, California, 90210`. +You can search for addresses with Amazon Location Service using the same [`SearchPlaceIndexForText`](https://docs.aws.amazon.com/location/previous/APIReference/API_SearchPlaceIndexForText.html) action. The more information that you provide, the more likely the address returned will match the one given. For example, `123 Main St` is less likely to find a correct result than `123 Main St, Anytown, California, 90210`. @@ -136,0 +145,2 @@ Allows you to choose a data source to support search queries. For example, you c +The latest API has no place index resource. Search operations under `geo-places` are called directly. See the latest [Amazon Location Service Places](https://docs.aws.amazon.com/location/latest/developerguide/places.html) developer guide. + @@ -141,0 +152,2 @@ Geocoding is the process of taking a text input, searching for it in the place i +For new code, see the latest [`Geocode`](https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Geocode.html) operation under `geo-places`. + @@ -146,0 +159,2 @@ Reverse geocoding is the process of taking a position and returning information +For new code, see the latest [`ReverseGeocode`](https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_ReverseGeocode.html) operation under `geo-places`. + @@ -170 +184 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Learn about Maps resources +Maps (V1)