locationservice_calculate_route {paws.application.integration} | 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.
See https://www.paws-r-sdk.com/docs/locationservice_calculate_route/ for full documentation.
Usage
locationservice_calculate_route(
ArrivalTime = NULL,
CalculatorName,
CarModeOptions = NULL,
DepartNow = NULL,
DeparturePosition,
DepartureTime = NULL,
DestinationPosition,
DistanceUnit = NULL,
IncludeLegGeometry = NULL,
Key = NULL,
OptimizeFor = NULL,
TravelMode = NULL,
TruckModeOptions = NULL,
WaypointPositions = NULL
)
Arguments
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. |
CalculatorName |
[required] The name of the route calculator resource that you want to use to calculate the route. |
CarModeOptions |
Specifies route preferences when traveling by Requirements: |
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: Valid Values: |
DeparturePosition |
[required] The start position for the route. Defined in World Geodetic System (WGS 84)
format:
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 Valid Values: |
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.
|
DestinationPosition |
[required] The finish position for the route. Defined in World Geodetic System (WGS 84)
format:
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. Valid Values: |
DistanceUnit |
Set the unit system to specify the distance. Default Value: |
IncludeLegGeometry |
Set to include the geometry details in the result for each path between a pair of positions. Default Value: Valid Values: |
Key |
The optional API key to authorize the request. |
OptimizeFor |
Specifies the distance to optimize for when calculating a route. |
TravelMode |
Specifies the mode of transport when calculating a route. Used in
estimating the speed of travel and road compatibility. You can choose
For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide. The
Default Value: |
TruckModeOptions |
Specifies route preferences when traveling by Requirements: |
WaypointPositions |
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
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 If Esri is the provider for your route calculator, specifying a route
that is longer than 400 km returns a Valid Values: |