RouteAvoidanceOptions
Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.
Contents
- Areas
-
Areas to be avoided.
Type: Array of RouteAvoidanceArea objects
Required: No
- CarShuttleTrains
-
Avoid car-shuttle-trains while calculating the route.
Type: Boolean
Required: No
- ControlledAccessHighways
-
Avoid controlled access highways while calculating the route.
Type: Boolean
Required: No
- DirtRoads
-
Avoid dirt roads while calculating the route.
Type: Boolean
Required: No
- Ferries
-
Avoid ferries while calculating the route.
Type: Boolean
Required: No
- SeasonalClosure
-
Avoid roads that have seasonal closure while calculating the route.
Type: Boolean
Required: No
- TollRoads
-
Avoids roads where the specified toll transponders are the only mode of payment.
Type: Boolean
Required: No
- TollTransponders
-
Avoids roads where the specified toll transponders are the only mode of payment.
Type: Boolean
Required: No
- TruckRoadTypes
-
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.Note
There are currently no other supported values as of 26th April 2024.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 12 items.
Length Constraints: Minimum length of 1. Maximum length of 3.
Required: No
- Tunnels
-
Avoid tunnels while calculating the route.
Type: Boolean
Required: No
- UTurns
-
Avoid U-turns for calculation on highways and motorways.
Type: Boolean
Required: No
- ZoneCategories
-
Zone categories to be avoided.
Type: Array of RouteAvoidanceZoneCategory objects
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
