class Aws::LocationService::Types::CalculateRouteResponse

Returns the result of the route calculation. Metadata includes legs and route summary.

@!attribute [rw] legs

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][1]\:

* 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.

[1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
@return [Array<Types::Leg>]

@!attribute [rw] summary

Contains information about the whole route, such as: `RouteBBox`,
`DataSource`, `Distance`, `DistanceUnit`, and `DurationSeconds`.
@return [Types::CalculateRouteSummary]

@see docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteResponse AWS API Documentation

Constants

SENSITIVE