AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Calculates a route matrix given the following required parameters:DeparturePositions
andDestinationPositions
.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 ofDeparturePositions
times the number ofDestinationPositions
.
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:
DepartureTime
or DepartNow
. This calculates routes based on predictive traffic data at the given time.DepartureTime
and DepartNow
in a single request. Specifying both parameters returns a validation error.CarModeOptions
if traveling by Car
, or TruckModeOptions
if traveling by Truck
.See also: AWS API Documentation
calculate-route-matrix
--calculator-name <value>
--departure-positions <value>
--destination-positions <value>
[--travel-mode <value>]
[--departure-time <value>]
[--depart-now | --no-depart-now]
[--distance-unit <value>]
[--car-mode-options <value>]
[--truck-mode-options <value>]
[--key <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--calculator-name
(string)
The name of the route calculator resource that you want to use to calculate the route matrix.
--departure-positions
(list)
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 inSnappedDeparturePositions
.Valid Values:
[-180 to 180,-90 to 90]
(list)
(double)
Shorthand Syntax:
double,double ...
JSON Syntax:
[
[double, ...]
...
]
--destination-positions
(list)
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 inSnappedDestinationPositions
.Valid Values:
[-180 to 180,-90 to 90]
(list)
(double)
Shorthand Syntax:
double,double ...
JSON Syntax:
[
[double, ...]
...
]
--travel-mode
(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 theCarModeOptions
parameter.- If traveling by
Truck
use theTruckModeOptions
parameter.Note
Bicycle
orMotorcycle
are only valid when usingGrab
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
Possible values:
Car
Truck
Walking
Bicycle
Motorcycle
--departure-time
(timestamp)
Specifies the desired time of departure. Uses the given time to calculate the route matrix. You can't set both
DepartureTime
andDepartNow
. 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 a400 ValidationException
error.
- In ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
. For example,2020–07-2T12:15:20.000Z+01:00
--depart-now
| --no-depart-now
(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
andDepartNow
. 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
--distance-unit
(string)
Set the unit system to specify the distance.
Default Value:
Kilometers
Possible values:
Kilometers
Miles
--car-mode-options
(structure)
Specifies route preferences when traveling by
Car
, such as avoiding routes that use ferries or tolls.Requirements:
TravelMode
must be specified asCar
.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
Shorthand Syntax:
AvoidFerries=boolean,AvoidTolls=boolean
JSON Syntax:
{
"AvoidFerries": true|false,
"AvoidTolls": true|false
}
--truck-mode-options
(structure)
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 asTruck
.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 -> (structure)
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.
Length -> (double)
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.Height -> (double)
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.Width -> (double)
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.Unit -> (string)
Specifies the unit of measurement for the truck dimensions.
Default Value:
Meters
Weight -> (structure)
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 -> (double)
The total weight of the truck.
- For example,
3500
.Unit -> (string)
The unit of measurement to use for the truck weight.
Default Value:
Kilograms
Shorthand Syntax:
AvoidFerries=boolean,AvoidTolls=boolean,Dimensions={Length=double,Height=double,Width=double,Unit=string},Weight={Total=double,Unit=string}
JSON Syntax:
{
"AvoidFerries": true|false,
"AvoidTolls": true|false,
"Dimensions": {
"Length": double,
"Height": double,
"Width": double,
"Unit": "Meters"|"Feet"
},
"Weight": {
"Total": double,
"Unit": "Kilograms"|"Pounds"
}
}
--key
(string)
The optional API key to authorize the request.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
RouteMatrix -> (list)
The calculated route matrix containing the results for all pairs of
DeparturePositions
toDestinationPositions
. Each row corresponds to one entry inDeparturePositions
. Each entry in the row corresponds to the route from that entry inDeparturePositions
to an entry inDestinationPositions
.(list)
(structure)
The result for the calculated route of one
DeparturePosition
DestinationPosition
pair.Distance -> (double)
The total distance of travel for the route.DurationSeconds -> (double)
The expected duration of travel for the route.Error -> (structure)
An error corresponding to the calculation of a route between the
DeparturePosition
andDestinationPosition
.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)
(double)
SnappedDestinationPositions -> (list)
The list of destination positions for the route matrix used for calculation of the
RouteMatrix
.(list)
(double)
Summary -> (structure)
Contains information about the route matrix,
DataSource
,DistanceUnit
,RouteCount
andErrorCount
.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 .
RouteCount -> (integer)
The count of cells in the route matrix. Equal to the number ofDeparturePositions
multiplied by the number ofDestinationPositions
.ErrorCount -> (integer)
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.DistanceUnit -> (string)
The unit of measurement for route distances.