feat(client-geo-routes): 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.

Author: awstools

clients/client-geo-routes/README.md

@@ -6,13 +6,14 @@
 
 AWS SDK for JavaScript GeoRoutes Client for Node.js, Browser and React Native.
 
-<p>With the Amazon Location Routes API you can calculate
-routes and estimate travel time based on up-to-date road network and live
-traffic information.</p>
-<p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p>
+<p>With the Amazon Location Routes API you can calculate routes and estimate travel time
+based on up-to-date road network and live traffic information.</p>
+<p>Calculate optimal travel routes and estimate travel times using up-to-date road network
+and traffic data. Key features include:</p>
 <ul>
 <li>
-<p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p>
+<p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
+directions</p>
 </li>
 <li>
 <p>Multi-point route optimization to minimize travel time or distance</p>
@@ -21,7 +22,8 @@ traffic information.</p>
 <p>Route matrices for efficient multi-destination planning</p>
 </li>
 <li>
-<p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p>
+<p>Isoline calculations to determine reachable areas within specified time or
+distance thresholds</p>
 </li>
 <li>
 <p>Map-matching to align GPS traces with the road network</p>

clients/client-geo-routes/src/GeoRoutes.ts

@@ -112,13 +112,14 @@ export interface GeoRoutes {
 }
 
 /**
- * <p>With the Amazon Location Routes API you can calculate
- *        routes and estimate travel time based on up-to-date road network and live
- *        traffic information.</p>
- *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p>
+ * <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
+ *          based on up-to-date road network and live traffic information.</p>
+ *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
+ *          and traffic data. Key features include:</p>
  *          <ul>
  *             <li>
- *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p>
+ *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
+ *                directions</p>
  *             </li>
  *             <li>
  *                <p>Multi-point route optimization to minimize travel time or distance</p>
@@ -127,7 +128,8 @@ export interface GeoRoutes {
  *                <p>Route matrices for efficient multi-destination planning</p>
  *             </li>
  *             <li>
- *                <p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p>
+ *                <p>Isoline calculations to determine reachable areas within specified time or
+ *                distance thresholds</p>
  *             </li>
  *             <li>
  *                <p>Map-matching to align GPS traces with the road network</p>

clients/client-geo-routes/src/GeoRoutesClient.ts

@@ -283,13 +283,14 @@ export type GeoRoutesClientResolvedConfigType = __SmithyResolvedConfiguration<__
 export interface GeoRoutesClientResolvedConfig extends GeoRoutesClientResolvedConfigType {}
 
 /**
- * <p>With the Amazon Location Routes API you can calculate
- *        routes and estimate travel time based on up-to-date road network and live
- *        traffic information.</p>
- *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p>
+ * <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
+ *          based on up-to-date road network and live traffic information.</p>
+ *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
+ *          and traffic data. Key features include:</p>
  *          <ul>
  *             <li>
- *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p>
+ *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
+ *                directions</p>
  *             </li>
  *             <li>
  *                <p>Multi-point route optimization to minimize travel time or distance</p>
@@ -298,7 +299,8 @@ export interface GeoRoutesClientResolvedConfig extends GeoRoutesClientResolvedCo
  *                <p>Route matrices for efficient multi-destination planning</p>
  *             </li>
  *             <li>
- *                <p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p>
+ *                <p>Isoline calculations to determine reachable areas within specified time or
+ *                distance thresholds</p>
  *             </li>
  *             <li>
  *                <p>Map-matching to align GPS traces with the road network</p>

clients/client-geo-routes/src/commands/CalculateIsolinesCommand.ts

@@ -293,7 +293,8 @@ export interface CalculateIsolinesCommandOutput extends CalculateIsolinesRespons
  *  <p>You don't have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

clients/client-geo-routes/src/commands/CalculateRouteMatrixCommand.ts

@@ -33,9 +33,10 @@ export interface CalculateRouteMatrixCommandInput extends CalculateRouteMatrixRe
 export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p> Use <code>CalculateRouteMatrix</code> 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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -259,7 +260,8 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
  *  <p>You don't have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

clients/client-geo-routes/src/commands/CalculateRoutesCommand.ts

@@ -33,8 +33,9 @@ export interface CalculateRoutesCommandInput extends CalculateRoutesRequest {}
 export interface CalculateRoutesCommandOutput extends CalculateRoutesResponse, __MetadataBearer {}
 
 /**
- * <p>Calculates a route given the following required parameters:
- *       <code>Origin</code> and <code>Destination</code>.</p>
+ * <p>
+ *             <code>CalculateRoutes</code> computes routes given the following required parameters:
+ *             <code>Origin</code> and <code>Destination</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -947,7 +948,8 @@ export interface CalculateRoutesCommandOutput extends CalculateRoutesResponse, _
  *  <p>You don't have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

clients/client-geo-routes/src/commands/OptimizeWaypointsCommand.ts

@@ -33,9 +33,10 @@ export interface OptimizeWaypointsCommandInput extends OptimizeWaypointsRequest
 export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p>
+ *             <code>OptimizeWaypoints</code> 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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -61,6 +62,12 @@ export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsRespons
  *     Tunnels: true || false,
  *     UTurns: true || false,
  *   },
+ *   Clustering: { // WaypointOptimizationClusteringOptions
+ *     Algorithm: "STRING_VALUE", // required
+ *     DrivingDistanceOptions: { // WaypointOptimizationDrivingDistanceOptions
+ *       DrivingDistance: Number("long"), // required
+ *     },
+ *   },
  *   DepartureTime: "STRING_VALUE",
  *   Destination: [ // Position
  *     Number("double"),
@@ -201,6 +208,7 @@ export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsRespons
  * //   OptimizedWaypoints: [ // WaypointOptimizationOptimizedWaypointList // required
  * //     { // WaypointOptimizationOptimizedWaypoint
  * //       ArrivalTime: "STRING_VALUE",
+ * //       ClusterIndex: Number("int"),
  * //       DepartureTime: "STRING_VALUE", // required
  * //       Id: "STRING_VALUE", // required
  * //       Position: [ // required
@@ -229,7 +237,8 @@ export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsRespons
  *  <p>You don't have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

clients/client-geo-routes/src/commands/SnapToRoadsCommand.ts

@@ -33,7 +33,8 @@ export interface SnapToRoadsCommandInput extends SnapToRoadsRequest {}
 export interface SnapToRoadsCommandOutput extends SnapToRoadsResponse, __MetadataBearer {}
 
 /**
- * <p>The SnapToRoads action matches GPS trace to roads most likely traveled on.</p>
+ * <p>
+ *             <code>SnapToRoads</code> matches GPS trace to roads most likely traveled on.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -118,7 +119,8 @@ export interface SnapToRoadsCommandOutput extends SnapToRoadsResponse, __Metadat
  *  <p>You don't have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.</p>
+ *  <p>The request processing has failed because of an unknown error, exception or
+ *          failure.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>

clients/client-geo-routes/src/index.ts

@@ -1,13 +1,14 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>With the Amazon Location Routes API you can calculate
- *        routes and estimate travel time based on up-to-date road network and live
- *        traffic information.</p>
- *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:</p>
+ * <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
+ *          based on up-to-date road network and live traffic information.</p>
+ *          <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
+ *          and traffic data. Key features include:</p>
  *          <ul>
  *             <li>
- *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn directions</p>
+ *                <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
+ *                directions</p>
  *             </li>
  *             <li>
  *                <p>Multi-point route optimization to minimize travel time or distance</p>
@@ -16,7 +17,8 @@
  *                <p>Route matrices for efficient multi-destination planning</p>
  *             </li>
  *             <li>
- *                <p>Isoline calculations to determine reachable areas within specified time or distance thresholds</p>
+ *                <p>Isoline calculations to determine reachable areas within specified time or
+ *                distance thresholds</p>
  *             </li>
  *             <li>
  *                <p>Map-matching to align GPS traces with the road network</p>