TravelMode as Car.
- `AvoidFerries` boolean — Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Default Value: false
Valid Values: false | true
The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].
For example, [-123.115, 49.285]
If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
Setting a departure time in the past returns a 400 ValidationException error.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].
For example, [-122.339, 47.615]
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
Valid Values: [-180 to 180,-90 to 90]
Set the unit system to specify the distance.
Default Value: Kilometers
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false | true
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.
Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.
Truck is not available for Grab.
For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.
The TravelMode you specify also determines how you specify route preferences:
If traveling by Car use the CarModeOptions parameter.
If traveling by Truck use the TruckModeOptions parameter.
Default Value: Car
TravelMode as Truck.
- `AvoidFerries` boolean — Avoids ferries when calculating routes.
Default Value: false
Valid Values: false | true
Avoids tolls when calculating routes.
Default Value: false
Valid Values: false | true
The height of the truck.
For example, 4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
The length of the truck.
For example, 15.5.
For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
Specifies the unit of measurement for the truck dimensions.
Default Value: Meters
The width of the truck.
For example, 4.5.
For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
The total weight of the truck.
For example, 3500.
The unit of measurement to use for the truck weight.
Default Value: Kilograms
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
Specifying more than 23 waypoints returns a 400 ValidationException error.
If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
Valid Values: [-180 to 180,-90 to 90]
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
The distance between the leg's StartPosition and EndPosition along a calculated route.
The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
- `EndPosition` Double[], required — The terminating position of the leg. Follows the format [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
The starting position of the leg. Follows the format [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
StartPosition and EndPosition.
- `DurationSeconds` number, double, required — The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.
- `EndPosition` Double[], required — The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
- `GeometryOffset` integer — Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to True.
RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
- `DataSource` string, required — The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
- `Distance` number, double, required —The total distance covered by the route. The sum of the distance travelled between every stop on the route.
If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.