CalculateRouteMatrix - Amazon Location Service
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

CalculateRouteMatrix

Calculates a route matrix given the following required parameters: DeparturePositions and DestinationPositions. CalculateRouteMatrix 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, CalculateRouteMatrix 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.

Note

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.

    Note

    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.

Request Syntax

POST /routes/v0/calculators/CalculatorName/calculate/route-matrix?key=Key HTTP/1.1
Content-type: application/json

{
   "CarModeOptions": { 
      "AvoidFerries": boolean,
      "AvoidTolls": boolean
   },
   "DepartNow": boolean,
   "DeparturePositions": [ 
      [ number ]
   ],
   "DepartureTime": "string",
   "DestinationPositions": [ 
      [ number ]
   ],
   "DistanceUnit": "string",
   "TravelMode": "string",
   "TruckModeOptions": { 
      "AvoidFerries": boolean,
      "AvoidTolls": boolean,
      "Dimensions": { 
         "Height": number,
         "Length": number,
         "Unit": "string",
         "Width": number
      },
      "Weight": { 
         "Total": number,
         "Unit": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

CalculatorName

The name of the route calculator resource that you want to use to calculate the route matrix.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

Request Body

The request accepts the following data in JSON format.

CarModeOptions

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

Requirements: TravelMode must be specified as Car.

Type: CalculateRouteCarModeOptions object

Required: No

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

Type: Boolean

Required: No

DeparturePositions

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

Important

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.

Note

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]

Type: Array of arrays of doubles

Array Members: Minimum number of 1 item. Maximum number of 350 items.

Array Members: Fixed number of 2 items.

Required: Yes

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.

Note

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

Type: Timestamp

Required: No

DestinationPositions

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]

Important

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.

Note

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]

Type: Array of arrays of doubles

Array Members: Minimum number of 1 item. Maximum number of 350 items.

Array Members: Fixed number of 2 items.

Required: Yes

DistanceUnit

Set the unit system to specify the distance.

Default Value: Kilometers

Type: String

Valid Values: Kilometers | Miles

Required: No

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.

Note

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

Type: String

Valid Values: Car | Truck | Walking | Bicycle | Motorcycle

Required: No

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.

Type: CalculateRouteTruckModeOptions object

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "RouteMatrix": [ 
      [ 
         { 
            "Distance": number,
            "DurationSeconds": number,
            "Error": { 
               "Code": "string",
               "Message": "string"
            }
         }
      ]
   ],
   "SnappedDeparturePositions": [ 
      [ number ]
   ],
   "SnappedDestinationPositions": [ 
      [ number ]
   ],
   "Summary": { 
      "DataSource": "string",
      "DistanceUnit": "string",
      "ErrorCount": number,
      "RouteCount": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RouteMatrix

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

Type: Array of arrays of RouteMatrixEntry objects

SnappedDeparturePositions

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

Type: Array of arrays of doubles

Array Members: Minimum number of 1 item. Maximum number of 350 items.

Array Members: Fixed number of 2 items.

SnappedDestinationPositions

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

Type: Array of arrays of doubles

Array Members: Minimum number of 1 item. Maximum number of 350 items.

Array Members: Fixed number of 2 items.

Summary

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

Type: CalculateRouteMatrixSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: