Skip to content

CalculateRouteSummary

Source code in docs_src/capo_location/types/calculate_route_summary.py 
15
16
17
18
19
20
21
22
23
24
25
class CalculateRouteSummary(TypedDict, closed=True):
    route_b_box: "capo_location.types.bounding_box.BoundingBox"
    """<p>Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, <code>[min x, min y, max x, max y]</code>.</p> <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner: </p> <ul> <li> <p>The first <code>bbox</code> position is the X coordinate or longitude of the lower southwest corner. </p> </li> <li> <p>The second <code>bbox</code> position is the Y coordinate or latitude of the lower southwest corner. </p> </li> </ul> <p>The next 2 <code>bbox</code> parameters describe the upper northeast corner: </p> <ul> <li> <p>The third <code>bbox</code> position is the X coordinate, or longitude of the upper northeast corner. </p> </li> <li> <p>The fourth <code>bbox</code> position is the Y coordinate, or latitude of the upper northeast corner. </p> </li> </ul>"""
    data_source: "str"
    """<p>The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:</p> <ul> <li> <p> <code>Esri</code> </p> </li> <li> <p> <code>Grab</code> </p> </li> <li> <p> <code>Here</code> </p> </li> </ul> <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>"""
    distance: "capo_location.types.sensitive_double.SensitiveDouble"
    """<p>The total distance covered by the route. The sum of the distance travelled between every stop on the route.</p> <note> <p>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 <code>400 RoutesValidationException</code> error.</p> </note>"""
    duration_seconds: "capo_location.types.sensitive_double.SensitiveDouble"
    """<p>The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.</p>"""
    distance_unit: "capo_location.types.distance_unit.DistanceUnit"
    """<p>The unit of measurement for route distances.</p>"""

data_source instance-attribute 

data_source: str

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.

distance instance-attribute 

distance: SensitiveDouble

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.

distance_unit instance-attribute 

distance_unit: DistanceUnit

The unit of measurement for route distances.

duration_seconds instance-attribute 

duration_seconds: SensitiveDouble

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

route_b_box instance-attribute 

route_b_box: BoundingBox

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.