Skip to content

Commit 37d295d

Browse files
author
awstools
committed
feat(client-geo-routes): Added RouteFerryNotice PotentialViolatedVehicleRestrictionUsage value for CalculateRoutes. This value indicates when the Route is potentially forbidden for the given vehicle profile.
1 parent abf1b24 commit 37d295d

File tree

11 files changed

+2532
-2615
lines changed

11 files changed

+2532
-2615
lines changed

clients/client-geo-routes/README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,7 @@
66

77
AWS SDK for JavaScript GeoRoutes Client for Node.js, Browser and React Native.
88

9-
<p>With the Amazon Location Routes API you can calculate routes and estimate travel time
10-
based on up-to-date road network and live traffic information.</p>
11-
<p>Calculate optimal travel routes and estimate travel times using up-to-date road network
12-
and traffic data. Key features include:</p>
13-
<ul>
14-
<li>
15-
<p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
16-
directions</p>
17-
</li>
18-
<li>
19-
<p>Multi-point route optimization to minimize travel time or distance</p>
20-
</li>
21-
<li>
22-
<p>Route matrices for efficient multi-destination planning</p>
23-
</li>
24-
<li>
25-
<p>Isoline calculations to determine reachable areas within specified time or
26-
distance thresholds</p>
27-
</li>
28-
<li>
29-
<p>Map-matching to align GPS traces with the road network</p>
30-
</li>
31-
</ul>
9+
<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> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <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> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
3210

3311
## Installing
3412

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

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -112,29 +112,7 @@ export interface GeoRoutes {
112112
}
113113

114114
/**
115-
* <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
116-
* based on up-to-date road network and live traffic information.</p>
117-
* <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
118-
* and traffic data. Key features include:</p>
119-
* <ul>
120-
* <li>
121-
* <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
122-
* directions</p>
123-
* </li>
124-
* <li>
125-
* <p>Multi-point route optimization to minimize travel time or distance</p>
126-
* </li>
127-
* <li>
128-
* <p>Route matrices for efficient multi-destination planning</p>
129-
* </li>
130-
* <li>
131-
* <p>Isoline calculations to determine reachable areas within specified time or
132-
* distance thresholds</p>
133-
* </li>
134-
* <li>
135-
* <p>Map-matching to align GPS traces with the road network</p>
136-
* </li>
137-
* </ul>
115+
* <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> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <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> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
138116
* @public
139117
*/
140118
export class GeoRoutes extends GeoRoutesClient implements GeoRoutes {}

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

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -283,29 +283,7 @@ export type GeoRoutesClientResolvedConfigType = __SmithyResolvedConfiguration<__
283283
export interface GeoRoutesClientResolvedConfig extends GeoRoutesClientResolvedConfigType {}
284284

285285
/**
286-
* <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
287-
* based on up-to-date road network and live traffic information.</p>
288-
* <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
289-
* and traffic data. Key features include:</p>
290-
* <ul>
291-
* <li>
292-
* <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
293-
* directions</p>
294-
* </li>
295-
* <li>
296-
* <p>Multi-point route optimization to minimize travel time or distance</p>
297-
* </li>
298-
* <li>
299-
* <p>Route matrices for efficient multi-destination planning</p>
300-
* </li>
301-
* <li>
302-
* <p>Isoline calculations to determine reachable areas within specified time or
303-
* distance thresholds</p>
304-
* </li>
305-
* <li>
306-
* <p>Map-matching to align GPS traces with the road network</p>
307-
* </li>
308-
* </ul>
286+
* <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> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <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> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
309287
* @public
310288
*/
311289
export class GeoRoutesClient extends __Client<

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CalculateIsolinesCommandInput extends CalculateIsolinesRequest
3333
export interface CalculateIsolinesCommandOutput extends CalculateIsolinesResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>Use the <code>CalculateIsolines</code> action to find service areas that can be reached
37-
* in a given threshold of time, distance.</p>
36+
* <p>Use the <code>CalculateIsolines</code> action to find service areas that can be reached in a given threshold of time, distance.</p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript
@@ -293,8 +292,7 @@ export interface CalculateIsolinesCommandOutput extends CalculateIsolinesRespons
293292
* <p>You don't have sufficient access to perform this action.</p>
294293
*
295294
* @throws {@link InternalServerException} (server fault)
296-
* <p>The request processing has failed because of an unknown error, exception or
297-
* failure.</p>
295+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
298296
*
299297
* @throws {@link ThrottlingException} (client fault)
300298
* <p>The request was denied due to request throttling.</p>

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ export interface CalculateRouteMatrixCommandInput extends CalculateRouteMatrixRe
3333
export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p> Use <code>CalculateRouteMatrix</code> to compute results for all pairs of Origins to
37-
* Destinations. Each row corresponds to one entry in Origins. Each entry in the row
38-
* corresponds to the route from that entry in Origins to an entry in Destinations
39-
* positions.</p>
36+
* <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>
4037
* @example
4138
* Use a bare-bones client and the command you need to make an API call.
4239
* ```javascript
@@ -260,8 +257,7 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
260257
* <p>You don't have sufficient access to perform this action.</p>
261258
*
262259
* @throws {@link InternalServerException} (server fault)
263-
* <p>The request processing has failed because of an unknown error, exception or
264-
* failure.</p>
260+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
265261
*
266262
* @throws {@link ThrottlingException} (client fault)
267263
* <p>The request was denied due to request throttling.</p>

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,7 @@ export interface CalculateRoutesCommandInput extends CalculateRoutesRequest {}
3333
export interface CalculateRoutesCommandOutput extends CalculateRoutesResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>
37-
* <code>CalculateRoutes</code> computes routes given the following required parameters:
38-
* <code>Origin</code> and <code>Destination</code>.</p>
36+
* <p> <code>CalculateRoutes</code> computes routes given the following required parameters: <code>Origin</code> and <code>Destination</code>.</p>
3937
* @example
4038
* Use a bare-bones client and the command you need to make an API call.
4139
* ```javascript
@@ -948,8 +946,7 @@ export interface CalculateRoutesCommandOutput extends CalculateRoutesResponse, _
948946
* <p>You don't have sufficient access to perform this action.</p>
949947
*
950948
* @throws {@link InternalServerException} (server fault)
951-
* <p>The request processing has failed because of an unknown error, exception or
952-
* failure.</p>
949+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
953950
*
954951
* @throws {@link ThrottlingException} (client fault)
955952
* <p>The request was denied due to request throttling.</p>

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ export interface OptimizeWaypointsCommandInput extends OptimizeWaypointsRequest
3333
export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsResponse, __MetadataBearer {}
3434

3535
/**
36-
* <p>
37-
* <code>OptimizeWaypoints</code> calculates the optimal order to travel between a set of
38-
* waypoints to minimize either the travel time or the distance travelled during the journey,
39-
* based on road network restrictions and the traffic pattern data.</p>
36+
* <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>
4037
* @example
4138
* Use a bare-bones client and the command you need to make an API call.
4239
* ```javascript
@@ -237,8 +234,7 @@ export interface OptimizeWaypointsCommandOutput extends OptimizeWaypointsRespons
237234
* <p>You don't have sufficient access to perform this action.</p>
238235
*
239236
* @throws {@link InternalServerException} (server fault)
240-
* <p>The request processing has failed because of an unknown error, exception or
241-
* failure.</p>
237+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
242238
*
243239
* @throws {@link ThrottlingException} (client fault)
244240
* <p>The request was denied due to request throttling.</p>

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface SnapToRoadsCommandInput extends SnapToRoadsRequest {}
3333
export interface SnapToRoadsCommandOutput extends SnapToRoadsResponse, __MetadataBearer {}
3434

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

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

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,7 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>With the Amazon Location Routes API you can calculate routes and estimate travel time
5-
* based on up-to-date road network and live traffic information.</p>
6-
* <p>Calculate optimal travel routes and estimate travel times using up-to-date road network
7-
* and traffic data. Key features include:</p>
8-
* <ul>
9-
* <li>
10-
* <p>Point-to-point routing with estimated travel time, distance, and turn-by-turn
11-
* directions</p>
12-
* </li>
13-
* <li>
14-
* <p>Multi-point route optimization to minimize travel time or distance</p>
15-
* </li>
16-
* <li>
17-
* <p>Route matrices for efficient multi-destination planning</p>
18-
* </li>
19-
* <li>
20-
* <p>Isoline calculations to determine reachable areas within specified time or
21-
* distance thresholds</p>
22-
* </li>
23-
* <li>
24-
* <p>Map-matching to align GPS traces with the road network</p>
25-
* </li>
26-
* </ul>
4+
* <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> </li> <li> <p>Multi-point route optimization to minimize travel time or distance</p> </li> <li> <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> </li> <li> <p>Map-matching to align GPS traces with the road network</p> </li> </ul>
275
*
286
* @packageDocumentation
297
*/

0 commit comments

Comments
 (0)