Module Awso_geo_routes.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule LanguageTag : sig ... end
Sourcemodule SensitiveString : sig ... end
Sourcemodule RouteDirection : sig ... end
Sourcemodule RouteHazardousCargoType : sig ... end
Sourcemodule RouteWeightConstraintType : sig ... end
Sourcemodule WeightKilograms : sig ... end
Sourcemodule LocalizedString : sig ... end

The localized string.

Sourcemodule RouteNumber : sig ... end

The route number.

Sourcemodule Double : sig ... end

Period for which the pass is valid.

Sourcemodule SensitiveBoolean : sig ... end
Sourcemodule RouteTollPaymentMethod : sig ... end
Sourcemodule CurrencyCode : sig ... end
Sourcemodule DurationSeconds : sig ... end
Sourcemodule RouteTollPriceValueDouble : sig ... end
Sourcemodule RouteTollPriceValueRange : sig ... end

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

Sourcemodule RouteTransponder : sig ... end

Transponders for which this toll can be applied.

Sourcemodule DimensionCentimeters : sig ... end
Sourcemodule RouteNoticeDetailRange : sig ... end

Notice Detail that is a range.

Sourcemodule RouteTruckType : sig ... end
Sourcemodule RouteWeightConstraint : sig ... end

The weight constraint for the route. Unit: kilograms

Sourcemodule String_ : sig ... end
Sourcemodule TunnelRestrictionCode : sig ... end
Sourcemodule WeightPerAxleGroup : sig ... end

Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types. Unit: kilograms

Sourcemodule RouteSignpostLabel : sig ... end

Labels presented on the sign post.

Sourcemodule Position23 : sig ... end
Sourcemodule RouteTollPass : sig ... end

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

Sourcemodule RouteTollPrice : sig ... end

The toll price.

Sourcemodule RouteTransponderList : sig ... end
Sourcemodule RouteViolatedConstraints : sig ... end

This property contains a summary of violated constraints.

Sourcemodule Integer : sig ... end
Sourcemodule SpeedKilometersPerHour : sig ... end
Sourcemodule RouteSpanRoadAttribute : sig ... end
Sourcemodule LocalizedStringList : sig ... end
Sourcemodule RouteSteeringDirection : sig ... end
Sourcemodule RouteTurnIntensity : sig ... end
Sourcemodule TurnAngle : sig ... end
Sourcemodule RouteNumberList : sig ... end
Sourcemodule RouteRoadType : sig ... end
Sourcemodule RoundaboutAngle : sig ... end
Sourcemodule RouteSignpostLabelList : sig ... end
Sourcemodule RouteTollPaymentSite : sig ... end

Locations or sites where the toll fare is collected.

Sourcemodule RouteTollRate : sig ... end

The toll rate.

Sourcemodule RouteVehicleNoticeDetail : sig ... end

Additional details of the notice.

Sourcemodule RouteFerryNoticeCode : sig ... end
Sourcemodule RouteNoticeImpact : sig ... end
Sourcemodule CountryCode3 : sig ... end
Sourcemodule DistanceMeters : sig ... end
Sourcemodule RouteFerryTravelStepType : sig ... end
Sourcemodule RoutePassThroughPlace : sig ... end

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

Sourcemodule RouteSideOfStreet : sig ... end
Sourcemodule RoutePedestrianNoticeCode : sig ... end
Sourcemodule IndexList : sig ... end

Details about the dynamic speed. Unit: kilometers per hour

Details about the speed limit corresponding to the span. Unit: kilometers per hour

Sourcemodule RouteContinueStepDetails : sig ... end

Details related to the continue step.

Sourcemodule RouteKeepStepDetails : sig ... end

Details that are specific to a Keep step.

Sourcemodule RouteRoad : sig ... end

The road on the route.

Details about the roundabout leg.

Details about the roundabout step.

Details about the step.

Sourcemodule RouteSignpost : sig ... end

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

Sourcemodule RouteTurnStepDetails : sig ... end

Details related to the turn step.

Sourcemodule RouteTollPaymentSiteList : sig ... end
Sourcemodule RouteTollRateList : sig ... end
Sourcemodule RouteVehicleIncidentType : sig ... end
Sourcemodule RouteVehicleNoticeCode : sig ... end
Sourcemodule RouteSpanGateAttribute : sig ... end

Details related to the continue highway step.

Details related to the enter highway step.

Sourcemodule RouteExitStepDetails : sig ... end

Details related to the exit step.

Sourcemodule RouteRampStepDetails : sig ... end

Details that are specific to a ramp step.

Sourcemodule RouteUTurnStepDetails : sig ... end

Details related to the U-turn step.

Sourcemodule RouteZoneCategory : sig ... end
Sourcemodule Position : sig ... end
Sourcemodule RouteFerryAfterTravelStep : sig ... end

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

Sourcemodule RouteFerryPlace : sig ... end

Position provided in the request.

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

Sourcemodule RouteFerryNotice : sig ... end

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

Sourcemodule RouteFerrySpan : sig ... end

Span computed for the requested SpanAdditionalFeatures.

Sourcemodule RouteFerryOverviewSummary : sig ... end

Summarized details of the leg.

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.

Sourcemodule RouteFerryTravelStep : sig ... end

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

Sourcemodule RoutePassThroughWaypoint : sig ... end

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

Sourcemodule RoutePedestrianPlace : sig ... end

Place details corresponding to the arrival or departure.

Sourcemodule RoutePedestrianNotice : sig ... end

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

Sourcemodule RoutePedestrianSpan : sig ... end

Span computed for the requested SpanAdditionalFeatures.

Provides a summary of a pedestrian route step.

Summarized details for the leg including travel steps.

Sourcemodule RoutePedestrianTravelStep : sig ... end

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

Sourcemodule RouteToll : sig ... end

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.

Sourcemodule RouteTollSystem : sig ... end

Toll systems are authorities that collect payments for the toll.

Sourcemodule RouteVehiclePlace : sig ... end

Place details corresponding to the arrival or departure.

Sourcemodule RouteVehicleIncident : sig ... end

Incidents corresponding to this leg of the route.

Sourcemodule RouteVehicleNotice : sig ... end

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

Sourcemodule RouteVehicleSpan : sig ... end

Span computed for the requested SpanAdditionalFeatures.

Summarized details of the leg.

Summarized details of the route.

Sourcemodule RouteVehicleTravelStep : sig ... end

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

Sourcemodule RouteZone : sig ... end

The zone.

Sourcemodule TruckRoadType : sig ... end
Sourcemodule LineString : sig ... end
Sourcemodule Polyline : sig ... end
Sourcemodule LinearRing : sig ... end
Sourcemodule PolylineRing : sig ... end
Sourcemodule RouteFerryArrival : sig ... end

Details corresponding to the arrival for the leg.

Sourcemodule RouteFerryDeparture : sig ... end

Details corresponding to the departure for the leg.

Sourcemodule RouteFerryNoticeList : sig ... end
Sourcemodule RouteFerrySpanList : sig ... end
Sourcemodule RouteFerrySummary : sig ... end

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.

Sourcemodule RouteFerryTravelStepList : sig ... end
Sourcemodule RoutePedestrianArrival : sig ... end

Details corresponding to the arrival for a leg. Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm Examples: 2020-04-22T17:57:24Z 2020-04-22T17:57:24+02:00

Sourcemodule RoutePedestrianDeparture : sig ... end

Details corresponding to the departure for a leg. Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm Examples: 2020-04-22T17:57:24Z 2020-04-22T17:57:24+02:00

Sourcemodule RoutePedestrianNoticeList : sig ... end
Sourcemodule RoutePedestrianSpanList : sig ... end
Sourcemodule RoutePedestrianSummary : sig ... end

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

Sourcemodule RouteTollList : sig ... end
Sourcemodule RouteTollSystemList : sig ... end
Sourcemodule RouteVehicleArrival : sig ... end

Details corresponding to the arrival for a leg.

Sourcemodule RouteVehicleDeparture : sig ... end

Details corresponding to the departure for the leg.

Sourcemodule RouteVehicleIncidentList : sig ... end
Sourcemodule RouteVehicleNoticeList : sig ... end
Sourcemodule RouteVehicleSpanList : sig ... end
Sourcemodule RouteVehicleSummary : sig ... end

Summarized details of the route.

Sourcemodule RouteZoneList : sig ... end
Sourcemodule TruckRoadTypeList : sig ... end
Sourcemodule BoundingBox : sig ... end
Sourcemodule Corridor : sig ... end

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

Sourcemodule PolylineCorridor : sig ... end

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

Sourcemodule DayOfWeek : sig ... end
Sourcemodule TimeOfDay : sig ... end
Sourcemodule RouteFerryLegDetails : sig ... end

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel.

Sourcemodule RouteLegGeometry : sig ... end

The returned Route leg geometry.

Sourcemodule RouteLegTravelMode : sig ... end
Sourcemodule RouteLegType : sig ... end
Sourcemodule RoutePedestrianLegDetails : sig ... end

Details that are specific to a pedestrian leg.

Sourcemodule RouteVehicleLegDetails : sig ... end

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

Sourcemodule RouteTollPriceSummary : sig ... end

Summary of the route and toll price.

Geometry of the area to be avoided.

Sourcemodule MatchingStrategy : sig ... end
Sourcemodule IsolineConnectionGeometry : sig ... end

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.

Sourcemodule LinearRings : sig ... end
Sourcemodule PolylineRingList : sig ... end

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.

The failed constraint.

Geometry of the area to be avoided.

Sourcemodule WaypointIndex : sig ... end

Hours of entry.

Sourcemodule RouteLeg : sig ... end

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.

Sourcemodule RouteMajorRoadLabel : sig ... end

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

Sourcemodule RouteTollSummary : sig ... end

The toll summary for the complete route.

Sourcemodule RouteMatrixErrorCode : sig ... end
Sourcemodule SensitiveDouble : sig ... end
Sourcemodule Heading : sig ... end

Matching options.

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

Geometry of the area to be avoided.

Sourcemodule RouteMatrixZoneCategory : sig ... end
Sourcemodule IsolineConnection : sig ... end

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.

Sourcemodule IsolineShapeGeometry : sig ... end

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.

Sourcemodule IsolineZoneCategory : sig ... end
Sourcemodule IsolineHazardousCargoType : sig ... end
Sourcemodule RoadSnapNoticeCode : sig ... end
Sourcemodule ValidationExceptionField : sig ... end

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

Sourcemodule RoadSnapTrailerOptions : sig ... end

Trailer options corresponding to the vehicle.

Sourcemodule WaypointId : sig ... end
Sourcemodule ClusterIndex : sig ... end

The area to be avoided.

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. Unit: seconds

Sourcemodule CountryCode : sig ... end

Trailer options corresponding to the vehicle.

Sourcemodule BeforeWaypointsList : sig ... end

Access hours corresponding to when a destination can be visited.

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

Sourcemodule RouteLegList : sig ... end
Sourcemodule RouteMajorRoadLabelsList : sig ... end
Sourcemodule RouteSummary : sig ... end

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.

Sourcemodule RouteResponseNoticeCode : sig ... end
Sourcemodule RouteAvoidanceArea : sig ... end

Areas to be avoided.

Zone categories to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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

Sourcemodule RouteEngineType : sig ... end
Sourcemodule RouteVehicleLicensePlate : sig ... end

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

Sourcemodule RouteTrailerOptions : sig ... end

Trailer options corresponding to the vehicle.

Sourcemodule RouteMatchingOptions : sig ... end

Options related to route matching.

Sourcemodule RouteSideOfStreetOptions : sig ... end

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

Sourcemodule RouteMatrixEntry : sig ... end

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.

Sourcemodule Circle : sig ... end

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.

Sourcemodule RouteMatrixAutoCircle : sig ... end

Provides the circle that was used while calculating the route.

Options related to the destination.

Sourcemodule RouteMatrixOriginOptions : sig ... end

Origin related options.

Sourcemodule RouteMatrixAvoidanceArea : sig ... end

Area to be avoided.

Zone categories to be avoided.

The vehicle License Plate.

Sourcemodule RouteMatrixTrailerOptions : sig ... end

Trailer options corresponding to the vehicle.

Sourcemodule RouteMatrixTruckType : sig ... end
Sourcemodule IsolineConnectionList : sig ... end
Sourcemodule IsolineShapeGeometryList : sig ... end
Sourcemodule IsolineAvoidanceArea : sig ... end

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.

Types of regulated zones that may affect routing.

Sourcemodule IsolineEngineType : sig ... end

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

Sourcemodule IsolineTrailerOptions : sig ... end

Additional specifications when the vehicle includes one or more trailers.

Sourcemodule IsolineTruckType : sig ... end
Sourcemodule RoadSnapNotice : sig ... end

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

Sourcemodule RoadSnapSnappedTracePoint : sig ... end

TracePoints snapped onto the road network.

Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule RoadSnapTruckOptions : sig ... end

Travel mode options when the provided travel mode is Truck.

Sourcemodule RoadSnapTracePoint : sig ... end

TracePoint indices for which the provided notice code corresponds to.

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

The impeding waypoint.

The optimized waypoint.

Driving distance related options.

Resting phase of the cycle.

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

Sourcemodule CountryCodeList : sig ... end
Sourcemodule TrafficUsage : sig ... end

Options related to a pedestrian.

Travel mode options when the provided travel mode is Truck.

Waypoint between the Origin and Destination.

Sourcemodule Route : sig ... end

The route.

Sourcemodule RouteResponseNotice : sig ... end

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

Sourcemodule RouteAvoidanceAreaList : sig ... end
Sourcemodule RouteLegAdditionalFeature : sig ... end
Sourcemodule RouteEmissionType : sig ... end

Type of the emission. Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

Sourcemodule RouteTollVehicleCategory : sig ... end
Sourcemodule RouteCarOptions : sig ... end

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.

Sourcemodule RoutePedestrianOptions : sig ... end

Options related to the pedestrian. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Sourcemodule RouteScooterOptions : sig ... end

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.

Sourcemodule RouteTruckOptions : sig ... end

Travel mode options when the provided travel mode is Truck. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

Sourcemodule RouteWaypoint : sig ... end

Waypoint between the Origin and Destination.

Sourcemodule RouteMatrixRow : sig ... end

Geometry of the routing boundary.

Sourcemodule RouteMatrixDestination : sig ... end

The route destination.

Sourcemodule RouteMatrixOrigin : sig ... end

The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].

Sourcemodule RouteMatrixCarOptions : sig ... end

Travel mode options when the provided travel mode is Car.

Sourcemodule RouteMatrixScooterOptions : sig ... end

Travel mode options when the provided travel mode is Scooter.

Sourcemodule RouteMatrixTruckOptions : sig ... end

Travel mode options when the provided travel mode is Truck.

Sourcemodule Isoline : sig ... end

Represents a single reachable area calculated for a specific threshold.

Sourcemodule IsolineAvoidanceAreaList : sig ... end
Sourcemodule IsolineMatchingOptions : sig ... end

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.

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.

Sourcemodule DistanceThresholdList : sig ... end
Sourcemodule TimeThresholdList : sig ... end
Sourcemodule IsolineCarOptions : sig ... end

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.

Sourcemodule IsolineScooterOptions : sig ... end

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.

Sourcemodule IsolineTruckOptions : sig ... end

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. These apply when the provided travel mode is Truck

Sourcemodule AccessDeniedException : sig ... end

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

Sourcemodule GeometryFormat : sig ... end
Sourcemodule InternalServerException : sig ... end

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

Sourcemodule RoadSnapNoticeList : sig ... end
Sourcemodule RoadSnapSnappedGeometry : sig ... end

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

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ApiKey : sig ... end
Sourcemodule RoadSnapTravelMode : sig ... end
Sourcemodule RoadSnapTravelModeOptions : sig ... end

Travel mode related options for the provided travel mode.

Time breakdown for the sequence.

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.

Destination related options.

Driver 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.

Origin related options.

Options related to traffic.

Travel mode related options for the provided travel mode.

Sourcemodule RouteList : sig ... end
Sourcemodule RouteResponseNoticeList : sig ... end
Sourcemodule MeasurementSystem : sig ... end
Sourcemodule RouteAllowOptions : sig ... end

Features that are allowed while calculating a route.

Sourcemodule RouteAvoidanceOptions : sig ... end

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.

Sourcemodule RouteDestinationOptions : sig ... end

Options related to the destination.

Sourcemodule RouteDriverOptions : sig ... end

Driver related options.

Sourcemodule RouteExclusionOptions : sig ... end

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.

Sourcemodule RouteOriginOptions : sig ... end

Origin related options.

Sourcemodule RouteTollOptions : sig ... end

Options related to Tolls on a route.

Sourcemodule RouteTrafficOptions : sig ... end

Traffic options for the route.

Sourcemodule RouteTravelMode : sig ... end
Sourcemodule RouteTravelModeOptions : sig ... end

Travel mode related options for the provided travel mode.

Sourcemodule RouteTravelStepType : sig ... end
Sourcemodule RouteWaypointList : sig ... end
Sourcemodule RoutingObjective : sig ... end
Sourcemodule RouteMatrix : sig ... end
Sourcemodule RouteMatrixBoundary : sig ... end

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

Sourcemodule RouteMatrixAllowOptions : sig ... end

Allow Options related to the route matrix.

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.

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.

Sourcemodule RouteMatrixTrafficOptions : sig ... end

Traffic related options.

Sourcemodule RouteMatrixTravelMode : sig ... end

Travel mode related options for the provided travel mode.

Sourcemodule IsolineList : sig ... end
Sourcemodule IsolineAllowOptions : sig ... end

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.

Sourcemodule IsolineAvoidanceOptions : sig ... end

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. Avoidance options include physical features (like ferries and tunnels), road characteristics (like dirt roads and highways), and regulated areas (like congestion zones). They can be combined to match specific routing needs, such as avoiding both toll roads and ferries.

Sourcemodule IsolineDestinationOptions : sig ... end

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.

Sourcemodule IsolineGranularityOptions : sig ... end

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.

Sourcemodule IsolineOriginOptions : sig ... end

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.

Sourcemodule IsolineThresholds : sig ... end

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.

Sourcemodule IsolineTrafficOptions : sig ... end

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.

Sourcemodule IsolineTravelMode : sig ... end
Sourcemodule IsolineTravelModeOptions : sig ... end

Mode-specific routing options that further refine how reachable areas are calculated. Options are only considered when they match the selected travel mode.

Sourcemodule SnapToRoadsResponse : sig ... end

SnapToRoads matches GPS trace to roads most likely traveled on. For more information, see Snap to Roads in the Amazon Location Service Developer Guide.

Sourcemodule SnapToRoadsRequest : sig ... end

SnapToRoads matches GPS trace to roads most likely traveled on. For more information, see Snap to Roads in the Amazon Location Service Developer Guide.

Sourcemodule OptimizeWaypointsResponse : sig ... end

OptimizeWaypoints 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. For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.

Sourcemodule OptimizeWaypointsRequest : sig ... end

OptimizeWaypoints 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. For more information, see Optimize waypoints in the Amazon Location Service Developer Guide.

Sourcemodule CalculateRoutesResponse : sig ... end

CalculateRoutes computes routes given the following required parameters: Origin and Destination. For more information, see Calculate routes in the Amazon Location Service Developer Guide.

Sourcemodule CalculateRoutesRequest : sig ... end

CalculateRoutes computes routes given the following required parameters: Origin and Destination. For more information, see Calculate routes in the Amazon Location Service Developer Guide.

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. 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 Destinations positions. For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. 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 Destinations positions. For more information, see Calculate route matrix in the Amazon Location Service Developer Guide.

Sourcemodule CalculateIsolinesResponse : sig ... end

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time. Isolines (also known as isochrones for time-based calculations) are useful for various applications including: Service area visualization - Show customers the area you can serve within promised delivery times Site selection - Analyze potential business locations based on population within travel distance Site selection - Determine areas that can be reached within specified response times Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored. For more information, see Calculate isolines in the Amazon Location Service Developer Guide.

Sourcemodule CalculateIsolinesRequest : sig ... end

Calculates areas that can be reached within specified time or distance thresholds from a given point. For example, you can use this operation to determine the area within a 30-minute drive of a store location, find neighborhoods within walking distance of a school, or identify delivery zones based on drive time. Isolines (also known as isochrones for time-based calculations) are useful for various applications including: Service area visualization - Show customers the area you can serve within promised delivery times Site selection - Analyze potential business locations based on population within travel distance Site selection - Determine areas that can be reached within specified response times Route preferences such as avoiding toll roads or ferries are treated as preferences rather than absolute restrictions. If a viable route cannot be calculated while honoring all preferences, some may be ignored. For more information, see Calculate isolines in the Amazon Location Service Developer Guide.