Documentation

A summary of the calculated route.

See: newCalculateRouteSummary smart constructor.

Create a value of CalculateRouteSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSource:CalculateRouteSummary', calculateRouteSummary_dataSource - The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

$sel:distance:CalculateRouteSummary', calculateRouteSummary_distance - The total distance covered by the route. The sum of the distance travelled between every stop on the route.

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 RoutesValidationException error.

$sel:distanceUnit:CalculateRouteSummary', calculateRouteSummary_distanceUnit - The unit of measurement for route distances.

$sel:durationSeconds:CalculateRouteSummary', calculateRouteSummary_durationSeconds - The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

$sel:routeBBox:CalculateRouteSummary', calculateRouteSummary_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 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.

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Here

For more information about data providers, see Amazon Location Service data providers.

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

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 RoutesValidationException error.

The unit of measurement for route distances.

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

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.