Module Values.OptimizeWaypointsRequestSource

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.

Sourcetype nonrec t = {
  1. avoid : WaypointOptimizationAvoidanceOptions.t option;
    (*

    Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

    *)
  2. clustering : WaypointOptimizationClusteringOptions.t option;
    (*

    Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

    *)
  3. departureTime : TimestampWithTimezoneOffset.t option;
    (*

    Departure time from the waypoint. 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

    *)
  4. destination : Position.t option;
    (*

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

    *)
  5. destinationOptions : WaypointOptimizationDestinationOptions.t option;
    (*

    Destination related options.

    *)
  6. driver : WaypointOptimizationDriverOptions.t option;
    (*

    Driver related options.

    *)
  7. exclude : WaypointOptimizationExclusionOptions.t option;
    (*

    Features to be strictly excluded while calculating the route.

    *)
  8. 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.

    *)
  9. optimizeSequencingFor : WaypointOptimizationSequencingObjective.t option;
    (*

    Specifies the optimization criteria for the calculated sequence. Default value: FastestRoute.

    *)
  10. origin : Position.t;
    (*

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

    *)
  11. originOptions : WaypointOptimizationOriginOptions.t option;
    (*

    Origin related options.

    *)
  12. traffic : WaypointOptimizationTrafficOptions.t option;
    (*

    Traffic-related options.

    *)
  13. travelMode : WaypointOptimizationTravelMode.t option;
    (*

    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. Default value: Car

    *)
  14. travelModeOptions : WaypointOptimizationTravelModeOptions.t option;
    (*

    Travel mode related options for the provided travel mode.

    *)
  15. waypoints : WaypointOptimizationWaypointList.t option;
    (*

    List of waypoints between the Origin and Destination.

    *)
}
Sourceval context_ : string
Sourceval make : ?avoid:??? -> ?clustering:??? -> ?departureTime:??? -> ?destination:??? -> ?destinationOptions:??? -> ?driver:??? -> ?exclude:??? -> ?key:??? -> ?optimizeSequencingFor:??? -> ?originOptions:??? -> ?traffic:??? -> ?travelMode:??? -> ?travelModeOptions:??? -> ?waypoints:??? -> origin:Position.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Double of Double.t | `Structure of (string * [> `Double of Heading.t | `List of [> `Double of Double.t | `Integer of WaypointIndex.t ] list | `Long of DurationSeconds.t | `String of TimestampWithTimezoneOffset.t | `Structure of (string * [> `Enum of string | `List of [> `Double of Double.t ] list | `Structure of (string * [> `Enum of string | `String of TimeOfDay.t ]) list ]) 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 CountryCode.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Double of Double.t ] list ]) list ]) list ] list | `Long of DurationSeconds.t | `String of TimestampWithTimezoneOffset.t | `Structure of (string * [> `Double of WaypointOptimizationPedestrianOptionsSpeedDouble.t | `Enum of string | `List of [> `Double of Double.t | `Enum of string ] list | `Long of WaypointOptimizationDrivingDistanceOptionsDrivingDistanceLong.t | `String of WaypointOptimizationRestProfileProfileString.t | `Structure of (string * [> `Enum of string | `Integer of WaypointOptimizationTrailerOptionsTrailerCountInteger.t | `Long of DurationSeconds.t | `String of TimeOfDay.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t