Calculate Route
locationservice_calculate_route | R Documentation |
Calculates a route given the following required parameters: DeparturePosition and DestinationPosition¶
Description¶
Calculates a
route
given the following required parameters: DeparturePosition
and
DestinationPosition
. Requires that you first create a route
calculator
resource.
By default, a request that doesn't specify a departure time uses the best time of day to travel with the best traffic conditions when calculating the route.
Additional options include:
-
Specifying a departure time using either
DepartureTime
orDepartNow
. This calculates a route based on predictive traffic data at the given time.You can't specify both
DepartureTime
andDepartNow
in a single request. Specifying both parameters returns a validation error. -
Specifying a travel mode using TravelMode sets the transportation mode used to calculate the routes. This also lets you specify additional route preferences in
CarModeOptions
if traveling byCar
, orTruckModeOptions
if traveling byTruck
.If you specify
walking
for the travel mode and your data provider is Esri, the start and destination must be within 40km.
Usage¶
locationservice_calculate_route(CalculatorName, DeparturePosition,
DestinationPosition, WaypointPositions, TravelMode, DepartureTime,
DepartNow, DistanceUnit, IncludeLegGeometry, CarModeOptions,
TruckModeOptions, ArrivalTime, OptimizeFor, Key)
Arguments¶
CalculatorName
[required] The name of the route calculator resource that you want to use to calculate the route.
DeparturePosition
[required] 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]
DestinationPosition
[required] 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]
WaypointPositions
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]
TravelMode
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
orMotorcycle
as options for theTravelMode
.Bicycle
andMotorcycle
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 theCarModeOptions
parameter.If traveling by
Truck
use theTruckModeOptions
parameter.
Default Value:
Car
DepartureTime
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.
In ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
. For example,2020–07-2T12:15:20.000Z+01:00
DepartNow
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
DistanceUnit
Set the unit system to specify the distance.
Default Value:
Kilometers
IncludeLegGeometry
Set to include the geometry details in the result for each path between a pair of positions.
Default Value:
false
Valid Values:
false
|true
CarModeOptions
Specifies route preferences when traveling by
Car
, such as avoiding routes that use ferries or tolls.Requirements:
TravelMode
must be specified asCar
.TruckModeOptions
Specifies route preferences when traveling by
Truck
, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.Requirements:
TravelMode
must be specified asTruck
.ArrivalTime
Specifies the desired time of arrival. 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.
ArrivalTime is not supported Esri.
OptimizeFor
Specifies the distance to optimize for when calculating a route.
Key
The optional API key to authorize the request.
Value¶
A list with the following syntax:
list(
Legs = list(
list(
StartPosition = list(
123.0
),
EndPosition = list(
123.0
),
Distance = 123.0,
DurationSeconds = 123.0,
Geometry = list(
LineString = list(
list(
123.0
)
)
),
Steps = list(
list(
StartPosition = list(
123.0
),
EndPosition = list(
123.0
),
Distance = 123.0,
DurationSeconds = 123.0,
GeometryOffset = 123
)
)
)
),
Summary = list(
RouteBBox = list(
123.0
),
DataSource = "string",
Distance = 123.0,
DurationSeconds = 123.0,
DistanceUnit = "Kilometers"|"Miles"
)
)
Request syntax¶
svc$calculate_route(
CalculatorName = "string",
DeparturePosition = list(
123.0
),
DestinationPosition = list(
123.0
),
WaypointPositions = list(
list(
123.0
)
),
TravelMode = "Car"|"Truck"|"Walking"|"Bicycle"|"Motorcycle",
DepartureTime = as.POSIXct(
"2015-01-01"
),
DepartNow = TRUE|FALSE,
DistanceUnit = "Kilometers"|"Miles",
IncludeLegGeometry = TRUE|FALSE,
CarModeOptions = list(
AvoidFerries = TRUE|FALSE,
AvoidTolls = TRUE|FALSE
),
TruckModeOptions = list(
AvoidFerries = TRUE|FALSE,
AvoidTolls = TRUE|FALSE,
Dimensions = list(
Length = 123.0,
Height = 123.0,
Width = 123.0,
Unit = "Meters"|"Feet"
),
Weight = list(
Total = 123.0,
Unit = "Kilograms"|"Pounds"
)
),
ArrivalTime = as.POSIXct(
"2015-01-01"
),
OptimizeFor = "FastestRoute"|"ShortestRoute",
Key = "string"
)