RouteLeg
A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.
Contents
- Geometry
-
Geometry of the area to be avoided.
Type: RouteLegGeometry object
Required: Yes
- TravelMode
-
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default value:
CarType: String
Valid Values:
Car | Ferry | Pedestrian | Scooter | Truck | CarShuttleTrain | AerialTramway | Airplane | Bus | BusRapidTransit | CityTrain | FunicularRailway | HighSpeedTrain | IntercityTrain | InterregionalTrain | LightRail | Monorail | PrivateBus | RegionalTrain | SubwayRequired: Yes
- Type
-
Type of the leg.
Type: String
Valid Values:
Ferry | Pedestrian | Vehicle | Rental | Taxi | TransitRequired: Yes
- FerryLegDetails
-
FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel. Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Type: RouteFerryLegDetails object
Required: No
- Language
-
List of languages for instructions within steps in the response. Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Type: String
Length Constraints: Minimum length of 2. Maximum length of 35.
Required: No
- PedestrianLegDetails
-
Details related to the pedestrian leg.
Type: RoutePedestrianLegDetails object
Required: No
- RentalLegDetails
-
Details related to the rental leg.
Note
Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Type: RouteRentalLegDetails object
Required: No
- TaxiLegDetails
-
Details related to the taxi leg.
Note
Not supported in
ap-southeast-1andap-southeast-5regions for GrabMaps customers.Type: RouteTaxiLegDetails object
Required: No
- TransitLegDetails
-
Details related to the transit leg.
Type: RouteTransitLegDetails object
Required: No
- VehicleLegDetails
-
Details related to the vehicle leg.
Type: RouteVehicleLegDetails object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: