2023/01/10 - Amazon Location Service - 2 updated api methods
Changes This release adds support for two new route travel models, Bicycle and Motorcycle which can be used with Grab data source.
{'TravelMode': {'Motorcycle', 'Bicycle'}}
Calculates a route given the following required parameters: DeparturePosition and DestinationPosition. 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 the route.
Additional options include:
Specifying a departure time using either DepartureTime or DepartNow. This calculates a route based on predictive traffic data at the given time.
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
client.calculate_route(
CalculatorName='string',
CarModeOptions={
'AvoidFerries': True|False,
'AvoidTolls': True|False
},
DepartNow=True|False,
DeparturePosition=[
123.0,
],
DepartureTime=datetime(2015, 1, 1),
DestinationPosition=[
123.0,
],
DistanceUnit='Kilometers'|'Miles',
IncludeLegGeometry=True|False,
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'
}
},
WaypointPositions=[
[
123.0,
],
]
)
string
[REQUIRED]
The name of the route calculator resource that you want to use to calculate the route.
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
boolean
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: false
Valid Values: false | true
list
[REQUIRED]
The start position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].
For example, [-123.115, 49.285]
Valid Values: [-180 to 180,-90 to 90]
(float) --
datetime
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.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
list
[REQUIRED]
The finish position for the route. Defined in World Geodetic System (WGS 84) format: [longitude, latitude].
For example, [-122.339, 47.615]
Valid Values: [-180 to 180,-90 to 90]
(float) --
string
Set the unit system to specify the distance.
Default Value: Kilometers
boolean
Set to include the geometry details in the result for each path between a pair of positions.
Default Value: false
Valid Values: false | true
string
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.
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.
Default Value: Car
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.
Length (float) --
The length of the truck.
For example, 15.5.
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.
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
list
Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
Valid Values: [-180 to 180,-90 to 90]
(list) --
(float) --
dict
Response Syntax
{
'Legs': [
{
'Distance': 123.0,
'DurationSeconds': 123.0,
'EndPosition': [
123.0,
],
'Geometry': {
'LineString': [
[
123.0,
],
]
},
'StartPosition': [
123.0,
],
'Steps': [
{
'Distance': 123.0,
'DurationSeconds': 123.0,
'EndPosition': [
123.0,
],
'GeometryOffset': 123,
'StartPosition': [
123.0,
]
},
]
},
],
'Summary': {
'DataSource': 'string',
'Distance': 123.0,
'DistanceUnit': 'Kilometers'|'Miles',
'DurationSeconds': 123.0,
'RouteBBox': [
123.0,
]
}
}
Response Structure
(dict) --
Returns the result of the route calculation. Metadata includes legs and route summary.
Legs (list) --
Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
(dict) --
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.
For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
The StartPosition is the departure position.
The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
Distance (float) --
The distance between the leg's StartPosition and EndPosition along a calculated route.
The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
DurationSeconds (float) --
The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
EndPosition (list) --
The terminating position of the leg. Follows the format [longitude,latitude].
(float) --
Geometry (dict) --
Contains the calculated route's path as a linestring geometry.
LineString (list) --
An ordered list of positions used to plot a route on a map.
The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.
For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]
(list) --
(float) --
StartPosition (list) --
The starting position of the leg. Follows the format [longitude,latitude].
(float) --
Steps (list) --
Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
(dict) --
Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.
Distance (float) --
The travel distance between the step's StartPosition and EndPosition.
DurationSeconds (float) --
The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.
EndPosition (list) --
The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.
(float) --
GeometryOffset (integer) --
Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.
Included in the response for queries that set IncludeLegGeometry to True.
StartPosition (list) --
The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.
(float) --
Summary (dict) --
Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
DataSource (string) --
The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:
Esri
Grab
Here
For more information about data providers, see Amazon Location Service data providers.
Distance (float) --
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
DistanceUnit (string) --
The unit of measurement for route distances.
DurationSeconds (float) --
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
RouteBBox (list) --
Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].
The first 2 bbox parameters describe the lower southwest corner:
The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.
The next 2 bbox parameters describe the upper northeast corner:
The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.
(float) --
{'TravelMode': {'Motorcycle', 'Bicycle'}}
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.
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.
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
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'
}
}
)
string
[REQUIRED]
The name of the route calculator resource that you want to use to calculate the route matrix.
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
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
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].
Valid Values: [-180 to 180,-90 to 90]
(list) --
(float) --
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.
In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
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]
Valid Values: [-180 to 180,-90 to 90]
(list) --
(float) --
string
Set the unit system to specify the distance.
Default Value: Kilometers
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.
Default Value: Car
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.
Length (float) --
The length of the truck.
For example, 15.5.
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.
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
dict
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.