locationservice_calculate_route_matrix: Calculates a route matrix given the following required...

In paws.application.integration: 'Amazon Web Services' Application Integration Services

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions

Description

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. calculate_route_matrix calculates routes and returns the travel time and travel distance from each departure position to each destination position in the request. For example, given departure positions A and B, and destination positions X and Y, calculate_route_matrix will return time and distance for routes from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned (and routes calculated) will be the number of DeparturePositions times the number of DestinationPositions.

See https://www.paws-r-sdk.com/docs/locationservice_calculate_route_matrix/ for full documentation.

Usage

locationservice_calculate_route_matrix(
  CalculatorName,
  CarModeOptions = NULL,
  DepartNow = NULL,
  DeparturePositions,
  DepartureTime = NULL,
  DestinationPositions,
  DistanceUnit = NULL,
  Key = NULL,
  TravelMode = NULL,
  TruckModeOptions = NULL
)

Arguments

CalculatorName	[required] The name of the route calculator resource that you want to use to calculate the route matrix.
CarModeOptions	Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls. Requirements: TravelMode must be specified as Car.
DepartNow	Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix. Default Value: false Valid Values: false | true
DeparturePositions	[required] The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: ⁠[longitude, latitude]⁠. For example, ⁠[-123.115, 49.285]⁠. Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide. For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions. Valid Values: ⁠[-180 to 180,-90 to 90]⁠
DepartureTime	Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix. 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⁠
DestinationPositions	[required] The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: ⁠[longitude, latitude]⁠. For example, ⁠[-122.339, 47.615]⁠ Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide. For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions. Valid Values: ⁠[-180 to 180,-90 to 90]⁠
DistanceUnit	Set the unit system to specify the distance. Default Value: Kilometers
Key	The optional API key to authorize the request.
TravelMode	Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. 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. Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia. Truck is not available for Grab. For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide. Default Value: Car
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 as Truck.

paws.application.integration documentation built on Sept. 12, 2023, 1:18 a.m.