aws-sdk-georoutes 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b98d320ff2842db2ccd78b70b69b9e823912538e2cebcca1e34e3522862ac22
-  data.tar.gz: 72d10e6e6211bfef4796ac846eac8ffecca894d93cb1ff850c80924af175cafa
+  metadata.gz: bd68388c160e1e3b10e816aa4aefef4b56bd7dc818646056497fca4767f09e61
+  data.tar.gz: 1d848a33ac7f4a392321bcdaea32107c5111af2f68d438b7777fedaecf3225ed
 SHA512:
-  metadata.gz: c5c240edf9cb8dd5afabd66c723ba001a8b2092d0cbf74ea504fdd375d7fafb3c628b82fbcb7def65a6acae6a0abbd87dbf66f1ea2661cf79f4b68c91926027b
-  data.tar.gz: 3b09b99761a57a3c76f95c3b4a0dce12182744dd0e31d6cf9024b7006097873e143ed65668d7cc35e175561eed5ecea46cd7904f6edb1f076d3445498ad6c728
+  metadata.gz: a605aa509d071c03b7c9e06ad8a2186a9987b1d31de6b006dc83ad395a0a0c69a3a4d5c21473dc5946b82880c7fb9cacedc40ecd3234637cc3a8887e74292dd1
+  data.tar.gz: cd1d6c1ed7633c15764ff90c40a4bd67695e6a204a12122e6f54bdb458ed0ba4323671b63ede1662f580cd17f055192f6148361e379399430c43af090c42a96f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.3.0 (2025-01-31)
+------------------
+
+* Feature - The OptimizeWaypoints API now supports 50 waypoints per request (20 with constraints like AccessHours or AppointmentTime). It adds waypoint clustering via Clustering and ClusteringIndex for better optimization. Also, total distance validation is removed for greater flexibility.
+
 1.2.0 (2025-01-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/aws-sdk-georoutes/client.rb

@@ -474,7 +474,7 @@ module Aws::GeoRoutes
     # reached in a given threshold of time, distance.
     #
     # @option params [Types::IsolineAllowOptions] :allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating an isoline.
     #
     # @option params [String] :arrival_time
     #   Time of arrival at the destination.
@@ -521,7 +521,7 @@ module Aws::GeoRoutes
     #   Default Value:`FlexiblePolyline`
     #
     # @option params [Types::IsolineGranularityOptions] :isoline_granularity
-    #   Defines the granularity of the returned Isoline
+    #   Defines the granularity of the returned Isoline.
     #
     # @option params [String] :key
     #   Optional: The API key to be used for authorization. Either an API key
@@ -552,6 +552,15 @@ module Aws::GeoRoutes
     #   Threshold to be used for the isoline calculation. Up to 3 thresholds
     #   per provided type can be requested.
     #
+    #   You incur a calculation charge for each threshold. Using a large
+    #   amount of thresholds in a request can lead you to incur unexpected
+    #   charges. See [ Amazon Location's pricing page][1] for more
+    #   information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
+    #
     # @option params [Types::IsolineTrafficOptions] :traffic
     #   Traffic related options.
     #
@@ -786,13 +795,13 @@ module Aws::GeoRoutes
       req.send_request(options)
     end
 
-    # Calculates route matrix containing the 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.
+    # 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.
     #
     # @option params [Types::RouteMatrixAllowOptions] :allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating a route.
     #
     # @option params [Types::RouteMatrixAvoidanceOptions] :avoid
     #   Features that are avoided while calculating a route. Avoidance is on a
@@ -817,6 +826,17 @@ module Aws::GeoRoutes
     # @option params [required, Array<Types::RouteMatrixDestination>] :destinations
     #   List of destinations for the route.
     #
+    #   <note markdown="1"> 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. See [ Amazon Location's pricing page][1] for
+    #   more information.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
+    #
     # @option params [Types::RouteMatrixExclusionOptions] :exclude
     #   Features to be strictly excluded while calculating the route.
     #
@@ -832,6 +852,17 @@ module Aws::GeoRoutes
     # @option params [required, Array<Types::RouteMatrixOrigin>] :origins
     #   The position in longitude and latitude for the origin.
     #
+    #   <note markdown="1"> 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. See [ Amazon Location's pricing page][1] for more
+    #   information.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
+    #
     # @option params [required, Types::RouteMatrixBoundary] :routing_boundary
     #   Boundary within which the matrix is to be calculated. All data,
     #   origins and destinations outside the boundary are considered invalid.
@@ -1043,11 +1074,11 @@ module Aws::GeoRoutes
       req.send_request(options)
     end
 
-    # Calculates a route given the following required parameters: `Origin`
-    # and `Destination`.
+    # `CalculateRoutes` computes routes given the following required
+    # parameters: `Origin` and `Destination`.
     #
     # @option params [Types::RouteAllowOptions] :allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating a route.
     #
     # @option params [String] :arrival_time
     #   Time of arrival at the destination.
@@ -1191,7 +1222,7 @@ module Aws::GeoRoutes
     #   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
-    #   naviagtion system.
+    #   navigation system.
     #
     # @option params [Array<Types::RouteWaypoint>] :waypoints
     #   List of waypoints between the Origin and Destination.
@@ -1449,7 +1480,7 @@ module Aws::GeoRoutes
     #   resp.routes[0].legs[0].ferry_leg_details.departure.place.waypoint_index #=> Integer
     #   resp.routes[0].legs[0].ferry_leg_details.departure.time #=> String
     #   resp.routes[0].legs[0].ferry_leg_details.notices #=> Array
-    #   resp.routes[0].legs[0].ferry_leg_details.notices[0].code #=> String, one of "AccuratePolylineUnavailable", "NoSchedule", "Other", "ViolatedAvoidFerry", "ViolatedAvoidRailFerry"
+    #   resp.routes[0].legs[0].ferry_leg_details.notices[0].code #=> String, one of "AccuratePolylineUnavailable", "NoSchedule", "Other", "ViolatedAvoidFerry", "ViolatedAvoidRailFerry", "SeasonalClosure"
     #   resp.routes[0].legs[0].ferry_leg_details.notices[0].impact #=> String, one of "High", "Low"
     #   resp.routes[0].legs[0].ferry_leg_details.pass_through_waypoints #=> Array
     #   resp.routes[0].legs[0].ferry_leg_details.pass_through_waypoints[0].geometry_offset #=> Integer
@@ -1608,7 +1639,7 @@ module Aws::GeoRoutes
     #   resp.routes[0].legs[0].pedestrian_leg_details.travel_steps[0].turn_step_details.turn_angle #=> Float
     #   resp.routes[0].legs[0].pedestrian_leg_details.travel_steps[0].turn_step_details.turn_intensity #=> String, one of "Sharp", "Slight", "Typical"
     #   resp.routes[0].legs[0].pedestrian_leg_details.travel_steps[0].type #=> String, one of "Arrive", "Continue", "Depart", "Keep", "RoundaboutEnter", "RoundaboutExit", "RoundaboutPass", "Turn", "Exit", "Ramp", "UTurn"
-    #   resp.routes[0].legs[0].travel_mode #=> String, one of "Car", "Ferry", "Pedestrian", "Scooter", "Truck"
+    #   resp.routes[0].legs[0].travel_mode #=> String, one of "Car", "Ferry", "Pedestrian", "Scooter", "Truck", "CarShuttleTrain"
     #   resp.routes[0].legs[0].type #=> String, one of "Ferry", "Pedestrian", "Vehicle"
     #   resp.routes[0].legs[0].vehicle_leg_details.arrival.place.name #=> String
     #   resp.routes[0].legs[0].vehicle_leg_details.arrival.place.original_position #=> Array
@@ -1888,15 +1919,19 @@ module Aws::GeoRoutes
       req.send_request(options)
     end
 
-    # 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.
+    # `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.
     #
     # @option params [Types::WaypointOptimizationAvoidanceOptions] :avoid
-    #   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, this setting is ignored.
+    #   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.
+    #
+    # @option params [Types::WaypointOptimizationClusteringOptions] :clustering
+    #   Clustering allows you to specify how nearby waypoints can be clustered
+    #   to improve the optimized sequence.
     #
     # @option params [String] :departure_time
     #   Departure time from the waypoint.
@@ -1981,6 +2016,12 @@ module Aws::GeoRoutes
     #       tunnels: false,
     #       u_turns: false,
     #     },
+    #     clustering: {
+    #       algorithm: "DrivingDistance", # required, accepts DrivingDistance, TopologySegment
+    #       driving_distance_options: {
+    #         driving_distance: 1, # required
+    #       },
+    #     },
     #     departure_time: "TimestampWithTimezoneOffset",
     #     destination: [1.0],
     #     destination_options: {
@@ -2096,6 +2137,7 @@ module Aws::GeoRoutes
     #   resp.impeding_waypoints[0].position[0] #=> Float
     #   resp.optimized_waypoints #=> Array
     #   resp.optimized_waypoints[0].arrival_time #=> String
+    #   resp.optimized_waypoints[0].cluster_index #=> Integer
     #   resp.optimized_waypoints[0].departure_time #=> String
     #   resp.optimized_waypoints[0].id #=> String
     #   resp.optimized_waypoints[0].position #=> Array
@@ -2115,8 +2157,7 @@ module Aws::GeoRoutes
       req.send_request(options)
     end
 
-    # The SnapToRoads action matches GPS trace to roads most likely traveled
-    # on.
+    # `SnapToRoads` matches GPS trace to roads most likely traveled on.
     #
     # @option params [String] :key
     #   Optional: The API key to be used for authorization. Either an API key
@@ -2232,7 +2273,7 @@ module Aws::GeoRoutes
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-georoutes'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-georoutes/client_api.rb

@@ -31,6 +31,7 @@ module Aws::GeoRoutes
     CalculateRoutesRequestMaxAlternativesInteger = Shapes::IntegerShape.new(name: 'CalculateRoutesRequestMaxAlternativesInteger')
     CalculateRoutesResponse = Shapes::StructureShape.new(name: 'CalculateRoutesResponse')
     Circle = Shapes::StructureShape.new(name: 'Circle')
+    ClusterIndex = Shapes::IntegerShape.new(name: 'ClusterIndex')
     Corridor = Shapes::StructureShape.new(name: 'Corridor')
     CountryCode = Shapes::StringShape.new(name: 'CountryCode')
     CountryCode3 = Shapes::StringShape.new(name: 'CountryCode3')
@@ -448,11 +449,14 @@ module Aws::GeoRoutes
     WaypointOptimizationAvoidanceAreaGeometry = Shapes::StructureShape.new(name: 'WaypointOptimizationAvoidanceAreaGeometry')
     WaypointOptimizationAvoidanceOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationAvoidanceOptions')
     WaypointOptimizationAvoidanceOptionsAreasList = Shapes::ListShape.new(name: 'WaypointOptimizationAvoidanceOptionsAreasList')
+    WaypointOptimizationClusteringAlgorithm = Shapes::StringShape.new(name: 'WaypointOptimizationClusteringAlgorithm')
+    WaypointOptimizationClusteringOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationClusteringOptions')
     WaypointOptimizationConnection = Shapes::StructureShape.new(name: 'WaypointOptimizationConnection')
     WaypointOptimizationConnectionList = Shapes::ListShape.new(name: 'WaypointOptimizationConnectionList')
     WaypointOptimizationConstraint = Shapes::StringShape.new(name: 'WaypointOptimizationConstraint')
     WaypointOptimizationDestinationOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationDestinationOptions')
     WaypointOptimizationDriverOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationDriverOptions')
+    WaypointOptimizationDrivingDistanceOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationDrivingDistanceOptions')
     WaypointOptimizationExclusionOptions = Shapes::StructureShape.new(name: 'WaypointOptimizationExclusionOptions')
     WaypointOptimizationFailedConstraint = Shapes::StructureShape.new(name: 'WaypointOptimizationFailedConstraint')
     WaypointOptimizationFailedConstraintList = Shapes::ListShape.new(name: 'WaypointOptimizationFailedConstraintList')
@@ -762,6 +766,7 @@ module Aws::GeoRoutes
     LocalizedStringList.member = Shapes::ShapeRef.new(shape: LocalizedString)
 
     OptimizeWaypointsRequest.add_member(:avoid, Shapes::ShapeRef.new(shape: WaypointOptimizationAvoidanceOptions, location_name: "Avoid"))
+    OptimizeWaypointsRequest.add_member(:clustering, Shapes::ShapeRef.new(shape: WaypointOptimizationClusteringOptions, location_name: "Clustering"))
     OptimizeWaypointsRequest.add_member(:departure_time, Shapes::ShapeRef.new(shape: TimestampWithTimezoneOffset, location_name: "DepartureTime"))
     OptimizeWaypointsRequest.add_member(:destination, Shapes::ShapeRef.new(shape: Position, location_name: "Destination"))
     OptimizeWaypointsRequest.add_member(:destination_options, Shapes::ShapeRef.new(shape: WaypointOptimizationDestinationOptions, location_name: "DestinationOptions"))
@@ -1733,6 +1738,10 @@ module Aws::GeoRoutes
 
     WaypointOptimizationAvoidanceOptionsAreasList.member = Shapes::ShapeRef.new(shape: WaypointOptimizationAvoidanceArea)
 
+    WaypointOptimizationClusteringOptions.add_member(:algorithm, Shapes::ShapeRef.new(shape: WaypointOptimizationClusteringAlgorithm, required: true, location_name: "Algorithm"))
+    WaypointOptimizationClusteringOptions.add_member(:driving_distance_options, Shapes::ShapeRef.new(shape: WaypointOptimizationDrivingDistanceOptions, location_name: "DrivingDistanceOptions"))
+    WaypointOptimizationClusteringOptions.struct_class = Types::WaypointOptimizationClusteringOptions
+
     WaypointOptimizationConnection.add_member(:distance, Shapes::ShapeRef.new(shape: DistanceMeters, required: true, location_name: "Distance"))
     WaypointOptimizationConnection.add_member(:from, Shapes::ShapeRef.new(shape: WaypointId, required: true, location_name: "From"))
     WaypointOptimizationConnection.add_member(:rest_duration, Shapes::ShapeRef.new(shape: DurationSeconds, required: true, location_name: "RestDuration"))
@@ -1756,6 +1765,9 @@ module Aws::GeoRoutes
     WaypointOptimizationDriverOptions.add_member(:treat_service_time_as, Shapes::ShapeRef.new(shape: WaypointOptimizationServiceTimeTreatment, location_name: "TreatServiceTimeAs"))
     WaypointOptimizationDriverOptions.struct_class = Types::WaypointOptimizationDriverOptions
 
+    WaypointOptimizationDrivingDistanceOptions.add_member(:driving_distance, Shapes::ShapeRef.new(shape: DistanceMeters, required: true, location_name: "DrivingDistance"))
+    WaypointOptimizationDrivingDistanceOptions.struct_class = Types::WaypointOptimizationDrivingDistanceOptions
+
     WaypointOptimizationExclusionOptions.add_member(:countries, Shapes::ShapeRef.new(shape: CountryCodeList, required: true, location_name: "Countries"))
     WaypointOptimizationExclusionOptions.struct_class = Types::WaypointOptimizationExclusionOptions
 
@@ -1775,6 +1787,7 @@ module Aws::GeoRoutes
     WaypointOptimizationImpedingWaypointList.member = Shapes::ShapeRef.new(shape: WaypointOptimizationImpedingWaypoint)
 
     WaypointOptimizationOptimizedWaypoint.add_member(:arrival_time, Shapes::ShapeRef.new(shape: TimestampWithTimezoneOffset, location_name: "ArrivalTime"))
+    WaypointOptimizationOptimizedWaypoint.add_member(:cluster_index, Shapes::ShapeRef.new(shape: ClusterIndex, location_name: "ClusterIndex"))
     WaypointOptimizationOptimizedWaypoint.add_member(:departure_time, Shapes::ShapeRef.new(shape: TimestampWithTimezoneOffset, required: true, location_name: "DepartureTime"))
     WaypointOptimizationOptimizedWaypoint.add_member(:id, Shapes::ShapeRef.new(shape: WaypointId, required: true, location_name: "Id"))
     WaypointOptimizationOptimizedWaypoint.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))

data/lib/aws-sdk-georoutes/types.rb

@@ -24,7 +24,7 @@ module Aws::GeoRoutes
     end
 
     # @!attribute [rw] allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating an isoline.
     #   @return [Types::IsolineAllowOptions]
     #
     # @!attribute [rw] arrival_time
@@ -80,7 +80,7 @@ module Aws::GeoRoutes
     #   @return [String]
     #
     # @!attribute [rw] isoline_granularity
-    #   Defines the granularity of the returned Isoline
+    #   Defines the granularity of the returned Isoline.
     #   @return [Types::IsolineGranularityOptions]
     #
     # @!attribute [rw] key
@@ -116,6 +116,15 @@ module Aws::GeoRoutes
     # @!attribute [rw] thresholds
     #   Threshold to be used for the isoline calculation. Up to 3 thresholds
     #   per provided type can be requested.
+    #
+    #   You incur a calculation charge for each threshold. Using a large
+    #   amount of thresholds in a request can lead you to incur unexpected
+    #   charges. See [ Amazon Location's pricing page][1] for more
+    #   information.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
     #   @return [Types::IsolineThresholds]
     #
     # @!attribute [rw] traffic
@@ -227,7 +236,7 @@ module Aws::GeoRoutes
     end
 
     # @!attribute [rw] allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating a route.
     #   @return [Types::RouteMatrixAllowOptions]
     #
     # @!attribute [rw] avoid
@@ -256,6 +265,17 @@ module Aws::GeoRoutes
     #
     # @!attribute [rw] destinations
     #   List of destinations for the route.
+    #
+    #   <note markdown="1"> 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. See [ Amazon Location's pricing page][1]
+    #   for more information.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
     #   @return [Array<Types::RouteMatrixDestination>]
     #
     # @!attribute [rw] exclude
@@ -275,6 +295,17 @@ module Aws::GeoRoutes
     #
     # @!attribute [rw] origins
     #   The position in longitude and latitude for the origin.
+    #
+    #   <note markdown="1"> 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. See [ Amazon Location's pricing page][1] for
+    #   more information.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`
     #   @return [Array<Types::RouteMatrixOrigin>]
     #
     # @!attribute [rw] routing_boundary
@@ -364,7 +395,7 @@ module Aws::GeoRoutes
     end
 
     # @!attribute [rw] allow
-    #   Features that are allowed while calculating. a route
+    #   Features that are allowed while calculating a route.
     #   @return [Types::RouteAllowOptions]
     #
     # @!attribute [rw] arrival_time
@@ -535,7 +566,7 @@ module Aws::GeoRoutes
     #   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
-    #   naviagtion system.
+    #   navigation system.
     #   @return [String]
     #
     # @!attribute [rw] waypoints
@@ -698,15 +729,19 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Features that are allowed while calculating. a route
+    # Features that are allowed while calculating an isoline.
     #
     # @!attribute [rw] hot
-    #   Allow Hot (High Occupancy Toll) lanes while calculating the route.
+    #   Allow Hot (High Occupancy Toll) lanes while calculating an isoline.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @!attribute [rw] hov
-    #   Allow Hov (High Occupancy vehicle) lanes while calculating the
-    #   route.
+    #   Allow Hov (High Occupancy vehicle) lanes while calculating an
+    #   isoline.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/IsolineAllowOptions AWS API Documentation
@@ -722,7 +757,7 @@ module Aws::GeoRoutes
     #
     # @!attribute [rw] except
     #   Exceptions to the provided avoidance geometry, to be included while
-    #   calculating the route.
+    #   calculating an isoline.
     #   @return [Array<Types::IsolineAvoidanceAreaGeometry>]
     #
     # @!attribute [rw] geometry
@@ -738,7 +773,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # The avoidance geometry, to be included while calculating the route.
+    # The avoidance geometry, to be included while calculating an isoline.
     #
     # @!attribute [rw] bounding_box
     #   Geometry defined as a bounding box. The first pair represents the X
@@ -791,33 +826,33 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # 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.
+    # Features that are avoided while calculating isolines. 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.
     #
     # @!attribute [rw] areas
     #   Areas to be avoided.
     #   @return [Array<Types::IsolineAvoidanceArea>]
     #
     # @!attribute [rw] car_shuttle_trains
-    #   Avoid car-shuttle-trains while calculating the route.
+    #   Avoid car-shuttle-trains while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] controlled_access_highways
-    #   Avoid controlled access highways while calculating the route.
+    #   Avoid controlled access highways while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] dirt_roads
-    #   Avoid dirt roads while calculating the route.
+    #   Avoid dirt roads while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] ferries
-    #   Avoid ferries while calculating the route.
+    #   Avoid ferries while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] seasonal_closure
-    #   Avoid roads that have seasonal closure while calculating the route.
+    #   Avoid roads that have seasonal closure while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] toll_roads
@@ -840,7 +875,7 @@ module Aws::GeoRoutes
     #   @return [Array<String>]
     #
     # @!attribute [rw] tunnels
-    #   Avoid tunnels while calculating the route.
+    #   Avoid tunnels while calculating an isoline.
     #   @return [Boolean]
     #
     # @!attribute [rw] u_turns
@@ -884,7 +919,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options for vehicles.
+    # Travel mode options when the provided travel mode is `Car`.
     #
     # @!attribute [rw] engine_type
     #   Engine type of the vehicle.
@@ -945,7 +980,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Geometry of the connection between different Isoline components.
+    # Geometry of the connection between different isoline components.
     #
     # @!attribute [rw] line_string
     #   An ordered list of positions used to plot a route on a map.
@@ -1015,7 +1050,7 @@ module Aws::GeoRoutes
     # @!attribute [rw] max_resolution
     #   Maximum resolution of the returned isoline.
     #
-    #   **Unit**: `centimeters`
+    #   **Unit**: `meters`
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/IsolineGranularityOptions AWS API Documentation
@@ -1067,7 +1102,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options for the property.
+    # Origin related options.
     #
     # @!attribute [rw] avoid_actions_for_distance
     #   Avoids actions for the provided distance. This is typically to
@@ -1100,7 +1135,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options for the property.
+    # Travel mode options when the provided travel mode is `Scooter`
     #
     # @!attribute [rw] engine_type
     #   Engine type of the vehicle.
@@ -1185,7 +1220,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Threshold to be used for the isoline calculation. Up to 3 thresholds
+    # Threshold to be used for the isoline calculation. Up to 5 thresholds
     # per provided type can be requested.
     #
     # @!attribute [rw] distance
@@ -1262,7 +1297,12 @@ module Aws::GeoRoutes
     #   @return [Types::IsolineCarOptions]
     #
     # @!attribute [rw] scooter
-    #   Travel mode options when the provided travel mode is "Scooter"
+    #   Travel mode options when the provided travel mode is `Scooter`
+    #
+    #   <note markdown="1"> When travel mode is set to `Scooter`, then the avoidance option
+    #   `ControlledAccessHighways` defaults to `true`.
+    #
+    #    </note>
     #   @return [Types::IsolineScooterOptions]
     #
     # @!attribute [rw] truck
@@ -1471,11 +1511,16 @@ module Aws::GeoRoutes
     end
 
     # @!attribute [rw] avoid
-    #   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, this setting is ignored.
+    #   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.
     #   @return [Types::WaypointOptimizationAvoidanceOptions]
     #
+    # @!attribute [rw] clustering
+    #   Clustering allows you to specify how nearby waypoints can be
+    #   clustered to improve the optimized sequence.
+    #   @return [Types::WaypointOptimizationClusteringOptions]
+    #
     # @!attribute [rw] departure_time
     #   Departure time from the waypoint.
     #
@@ -1548,6 +1593,7 @@ module Aws::GeoRoutes
     #
     class OptimizeWaypointsRequest < Struct.new(
       :avoid,
+      :clustering,
       :departure_time,
       :destination,
       :destination_options,
@@ -1888,15 +1934,19 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Features that are allowed while calculating. a route
+    # Features that are allowed while calculating a route.
     #
     # @!attribute [rw] hot
     #   Allow Hot (High Occupancy Toll) lanes while calculating the route.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @!attribute [rw] hov
     #   Allow Hov (High Occupancy vehicle) lanes while calculating the
     #   route.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/RouteAllowOptions AWS API Documentation
@@ -1975,7 +2025,12 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options related to areas 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.
     #
     # @!attribute [rw] areas
     #   Areas to be avoided.
@@ -2065,7 +2120,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Travel mode options when the provided travel mode is "Car"
+    # Travel mode options when the provided travel mode is `Car`.
     #
     # @!attribute [rw] engine_type
     #   Engine type of the vehicle.
@@ -2278,7 +2333,9 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Exclusion options for the route.
+    # 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.
     #
     # @!attribute [rw] countries
     #   List of countries to be avoided defined by two-letter or
@@ -2573,6 +2630,8 @@ module Aws::GeoRoutes
     # @!attribute [rw] distance
     #   Distance of the computed span. This feature doesn't split a span,
     #   but is always computed on a span split by other properties.
+    #
+    #   **Unit**: `meters`
     #   @return [Integer]
     #
     # @!attribute [rw] duration
@@ -2865,11 +2924,15 @@ module Aws::GeoRoutes
     #
     # @!attribute [rw] hot
     #   Allow Hot (High Occupancy Toll) lanes while calculating the route.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @!attribute [rw] hov
     #   Allow Hov (High Occupancy vehicle) lanes while calculating the
     #   route.
+    #
+    #   Default value: `false`
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/RouteMatrixAllowOptions AWS API Documentation
@@ -2949,7 +3012,12 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # 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.
     #
     # @!attribute [rw] areas
     #   Areas to be avoided.
@@ -3089,7 +3157,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options related to the car.
+    # Travel mode options when the provided travel mode is `Car`.
     #
     # @!attribute [rw] license_plate
     #   The vehicle License Plate.
@@ -3198,7 +3266,9 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Exclusion 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.
     #
     # @!attribute [rw] countries
     #   List of countries to be avoided defined by two-letter or
@@ -3305,7 +3375,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Travel mode options when the provided travel mode is "Scooter"
+    # Travel mode options when the provided travel mode is `Scooter`
     #
     # @!attribute [rw] license_plate
     #   The vehicle License Plate.
@@ -3406,7 +3476,12 @@ module Aws::GeoRoutes
     #   @return [Types::RouteMatrixCarOptions]
     #
     # @!attribute [rw] scooter
-    #   Travel mode options when the provided travel mode is "Scooter"
+    #   Travel mode options when the provided travel mode is `Scooter`
+    #
+    #   <note markdown="1"> When travel mode is set to `Scooter`, then the avoidance option
+    #   `ControlledAccessHighways` defaults to `true`.
+    #
+    #    </note>
     #   @return [Types::RouteMatrixScooterOptions]
     #
     # @!attribute [rw] truck
@@ -4292,7 +4367,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Travel mode options when the provided travel mode is "Scooter"
+    # Travel mode options when the provided travel mode is `Scooter`
     #
     # @!attribute [rw] engine_type
     #   Engine type of the vehicle.
@@ -4861,7 +4936,12 @@ module Aws::GeoRoutes
     #   @return [Types::RoutePedestrianOptions]
     #
     # @!attribute [rw] scooter
-    #   Travel mode options when the provided travel mode is "Scooter"
+    #   Travel mode options when the provided travel mode is `Scooter`
+    #
+    #   <note markdown="1"> When travel mode is set to `Scooter`, then the avoidance option
+    #   `ControlledAccessHighways` defaults to `true`.
+    #
+    #    </note>
     #   @return [Types::RouteScooterOptions]
     #
     # @!attribute [rw] truck
@@ -6154,7 +6234,11 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options for WaypointOptimizationAvoidance.
+    # 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.
     #
     # @!attribute [rw] areas
     #   Areas to be avoided.
@@ -6204,6 +6288,30 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
+    # Options for WaypointOptimizationClustering.
+    #
+    # @!attribute [rw] algorithm
+    #   The algorithm to be used. `DrivingDistance` assigns all the
+    #   waypoints that are within driving distance of each other into a
+    #   single cluster. `TopologySegment` assigns all the waypoints that are
+    #   within the same topology segment into a single cluster. A Topology
+    #   segment is a linear stretch of road between two junctions.
+    #   @return [String]
+    #
+    # @!attribute [rw] driving_distance_options
+    #   Driving distance options to be used when the clustering algorithm is
+    #   DrivingDistance.
+    #   @return [Types::WaypointOptimizationDrivingDistanceOptions]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/WaypointOptimizationClusteringOptions AWS API Documentation
+    #
+    class WaypointOptimizationClusteringOptions < Struct.new(
+      :algorithm,
+      :driving_distance_options)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This contains information such as distance and duration from one
     # waypoint to the next waypoint in the sequence.
     #
@@ -6321,7 +6429,24 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Exclusion options.
+    # Driving distance related options.
+    #
+    # @!attribute [rw] driving_distance
+    #   DrivingDistance assigns all the waypoints that are within driving
+    #   distance of each other into a single cluster.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/geo-routes-2020-11-19/WaypointOptimizationDrivingDistanceOptions AWS API Documentation
+    #
+    class WaypointOptimizationDrivingDistanceOptions < Struct.new(
+      :driving_distance)
+      SENSITIVE = []
+      include Aws::Structure
+    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.
     #
     # @!attribute [rw] countries
     #   List of countries to be avoided defined by two-letter or
@@ -6394,6 +6519,12 @@ module Aws::GeoRoutes
     #   `2020-04-22T17:57:24+02:00`
     #   @return [String]
     #
+    # @!attribute [rw] cluster_index
+    #   Index of the cluster the waypoint is associated with. The index is
+    #   included in the response only if clustering was performed while
+    #   processing the request.
+    #   @return [Integer]
+    #
     # @!attribute [rw] departure_time
     #   Estimated time of departure from thr origin.
     #
@@ -6419,6 +6550,7 @@ module Aws::GeoRoutes
     #
     class WaypointOptimizationOptimizedWaypoint < Struct.new(
       :arrival_time,
+      :cluster_index,
       :departure_time,
       :id,
       :position)
@@ -6426,7 +6558,7 @@ module Aws::GeoRoutes
       include Aws::Structure
     end
 
-    # Options related to the origin.
+    # Origin related options.
     #
     # @!attribute [rw] id
     #   The Origin Id.

data/lib/aws-sdk-georoutes.rb

@@ -54,7 +54,7 @@ module Aws::GeoRoutes
   autoload :EndpointProvider, 'aws-sdk-georoutes/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-georoutes/endpoints'
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end
 

data/sig/client.rbs

@@ -664,6 +664,12 @@ module Aws
                                   tunnels: bool?,
                                   u_turns: bool?
                                 },
+                                ?clustering: {
+                                  algorithm: ("DrivingDistance" | "TopologySegment"),
+                                  driving_distance_options: {
+                                    driving_distance: ::Integer
+                                  }?
+                                },
                                 ?departure_time: ::String,
                                 ?destination: Array[::Float],
                                 ?destination_options: {

data/sig/types.rbs

@@ -307,6 +307,7 @@ module Aws::GeoRoutes
 
     class OptimizeWaypointsRequest
       attr_accessor avoid: Types::WaypointOptimizationAvoidanceOptions
+      attr_accessor clustering: Types::WaypointOptimizationClusteringOptions
       attr_accessor departure_time: ::String
       attr_accessor destination: ::Array[::Float]
       attr_accessor destination_options: Types::WaypointOptimizationDestinationOptions
@@ -549,7 +550,7 @@ module Aws::GeoRoutes
     end
 
     class RouteFerryNotice
-      attr_accessor code: ("AccuratePolylineUnavailable" | "NoSchedule" | "Other" | "ViolatedAvoidFerry" | "ViolatedAvoidRailFerry")
+      attr_accessor code: ("AccuratePolylineUnavailable" | "NoSchedule" | "Other" | "ViolatedAvoidFerry" | "ViolatedAvoidRailFerry" | "SeasonalClosure")
       attr_accessor impact: ("High" | "Low")
       SENSITIVE: []
     end
@@ -611,7 +612,7 @@ module Aws::GeoRoutes
       attr_accessor geometry: Types::RouteLegGeometry
       attr_accessor language: ::String
       attr_accessor pedestrian_leg_details: Types::RoutePedestrianLegDetails
-      attr_accessor travel_mode: ("Car" | "Ferry" | "Pedestrian" | "Scooter" | "Truck")
+      attr_accessor travel_mode: ("Car" | "Ferry" | "Pedestrian" | "Scooter" | "Truck" | "CarShuttleTrain")
       attr_accessor type: ("Ferry" | "Pedestrian" | "Vehicle")
       attr_accessor vehicle_leg_details: Types::RouteVehicleLegDetails
       SENSITIVE: []
@@ -1433,6 +1434,12 @@ module Aws::GeoRoutes
       SENSITIVE: []
     end
 
+    class WaypointOptimizationClusteringOptions
+      attr_accessor algorithm: ("DrivingDistance" | "TopologySegment")
+      attr_accessor driving_distance_options: Types::WaypointOptimizationDrivingDistanceOptions
+      SENSITIVE: []
+    end
+
     class WaypointOptimizationConnection
       attr_accessor distance: ::Integer
       attr_accessor from: ::String
@@ -1460,6 +1467,11 @@ module Aws::GeoRoutes
       SENSITIVE: []
     end
 
+    class WaypointOptimizationDrivingDistanceOptions
+      attr_accessor driving_distance: ::Integer
+      SENSITIVE: []
+    end
+
     class WaypointOptimizationExclusionOptions
       attr_accessor countries: ::Array[::String]
       SENSITIVE: []
@@ -1480,6 +1492,7 @@ module Aws::GeoRoutes
 
     class WaypointOptimizationOptimizedWaypoint
       attr_accessor arrival_time: ::String
+      attr_accessor cluster_index: ::Integer
       attr_accessor departure_time: ::String
       attr_accessor id: ::String
       attr_accessor position: ::Array[::Float]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-georoutes
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core