class Aws::LocationService::Types::Leg
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.
[1]: docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
@!attribute [rw] distance
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`. ^ @return [Float]
@!attribute [rw] duration_seconds
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. @return [Float]
@!attribute [rw] end_position
The terminating position of the leg. Follows the format `[longitude,latitude]`. <note markdown="1"> If the `EndPosition` isn't located on a road, it's [snapped to a nearby road][1]. </note> [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road @return [Array<Float>]
@!attribute [rw] geometry
Contains the calculated route's path as a linestring geometry. @return [Types::LegGeometry]
@!attribute [rw] start_position
The starting position of the leg. Follows the format `[longitude,latitude]`. <note markdown="1"> If the `StartPosition` isn't located on a road, it's [snapped to a nearby road][1]. </note> [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road @return [Array<Float>]
@!attribute [rw] steps
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. @return [Array<Types::Step>]
@see docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Leg AWS API Documentation
Constants
- SENSITIVE