AWS cli documentation change
Summary
Updated AWS CLI command reference for Amazon Location Service's CalculateRouteMatrix operation. Changes include: updated CLI version from 2.34.21 to 2.34.23; added developer guide links; made --routing-boundary parameter optional; added region-specific limitations for GrabMaps customers in ap-southeast-1 and ap-southeast-5 regions; corrected typos; updated polyline encoding reference; clarified parameter descriptions and units; standardized default value formatting; and improved documentation of position formats and truck specifications.
Security assessment
The changes are routine documentation updates including version updates, typo corrections, clarification of parameter behaviors, and addition of region-specific limitations for GrabMaps customers. There is no evidence of addressing security vulnerabilities, patches, or security incidents. The changes focus on improving documentation clarity, accuracy, and user guidance without introducing or modifying security controls.
Diff
diff --git a/cli/latest/reference/geo-routes/calculate-route-matrix.md b/cli/latest/reference/geo-routes/calculate-route-matrix.md index 4bd73961a..871032227 100644 --- a//cli/latest/reference/geo-routes/calculate-route-matrix.md +++ b//cli/latest/reference/geo-routes/calculate-route-matrix.md @@ -15 +15 @@ - * [AWS CLI 2.34.21 Command Reference](../../index.html) » + * [AWS CLI 2.34.23 Command Reference](../../index.html) » @@ -60,0 +61,2 @@ Use `CalculateRouteMatrix` to compute results for all pairs of Origins to Destin +For more information, see [Calculate route matrix](https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html) in the _Amazon Location Service Developer Guide_ . + @@ -76 +78 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/geo-ro - --routing-boundary <value> + [--routing-boundary <value>] @@ -138 +140 @@ JSON Syntax: -> Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. +> Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `TollRoads` , `Ferries` , and `ControlledAccessHighways` . @@ -204 +206 @@ JSON Syntax: ->>>>> A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see <https://github.com/heremaps/flexiblepolyline/blob/master/README.md> . +>>>>> A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see <https://github.com/aws-geospatial/polyline> . @@ -348 +350 @@ JSON Syntax: -> Time of departure from thr origin. +> Time of departure from the origin. @@ -370 +372 @@ JSON Syntax: -> Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location’s pricing page <https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html>`__ for more information. +> Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see [Routes pricing](https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html) in the _Amazon Location Service Developer Guide_ . @@ -384 +386 @@ JSON Syntax: ->>> Destination related options. +>>> Destination related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. @@ -431 +433 @@ JSON Syntax: ->>>>>> **Unit** : `Meters` +>>>>>> **Unit** : `meters` @@ -457 +459 @@ JSON Syntax: ->>>>> Position defined as `[longitude, latitude]` . +>>>>> Position in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -472 +474 @@ JSON Syntax: ->>>>> Default Value: `DividedStreetOnly` +>>>>> Default value: `DividedStreetOnly` @@ -483 +485 @@ JSON Syntax: ->>> Position defined as `[longitude, latitude]` . +>>> Position in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -521 +523 @@ JSON Syntax: -> Features to be strictly excluded while calculating the route. +> Features to be strictly excluded while calculating the route. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. @@ -571 +573 @@ JSON Syntax: -> Specifies the optimization criteria for calculating a route. +> Controls the trade-off between finding the shortest travel time (`FastestRoute` ) and the shortest distance (`ShortestRoute` ) when calculating reachable areas. @@ -573 +575 @@ JSON Syntax: -> Default Value: `FastestRoute` +> Default value: `FastestRoute` @@ -584 +586 @@ JSON Syntax: -> The position in longitude and latitude for the origin. +> The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -588 +590 @@ JSON Syntax: -> Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location’s pricing page <https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html>`__ for more information. +> Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see [Routes pricing](https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html) in the _Amazon Location Service Developer Guide_ . @@ -598 +600 @@ JSON Syntax: ->> The start position for the route. +>> The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -602 +604 @@ JSON Syntax: ->>> Origin related options. +>>> Origin related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. @@ -649 +651 @@ JSON Syntax: ->>>>>> **Unit** : `Meters` +>>>>>> **Unit** : `meters` @@ -675 +677 @@ JSON Syntax: ->>>>> Position defined as `[longitude, latitude]` . +>>>>> Position in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -690 +692 @@ JSON Syntax: ->>>>> Default Value: `DividedStreetOnly` +>>>>> Default value: `DividedStreetOnly` @@ -701 +703 @@ JSON Syntax: ->>> Position defined as `[longitude, latitude]` . +>>> Position in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -737 +739 @@ JSON Syntax: -`--routing-boundary` (structure) [required] +`--routing-boundary` (structure) @@ -739 +741,3 @@ JSON Syntax: -> Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. +> Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `Unbounded` set to `true` . +> +> Default value: `Unbounded set to true` @@ -781 +785 @@ JSON Syntax: ->>>> Center of the Circle defined in longitude and latitude coordinates. +>>>> Center of the Circle in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -875 +879 @@ JSON Syntax: -> Traffic related options. +> Traffic related options. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. @@ -892 +896 @@ JSON Syntax: ->> Default Value: `UseTrafficData` +>> Default value: `UseTrafficData` @@ -918 +922 @@ JSON Syntax: -> Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. +> Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only `Car` , `Pedestrian` , and `Scooter` . @@ -920 +924 @@ JSON Syntax: -> Default Value: `Car` +> Default value: `Car` @@ -933 +937 @@ JSON Syntax: -> Travel mode related options for the provided travel mode. +> Travel mode related options for the provided travel mode. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers. @@ -937 +941 @@ JSON Syntax: ->> Travel mode options when the provided travel mode is “Car” +>> Travel mode options when the provided travel mode is `Car` . @@ -958 +962 @@ JSON Syntax: ->>>> **Unit** : `KilometersPerHour` +>>>> **Unit** : `kilometers per hour` @@ -971 +975 @@ JSON Syntax: ->>> Default Value: `1` +>>> Default value: `1` @@ -981 +985 @@ JSON Syntax: ->> Travel mode options when the provided travel mode is `Scooter` +>> Travel mode options when the provided travel mode is `Scooter` . @@ -1006 +1010 @@ JSON Syntax: ->>>> **Unit** : `KilometersPerHour` +>>>> **Unit** : `kilometers per hour` @@ -1019 +1023 @@ JSON Syntax: ->>> Default Value: `1` +>>> Default value: `1` @@ -1029 +1033 @@ JSON Syntax: ->> Travel mode options when the provided travel mode is “Truck” +>> Travel mode options when the provided travel mode is `Truck` . @@ -1046 +1050 @@ JSON Syntax: ->>>> **Unit** : `Kilograms` +>>>> **Unit** : `kilograms` @@ -1142 +1146 @@ JSON Syntax: ->>>> **Unit** : `KilometersPerHour` +>>>> **Unit** : `kilometers per hour` @@ -1155 +1159 @@ JSON Syntax: ->>> Default Value: `1` +>>> Default value: `1` @@ -1184 +1188 @@ JSON Syntax: ->>>> Default Value: `0` +>>>> Default value: `0` @@ -1195 +1199 @@ JSON Syntax: ->>> Type of the truck. +>>> The type of truck: `LightTruck` for smaller delivery vehicles, `StraightTruck` for rigid body trucks, or `Tractor` for tractor-trailer combinations. @@ -1237 +1241 @@ JSON Syntax: ->>>> **Unit** : `Kilograms` +>>>> **Unit** : `kilograms` @@ -1252 +1256 @@ JSON Syntax: ->>>> Weight for single axle group. +>>>> Total weight in kilograms for single axle configurations. @@ -1254 +1258 @@ JSON Syntax: ->>>>> **Unit** : `Kilograms` +>>>>> **Unit** : `kilograms` @@ -1265 +1269 @@ JSON Syntax: ->>>> Weight for tandem axle group. +>>>> Total weight in kilograms for tandem (two adjacent) axle configurations. @@ -1267 +1271 @@ JSON Syntax: ->>>>> **Unit** : `Kilograms` +>>>>> **Unit** : `kilograms` @@ -1278 +1282 @@ JSON Syntax: ->>>> Weight for triple axle group. +>>>> Total weight in kilograms for triple (three adjacent) axle configurations. @@ -1280 +1284 @@ JSON Syntax: ->>>>> **Unit** : `Kilograms` +>>>>> **Unit** : `kilograms` @@ -1291 +1295 @@ JSON Syntax: ->>>> Weight for quad axle group. +>>>> Total weight in kilograms for quad (four adjacent) axle configurations. @@ -1293 +1297 @@ JSON Syntax: ->>>>> **Unit** : `Kilograms` +>>>>> **Unit** : `kilograms` @@ -1304 +1308 @@ JSON Syntax: ->>>> Weight for quad quint group. +>>>> Total weight in kilograms for quint (five adjacent) axle configurations. @@ -1306 +1310 @@ JSON Syntax: ->>>>> **Unit** : `Kilograms` +>>>>> **Unit** : `kilograms` @@ -1606 +1610 @@ RoutingBoundary -> (structure) ->>>> Center of the Circle defined in longitude and latitude coordinates. +>>>> Center of the Circle in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -1682 +1686 @@ RoutingBoundary -> (structure) - * [AWS CLI 2.34.21 Command Reference](../../index.html) » + * [AWS CLI 2.34.23 Command Reference](../../index.html) »