Skip to content
/ location-service Public

Commit e43b5ef

Browse files
async-aws-botstof
async-aws-bot
and
stof
authored
Update generated code (#1964)
* update generated code * Update changelogs --------- Co-authored-by: Christophe Coevoet <stof@notk.org>
1 parent 529fc15 commit e43b5ef

2 files changed

Lines changed: 81 additions & 16 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
### Changed
66

77
- Apply new CodingStandard from latest php-cs-fixer.
8+
- AWS enhancement: Documentation updates.
89

910
## 1.1.2
1011

‎src/LocationServiceClient.php‎

Lines changed: 80 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,46 @@
2929
class LocationServiceClient extends AbstractApi
3030
{
3131
/**
32-
* Calculates a route [^1] given the following required parameters: `DeparturePosition` and `DestinationPosition`.
33-
* Requires that you first create a route calculator resource [^2].
32+
* ! This operation is no longer current and may be deprecated in the future. We recommend you upgrade to
33+
* ! `CalculateRoutes` [^1] or `CalculateIsolines` [^2] unless you require Grab data.
34+
* !
35+
* ! - `CalculateRoute` is part of a previous Amazon Location Service Routes API (version 1) which has been superseded
36+
* ! by a more intuitive, powerful, and complete API (version 2).
37+
* ! - The version 2 `CalculateRoutes` operation gives better results for point-to-point routing, while the version 2
38+
* ! `CalculateIsolines` operation adds support for calculating service areas and travel time envelopes.
39+
* ! - If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is
40+
* ! found under `geo-routes` or `geo_routes`, not under `location`.
41+
* ! - Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when
42+
* ! using Grab.
43+
* !
44+
*
45+
* Calculates a route [^3] given the following required parameters: `DeparturePosition` and `DestinationPosition`.
46+
* Requires that you first create a route calculator resource [^4].
3447
*
3548
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic
3649
* conditions when calculating the route.
3750
*
3851
* Additional options include:
3952
*
40-
* - Specifying a departure time [^3] using either `DepartureTime` or `DepartNow`. This calculates a route based on
53+
* - Specifying a departure time [^5] using either `DepartureTime` or `DepartNow`. This calculates a route based on
4154
* predictive traffic data at the given time.
4255
*
4356
* > You can't specify both `DepartureTime` and `DepartNow` in a single request. Specifying both parameters returns a
4457
* > validation error.
4558
*
46-
* - Specifying a travel mode [^4] using TravelMode sets the transportation mode used to calculate the routes. This also
59+
* - Specifying a travel mode [^6] using TravelMode sets the transportation mode used to calculate the routes. This also
4760
* lets you specify additional route preferences in `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if
4861
* traveling by `Truck`.
4962
*
5063
* > If you specify `walking` for the travel mode and your data provider is Esri, the start and destination must be
5164
* > within 40km.
5265
*
53-
* [^1]: https://docs.aws.amazon.com/location/previous/developerguide/calculate-route.html
54-
* [^2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
55-
* [^3]: https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html
56-
* [^4]: https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html
66+
* [^1]: /location/latest/APIReference/API_CalculateRoutes.html
67+
* [^2]: /location/latest/APIReference/API_CalculateIsolines.html
68+
* [^3]: https://docs.aws.amazon.com/location/previous/developerguide/calculate-route.html
69+
* [^4]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
70+
* [^5]: https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html
71+
* [^6]: https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html
5772
*
5873
* @see https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRoute.html
5974
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-geo-2020-11-19.html#calculateroute
@@ -97,7 +112,20 @@ public function calculateRoute($input): CalculateRouteResponse
97112
}
98113

99114
/**
100-
* Calculates a route matrix [^1] given the following required parameters: `DeparturePositions` and
115+
* ! This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2
116+
* ! `CalculateRouteMatrix` [^1] unless you require Grab data.
117+
* !
118+
* ! - This version of `CalculateRouteMatrix` is part of a previous Amazon Location Service Routes API (version 1) which
119+
* ! has been superseded by a more intuitive, powerful, and complete API (version 2).
120+
* ! - The version 2 `CalculateRouteMatrix` operation gives better results for matrix routing calculations.
121+
* ! - If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is
122+
* ! found under `geo-routes` or `geo_routes`, not under `location`.
123+
* ! - Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when
124+
* ! using Grab.
125+
* ! - Start your version 2 API journey with the Routes V2 API Reference [^2] or the Developer Guide [^3].
126+
* !
127+
*
128+
* Calculates a route matrix [^4] given the following required parameters: `DeparturePositions` and
101129
* `DestinationPositions`. `CalculateRouteMatrix` calculates routes and returns the travel time and travel distance from
102130
* each departure position to each destination position in the request. For example, given departure positions A and B,
103131
* and destination positions X and Y, `CalculateRouteMatrix` will return time and distance for routes from A to X, A to
@@ -106,27 +134,30 @@ public function calculateRoute($input): CalculateRouteResponse
106134
*
107135
* > Your account is charged for each route calculated, not the number of requests.
108136
*
109-
* Requires that you first create a route calculator resource [^2].
137+
* Requires that you first create a route calculator resource [^5].
110138
*
111139
* By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic
112140
* conditions when calculating routes.
113141
*
114142
* Additional options include:
115143
*
116-
* - Specifying a departure time [^3] using either `DepartureTime` or `DepartNow`. This calculates routes based on
144+
* - Specifying a departure time [^6] using either `DepartureTime` or `DepartNow`. This calculates routes based on
117145
* predictive traffic data at the given time.
118146
*
119147
* > You can't specify both `DepartureTime` and `DepartNow` in a single request. Specifying both parameters returns a
120148
* > validation error.
121149
*
122-
* - Specifying a travel mode [^4] using TravelMode sets the transportation mode used to calculate the routes. This also
150+
* - Specifying a travel mode [^7] using TravelMode sets the transportation mode used to calculate the routes. This also
123151
* lets you specify additional route preferences in `CarModeOptions` if traveling by `Car`, or `TruckModeOptions` if
124152
* traveling by `Truck`.
125153
*
126-
* [^1]: https://docs.aws.amazon.com/location/previous/developerguide/calculate-route-matrix.html
127-
* [^2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
128-
* [^3]: https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html
129-
* [^4]: https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html
154+
* [^1]: /location/latest/APIReference/API_CalculateRouteMatrix.html
155+
* [^2]: /location/latest/APIReference/API_Operations_Amazon_Location_Service_Routes_V2.html
156+
* [^3]: /location/latest/developerguide/routes.html
157+
* [^4]: https://docs.aws.amazon.com/location/previous/developerguide/calculate-route-matrix.html
158+
* [^5]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
159+
* [^6]: https://docs.aws.amazon.com/location/previous/developerguide/departure-time.html
160+
* [^7]: https://docs.aws.amazon.com/location/previous/developerguide/travel-mode.html
130161
*
131162
* @see https://docs.aws.amazon.com/location/latest/APIReference/API_CalculateRouteMatrix.html
132163
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-geo-2020-11-19.html#calculateroutematrix
@@ -166,9 +197,26 @@ public function calculateRouteMatrix($input): CalculateRouteMatrixResponse
166197
}
167198

168199
/**
200+
* ! This operation is no longer current and may be deprecated in the future. We recommend you upgrade to
201+
* ! `ReverseGeocode` [^1] or `SearchNearby` [^2] unless you require Grab data.
202+
* !
203+
* ! - `SearchPlaceIndexForPosition` is part of a previous Amazon Location Service Places API (version 1) which has been
204+
* ! superseded by a more intuitive, powerful, and complete API (version 2).
205+
* ! - The version 2 `ReverseGeocode` operation gives better results in the address reverse-geocoding use case, while
206+
* ! the version 2 `SearchNearby` operation gives better results when searching for businesses and points of interest
207+
* ! near a specific location.
208+
* ! - If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is
209+
* ! found under `geo-places` or `geo_places`, not under `location`.
210+
* ! - Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when
211+
* ! using Grab.
212+
* !
213+
*
169214
* Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of
170215
* interest near a given position.
171216
*
217+
* [^1]: /location/latest/APIReference/API_geoplaces_ReverseGeocode.html
218+
* [^2]: /location/latest/APIReference/API_geoplaces_SearchNearby.html
219+
*
172220
* @see https://docs.aws.amazon.com/location/latest/APIReference/API_SearchPlaceIndexForPosition.html
173221
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-geo-2020-11-19.html#searchplaceindexforposition
174222
*
@@ -202,6 +250,19 @@ public function searchPlaceIndexForPosition($input): SearchPlaceIndexForPosition
202250
}
203251

204252
/**
253+
* ! This operation is no longer current and may be deprecated in the future. We recommend you upgrade to `Geocode` [^1]
254+
* ! or `SearchText` [^2] unless you require Grab data.
255+
* !
256+
* ! - `SearchPlaceIndexForText` is part of a previous Amazon Location Service Places API (version 1) which has been
257+
* ! superseded by a more intuitive, powerful, and complete API (version 2).
258+
* ! - The version 2 `Geocode` operation gives better results in the address geocoding use case, while the version 2
259+
* ! `SearchText` operation gives better results when searching for businesses and points of interest.
260+
* ! - If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is
261+
* ! found under `geo-places` or `geo_places`, not under `location`.
262+
* ! - Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when
263+
* ! using Grab.
264+
* !
265+
*
205266
* Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of
206267
* interest.
207268
*
@@ -213,6 +274,9 @@ public function searchPlaceIndexForPosition($input): SearchPlaceIndexForPosition
213274
*
214275
* Search results are returned in order of highest to lowest relevance.
215276
*
277+
* [^1]: /location/latest/APIReference/API_geoplaces_Geocode.html
278+
* [^2]: /location/latest/APIReference/API_geoplaces_SearchText.html
279+
*
216280
* @see https://docs.aws.amazon.com/location/latest/APIReference/API_SearchPlaceIndexForText.html
217281
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-geo-2020-11-19.html#searchplaceindexfortext
218282
*

0 commit comments

Comments
 (0)