Skip to content

CalculateRouteMatrixSummary

Source code in docs_src/capo_location/types/calculate_route_matrix_summary.py 
13
14
15
16
17
18
19
20
21
class CalculateRouteMatrixSummary(TypedDict, closed=True):
    data_source: "str"
    """<p>The data provider of traffic and road network data used to calculate the routes. 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>"""
    route_count: "int"
    """<p>The count of cells in the route matrix. Equal to the number of <code>DeparturePositions</code> multiplied by the number of <code>DestinationPositions</code>.</p>"""
    error_count: "int"
    """<p>The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.</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 routes. Indicates one of the available providers:

  • Esri

  • Grab

  • Here

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

distance_unit instance-attribute 

distance_unit: DistanceUnit

The unit of measurement for route distances.

error_count instance-attribute 

error_count: int

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

route_count instance-attribute 

route_count: int

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.