CalculateRouteSummary
A summary of the calculated route.
Contents
- DataSource
-
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.
Type: String
Required: Yes
-
- Distance
-
The total distance covered by the route. The sum of the distance travelled between every stop on the route.
Note
If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a
400 RoutesValidationExceptionerror.Type: Double
Valid Range: Minimum value of 0.
Required: Yes
- DistanceUnit
-
The unit of measurement for route distances.
Type: String
Valid Values:
Kilometers | MilesRequired: Yes
- DurationSeconds
-
The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
Type: Double
Valid Range: Minimum value of 0.
Required: Yes
- RouteBBox
-
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
bboxparameters describe the lower southwest corner:-
The first
bboxposition is the X coordinate or longitude of the lower southwest corner. -
The second
bboxposition is the Y coordinate or latitude of the lower southwest corner.
The next 2
bboxparameters describe the upper northeast corner:-
The third
bboxposition is the X coordinate, or longitude of the upper northeast corner. -
The fourth
bboxposition is the Y coordinate, or latitude of the upper northeast corner.
Type: Array of doubles
Array Members: Fixed number of 4 items.
Required: Yes
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
