AWS cli documentation change
Summary
Updated AWS CLI version references and added detailed specifications for routing boundary configurations including maximum origins/destinations, matrix size limits, and geometric constraints
Security assessment
The changes primarily clarify operational limits and geometric constraints for route calculations. While they enforce boundary restrictions that could prevent oversized requests, there's no evidence of addressing a specific security vulnerability. The changes document service limits and data formatting requirements rather than security features.
Diff
diff --git a/cli/latest/reference/geo-routes/calculate-route-matrix.md b/cli/latest/reference/geo-routes/calculate-route-matrix.md index 53f6eecdb..69b5d87f8 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.57 Command Reference](../../index.html) » + * [AWS CLI 2.34.61 Command Reference](../../index.html) » @@ -368 +368 @@ JSON Syntax: -> List of destinations for the route. +> List of destinations for the route in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -372,0 +373,16 @@ JSON Syntax: +> +> The maximum number of destinations depends on the routing boundary configuration: +> +> * With `RoutingBoundary.Geometry` set: maximum 500 destinations +> * With `RoutingBoundary.Unbounded` set to `true` : maximum 100 destinations +> * For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers in `ap-southeast-1` and `ap-southeast-5` : maximum 350 destinations +> + +> +> The total matrix size (origins × destinations) must not exceed: +> +> * With `RoutingBoundary.Geometry` : 160,000 +> * With `RoutingBoundary.Unbounded` : 100 +> * For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers in `ap-southeast-1` and `ap-southeast-5` : 122,500 +> + @@ -586 +602 @@ JSON Syntax: -> The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude]. +> List of origins for the route in World Geodetic System (WGS 84) format: [longitude, latitude]. @@ -590,0 +607,16 @@ JSON Syntax: +> +> The maximum number of origins depends on the routing boundary configuration: +> +> * With `RoutingBoundary.Geometry` set: maximum 500 origins +> * With `RoutingBoundary.Unbounded` set to `true` : maximum 15 origins +> * For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers in `ap-southeast-1` and `ap-southeast-5` : maximum 350 origins +> + +> +> The total matrix size (origins × destinations) must not exceed: +> +> * With `RoutingBoundary.Geometry` : 160,000 +> * With `RoutingBoundary.Unbounded` : 100 +> * For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers in `ap-southeast-1` and `ap-southeast-5` : 122,500 +> + @@ -747 +779 @@ JSON Syntax: -> When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings. +> When `AutoCircle` is set in the request, the response routing boundary will return `Circle` derived from the `AutoCircle` settings. @@ -755 +787,3 @@ JSON Syntax: ->>> Provides the circle that was used while calculating the route. +>>> > `AutoCircle` requests the route matrix service to define a `Circle` boundary that best attempts to include most waypoints (`Origins` and `Destinations` ) using the `AutoCircle` settings. Any waypoints outside of the auto-defined `Circle` boundary will be considered out of the routing boundary, which results in a route matrix entry error. +>>>> +>>>> `AutoCircle` is only used in the request to configure a `Circle` for the route calculation. The derived `Circle` will also be provided in the response. @@ -759 +793,3 @@ JSON Syntax: ->>>> The margin provided for the calculation. +>>>> The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary. +>>>> +>>>> The total of `MaxRadius` and `Margin` must be less than or equal to 200,000 meters. @@ -770 +806,3 @@ JSON Syntax: ->>>> The maximum size of the radius provided for the calculation. +>>>> The maximum radius, in meters, that the auto-defined `Circle` boundary should have, before the `Margin` distance is added to the circle. +>>>> +>>>> The total of `MaxRadius` and `Margin` must be less than or equal to 200,000 meters. @@ -781 +819,3 @@ JSON Syntax: ->>> Geometry defined as a circle. When request routing boundary was set as `AutoCircle` , the response routing boundary will return `Circle` derived from the `AutoCircle` settings. +>>> Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error. +>>> +>>> You can specify a `Circle` directly in the request, or it will be auto-derived when `AutoCircle` is used. When `AutoCircle` is set in the request, the response routing boundary will return `Circle` derived from the `AutoCircle` settings. @@ -802,0 +843,2 @@ JSON Syntax: +>>>> +>>>> Valid Range: Minimum value of 0. Maximum value of 200000. @@ -807,0 +850,2 @@ JSON Syntax: +>>> Diagonal distance of the bounding box must be less than or equal to 400,000 meters. +>>> @@ -819 +863,5 @@ JSON Syntax: ->>> Geometry defined as a polygon with only one linear ring. +>>> Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format. +>>> +>>> The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude]. +>>> +>>> Maximum distance between any two vertices must be less than or equal to 400,000 meters. @@ -1572 +1620 @@ RoutingBoundary -> (structure) -> When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings. +> When `AutoCircle` is set in the request, the response routing boundary will return `Circle` derived from the `AutoCircle` settings. @@ -1580 +1628,3 @@ RoutingBoundary -> (structure) ->>> Provides the circle that was used while calculating the route. +>>> > `AutoCircle` requests the route matrix service to define a `Circle` boundary that best attempts to include most waypoints (`Origins` and `Destinations` ) using the `AutoCircle` settings. Any waypoints outside of the auto-defined `Circle` boundary will be considered out of the routing boundary, which results in a route matrix entry error. +>>>> +>>>> `AutoCircle` is only used in the request to configure a `Circle` for the route calculation. The derived `Circle` will also be provided in the response. @@ -1584 +1634,3 @@ RoutingBoundary -> (structure) ->>>> The margin provided for the calculation. +>>>> The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary. +>>>> +>>>> The total of `MaxRadius` and `Margin` must be less than or equal to 200,000 meters. @@ -1595 +1647,3 @@ RoutingBoundary -> (structure) ->>>> The maximum size of the radius provided for the calculation. +>>>> The maximum radius, in meters, that the auto-defined `Circle` boundary should have, before the `Margin` distance is added to the circle. +>>>> +>>>> The total of `MaxRadius` and `Margin` must be less than or equal to 200,000 meters. @@ -1606 +1660,3 @@ RoutingBoundary -> (structure) ->>> Geometry defined as a circle. When request routing boundary was set as `AutoCircle` , the response routing boundary will return `Circle` derived from the `AutoCircle` settings. +>>> Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error. +>>> +>>> You can specify a `Circle` directly in the request, or it will be auto-derived when `AutoCircle` is used. When `AutoCircle` is set in the request, the response routing boundary will return `Circle` derived from the `AutoCircle` settings. @@ -1627,0 +1684,2 @@ RoutingBoundary -> (structure) +>>>> +>>>> Valid Range: Minimum value of 0. Maximum value of 200000. @@ -1632,0 +1691,2 @@ RoutingBoundary -> (structure) +>>> Diagonal distance of the bounding box must be less than or equal to 400,000 meters. +>>> @@ -1644 +1704,5 @@ RoutingBoundary -> (structure) ->>> Geometry defined as a polygon with only one linear ring. +>>> Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format. +>>> +>>> The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude]. +>>> +>>> Maximum distance between any two vertices must be less than or equal to 400,000 meters. @@ -1686 +1750 @@ RoutingBoundary -> (structure) - * [AWS CLI 2.34.57 Command Reference](../../index.html) » + * [AWS CLI 2.34.61 Command Reference](../../index.html) »