Skip to content

RouteAvoidanceOptions

Source code in docs_src/capo_geo_routes/types/route_avoidance_options.py
class RouteAvoidanceOptions(TypedDict, closed=True):
    areas: NotRequired[
        "capo_geo_routes.types.route_avoidance_area_list.RouteAvoidanceAreaList"
    ]
    """<p> Areas to be avoided. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    car_shuttle_trains: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p> Avoid car-shuttle-trains while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    controlled_access_highways: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>Avoid controlled access highways while calculating the route.</p>"""
    dirt_roads: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p> Avoid dirt roads while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    ferries: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoid ferries while calculating the route.</p>"""
    seasonal_closure: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p> Avoid roads that have seasonal closure while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    toll_roads: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoids roads where the specified toll transponders are the only mode of payment.</p>"""
    toll_transponders: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p> Avoids roads where the specified toll transponders are the only mode of payment. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    truck_road_types: NotRequired[
        "capo_geo_routes.types.truck_road_type_list.TruckRoadTypeList"
    ]
    """<p> Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>"""
    tunnels: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p> Avoid tunnels while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    u_turns: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p> Avoid U-turns for calculation on highways and motorways. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""
    zone_categories: NotRequired[
        "capo_geo_routes.types.route_avoidance_zone_category_list.RouteAvoidanceZoneCategoryList"
    ]
    """<p> Zone categories to be avoided. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>"""

areas instance-attribute

areas: NotRequired[RouteAvoidanceAreaList]

Areas to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

car_shuttle_trains instance-attribute

car_shuttle_trains: NotRequired[SensitiveBoolean]

Avoid car-shuttle-trains while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

controlled_access_highways instance-attribute

controlled_access_highways: NotRequired[SensitiveBoolean]

Avoid controlled access highways while calculating the route.

dirt_roads instance-attribute

dirt_roads: NotRequired[SensitiveBoolean]

Avoid dirt roads while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

ferries instance-attribute

ferries: NotRequired[SensitiveBoolean]

Avoid ferries while calculating the route.

seasonal_closure instance-attribute

seasonal_closure: NotRequired[SensitiveBoolean]

Avoid roads that have seasonal closure while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

toll_roads instance-attribute

toll_roads: NotRequired[SensitiveBoolean]

Avoids roads where the specified toll transponders are the only mode of payment.

toll_transponders instance-attribute

toll_transponders: NotRequired[SensitiveBoolean]

Avoids roads where the specified toll transponders are the only mode of payment. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

truck_road_types instance-attribute

truck_road_types: NotRequired[TruckRoadTypeList]

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

There are currently no other supported values as of 26th April 2024.

tunnels instance-attribute

tunnels: NotRequired[SensitiveBoolean]

Avoid tunnels while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

u_turns instance-attribute

u_turns: NotRequired[SensitiveBoolean]

Avoid U-turns for calculation on highways and motorways. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

zone_categories instance-attribute

zone_categories: NotRequired[RouteAvoidanceZoneCategoryList]

Zone categories to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.