RouteMatrixAutoCircle
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.
Contents
- Margin
-
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
MaxRadiusandMarginmust be less than or equal to 200,000 meters.Type: Long
Valid Range: Minimum value of 0. Maximum value of 200000.
Required: No
- MaxRadius
-
The maximum radius, in meters, that the auto-defined
Circleboundary should have, before theMargindistance is added to the circle.The total of
MaxRadiusandMarginmust be less than or equal to 200,000 meters.Type: Long
Valid Range: Minimum value of 0. Maximum value of 200000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
