Values.CalculateRouteMatrixRequestSourceUse 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.
type nonrec t = {allow : RouteMatrixAllowOptions.t option;Features that are allowed while calculating a route.
*)avoid : RouteMatrixAvoidanceOptions.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 TollRoads, Ferries, and ControlledAccessHighways.
*)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
*)destinations : CalculateRouteMatrixRequestDestinationsList.t;List of destinations for the route. Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
*)exclude : RouteMatrixExclusionOptions.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.
*)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.
*)optimizeRoutingFor : RoutingObjective.t option;Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas. Default value: FastestRoute
*)origins : CalculateRouteMatrixRequestOriginsList.t;The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude]. Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.
*)routingBoundary : RouteMatrixBoundary.t option;Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Unbounded set to true. Default value: Unbounded set to true When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
*)traffic : RouteMatrixTrafficOptions.t option;Traffic related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)travelMode : RouteMatrixTravelMode.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. Default value: Car
*)travelModeOptions : RouteMatrixTravelModeOptions.t option;Travel mode related options for the provided travel mode. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
*)}val make :
?allow:??? ->
?avoid:??? ->
?departNow:??? ->
?departureTime:??? ->
?exclude:??? ->
?key:??? ->
?optimizeRoutingFor:??? ->
?routingBoundary:??? ->
?traffic:??? ->
?travelMode:??? ->
?travelModeOptions:??? ->
destinations:CalculateRouteMatrixRequestDestinationsList.t ->
origins:CalculateRouteMatrixRequestOriginsList.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `Enum of string
| `List of
[> `Structure of
(string
* [> `List of [> `Double of Double.t ] list
| `Structure of
(string
* [> `Double of Heading.t
| `Long of
RouteMatrixDestinationOptionsAvoidActionsForDistanceLong.t
| `Structure of
(string
* [> `Enum of string
| `List of [> `Double of Double.t ] list
| `Long of
RouteMatrixMatchingOptionsOnRoadThresholdLong.t
| `String of SensitiveString.t ])
list ])
list ])
list ]
list
| `String of TimestampWithTimezoneOffset.t
| `Structure of
(string
* [> `Boolean of SensitiveBoolean.t
| `Enum of string
| `List of
[> `String of TruckRoadType.t
| `Structure of
(string
* [> `Enum of string
| `Structure of
(string
* [> `List of
[> `Double of Double.t
| `List of
[> `List of [> `Double of Double.t ] list ]
list
| `String of PolylineRing.t ]
list ])
list ])
list ]
list
| `Long of DurationSeconds.t
| `Structure of
(string
* [> `Double of RouteMatrixCarOptionsMaxSpeedDouble.t
| `Enum of string
| `Integer of RouteMatrixCarOptionsOccupancyInteger.t
| `List of
[> `Double of Double.t
| `Enum of string
| `List of
[> `List of [> `Double of Double.t ] list ] list ]
list
| `Long of WeightKilograms.t
| `String of TunnelRestrictionCode.t
| `Structure of
(string
* [> `Double of SensitiveDouble.t
| `Integer of
RouteMatrixTrailerOptionsTrailerCountInteger.t
| `List of [> `Double of Double.t ] list
| `Long of RouteMatrixAutoCircleMarginLong.t
| `String of
RouteMatrixVehicleLicensePlateLastCharacterString.t ])
list ])
list ])
list ])
list ]