Package-level declarations
Types
You don't have sufficient access to perform this action.
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.
Special road types or features that should be considered available for routing. For example, this attribute can be used to allow the use of HOV (high-occupancy vehicle) or HOT (high-occupancy toll) lanes, even if they would otherwise not be.
Defines an area to avoid when calculating routes. Consists of a primary geometry to avoid, with the ability to specify exception areas within that geometry where travel is permitted.
Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible.
Specifies features of the road network to avoid when calculating reachable areas. These preferences guide route calculations but may be overridden when no reasonable alternative exists. For example, if avoiding toll roads would make an area unreachable, toll roads may still be used.
Types of regulated zones that may affect routing.
Vehicle characteristics and preferences that affect routing for passenger cars. This includes vehicle type, occupancy, and speed restrictions that may influence which roads can be used and expected travel times.
Represents a segment of the transportation network that connects separate parts of a reachable area. These connections show how discontinuous areas are linked, such as by ferry routes or bridges crossing unroutable terrain.
Represents the geometry of connections between non-contiguous parts of an isoline. These connections can be provided in either coordinate pairs (LineString) or encoded (Polyline) format, matching the format specified in the request.
Options that control how the destination point is interpreted and matched to the road network when calculating reachable areas. This affects which roads are considered accessible near the destination and how the final approach is calculated.
Controls the detail level and smoothness of generated isolines. More detailed isolines provide better visual representation of reachable areas but require more processing time and result in larger responses.
Controls how origin and destination points are matched to the road network when they don't fall exactly on a road. Matching options help ensure realistic routing by connecting points to appropriate roads.
Options that control how the origin point is interpreted when calculating reachable areas. These options affect which roads are considered accessible from the starting point and how initial routing decisions are made.
Vehicle characteristics that affect which roads and paths can be used when calculating reachable areas for scooters. This includes areas such as bike lanes, shared paths, and roads where scooters are permitted.
Represents the shape of a reachable area. The geometry can be provided either as coordinate pairs (Polygon) or in encoded format (PolylinePolygon), matching the format specified in the request.
Controls how points are matched to specific sides of streets. This is important when the side of the street matters for accessibility - for example, when building entrances or parking lot access points can only be reached from one side of a divided road.
Specifies the time or distance limits used to calculate reachable areas. You can provide up to five thresholds for a single type to generate multiple isolines in a single request. For example, you might request areas reachable within 5, 10, and 15 minutes, or within 1, 2, and 5 kilometers.
Controls how real-time and historical traffic data is used when calculating reachable areas. This affects both the size and shape of isolines by accounting for expected travel speeds based on congestion patterns.
Additional specifications when the vehicle includes one or more trailers.
Mode-specific routing options that further refine how reachable areas are calculated. Options are only considered when they match the selected travel mode.
Vehicle characteristics and restrictions that affect which roads can be used when calculating reachable areas for trucks. These details ensure that routes respect physical limitations and legal requirements.
License plate information used in regions where road access or routing restrictions are based on license plate numbers.
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.
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. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
Travel mode options when the provided travel mode is Car. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only LicensePlate options.
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 to ferry travel.
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 in World Geodetic System (WGS 84) format: [longitude, latitude].
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. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
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.
Details about the roundabout leg.
Details about the roundabout step.
Details about the step.
Travel mode options when the provided travel mode is Scooter. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only LicensePlate options.
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.
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. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
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 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 different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.