LocationServiceRoutesV2Client#

Index > LocationServiceRoutesV2 > LocationServiceRoutesV2Client

Auto-generated documentation for LocationServiceRoutesV2 type annotations stubs module types-boto3-geo-routes.

LocationServiceRoutesV2Client#

Type annotations and code completion for boto3.client("geo-routes"). boto3 documentation

# LocationServiceRoutesV2Client usage example

from boto3.session import Session
from types_boto3_geo_routes.client import LocationServiceRoutesV2Client

def get_geo-routes_client() -> LocationServiceRoutesV2Client:
    return Session().client("geo-routes")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("geo-routes").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("geo-routes")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_geo_routes.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("geo-routes").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("geo-routes").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

calculate_isolines#

Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.

Type annotations and code completion for boto3.client("geo-routes").calculate_isolines method. boto3 documentation

# calculate_isolines method definition

def calculate_isolines(
    self,
    *,
    Thresholds: IsolineThresholdsTypeDef,  # (1)
    Allow: IsolineAllowOptionsTypeDef = ...,  # (2)
    ArrivalTime: str = ...,
    Avoid: IsolineAvoidanceOptionsTypeDef = ...,  # (3)
    DepartNow: bool = ...,
    DepartureTime: str = ...,
    Destination: Sequence[float] = ...,
    DestinationOptions: IsolineDestinationOptionsTypeDef = ...,  # (4)
    IsolineGeometryFormat: GeometryFormatType = ...,  # (5)
    IsolineGranularity: IsolineGranularityOptionsTypeDef = ...,  # (6)
    Key: str = ...,
    OptimizeIsolineFor: IsolineOptimizationObjectiveType = ...,  # (7)
    OptimizeRoutingFor: RoutingObjectiveType = ...,  # (8)
    Origin: Sequence[float] = ...,
    OriginOptions: IsolineOriginOptionsTypeDef = ...,  # (9)
    Traffic: IsolineTrafficOptionsTypeDef = ...,  # (10)
    TravelMode: IsolineTravelModeType = ...,  # (11)
    TravelModeOptions: IsolineTravelModeOptionsTypeDef = ...,  # (12)
) -> CalculateIsolinesResponseTypeDef:  # (13)
    ...

# calculate_isolines method usage example with argument unpacking

kwargs: CalculateIsolinesRequestRequestTypeDef = {  # (1)
    "Thresholds": ...,
}

parent.calculate_isolines(**kwargs)

See CalculateIsolinesRequestRequestTypeDef

calculate_route_matrix#

Calculates route matrix containing the results for all pairs of Origins to Destinations.

Type annotations and code completion for boto3.client("geo-routes").calculate_route_matrix method. boto3 documentation

# calculate_route_matrix method definition

def calculate_route_matrix(
    self,
    *,
    Destinations: Sequence[RouteMatrixDestinationTypeDef],  # (1)
    Origins: Sequence[RouteMatrixOriginTypeDef],  # (2)
    RoutingBoundary: RouteMatrixBoundaryTypeDef,  # (3)
    Allow: RouteMatrixAllowOptionsTypeDef = ...,  # (4)
    Avoid: RouteMatrixAvoidanceOptionsTypeDef = ...,  # (5)
    DepartNow: bool = ...,
    DepartureTime: str = ...,
    Exclude: RouteMatrixExclusionOptionsTypeDef = ...,  # (6)
    Key: str = ...,
    OptimizeRoutingFor: RoutingObjectiveType = ...,  # (7)
    Traffic: RouteMatrixTrafficOptionsTypeDef = ...,  # (8)
    TravelMode: RouteMatrixTravelModeType = ...,  # (9)
    TravelModeOptions: RouteMatrixTravelModeOptionsTypeDef = ...,  # (10)
) -> CalculateRouteMatrixResponseTypeDef:  # (11)
    ...

# calculate_route_matrix method usage example with argument unpacking

kwargs: CalculateRouteMatrixRequestRequestTypeDef = {  # (1)
    "Destinations": ...,
    "Origins": ...,
    "RoutingBoundary": ...,
}

parent.calculate_route_matrix(**kwargs)

See CalculateRouteMatrixRequestRequestTypeDef

calculate_routes#

Calculates a route given the following required parameters: Origin and Destination.

Type annotations and code completion for boto3.client("geo-routes").calculate_routes method. boto3 documentation

# calculate_routes method definition

def calculate_routes(
    self,
    *,
    Destination: Sequence[float],
    Origin: Sequence[float],
    Allow: RouteAllowOptionsTypeDef = ...,  # (1)
    ArrivalTime: str = ...,
    Avoid: RouteAvoidanceOptionsTypeDef = ...,  # (2)
    DepartNow: bool = ...,
    DepartureTime: str = ...,
    DestinationOptions: RouteDestinationOptionsTypeDef = ...,  # (3)
    Driver: RouteDriverOptionsTypeDef = ...,  # (4)
    Exclude: RouteExclusionOptionsTypeDef = ...,  # (5)
    InstructionsMeasurementSystem: MeasurementSystemType = ...,  # (6)
    Key: str = ...,
    Languages: Sequence[str] = ...,
    LegAdditionalFeatures: Sequence[RouteLegAdditionalFeatureType] = ...,  # (7)
    LegGeometryFormat: GeometryFormatType = ...,  # (8)
    MaxAlternatives: int = ...,
    OptimizeRoutingFor: RoutingObjectiveType = ...,  # (9)
    OriginOptions: RouteOriginOptionsTypeDef = ...,  # (10)
    SpanAdditionalFeatures: Sequence[RouteSpanAdditionalFeatureType] = ...,  # (11)
    Tolls: RouteTollOptionsTypeDef = ...,  # (12)
    Traffic: RouteTrafficOptionsTypeDef = ...,  # (13)
    TravelMode: RouteTravelModeType = ...,  # (14)
    TravelModeOptions: RouteTravelModeOptionsTypeDef = ...,  # (15)
    TravelStepType: RouteTravelStepTypeType = ...,  # (16)
    Waypoints: Sequence[RouteWaypointTypeDef] = ...,  # (17)
) -> CalculateRoutesResponseTypeDef:  # (18)
    ...

# calculate_routes method usage example with argument unpacking

kwargs: CalculateRoutesRequestRequestTypeDef = {  # (1)
    "Destination": ...,
    "Origin": ...,
}

parent.calculate_routes(**kwargs)

See CalculateRoutesRequestRequestTypeDef

optimize_waypoints#

Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

Type annotations and code completion for boto3.client("geo-routes").optimize_waypoints method. boto3 documentation

# optimize_waypoints method definition

def optimize_waypoints(
    self,
    *,
    Origin: Sequence[float],
    Avoid: WaypointOptimizationAvoidanceOptionsTypeDef = ...,  # (1)
    DepartureTime: str = ...,
    Destination: Sequence[float] = ...,
    DestinationOptions: WaypointOptimizationDestinationOptionsTypeDef = ...,  # (2)
    Driver: WaypointOptimizationDriverOptionsTypeDef = ...,  # (3)
    Exclude: WaypointOptimizationExclusionOptionsTypeDef = ...,  # (4)
    Key: str = ...,
    OptimizeSequencingFor: WaypointOptimizationSequencingObjectiveType = ...,  # (5)
    OriginOptions: WaypointOptimizationOriginOptionsTypeDef = ...,  # (6)
    Traffic: WaypointOptimizationTrafficOptionsTypeDef = ...,  # (7)
    TravelMode: WaypointOptimizationTravelModeType = ...,  # (8)
    TravelModeOptions: WaypointOptimizationTravelModeOptionsTypeDef = ...,  # (9)
    Waypoints: Sequence[WaypointOptimizationWaypointTypeDef] = ...,  # (10)
) -> OptimizeWaypointsResponseTypeDef:  # (11)
    ...

# optimize_waypoints method usage example with argument unpacking

kwargs: OptimizeWaypointsRequestRequestTypeDef = {  # (1)
    "Origin": ...,
}

parent.optimize_waypoints(**kwargs)

See OptimizeWaypointsRequestRequestTypeDef

snap_to_roads#

The SnapToRoads action matches GPS trace to roads most likely traveled on.

Type annotations and code completion for boto3.client("geo-routes").snap_to_roads method. boto3 documentation

# snap_to_roads method definition

def snap_to_roads(
    self,
    *,
    TracePoints: Sequence[RoadSnapTracePointTypeDef],  # (1)
    Key: str = ...,
    SnappedGeometryFormat: GeometryFormatType = ...,  # (2)
    SnapRadius: int = ...,
    TravelMode: RoadSnapTravelModeType = ...,  # (3)
    TravelModeOptions: RoadSnapTravelModeOptionsTypeDef = ...,  # (4)
) -> SnapToRoadsResponseTypeDef:  # (5)
    ...

# snap_to_roads method usage example with argument unpacking

kwargs: SnapToRoadsRequestRequestTypeDef = {  # (1)
    "TracePoints": ...,
}

parent.snap_to_roads(**kwargs)

See SnapToRoadsRequestRequestTypeDef