Package-level declarations

You don't have sufficient access to perform this action.

Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

Base class for all service related exceptions thrown by the GeoRoutes client

The request processing has failed because of an unknown error, exception or failure.

Calculated isolines and associated properties.

Features that are allowed while calculating an isoline.

The area to be avoided.

The avoidance geometry, to be included while calculating an isoline.

Features that are avoided while calculating isolines. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Zone category to be avoided.

Travel mode options when the provided travel mode is Car.

Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.

Geometry of the connection between different isoline components.

Destination related options.

Isoline granularity related options.

Isoline matching related options.

Origin related options.

Travel mode options when the provided travel mode is Scooter

Geometry of the connection between different Isoline components.

Options to configure matching the provided position to a side of the street.

Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type can be requested.

Options related to traffic.

Trailer options corresponding to the vehicle.

Travel mode related options for the provided travel mode.

Travel mode options when the provided travel mode is "Truck"

The vehicle license plate.

The localized string.

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.

Interpolated geometry for the snapped route that is overlay-able onto a map.

TracePoints snapped onto the road network.

TracePoint indices for which the provided notice code corresponds to.

Trailer options corresponding to the vehicle.

Travel mode related options for the provided travel mode.

Travel mode options when the provided travel mode is "Truck".

The route.

Features that are allowed while calculating a route.

Areas to be avoided.

Geometry of the area to be avoided.

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

Zone categories to be avoided.

Travel mode options when the provided travel mode is Car.

Details related to the continue highway step.

Details related to the continue step.

Options related to the destination.

Driver related options.

Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.

Type of the emission.

Details related to the enter highway step.

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

Details related to the exit step.

Steps of a leg that must be performed after the travel portion of the leg.

Details corresponding to the arrival for the leg.

Steps of a leg that must be performed before the travel portion of the leg.

Details corresponding to the departure for the leg.

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

Notices are additional information returned that indicate issues that occurred during route calculation.

Summarized details of the leg.

Position provided in the request.

Span computed for the requested SpanAdditionalFeatures.

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

Steps of a leg that must be performed during the travel portion of the leg.

Details that are specific to a Keep step.

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

The returned Route leg geometry.

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

Options related to route matching.

Allow Options related to the route matrix.

Provides the circle that was used while calculating the route.

Area to be avoided.

Geometry of the area to be avoided.

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

Zone categories to be avoided.

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

Geometry of the routing boundary.

Travel mode options when the provided travel mode is Car.

The route destination.

Options related to the destination.

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

Matching options.

The start position for the route.

Origin related options.

Travel mode options when the provided travel mode is Scooter

Options to configure matching the provided position to a side of the street.

Traffic related options.

Trailer options corresponding to the vehicle.

Travel mode related options for the provided travel mode.

Travel mode options when the provided travel mode is "Truck"

The vehicle License Plate.

Notice Detail that is a range.

The route number.

Origin related options.

The place where the waypoint is passed through and not treated as a stop.

If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.

Details corresponding to the arrival for a leg.

Details corresponding to the departure for a leg.

Details that are specific to a pedestrian leg.

Notices are additional information returned that indicate issues that occurred during route calculation.

Options related to the pedestrian.

Provides a summary of a pedestrian route step.

Place details corresponding to the arrival or departure.

Span computed for the requested SpanAdditionalFeatures.

Summarized details for the leg including before travel, travel and after travel steps.

Summarized details for the leg including travel steps.

Steps of a leg that must be performed during the travel portion of the leg.

Details that are specific to a ramp step.

Notices are additional information returned that indicate issues that occurred during route calculation.

The road on the route.

Details about the roundabout leg.

Details about the roundabout step.

Details about the step.

Travel mode options when the provided travel mode is Scooter

Options to configure matching the provided position to a side of the street.

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

Labels presented on the sign post.

Details about the dynamic speed.

Details about the speed limit corresponding to the span.

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.

Options related to Tolls on a route.

Details if the toll rate can be a pass that supports multiple trips.

Period for which the pass is valid.

Locations or sites where the toll fare is collected.

The toll price.

Summary of the route and toll price.

Price range with a minimum and maximum value, if a range.

The toll rate.

The toll summary for the complete route.

Toll systems are authorities that collect payments for the toll.

Traffic options for the route.

Trailer options corresponding to the vehicle.

Transponders for which this toll can be applied.

Travel mode related options for the provided travel mode.

Travel mode options when the provided travel mode is "Truck"

Details related to the turn step.

Details related to the U-turn step.

Details corresponding to the arrival for a leg.

Details corresponding to the departure for the leg.

Incidents corresponding to this leg of the route.

Steps of a leg that correspond to the travel portion of the leg.

License plate information of the vehicle. Currently, only the last character is used where license plate based controlled access is enforced.

Notices are additional information returned that indicate issues that occurred during route calculation.

Additional details of the notice.

Summarized details of the leg.

Place details corresponding to the arrival or departure.

Span computed for the requested SpanAdditionalFeatures.

Summarized details of the route.

Summarized details of the route.

Steps of a leg that correspond to the travel portion of the leg.

This property contains a summary of violated constraints.

Waypoint between the Origin and Destination.

The weight constraint for the route.

The zone.

The request was denied due to request throttling.

The input fails to satisfy the constraints specified by an AWS service.

The input fails to satisfy the constraints specified by the Amazon Location service.

Access hours corresponding to when a destination can be visited.

Hours of entry.

The area to be avoided.

Geometry of the area to be avoided.

Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

Options for WaypointOptimizationClustering.

This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.

Destination related options.

Driver related options.

Driving distance related options.

Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.

The failed constraint.

The impeding waypoint.

The optimized waypoint.

Origin related options.

Options related to a pedestrian.

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

Resting phase of the cycle.

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

Options to configure matching the provided position to a side of the street.

Time breakdown for the sequence.

Options related to traffic.

Trailer options corresponding to the vehicle.

Travel mode related options for the provided travel mode.

Travel mode options when the provided travel mode is "Truck"

Waypoint between the Origin and Destination.

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.