LocationService / Client / calculate_route_matrix

calculate_route_matrix#

LocationService.Client.calculate_route_matrix(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.calculate_route_matrix(
    CalculatorName='string',
    CarModeOptions={
        'AvoidFerries': True|False,
        'AvoidTolls': True|False
    },
    DepartNow=True|False,
    DeparturePositions=[
        [
            123.0,
        ],
    ],
    DepartureTime=datetime(2015, 1, 1),
    DestinationPositions=[
        [
            123.0,
        ],
    ],
    DistanceUnit='Kilometers'|'Miles',
    TravelMode='Car'|'Truck'|'Walking'|'Bicycle'|'Motorcycle',
    TruckModeOptions={
        'AvoidFerries': True|False,
        'AvoidTolls': True|False,
        'Dimensions': {
            'Height': 123.0,
            'Length': 123.0,
            'Unit': 'Meters'|'Feet',
            'Width': 123.0
        },
        'Weight': {
            'Total': 123.0,
            'Unit': 'Kilograms'|'Pounds'
        }
    }
)

Parameters:

CalculatorName (string) –
[REQUIRED]

The name of the route calculator resource that you want to use to calculate the route matrix.
CarModeOptions (dict) –
Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.
- AvoidFerries (boolean) –
  
  Avoids ferries when calculating routes.
  
  Default Value: false
  
  Valid Values: false | true
- AvoidTolls (boolean) –
  
  Avoids tolls when calculating routes.
  
  Default Value: false
  
  Valid Values: false | true
DepartNow (boolean) –
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 (list) –
[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].

Warning

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]
- (list) –
  - (float) –
DepartureTime (datetime) –
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
DestinationPositions (list) –
[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]

Warning

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]
- (list) –
  - (float) –
DistanceUnit (string) –
Set the unit system to specify the distance.

Default Value: Kilometers
TravelMode (string) –
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
TruckModeOptions (dict) –
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.
- AvoidFerries (boolean) –
  
  Avoids ferries when calculating routes.
  
  Default Value: false
  
  Valid Values: false | true
- AvoidTolls (boolean) –
  
  Avoids tolls when calculating routes.
  
  Default Value: false
  
  Valid Values: false | true
- Dimensions (dict) –
  
  Specifies the truck’s dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can’t support the truck’s dimensions.
  - Height (float) –
    
    The height of the truck.
    - For example, 4.5.
    Note
    
    For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
  - Length (float) –
    
    The length of the truck.
    - For example, 15.5.
    Note
    
    For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
  - Unit (string) –
    
    Specifies the unit of measurement for the truck dimensions.
    
    Default Value: Meters
  - Width (float) –
    
    The width of the truck.
    - For example, 4.5.
    Note
    
    For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
- Weight (dict) –
  
  Specifies the truck’s weight specifications including total weight and unit of measurement. Used to avoid roads that can’t support the truck’s weight.
  - Total (float) –
    
    The total weight of the truck.
    - For example, 3500.
  - Unit (string) –
    
    The unit of measurement to use for the truck weight.
    
    Default Value: Kilograms

Return type:

dict

Returns:

Response Syntax

{
    'RouteMatrix': [
        [
            {
                'Distance': 123.0,
                'DurationSeconds': 123.0,
                'Error': {
                    'Code': 'RouteNotFound'|'RouteTooLong'|'PositionsNotFound'|'DestinationPositionNotFound'|'DeparturePositionNotFound'|'OtherValidationError',
                    'Message': 'string'
                }
            },
        ],
    ],
    'SnappedDeparturePositions': [
        [
            123.0,
        ],
    ],
    'SnappedDestinationPositions': [
        [
            123.0,
        ],
    ],
    'Summary': {
        'DataSource': 'string',
        'DistanceUnit': 'Kilometers'|'Miles',
        'ErrorCount': 123,
        'RouteCount': 123
    }
}

Response Structure

(dict) –

Returns the result of the route matrix calculation.
- RouteMatrix (list) –
  
  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.
  - (list) –
    - (dict) –
      
      The result for the calculated route of one DeparturePosition DestinationPosition pair.
      - Distance (float) –
        
        The total distance of travel for the route.
      - DurationSeconds (float) –
        
        The expected duration of travel for the route.
      - Error (dict) –
        
        An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.
        
        Code (string) –
        
        The type of error which occurred for the route calculation.
        
        Message (string) –
        
        A message about the error that occurred for the route calculation.
- SnappedDeparturePositions (list) –
  
  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.
  - (list) –
    - (float) –
- SnappedDestinationPositions (list) –
  
  The list of destination positions for the route matrix used for calculation of the RouteMatrix.
  - (list) –
    - (float) –
- Summary (dict) –
  
  Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.
  - DataSource (string) –
    
    The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:
    - Esri
    - Grab
    - Here
    For more information about data providers, see Amazon Location Service data providers.
  - DistanceUnit (string) –
    
    The unit of measurement for route distances.
  - ErrorCount (integer) –
    
    The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
  - RouteCount (integer) –
    
    The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException