This operation is no longer current and may be deprecated in the future¶

Description¶

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2 calculate_route_matrix unless you require Grab data.

This version of calculate_route_matrix is part of a previous Amazon Location Service Routes API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
The version 2 calculate_route_matrix operation gives better results for matrix routing calculations.
If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Routes API version 2 is found under geo-routes or geo_routes, not under location.
Since Grab is not yet fully supported in Routes API version 2, we recommend you continue using API version 1 when using Grab.
Start your version 2 API journey with the Routes V2 API Reference or the Developer Guide.

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.

Your account is charged for each route calculated, not the number of requests.

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 routes.

Additional options include:

Specifying a departure time using either DepartureTime or DepartNow. This calculates routes based on predictive traffic data at the given time.

You can't specify both DepartureTime and DepartNow 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 by Car, or TruckModeOptions if traveling by Truck.

Usage¶

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

Arguments¶

CalculatorName

[required] The name of the route calculator resource that you want to use to calculate the route matrix.
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]
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]
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
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
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
DistanceUnit

Set the unit system to specify the distance.

Default Value: Kilometers
CarModeOptions

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as 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.
Key

The optional API key to authorize the request.

Value¶

A list with the following syntax:

list(
  RouteMatrix = list(
    list(
      list(
        Distance = 123.0,
        DurationSeconds = 123.0,
        Error = list(
          Code = "RouteNotFound"|"RouteTooLong"|"PositionsNotFound"|"DestinationPositionNotFound"|"DeparturePositionNotFound"|"OtherValidationError",
          Message = "string"
        )
      )
    )
  ),
  SnappedDeparturePositions = list(
    list(
      123.0
    )
  ),
  SnappedDestinationPositions = list(
    list(
      123.0
    )
  ),
  Summary = list(
    DataSource = "string",
    RouteCount = 123,
    ErrorCount = 123,
    DistanceUnit = "Kilometers"|"Miles"
  )
)

Request syntax¶

svc$calculate_route_matrix(
  CalculatorName = "string",
  DeparturePositions = list(
    list(
      123.0
    )
  ),
  DestinationPositions = list(
    list(
      123.0
    )
  ),
  TravelMode = "Car"|"Truck"|"Walking"|"Bicycle"|"Motorcycle",
  DepartureTime = as.POSIXct(
    "2015-01-01"
  ),
  DepartNow = TRUE|FALSE,
  DistanceUnit = "Kilometers"|"Miles",
  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"
    )
  ),
  Key = "string"
)