Skip to content

RouteTravelModeOptions

Used by
Source code in docs_src/capo_geo_routes/types/route_travel_mode_options.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class RouteTravelModeOptions(TypedDict, closed=True):
    car: NotRequired["capo_geo_routes.types.route_car_options.RouteCarOptions"]
    """<p>Travel mode options when the provided travel mode is <code>Car</code>.</p>"""
    pedestrian: NotRequired[
        "capo_geo_routes.types.route_pedestrian_options.RoutePedestrianOptions"
    ]
    """<p>Travel mode options when the provided travel mode is <code>Pedestrian</code>.</p>"""
    scooter: NotRequired[
        "capo_geo_routes.types.route_scooter_options.RouteScooterOptions"
    ]
    """<p>Travel mode options when the provided travel mode is <code>Scooter</code>. </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>"""
    truck: NotRequired["capo_geo_routes.types.route_truck_options.RouteTruckOptions"]
    """<p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>"""
    intermodal: NotRequired[
        "capo_geo_routes.types.route_intermodal_options.RouteIntermodalOptions"
    ]
    """<p>Travel mode options when the provided travel mode is <code>Intermodal</code>.</p> <note> <p>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>"""
    transit: NotRequired[
        "capo_geo_routes.types.route_transit_options.RouteTransitOptions"
    ]
    """<p>Travel mode options when the provided travel mode is <code>Transit</code>.</p> <note> <p>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>"""

car instance-attribute 

car: NotRequired[RouteCarOptions]

Travel mode options when the provided travel mode is Car.

intermodal instance-attribute 

intermodal: NotRequired[RouteIntermodalOptions]

Travel mode options when the provided travel mode is Intermodal.

Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

pedestrian instance-attribute 

pedestrian: NotRequired[RoutePedestrianOptions]

Travel mode options when the provided travel mode is Pedestrian.

scooter instance-attribute 

scooter: NotRequired[RouteScooterOptions]

Travel mode options when the provided travel mode is Scooter.

When travel mode is set to Scooter, then the avoidance option ControlledAccessHighways defaults to true.

transit instance-attribute 

transit: NotRequired[RouteTransitOptions]

Travel mode options when the provided travel mode is Transit.

Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

truck instance-attribute 

truck: NotRequired[RouteTruckOptions]

Travel mode options when the provided travel mode is Truck.