Values.CalculateRoutesRequestSourceCalculateRoutes computes routes given the following required parameters: Origin and Destination. For more information, see Calculate routes in the Amazon Location Service Developer Guide.
type nonrec t = {allow : RouteAllowOptions.t option;Features that are allowed while calculating a route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)arrivalTime : TimestampWithTimezoneOffset.t option;Time of arrival at the destination. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. 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
*)avoid : RouteAvoidanceOptions.t option;Features that are avoided while calculating a route. 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. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only ControlledAccessHighways, Ferries, and TollRoads
*)departNow : SensitiveBoolean.t option;Uses the current time as the time of departure.
*)departureTime : TimestampWithTimezoneOffset.t option;Time of departure from the origin. 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
*)destination : Position.t;The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
*)destinationOptions : RouteDestinationOptions.t option;Destination related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)driver : RouteDriverOptions.t option;Driver related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)exclude : RouteExclusionOptions.t option;Features to be strictly excluded while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)instructionsMeasurementSystem : MeasurementSystem.t option;Measurement system to be used for instructions within steps in the response.
*)key : ApiKey.t option;Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
*)languages : CalculateRoutesRequestLanguagesList.t option;List of languages for instructions within steps in the response. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. Instructions in the requested language are returned only if they are available.
*)legAdditionalFeatures : RouteLegAdditionalFeatureList.t option;A list of optional additional parameters such as timezone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only PassThroughWaypoints, Summary, and TravelStepInstructions Elevation: Retrieves the elevation information for each location. Incidents: Provides information on traffic incidents along the route. PassThroughWaypoints: Indicates waypoints that are passed through without stopping. Summary: Returns a summary of the route, including distance and duration. Tolls: Supplies toll cost information along the route. TravelStepInstructions: Provides step-by-step instructions for travel along the route. TruckRoadTypes: Returns information about road types suitable for trucks. TypicalDuration: Gives typical travel duration based on historical data. Zones: Specifies the time zone information for each waypoint.
*)legGeometryFormat : GeometryFormat.t option;Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats. FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for https://github.com/aws-geospatial/polyline. Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.
*)maxAlternatives : CalculateRoutesRequestMaxAlternativesInteger.t option;Maximum number of alternative routes to be provided in the response, if available. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only up to 3 alternative routes.
*)optimizeRoutingFor : RoutingObjective.t option;Controls the trade-off between achieving the shortest travel time (FastestRoute) and achieving the shortest physical distance ((ShortestRoute) when calculating each route in the matrix. Default value: FastestRoute
*)origin : Position.t;The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].
*)originOptions : RouteOriginOptions.t option;Specifies how the origin point should be matched to the road network and any routing constraints that apply when the traveler is departing the origin. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)spanAdditionalFeatures : RouteSpanAdditionalFeatureList.t option;A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)tolls : RouteTollOptions.t option;Toll related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)traffic : RouteTrafficOptions.t option;Traffic related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)travelMode : RouteTravelMode.t option;Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car, Pedestrian, and Scooter values. Default value: Car
*)travelModeOptions : RouteTravelModeOptions.t option;Travel mode related options for the provided travel mode. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car and Pedestrian travel mode options.
*)travelStepType : RouteTravelStepType.t option;Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions Default does not return any steps.
*)waypoints : RouteWaypointList.t option;List of waypoints between the Origin and Destination. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions max length is 100. Max length: 23
*)}val make :
?allow:??? ->
?arrivalTime:??? ->
?avoid:??? ->
?departNow:??? ->
?departureTime:??? ->
?destinationOptions:??? ->
?driver:??? ->
?exclude:??? ->
?instructionsMeasurementSystem:??? ->
?key:??? ->
?languages:??? ->
?legAdditionalFeatures:??? ->
?legGeometryFormat:??? ->
?maxAlternatives:??? ->
?optimizeRoutingFor:??? ->
?originOptions:??? ->
?spanAdditionalFeatures:??? ->
?tolls:??? ->
?traffic:??? ->
?travelMode:??? ->
?travelModeOptions:??? ->
?travelStepType:??? ->
?waypoints:??? ->
destination:Position.t ->
origin:Position.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `Enum of string
| `Integer of CalculateRoutesRequestMaxAlternativesInteger.t
| `List of
[> `Double of Double.t
| `Enum of string
| `String of LanguageTag.t
| `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `Double of Heading.t
| `List of [> `Double of Double.t ] list
| `Long of RouteWaypointAvoidActionsForDistanceLong.t
| `Structure of
(string
* [> `Enum of string
| `List of [> `Double of Double.t ] list
| `Long of DistanceMeters.t
| `String of RouteMatchingOptionsNameHintString.t ])
list ])
list ]
list
| `String of TimestampWithTimezoneOffset.t
| `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `Double of Heading.t
| `Enum of string
| `List of
[> `String of TruckRoadType.t
| `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `List of
[> `Double of Double.t
| `List of
[> `List of
[> `Double of Double.t ] list ]
list
| `String of PolylineRing.t ]
list
| `Structure of
(string
* [> `Integer of Integer.t
| `List of
[> `List of
[> `Double of Double.t ] list ]
list
| `String of Polyline.t ])
list ])
list ]
list
| `Long of DurationSeconds.t
| `Structure of
(string
* [> `List of
[> `Double of Double.t
| `List of
[> `List of [> `Double of Double.t ] list ]
list
| `String of PolylineRing.t ]
list
| `Structure of
(string
* [> `Integer of Integer.t
| `List of
[> `List of [> `Double of Double.t ] list ]
list
| `String of Polyline.t ])
list ])
list ])
list ]
list
| `Long of RouteDestinationOptionsAvoidActionsForDistanceLong.t
| `String of CurrencyCode.t
| `Structure of
(string
* [> `Double of RouteCarOptionsMaxSpeedDouble.t
| `Enum of string
| `Integer of RouteCarOptionsOccupancyInteger.t
| `List of [> `Double of Double.t | `Enum of string ] list
| `Long of DistanceMeters.t
| `String of RouteMatchingOptionsNameHintString.t
| `Structure of
(string
* [> `Integer of RouteTrailerOptionsAxleCountInteger.t
| `Long of WeightKilograms.t
| `String of
RouteVehicleLicensePlateLastCharacterString.t ])
list ])
list ])
list ])
list ]