@aws-sdk/client-geo-routes 3.738.0 → 3.740.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -6
- package/dist-cjs/models/models_0.js +8 -2
- package/dist-cjs/protocols/Aws_restJson1.js +2 -0
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +2 -0
- package/dist-types/GeoRoutes.d.ts +8 -6
- package/dist-types/GeoRoutesClient.d.ts +8 -6
- package/dist-types/commands/CalculateIsolinesCommand.d.ts +2 -1
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +6 -4
- package/dist-types/commands/CalculateRoutesCommand.d.ts +5 -3
- package/dist-types/commands/OptimizeWaypointsCommand.d.ts +13 -4
- package/dist-types/commands/SnapToRoadsCommand.d.ts +4 -2
- package/dist-types/index.d.ts +8 -6
- package/dist-types/models/models_0.d.ts +588 -281
- package/dist-types/ts3.4/models/models_0.d.ts +19 -0
- package/package.json +1 -1
|
@@ -14,23 +14,28 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>Features that are allowed while calculating
|
|
17
|
+
* <p>Features that are allowed while calculating an isoline.</p>
|
|
18
18
|
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface IsolineAllowOptions {
|
|
21
21
|
/**
|
|
22
|
-
* <p>Allow Hot (High Occupancy Toll) lanes while calculating
|
|
22
|
+
* <p>Allow Hot (High Occupancy Toll) lanes while calculating an isoline.</p>
|
|
23
|
+
* <p>Default value: <code>false</code>
|
|
24
|
+
* </p>
|
|
23
25
|
* @public
|
|
24
26
|
*/
|
|
25
27
|
Hot?: boolean | undefined;
|
|
26
28
|
/**
|
|
27
|
-
* <p>Allow Hov (High Occupancy vehicle) lanes while calculating
|
|
29
|
+
* <p>Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.</p>
|
|
30
|
+
* <p>Default value: <code>false</code>
|
|
31
|
+
* </p>
|
|
28
32
|
* @public
|
|
29
33
|
*/
|
|
30
34
|
Hov?: boolean | undefined;
|
|
31
35
|
}
|
|
32
36
|
/**
|
|
33
|
-
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
37
|
+
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
38
|
+
* the corridor.</p>
|
|
34
39
|
* @public
|
|
35
40
|
*/
|
|
36
41
|
export interface Corridor {
|
|
@@ -55,7 +60,8 @@ export interface Corridor {
|
|
|
55
60
|
*/
|
|
56
61
|
export interface PolylineCorridor {
|
|
57
62
|
/**
|
|
58
|
-
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
63
|
+
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
64
|
+
* format.</p>
|
|
59
65
|
* <note>
|
|
60
66
|
* <p>LineString and Polyline are mutually exclusive properties.</p>
|
|
61
67
|
* </note>
|
|
@@ -63,7 +69,8 @@ export interface PolylineCorridor {
|
|
|
63
69
|
*/
|
|
64
70
|
Polyline: string | undefined;
|
|
65
71
|
/**
|
|
66
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
72
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
73
|
+
* roads that are considered are determined by the provided Strategy.</p>
|
|
67
74
|
* <p>
|
|
68
75
|
* <b>Unit</b>: <code>Meters</code>
|
|
69
76
|
* </p>
|
|
@@ -72,7 +79,7 @@ export interface PolylineCorridor {
|
|
|
72
79
|
Radius: number | undefined;
|
|
73
80
|
}
|
|
74
81
|
/**
|
|
75
|
-
* <p>The
|
|
82
|
+
* <p>The avoidance geometry, to be included while calculating an isoline.</p>
|
|
76
83
|
* @public
|
|
77
84
|
*/
|
|
78
85
|
export interface IsolineAvoidanceAreaGeometry {
|
|
@@ -84,24 +91,26 @@ export interface IsolineAvoidanceAreaGeometry {
|
|
|
84
91
|
*/
|
|
85
92
|
BoundingBox?: number[] | undefined;
|
|
86
93
|
/**
|
|
87
|
-
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
94
|
+
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
95
|
+
* the corridor.</p>
|
|
88
96
|
* @public
|
|
89
97
|
*/
|
|
90
98
|
Corridor?: Corridor | undefined;
|
|
91
99
|
/**
|
|
92
|
-
* <p>A list of Polygon will be excluded for calculating isolines, the list can only contain 1
|
|
100
|
+
* <p>A list of Polygon will be excluded for calculating isolines, the list can only contain 1
|
|
101
|
+
* polygon.</p>
|
|
93
102
|
* @public
|
|
94
103
|
*/
|
|
95
104
|
Polygon?: number[][][] | undefined;
|
|
96
105
|
/**
|
|
97
|
-
* <p>Geometry defined as an encoded corridor – a polyline with a radius that defines the
|
|
98
|
-
* encoding, see <a href="https://github.com/heremaps/flexiblepolyline/blob/master/README.md">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>.</p>
|
|
106
|
+
* <p>Geometry defined as an encoded corridor – a polyline with a radius that defines the
|
|
107
|
+
* width of the corridor. For more information on polyline encoding, see <a href="https://github.com/heremaps/flexiblepolyline/blob/master/README.md">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>.</p>
|
|
99
108
|
* @public
|
|
100
109
|
*/
|
|
101
110
|
PolylineCorridor?: PolylineCorridor | undefined;
|
|
102
111
|
/**
|
|
103
|
-
* <p>A list of PolylinePolygon's that are excluded for calculating isolines, the list can
|
|
104
|
-
* </p>
|
|
112
|
+
* <p>A list of PolylinePolygon's that are excluded for calculating isolines, the list can
|
|
113
|
+
* only contain 1 polygon. For more information on polyline encoding, see <a href="https://github.com/heremaps/flexiblepolyline/blob/master/README.md">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>. </p>
|
|
105
114
|
* @public
|
|
106
115
|
*/
|
|
107
116
|
PolylinePolygon?: string[] | undefined;
|
|
@@ -112,7 +121,8 @@ export interface IsolineAvoidanceAreaGeometry {
|
|
|
112
121
|
*/
|
|
113
122
|
export interface IsolineAvoidanceArea {
|
|
114
123
|
/**
|
|
115
|
-
* <p>Exceptions to the provided avoidance geometry, to be included while calculating
|
|
124
|
+
* <p>Exceptions to the provided avoidance geometry, to be included while calculating an
|
|
125
|
+
* isoline.</p>
|
|
116
126
|
* @public
|
|
117
127
|
*/
|
|
118
128
|
Except?: IsolineAvoidanceAreaGeometry[] | undefined;
|
|
@@ -147,8 +157,8 @@ export interface IsolineAvoidanceZoneCategory {
|
|
|
147
157
|
Category?: IsolineZoneCategory | undefined;
|
|
148
158
|
}
|
|
149
159
|
/**
|
|
150
|
-
* <p>Features that are avoided while calculating
|
|
151
|
-
* avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
160
|
+
* <p>Features that are avoided while calculating isolines. Avoidance is on a best-case basis.
|
|
161
|
+
* If an avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
152
162
|
* returned response produces a notice for the violation.</p>
|
|
153
163
|
* @public
|
|
154
164
|
*/
|
|
@@ -159,27 +169,27 @@ export interface IsolineAvoidanceOptions {
|
|
|
159
169
|
*/
|
|
160
170
|
Areas?: IsolineAvoidanceArea[] | undefined;
|
|
161
171
|
/**
|
|
162
|
-
* <p>Avoid car-shuttle-trains while calculating
|
|
172
|
+
* <p>Avoid car-shuttle-trains while calculating an isoline.</p>
|
|
163
173
|
* @public
|
|
164
174
|
*/
|
|
165
175
|
CarShuttleTrains?: boolean | undefined;
|
|
166
176
|
/**
|
|
167
|
-
* <p>Avoid controlled access highways while calculating
|
|
177
|
+
* <p>Avoid controlled access highways while calculating an isoline.</p>
|
|
168
178
|
* @public
|
|
169
179
|
*/
|
|
170
180
|
ControlledAccessHighways?: boolean | undefined;
|
|
171
181
|
/**
|
|
172
|
-
* <p>Avoid dirt roads while calculating
|
|
182
|
+
* <p>Avoid dirt roads while calculating an isoline.</p>
|
|
173
183
|
* @public
|
|
174
184
|
*/
|
|
175
185
|
DirtRoads?: boolean | undefined;
|
|
176
186
|
/**
|
|
177
|
-
* <p>Avoid ferries while calculating
|
|
187
|
+
* <p>Avoid ferries while calculating an isoline.</p>
|
|
178
188
|
* @public
|
|
179
189
|
*/
|
|
180
190
|
Ferries?: boolean | undefined;
|
|
181
191
|
/**
|
|
182
|
-
* <p>Avoid roads that have seasonal closure while calculating
|
|
192
|
+
* <p>Avoid roads that have seasonal closure while calculating an isoline.</p>
|
|
183
193
|
* @public
|
|
184
194
|
*/
|
|
185
195
|
SeasonalClosure?: boolean | undefined;
|
|
@@ -194,8 +204,8 @@ export interface IsolineAvoidanceOptions {
|
|
|
194
204
|
*/
|
|
195
205
|
TollTransponders?: boolean | undefined;
|
|
196
206
|
/**
|
|
197
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
198
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
207
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
208
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
199
209
|
* <note>
|
|
200
210
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
201
211
|
* </note>
|
|
@@ -203,7 +213,7 @@ export interface IsolineAvoidanceOptions {
|
|
|
203
213
|
*/
|
|
204
214
|
TruckRoadTypes?: string[] | undefined;
|
|
205
215
|
/**
|
|
206
|
-
* <p>Avoid tunnels while calculating
|
|
216
|
+
* <p>Avoid tunnels while calculating an isoline.</p>
|
|
207
217
|
* @public
|
|
208
218
|
*/
|
|
209
219
|
Tunnels?: boolean | undefined;
|
|
@@ -241,7 +251,8 @@ export interface IsolineMatchingOptions {
|
|
|
241
251
|
*/
|
|
242
252
|
NameHint?: string | undefined;
|
|
243
253
|
/**
|
|
244
|
-
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
254
|
+
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
255
|
+
* will be snapped to the highway/bridge/tunnel/sliproad.</p>
|
|
245
256
|
* <p>
|
|
246
257
|
* <b>Unit</b>: <code>meters</code>
|
|
247
258
|
* </p>
|
|
@@ -249,7 +260,8 @@ export interface IsolineMatchingOptions {
|
|
|
249
260
|
*/
|
|
250
261
|
OnRoadThreshold?: number | undefined;
|
|
251
262
|
/**
|
|
252
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
263
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
264
|
+
* roads that are considered are determined by the provided Strategy.</p>
|
|
253
265
|
* <p>
|
|
254
266
|
* <b>Unit</b>: <code>Meters</code>
|
|
255
267
|
* </p>
|
|
@@ -257,7 +269,9 @@ export interface IsolineMatchingOptions {
|
|
|
257
269
|
*/
|
|
258
270
|
Radius?: number | undefined;
|
|
259
271
|
/**
|
|
260
|
-
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
272
|
+
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
273
|
+
* all roads possible, whereas MatchMostSignificantRoad matches to the most significant
|
|
274
|
+
* road.</p>
|
|
261
275
|
* @public
|
|
262
276
|
*/
|
|
263
277
|
Strategy?: MatchingStrategy | undefined;
|
|
@@ -285,7 +299,8 @@ export interface IsolineSideOfStreetOptions {
|
|
|
285
299
|
*/
|
|
286
300
|
Position: number[] | undefined;
|
|
287
301
|
/**
|
|
288
|
-
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
302
|
+
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
303
|
+
* always use the provided position.</p>
|
|
289
304
|
* <p>Default Value: <code>DividedStreetOnly</code>
|
|
290
305
|
* </p>
|
|
291
306
|
* @public
|
|
@@ -298,7 +313,9 @@ export interface IsolineSideOfStreetOptions {
|
|
|
298
313
|
*/
|
|
299
314
|
export interface IsolineDestinationOptions {
|
|
300
315
|
/**
|
|
301
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
316
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
317
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
318
|
+
* destination.</p>
|
|
302
319
|
* @public
|
|
303
320
|
*/
|
|
304
321
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -343,7 +360,7 @@ export interface IsolineGranularityOptions {
|
|
|
343
360
|
/**
|
|
344
361
|
* <p>Maximum resolution of the returned isoline.</p>
|
|
345
362
|
* <p>
|
|
346
|
-
* <b>Unit</b>: <code>
|
|
363
|
+
* <b>Unit</b>: <code>meters</code>
|
|
347
364
|
* </p>
|
|
348
365
|
* @public
|
|
349
366
|
*/
|
|
@@ -375,12 +392,14 @@ export declare const RoutingObjective: {
|
|
|
375
392
|
*/
|
|
376
393
|
export type RoutingObjective = (typeof RoutingObjective)[keyof typeof RoutingObjective];
|
|
377
394
|
/**
|
|
378
|
-
* <p>
|
|
395
|
+
* <p>Origin related options.</p>
|
|
379
396
|
* @public
|
|
380
397
|
*/
|
|
381
398
|
export interface IsolineOriginOptions {
|
|
382
399
|
/**
|
|
383
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
400
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
401
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
402
|
+
* destination.</p>
|
|
384
403
|
* @public
|
|
385
404
|
*/
|
|
386
405
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -401,7 +420,7 @@ export interface IsolineOriginOptions {
|
|
|
401
420
|
SideOfStreet?: IsolineSideOfStreetOptions | undefined;
|
|
402
421
|
}
|
|
403
422
|
/**
|
|
404
|
-
* <p>Threshold to be used for the isoline calculation. Up to
|
|
423
|
+
* <p>Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type
|
|
405
424
|
* can be requested.</p>
|
|
406
425
|
* @public
|
|
407
426
|
*/
|
|
@@ -435,7 +454,10 @@ export type TrafficUsage = (typeof TrafficUsage)[keyof typeof TrafficUsage];
|
|
|
435
454
|
*/
|
|
436
455
|
export interface IsolineTrafficOptions {
|
|
437
456
|
/**
|
|
438
|
-
* <p>Duration for which flow traffic is considered valid. For this period, the flow traffic
|
|
457
|
+
* <p>Duration for which flow traffic is considered valid. For this period, the flow traffic
|
|
458
|
+
* is used over historical traffic data. Flow traffic refers to congestion, which changes very
|
|
459
|
+
* quickly. Duration in seconds for which flow traffic event would be considered valid. While
|
|
460
|
+
* flow traffic event is valid it will be used over the historical traffic data. </p>
|
|
439
461
|
* <p>
|
|
440
462
|
* <b>Unit</b>: <code>seconds</code>
|
|
441
463
|
* </p>
|
|
@@ -489,7 +511,7 @@ export interface IsolineVehicleLicensePlate {
|
|
|
489
511
|
LastCharacter?: string | undefined;
|
|
490
512
|
}
|
|
491
513
|
/**
|
|
492
|
-
* <p>
|
|
514
|
+
* <p>Travel mode options when the provided travel mode is <code>Car</code>.</p>
|
|
493
515
|
* @public
|
|
494
516
|
*/
|
|
495
517
|
export interface IsolineCarOptions {
|
|
@@ -520,7 +542,8 @@ export interface IsolineCarOptions {
|
|
|
520
542
|
Occupancy?: number | undefined;
|
|
521
543
|
}
|
|
522
544
|
/**
|
|
523
|
-
* <p>
|
|
545
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
546
|
+
* </p>
|
|
524
547
|
* @public
|
|
525
548
|
*/
|
|
526
549
|
export interface IsolineScooterOptions {
|
|
@@ -603,7 +626,8 @@ export declare const IsolineTruckType: {
|
|
|
603
626
|
*/
|
|
604
627
|
export type IsolineTruckType = (typeof IsolineTruckType)[keyof typeof IsolineTruckType];
|
|
605
628
|
/**
|
|
606
|
-
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
629
|
+
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
630
|
+
* that have different regulations based on the axle group type.</p>
|
|
607
631
|
* <p>
|
|
608
632
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
609
633
|
* </p>
|
|
@@ -756,8 +780,9 @@ export interface IsolineTruckOptions {
|
|
|
756
780
|
TruckType?: IsolineTruckType | undefined;
|
|
757
781
|
/**
|
|
758
782
|
* <p>The tunnel restriction code.</p>
|
|
759
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
760
|
-
* They relate to the types of dangerous goods that can be transported
|
|
783
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
784
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
785
|
+
* through them.</p>
|
|
761
786
|
* <ul>
|
|
762
787
|
* <li>
|
|
763
788
|
* <p>
|
|
@@ -824,7 +849,9 @@ export interface IsolineTruckOptions {
|
|
|
824
849
|
*/
|
|
825
850
|
TunnelRestrictionCode?: string | undefined;
|
|
826
851
|
/**
|
|
827
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
852
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
853
|
+
* usage in countries where the differences in axle types or axle groups are not
|
|
854
|
+
* distinguished.</p>
|
|
828
855
|
* <p>
|
|
829
856
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
830
857
|
* </p>
|
|
@@ -832,7 +859,8 @@ export interface IsolineTruckOptions {
|
|
|
832
859
|
*/
|
|
833
860
|
WeightPerAxle?: number | undefined;
|
|
834
861
|
/**
|
|
835
|
-
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
862
|
+
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
863
|
+
* that have different regulations based on the axle group type.</p>
|
|
836
864
|
* <p>
|
|
837
865
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
838
866
|
* </p>
|
|
@@ -859,7 +887,12 @@ export interface IsolineTravelModeOptions {
|
|
|
859
887
|
*/
|
|
860
888
|
Car?: IsolineCarOptions | undefined;
|
|
861
889
|
/**
|
|
862
|
-
* <p>Travel mode options when the provided travel mode is
|
|
890
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
891
|
+
* </p>
|
|
892
|
+
* <note>
|
|
893
|
+
* <p>When travel mode is set to <code>Scooter</code>, then the avoidance option
|
|
894
|
+
* <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p>
|
|
895
|
+
* </note>
|
|
863
896
|
* @public
|
|
864
897
|
*/
|
|
865
898
|
Scooter?: IsolineScooterOptions | undefined;
|
|
@@ -874,13 +907,14 @@ export interface IsolineTravelModeOptions {
|
|
|
874
907
|
*/
|
|
875
908
|
export interface CalculateIsolinesRequest {
|
|
876
909
|
/**
|
|
877
|
-
* <p>Features that are allowed while calculating
|
|
910
|
+
* <p>Features that are allowed while calculating an isoline.</p>
|
|
878
911
|
* @public
|
|
879
912
|
*/
|
|
880
913
|
Allow?: IsolineAllowOptions | undefined;
|
|
881
914
|
/**
|
|
882
915
|
* <p>Time of arrival at the destination.</p>
|
|
883
|
-
* <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ |
|
|
916
|
+
* <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ |
|
|
917
|
+
* YYYY-MM-DDThh:mm:ss.sss+hh:mm</code>
|
|
884
918
|
* </p>
|
|
885
919
|
* <p>Examples:</p>
|
|
886
920
|
* <p>
|
|
@@ -893,8 +927,8 @@ export interface CalculateIsolinesRequest {
|
|
|
893
927
|
*/
|
|
894
928
|
ArrivalTime?: string | undefined;
|
|
895
929
|
/**
|
|
896
|
-
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
897
|
-
* avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
930
|
+
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
931
|
+
* If an avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
898
932
|
* returned response produces a notice for the violation.</p>
|
|
899
933
|
* @public
|
|
900
934
|
*/
|
|
@@ -919,7 +953,8 @@ export interface CalculateIsolinesRequest {
|
|
|
919
953
|
*/
|
|
920
954
|
DepartureTime?: string | undefined;
|
|
921
955
|
/**
|
|
922
|
-
* <p>The final position for the route. In the World Geodetic System (WGS 84) format:
|
|
956
|
+
* <p>The final position for the route. In the World Geodetic System (WGS 84) format:
|
|
957
|
+
* <code>[longitude, latitude]</code>.</p>
|
|
923
958
|
* @public
|
|
924
959
|
*/
|
|
925
960
|
Destination?: number[] | undefined;
|
|
@@ -936,7 +971,7 @@ export interface CalculateIsolinesRequest {
|
|
|
936
971
|
*/
|
|
937
972
|
IsolineGeometryFormat?: GeometryFormat | undefined;
|
|
938
973
|
/**
|
|
939
|
-
* <p>Defines the granularity of the returned Isoline
|
|
974
|
+
* <p>Defines the granularity of the returned Isoline.</p>
|
|
940
975
|
* @public
|
|
941
976
|
*/
|
|
942
977
|
IsolineGranularity?: IsolineGranularityOptions | undefined;
|
|
@@ -947,9 +982,10 @@ export interface CalculateIsolinesRequest {
|
|
|
947
982
|
*/
|
|
948
983
|
Key?: string | undefined;
|
|
949
984
|
/**
|
|
950
|
-
* <p>Specifies the optimization criteria for when calculating an isoline. AccurateCalculation
|
|
951
|
-
*
|
|
952
|
-
*
|
|
985
|
+
* <p>Specifies the optimization criteria for when calculating an isoline. AccurateCalculation
|
|
986
|
+
* generates an isoline of higher granularity that is more precise. FastCalculation generates
|
|
987
|
+
* an isoline faster by reducing the granularity, and in turn the quality of the isoline.
|
|
988
|
+
* BalancedCalculation generates an isoline by balancing between quality and performance. </p>
|
|
953
989
|
* <p>Default Value: <code>BalancedCalculation</code>
|
|
954
990
|
* </p>
|
|
955
991
|
* @public
|
|
@@ -973,8 +1009,12 @@ export interface CalculateIsolinesRequest {
|
|
|
973
1009
|
*/
|
|
974
1010
|
OriginOptions?: IsolineOriginOptions | undefined;
|
|
975
1011
|
/**
|
|
976
|
-
* <p>Threshold to be used for the isoline calculation. Up to
|
|
977
|
-
*
|
|
1012
|
+
* <p>Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type
|
|
1013
|
+
* can be requested.</p>
|
|
1014
|
+
* <p> You incur a calculation charge for each threshold. Using a large amount of thresholds in a
|
|
1015
|
+
* request can lead you to incur unexpected charges. See
|
|
1016
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`">
|
|
1017
|
+
* Amazon Location's pricing page</a> for more information.</p>
|
|
978
1018
|
* @public
|
|
979
1019
|
*/
|
|
980
1020
|
Thresholds: IsolineThresholds | undefined;
|
|
@@ -984,10 +1024,11 @@ export interface CalculateIsolinesRequest {
|
|
|
984
1024
|
*/
|
|
985
1025
|
Traffic?: IsolineTrafficOptions | undefined;
|
|
986
1026
|
/**
|
|
987
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
988
|
-
*
|
|
1027
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
1028
|
+
* of travel and road compatibility.</p>
|
|
989
1029
|
* <note>
|
|
990
|
-
* <p> The mode <code>Scooter</code> also applies to motorcycles, set to
|
|
1030
|
+
* <p> The mode <code>Scooter</code> also applies to motorcycles, set to
|
|
1031
|
+
* <code>Scooter</code> when wanted to calculate options for motorcycles.</p>
|
|
991
1032
|
* </note>
|
|
992
1033
|
* <p>Default Value: <code>Car</code>
|
|
993
1034
|
* </p>
|
|
@@ -1001,7 +1042,7 @@ export interface CalculateIsolinesRequest {
|
|
|
1001
1042
|
TravelModeOptions?: IsolineTravelModeOptions | undefined;
|
|
1002
1043
|
}
|
|
1003
1044
|
/**
|
|
1004
|
-
* <p>Geometry of the connection between different
|
|
1045
|
+
* <p>Geometry of the connection between different isoline components.</p>
|
|
1005
1046
|
* @public
|
|
1006
1047
|
*/
|
|
1007
1048
|
export interface IsolineConnectionGeometry {
|
|
@@ -1014,7 +1055,8 @@ export interface IsolineConnectionGeometry {
|
|
|
1014
1055
|
*/
|
|
1015
1056
|
LineString?: number[][] | undefined;
|
|
1016
1057
|
/**
|
|
1017
|
-
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
1058
|
+
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
1059
|
+
* format.</p>
|
|
1018
1060
|
* <note>
|
|
1019
1061
|
* <p>LineString and Polyline are mutually exclusive properties.</p>
|
|
1020
1062
|
* </note>
|
|
@@ -1023,12 +1065,15 @@ export interface IsolineConnectionGeometry {
|
|
|
1023
1065
|
Polyline?: string | undefined;
|
|
1024
1066
|
}
|
|
1025
1067
|
/**
|
|
1026
|
-
* <p>Isolines may contain multiple components, if these components are connected by ferry
|
|
1068
|
+
* <p>Isolines may contain multiple components, if these components are connected by ferry
|
|
1069
|
+
* links. These components are returned as separate polygons while the ferry links are
|
|
1070
|
+
* returned as connections.</p>
|
|
1027
1071
|
* @public
|
|
1028
1072
|
*/
|
|
1029
1073
|
export interface IsolineConnection {
|
|
1030
1074
|
/**
|
|
1031
|
-
* <p>Index of the polygon corresponding to the "from" component of the connection.
|
|
1075
|
+
* <p>Index of the polygon corresponding to the "from" component of the connection.
|
|
1076
|
+
* The polygon is available from <code>Isoline[].Geometries</code>.</p>
|
|
1032
1077
|
* @public
|
|
1033
1078
|
*/
|
|
1034
1079
|
FromPolygonIndex: number | undefined;
|
|
@@ -1038,7 +1083,8 @@ export interface IsolineConnection {
|
|
|
1038
1083
|
*/
|
|
1039
1084
|
Geometry: IsolineConnectionGeometry | undefined;
|
|
1040
1085
|
/**
|
|
1041
|
-
* <p>Index of the polygon corresponding to the "to" component of the connection.
|
|
1086
|
+
* <p>Index of the polygon corresponding to the "to" component of the connection.
|
|
1087
|
+
* The polygon is available from <code>Isoline[].Geometries</code>.</p>
|
|
1042
1088
|
* @public
|
|
1043
1089
|
*/
|
|
1044
1090
|
ToPolygonIndex: number | undefined;
|
|
@@ -1049,14 +1095,15 @@ export interface IsolineConnection {
|
|
|
1049
1095
|
*/
|
|
1050
1096
|
export interface IsolineShapeGeometry {
|
|
1051
1097
|
/**
|
|
1052
|
-
* <p>A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first
|
|
1098
|
+
* <p>A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first
|
|
1099
|
+
* linear ring (the outer ring) and from 2nd item to the last item (the inner rings).</p>
|
|
1053
1100
|
* @public
|
|
1054
1101
|
*/
|
|
1055
1102
|
Polygon?: number[][][] | undefined;
|
|
1056
1103
|
/**
|
|
1057
|
-
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1104
|
+
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains
|
|
1105
|
+
* PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last
|
|
1106
|
+
* item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/heremaps/flexiblepolyline/blob/master/README.md">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>.</p>
|
|
1060
1107
|
* @public
|
|
1061
1108
|
*/
|
|
1062
1109
|
PolylinePolygon?: string[] | undefined;
|
|
@@ -1067,7 +1114,9 @@ export interface IsolineShapeGeometry {
|
|
|
1067
1114
|
*/
|
|
1068
1115
|
export interface Isoline {
|
|
1069
1116
|
/**
|
|
1070
|
-
* <p>Isolines may contain multiple components, if these components are connected by ferry
|
|
1117
|
+
* <p>Isolines may contain multiple components, if these components are connected by ferry
|
|
1118
|
+
* links. These components are returned as separate polygons while the ferry links are
|
|
1119
|
+
* returned as connections.</p>
|
|
1071
1120
|
* @public
|
|
1072
1121
|
*/
|
|
1073
1122
|
Connections: IsolineConnection[] | undefined;
|
|
@@ -1092,7 +1141,8 @@ export interface Isoline {
|
|
|
1092
1141
|
*/
|
|
1093
1142
|
export interface CalculateIsolinesResponse {
|
|
1094
1143
|
/**
|
|
1095
|
-
* <p>Time of arrival at the destination. This parameter is returned only if the Destination
|
|
1144
|
+
* <p>Time of arrival at the destination. This parameter is returned only if the Destination
|
|
1145
|
+
* parameters was provided in the request. </p>
|
|
1096
1146
|
* <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code>
|
|
1097
1147
|
* </p>
|
|
1098
1148
|
* <p>Examples:</p>
|
|
@@ -1148,7 +1198,8 @@ export interface CalculateIsolinesResponse {
|
|
|
1148
1198
|
SnappedOrigin?: number[] | undefined;
|
|
1149
1199
|
}
|
|
1150
1200
|
/**
|
|
1151
|
-
* <p>The request processing has failed because of an unknown error, exception or
|
|
1201
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
1202
|
+
* failure.</p>
|
|
1152
1203
|
* @public
|
|
1153
1204
|
*/
|
|
1154
1205
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -1176,7 +1227,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1176
1227
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1177
1228
|
}
|
|
1178
1229
|
/**
|
|
1179
|
-
* <p>The input fails to satisfy the constraints specified by the Amazon Location
|
|
1230
|
+
* <p>The input fails to satisfy the constraints specified by the Amazon Location
|
|
1231
|
+
* service.</p>
|
|
1180
1232
|
* @public
|
|
1181
1233
|
*/
|
|
1182
1234
|
export interface ValidationExceptionField {
|
|
@@ -1259,11 +1311,15 @@ export declare class ValidationException extends __BaseException {
|
|
|
1259
1311
|
export interface RouteMatrixAllowOptions {
|
|
1260
1312
|
/**
|
|
1261
1313
|
* <p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p>
|
|
1314
|
+
* <p>Default value: <code>false</code>
|
|
1315
|
+
* </p>
|
|
1262
1316
|
* @public
|
|
1263
1317
|
*/
|
|
1264
1318
|
Hot?: boolean | undefined;
|
|
1265
1319
|
/**
|
|
1266
1320
|
* <p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p>
|
|
1321
|
+
* <p>Default value: <code>false</code>
|
|
1322
|
+
* </p>
|
|
1267
1323
|
* @public
|
|
1268
1324
|
*/
|
|
1269
1325
|
Hov?: boolean | undefined;
|
|
@@ -1329,7 +1385,11 @@ export interface RouteMatrixAvoidanceZoneCategory {
|
|
|
1329
1385
|
Category?: RouteMatrixZoneCategory | undefined;
|
|
1330
1386
|
}
|
|
1331
1387
|
/**
|
|
1332
|
-
* <p>
|
|
1388
|
+
* <p>Specifies options for areas to avoid when calculating the route. This is a best-effort
|
|
1389
|
+
* avoidance setting, meaning the router will try to honor the avoidance preferences but may
|
|
1390
|
+
* still include restricted areas if no feasible alternative route exists. If avoidance
|
|
1391
|
+
* options are not followed, the response will indicate that the avoidance criteria were
|
|
1392
|
+
* violated.</p>
|
|
1333
1393
|
* @public
|
|
1334
1394
|
*/
|
|
1335
1395
|
export interface RouteMatrixAvoidanceOptions {
|
|
@@ -1369,8 +1429,8 @@ export interface RouteMatrixAvoidanceOptions {
|
|
|
1369
1429
|
*/
|
|
1370
1430
|
TollTransponders?: boolean | undefined;
|
|
1371
1431
|
/**
|
|
1372
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
1373
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
1432
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
1433
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
1374
1434
|
* <note>
|
|
1375
1435
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
1376
1436
|
* </note>
|
|
@@ -1404,7 +1464,8 @@ export interface RouteMatrixMatchingOptions {
|
|
|
1404
1464
|
*/
|
|
1405
1465
|
NameHint?: string | undefined;
|
|
1406
1466
|
/**
|
|
1407
|
-
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
1467
|
+
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
1468
|
+
* will be snapped to the highway/bridge/tunnel/sliproad.</p>
|
|
1408
1469
|
* <p>
|
|
1409
1470
|
* <b>Unit</b>: <code>meters</code>
|
|
1410
1471
|
* </p>
|
|
@@ -1412,7 +1473,8 @@ export interface RouteMatrixMatchingOptions {
|
|
|
1412
1473
|
*/
|
|
1413
1474
|
OnRoadThreshold?: number | undefined;
|
|
1414
1475
|
/**
|
|
1415
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
1476
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
1477
|
+
* roads that are considered are determined by the provided Strategy.</p>
|
|
1416
1478
|
* <p>
|
|
1417
1479
|
* <b>Unit</b>: <code>Meters</code>
|
|
1418
1480
|
* </p>
|
|
@@ -1420,7 +1482,9 @@ export interface RouteMatrixMatchingOptions {
|
|
|
1420
1482
|
*/
|
|
1421
1483
|
Radius?: number | undefined;
|
|
1422
1484
|
/**
|
|
1423
|
-
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
1485
|
+
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
1486
|
+
* all roads possible, whereas MatchMostSignificantRoad matches to the most significant
|
|
1487
|
+
* road.</p>
|
|
1424
1488
|
* @public
|
|
1425
1489
|
*/
|
|
1426
1490
|
Strategy?: MatchingStrategy | undefined;
|
|
@@ -1436,7 +1500,8 @@ export interface RouteMatrixSideOfStreetOptions {
|
|
|
1436
1500
|
*/
|
|
1437
1501
|
Position: number[] | undefined;
|
|
1438
1502
|
/**
|
|
1439
|
-
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
1503
|
+
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
1504
|
+
* always use the provided position.</p>
|
|
1440
1505
|
* <p>Default Value: <code>DividedStreetOnly</code>
|
|
1441
1506
|
* </p>
|
|
1442
1507
|
* @public
|
|
@@ -1449,7 +1514,9 @@ export interface RouteMatrixSideOfStreetOptions {
|
|
|
1449
1514
|
*/
|
|
1450
1515
|
export interface RouteMatrixDestinationOptions {
|
|
1451
1516
|
/**
|
|
1452
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
1517
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
1518
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
1519
|
+
* destination.</p>
|
|
1453
1520
|
* @public
|
|
1454
1521
|
*/
|
|
1455
1522
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -1486,12 +1553,15 @@ export interface RouteMatrixDestination {
|
|
|
1486
1553
|
Position: number[] | undefined;
|
|
1487
1554
|
}
|
|
1488
1555
|
/**
|
|
1489
|
-
* <p>
|
|
1556
|
+
* <p>Specifies strict exclusion options for the route calculation. This setting mandates that
|
|
1557
|
+
* the router will avoid any routes that include the specified options, rather than merely
|
|
1558
|
+
* attempting to minimize them.</p>
|
|
1490
1559
|
* @public
|
|
1491
1560
|
*/
|
|
1492
1561
|
export interface RouteMatrixExclusionOptions {
|
|
1493
1562
|
/**
|
|
1494
|
-
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
1563
|
+
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
1564
|
+
* codes.</p>
|
|
1495
1565
|
* @public
|
|
1496
1566
|
*/
|
|
1497
1567
|
Countries: string[] | undefined;
|
|
@@ -1502,7 +1572,9 @@ export interface RouteMatrixExclusionOptions {
|
|
|
1502
1572
|
*/
|
|
1503
1573
|
export interface RouteMatrixOriginOptions {
|
|
1504
1574
|
/**
|
|
1505
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
1575
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
1576
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
1577
|
+
* destination.</p>
|
|
1506
1578
|
* @public
|
|
1507
1579
|
*/
|
|
1508
1580
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -1555,13 +1627,16 @@ export interface RouteMatrixAutoCircle {
|
|
|
1555
1627
|
MaxRadius?: number | undefined;
|
|
1556
1628
|
}
|
|
1557
1629
|
/**
|
|
1558
|
-
* <p>Geometry defined as a circle. When request routing boundary was set as
|
|
1630
|
+
* <p>Geometry defined as a circle. When request routing boundary was set as
|
|
1631
|
+
* <code>AutoCircle</code>, the response routing boundary will return <code>Circle</code>
|
|
1632
|
+
* derived from the <code>AutoCircle</code> settings.</p>
|
|
1559
1633
|
* @public
|
|
1560
1634
|
*/
|
|
1561
1635
|
export interface Circle {
|
|
1562
1636
|
/**
|
|
1563
1637
|
* <p>Center of the Circle defined in longitude and latitude coordinates.</p>
|
|
1564
|
-
* <p>Example: <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
1638
|
+
* <p>Example: <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
1639
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>. </p>
|
|
1565
1640
|
* @public
|
|
1566
1641
|
*/
|
|
1567
1642
|
Center: number[] | undefined;
|
|
@@ -1585,7 +1660,9 @@ export interface RouteMatrixBoundaryGeometry {
|
|
|
1585
1660
|
*/
|
|
1586
1661
|
AutoCircle?: RouteMatrixAutoCircle | undefined;
|
|
1587
1662
|
/**
|
|
1588
|
-
* <p>Geometry defined as a circle. When request routing boundary was set as
|
|
1663
|
+
* <p>Geometry defined as a circle. When request routing boundary was set as
|
|
1664
|
+
* <code>AutoCircle</code>, the response routing boundary will return <code>Circle</code>
|
|
1665
|
+
* derived from the <code>AutoCircle</code> settings.</p>
|
|
1589
1666
|
* @public
|
|
1590
1667
|
*/
|
|
1591
1668
|
Circle?: Circle | undefined;
|
|
@@ -1603,7 +1680,8 @@ export interface RouteMatrixBoundaryGeometry {
|
|
|
1603
1680
|
Polygon?: number[][][] | undefined;
|
|
1604
1681
|
}
|
|
1605
1682
|
/**
|
|
1606
|
-
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations
|
|
1683
|
+
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations
|
|
1684
|
+
* outside the boundary are considered invalid.</p>
|
|
1607
1685
|
* @public
|
|
1608
1686
|
*/
|
|
1609
1687
|
export interface RouteMatrixBoundary {
|
|
@@ -1613,7 +1691,8 @@ export interface RouteMatrixBoundary {
|
|
|
1613
1691
|
*/
|
|
1614
1692
|
Geometry?: RouteMatrixBoundaryGeometry | undefined;
|
|
1615
1693
|
/**
|
|
1616
|
-
* <p>No restrictions in terms of a routing boundary, and is typically used for longer
|
|
1694
|
+
* <p>No restrictions in terms of a routing boundary, and is typically used for longer
|
|
1695
|
+
* routes.</p>
|
|
1617
1696
|
* @public
|
|
1618
1697
|
*/
|
|
1619
1698
|
Unbounded?: boolean | undefined;
|
|
@@ -1624,11 +1703,10 @@ export interface RouteMatrixBoundary {
|
|
|
1624
1703
|
*/
|
|
1625
1704
|
export interface RouteMatrixTrafficOptions {
|
|
1626
1705
|
/**
|
|
1627
|
-
* <p>Duration for which flow traffic is considered valid.
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
* While flow traffic event is valid it will be used over the historical traffic data. </p>
|
|
1706
|
+
* <p>Duration for which flow traffic is considered valid. For this period, the flow traffic
|
|
1707
|
+
* is used over historical traffic data. Flow traffic refers to congestion, which changes very
|
|
1708
|
+
* quickly. Duration in seconds for which flow traffic event would be considered valid. While
|
|
1709
|
+
* flow traffic event is valid it will be used over the historical traffic data. </p>
|
|
1632
1710
|
* @public
|
|
1633
1711
|
*/
|
|
1634
1712
|
FlowEventThresholdOverride?: number | undefined;
|
|
@@ -1666,7 +1744,7 @@ export interface RouteMatrixVehicleLicensePlate {
|
|
|
1666
1744
|
LastCharacter?: string | undefined;
|
|
1667
1745
|
}
|
|
1668
1746
|
/**
|
|
1669
|
-
* <p>
|
|
1747
|
+
* <p>Travel mode options when the provided travel mode is <code>Car</code>.</p>
|
|
1670
1748
|
* @public
|
|
1671
1749
|
*/
|
|
1672
1750
|
export interface RouteMatrixCarOptions {
|
|
@@ -1692,7 +1770,8 @@ export interface RouteMatrixCarOptions {
|
|
|
1692
1770
|
Occupancy?: number | undefined;
|
|
1693
1771
|
}
|
|
1694
1772
|
/**
|
|
1695
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1773
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
1774
|
+
* </p>
|
|
1696
1775
|
* @public
|
|
1697
1776
|
*/
|
|
1698
1777
|
export interface RouteMatrixScooterOptions {
|
|
@@ -1851,8 +1930,9 @@ export interface RouteMatrixTruckOptions {
|
|
|
1851
1930
|
TruckType?: RouteMatrixTruckType | undefined;
|
|
1852
1931
|
/**
|
|
1853
1932
|
* <p>The tunnel restriction code.</p>
|
|
1854
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
1855
|
-
* They relate to the types of dangerous goods that can be transported
|
|
1933
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
1934
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
1935
|
+
* through them.</p>
|
|
1856
1936
|
* <ul>
|
|
1857
1937
|
* <li>
|
|
1858
1938
|
* <p>
|
|
@@ -1919,7 +1999,9 @@ export interface RouteMatrixTruckOptions {
|
|
|
1919
1999
|
*/
|
|
1920
2000
|
TunnelRestrictionCode?: string | undefined;
|
|
1921
2001
|
/**
|
|
1922
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
2002
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
2003
|
+
* usage in countries where the differences in axle types or axle groups are not
|
|
2004
|
+
* distinguished.</p>
|
|
1923
2005
|
* <p>
|
|
1924
2006
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
1925
2007
|
* </p>
|
|
@@ -1927,7 +2009,8 @@ export interface RouteMatrixTruckOptions {
|
|
|
1927
2009
|
*/
|
|
1928
2010
|
WeightPerAxle?: number | undefined;
|
|
1929
2011
|
/**
|
|
1930
|
-
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
2012
|
+
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
2013
|
+
* that have different regulations based on the axle group type.</p>
|
|
1931
2014
|
* @public
|
|
1932
2015
|
*/
|
|
1933
2016
|
WeightPerAxleGroup?: WeightPerAxleGroup | undefined;
|
|
@@ -1951,7 +2034,12 @@ export interface RouteMatrixTravelModeOptions {
|
|
|
1951
2034
|
*/
|
|
1952
2035
|
Car?: RouteMatrixCarOptions | undefined;
|
|
1953
2036
|
/**
|
|
1954
|
-
* <p>Travel mode options when the provided travel mode is
|
|
2037
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
2038
|
+
* </p>
|
|
2039
|
+
* <note>
|
|
2040
|
+
* <p>When travel mode is set to <code>Scooter</code>, then the avoidance option
|
|
2041
|
+
* <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p>
|
|
2042
|
+
* </note>
|
|
1955
2043
|
* @public
|
|
1956
2044
|
*/
|
|
1957
2045
|
Scooter?: RouteMatrixScooterOptions | undefined;
|
|
@@ -1966,13 +2054,13 @@ export interface RouteMatrixTravelModeOptions {
|
|
|
1966
2054
|
*/
|
|
1967
2055
|
export interface CalculateRouteMatrixRequest {
|
|
1968
2056
|
/**
|
|
1969
|
-
* <p>Features that are allowed while calculating
|
|
2057
|
+
* <p>Features that are allowed while calculating a route.</p>
|
|
1970
2058
|
* @public
|
|
1971
2059
|
*/
|
|
1972
2060
|
Allow?: RouteMatrixAllowOptions | undefined;
|
|
1973
2061
|
/**
|
|
1974
|
-
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
1975
|
-
* avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
2062
|
+
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
2063
|
+
* If an avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
1976
2064
|
* returned response produces a notice for the violation.</p>
|
|
1977
2065
|
* @public
|
|
1978
2066
|
*/
|
|
@@ -1998,6 +2086,11 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1998
2086
|
DepartureTime?: string | undefined;
|
|
1999
2087
|
/**
|
|
2000
2088
|
* <p>List of destinations for the route.</p>
|
|
2089
|
+
* <note>
|
|
2090
|
+
* <p>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
|
|
2091
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`">
|
|
2092
|
+
* Amazon Location's pricing page</a> for more information.</p>
|
|
2093
|
+
* </note>
|
|
2001
2094
|
* @public
|
|
2002
2095
|
*/
|
|
2003
2096
|
Destinations: RouteMatrixDestination[] | undefined;
|
|
@@ -2021,14 +2114,21 @@ export interface CalculateRouteMatrixRequest {
|
|
|
2021
2114
|
OptimizeRoutingFor?: RoutingObjective | undefined;
|
|
2022
2115
|
/**
|
|
2023
2116
|
* <p>The position in longitude and latitude for the origin.</p>
|
|
2117
|
+
* <note>
|
|
2118
|
+
* <p>Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a
|
|
2119
|
+
* request can lead you to incur unexpected charges. See
|
|
2120
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`">
|
|
2121
|
+
* Amazon Location's pricing page</a> for more information.</p>
|
|
2122
|
+
* </note>
|
|
2024
2123
|
* @public
|
|
2025
2124
|
*/
|
|
2026
2125
|
Origins: RouteMatrixOrigin[] | undefined;
|
|
2027
2126
|
/**
|
|
2028
|
-
* <p>Boundary within which the matrix is to be calculated.
|
|
2029
|
-
*
|
|
2127
|
+
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations
|
|
2128
|
+
* outside the boundary are considered invalid.</p>
|
|
2030
2129
|
* <note>
|
|
2031
|
-
* <p>When request routing boundary was set as AutoCircle, the response routing boundary
|
|
2130
|
+
* <p>When request routing boundary was set as AutoCircle, the response routing boundary
|
|
2131
|
+
* will return Circle derived from the AutoCircle settings.</p>
|
|
2032
2132
|
* </note>
|
|
2033
2133
|
* @public
|
|
2034
2134
|
*/
|
|
@@ -2039,8 +2139,8 @@ export interface CalculateRouteMatrixRequest {
|
|
|
2039
2139
|
*/
|
|
2040
2140
|
Traffic?: RouteMatrixTrafficOptions | undefined;
|
|
2041
2141
|
/**
|
|
2042
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
2043
|
-
*
|
|
2142
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
2143
|
+
* of travel and road compatibility.</p>
|
|
2044
2144
|
* <p>Default Value: <code>Car</code>
|
|
2045
2145
|
* </p>
|
|
2046
2146
|
* @public
|
|
@@ -2072,7 +2172,10 @@ export declare const RouteMatrixErrorCode: {
|
|
|
2072
2172
|
*/
|
|
2073
2173
|
export type RouteMatrixErrorCode = (typeof RouteMatrixErrorCode)[keyof typeof RouteMatrixErrorCode];
|
|
2074
2174
|
/**
|
|
2075
|
-
* <p>The calculated route matrix containing the results for all pairs of Origins to
|
|
2175
|
+
* <p>The calculated route matrix containing the results for all pairs of Origins to
|
|
2176
|
+
* Destination positions. Each row corresponds to one entry in Origins. Each entry in the row
|
|
2177
|
+
* corresponds to the route from that entry in Origins to an entry in Destination
|
|
2178
|
+
* positions.</p>
|
|
2076
2179
|
* @public
|
|
2077
2180
|
*/
|
|
2078
2181
|
export interface RouteMatrixEntry {
|
|
@@ -2100,7 +2203,8 @@ export interface RouteMatrixEntry {
|
|
|
2100
2203
|
*/
|
|
2101
2204
|
export interface CalculateRouteMatrixResponse {
|
|
2102
2205
|
/**
|
|
2103
|
-
* <p>The count of error results in the route matrix. If this number is 0, all routes were
|
|
2206
|
+
* <p>The count of error results in the route matrix. If this number is 0, all routes were
|
|
2207
|
+
* calculated successfully.</p>
|
|
2104
2208
|
* @public
|
|
2105
2209
|
*/
|
|
2106
2210
|
ErrorCount: number | undefined;
|
|
@@ -2110,31 +2214,40 @@ export interface CalculateRouteMatrixResponse {
|
|
|
2110
2214
|
*/
|
|
2111
2215
|
PricingBucket: string | undefined;
|
|
2112
2216
|
/**
|
|
2113
|
-
* <p>The calculated route matrix containing the results for all pairs of Origins to
|
|
2217
|
+
* <p>The calculated route matrix containing the results for all pairs of Origins to
|
|
2218
|
+
* Destination positions. Each row corresponds to one entry in Origins. Each entry in the row
|
|
2219
|
+
* corresponds to the route from that entry in Origins to an entry in Destination
|
|
2220
|
+
* positions.</p>
|
|
2114
2221
|
* @public
|
|
2115
2222
|
*/
|
|
2116
2223
|
RouteMatrix: RouteMatrixEntry[][] | undefined;
|
|
2117
2224
|
/**
|
|
2118
|
-
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations
|
|
2225
|
+
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations
|
|
2226
|
+
* outside the boundary are considered invalid.</p>
|
|
2119
2227
|
* <note>
|
|
2120
|
-
* <p>When request routing boundary was set as AutoCircle, the response routing boundary
|
|
2228
|
+
* <p>When request routing boundary was set as AutoCircle, the response routing boundary
|
|
2229
|
+
* will return Circle derived from the AutoCircle settings.</p>
|
|
2121
2230
|
* </note>
|
|
2122
2231
|
* @public
|
|
2123
2232
|
*/
|
|
2124
2233
|
RoutingBoundary: RouteMatrixBoundary | undefined;
|
|
2125
2234
|
}
|
|
2126
2235
|
/**
|
|
2127
|
-
* <p>Features that are allowed while calculating
|
|
2236
|
+
* <p>Features that are allowed while calculating a route.</p>
|
|
2128
2237
|
* @public
|
|
2129
2238
|
*/
|
|
2130
2239
|
export interface RouteAllowOptions {
|
|
2131
2240
|
/**
|
|
2132
2241
|
* <p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p>
|
|
2242
|
+
* <p>Default value: <code>false</code>
|
|
2243
|
+
* </p>
|
|
2133
2244
|
* @public
|
|
2134
2245
|
*/
|
|
2135
2246
|
Hot?: boolean | undefined;
|
|
2136
2247
|
/**
|
|
2137
2248
|
* <p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p>
|
|
2249
|
+
* <p>Default value: <code>false</code>
|
|
2250
|
+
* </p>
|
|
2138
2251
|
* @public
|
|
2139
2252
|
*/
|
|
2140
2253
|
Hov?: boolean | undefined;
|
|
@@ -2145,7 +2258,8 @@ export interface RouteAllowOptions {
|
|
|
2145
2258
|
*/
|
|
2146
2259
|
export interface RouteAvoidanceAreaGeometry {
|
|
2147
2260
|
/**
|
|
2148
|
-
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
2261
|
+
* <p>Geometry defined as a corridor - a LineString with a radius that defines the width of
|
|
2262
|
+
* the corridor.</p>
|
|
2149
2263
|
* @public
|
|
2150
2264
|
*/
|
|
2151
2265
|
Corridor?: Corridor | undefined;
|
|
@@ -2168,9 +2282,9 @@ export interface RouteAvoidanceAreaGeometry {
|
|
|
2168
2282
|
*/
|
|
2169
2283
|
PolylineCorridor?: PolylineCorridor | undefined;
|
|
2170
2284
|
/**
|
|
2171
|
-
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains
|
|
2172
|
-
*
|
|
2173
|
-
*
|
|
2285
|
+
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains
|
|
2286
|
+
* PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last
|
|
2287
|
+
* item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/heremaps/flexiblepolyline/blob/master/README.md">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>.</p>
|
|
2174
2288
|
* @public
|
|
2175
2289
|
*/
|
|
2176
2290
|
PolylinePolygon?: string[] | undefined;
|
|
@@ -2181,7 +2295,8 @@ export interface RouteAvoidanceAreaGeometry {
|
|
|
2181
2295
|
*/
|
|
2182
2296
|
export interface RouteAvoidanceArea {
|
|
2183
2297
|
/**
|
|
2184
|
-
* <p>Exceptions to the provided avoidance geometry, to be included while calculating the
|
|
2298
|
+
* <p>Exceptions to the provided avoidance geometry, to be included while calculating the
|
|
2299
|
+
* route.</p>
|
|
2185
2300
|
* @public
|
|
2186
2301
|
*/
|
|
2187
2302
|
Except?: RouteAvoidanceAreaGeometry[] | undefined;
|
|
@@ -2216,7 +2331,11 @@ export interface RouteAvoidanceZoneCategory {
|
|
|
2216
2331
|
Category: RouteZoneCategory | undefined;
|
|
2217
2332
|
}
|
|
2218
2333
|
/**
|
|
2219
|
-
* <p>
|
|
2334
|
+
* <p>Specifies options for areas to avoid when calculating the route. This is a best-effort
|
|
2335
|
+
* avoidance setting, meaning the router will try to honor the avoidance preferences but may
|
|
2336
|
+
* still include restricted areas if no feasible alternative route exists. If avoidance
|
|
2337
|
+
* options are not followed, the response will indicate that the avoidance criteria were
|
|
2338
|
+
* violated.</p>
|
|
2220
2339
|
* @public
|
|
2221
2340
|
*/
|
|
2222
2341
|
export interface RouteAvoidanceOptions {
|
|
@@ -2261,8 +2380,8 @@ export interface RouteAvoidanceOptions {
|
|
|
2261
2380
|
*/
|
|
2262
2381
|
TollTransponders?: boolean | undefined;
|
|
2263
2382
|
/**
|
|
2264
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
2265
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
2383
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
2384
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
2266
2385
|
* <note>
|
|
2267
2386
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
2268
2387
|
* </note>
|
|
@@ -2296,7 +2415,8 @@ export interface RouteMatchingOptions {
|
|
|
2296
2415
|
*/
|
|
2297
2416
|
NameHint?: string | undefined;
|
|
2298
2417
|
/**
|
|
2299
|
-
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
2418
|
+
* <p>If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint
|
|
2419
|
+
* will be snapped to the highway/bridge/tunnel/sliproad.</p>
|
|
2300
2420
|
* <p>
|
|
2301
2421
|
* <b>Unit</b>: <code>meters</code>
|
|
2302
2422
|
* </p>
|
|
@@ -2304,7 +2424,8 @@ export interface RouteMatchingOptions {
|
|
|
2304
2424
|
*/
|
|
2305
2425
|
OnRoadThreshold?: number | undefined;
|
|
2306
2426
|
/**
|
|
2307
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
2427
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The
|
|
2428
|
+
* roads that are considered are determined by the provided Strategy.</p>
|
|
2308
2429
|
* <p>
|
|
2309
2430
|
* <b>Unit</b>: <code>Meters</code>
|
|
2310
2431
|
* </p>
|
|
@@ -2312,7 +2433,9 @@ export interface RouteMatchingOptions {
|
|
|
2312
2433
|
*/
|
|
2313
2434
|
Radius?: number | undefined;
|
|
2314
2435
|
/**
|
|
2315
|
-
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
2436
|
+
* <p>Strategy that defines matching of the position onto the road network. MatchAny considers
|
|
2437
|
+
* all roads possible, whereas MatchMostSignificantRoad matches to the most significant
|
|
2438
|
+
* road.</p>
|
|
2316
2439
|
* @public
|
|
2317
2440
|
*/
|
|
2318
2441
|
Strategy?: MatchingStrategy | undefined;
|
|
@@ -2341,7 +2464,9 @@ export interface RouteSideOfStreetOptions {
|
|
|
2341
2464
|
*/
|
|
2342
2465
|
export interface RouteDestinationOptions {
|
|
2343
2466
|
/**
|
|
2344
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
2467
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
2468
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
2469
|
+
* destination.</p>
|
|
2345
2470
|
* @public
|
|
2346
2471
|
*/
|
|
2347
2472
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -2375,8 +2500,8 @@ export interface RouteDestinationOptions {
|
|
|
2375
2500
|
StopDuration?: number | undefined;
|
|
2376
2501
|
}
|
|
2377
2502
|
/**
|
|
2378
|
-
* <p>Interval of the driver work-rest schedule.
|
|
2379
|
-
*
|
|
2503
|
+
* <p>Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest
|
|
2504
|
+
* schedule.</p>
|
|
2380
2505
|
* @public
|
|
2381
2506
|
*/
|
|
2382
2507
|
export interface RouteDriverScheduleInterval {
|
|
@@ -2409,12 +2534,15 @@ export interface RouteDriverOptions {
|
|
|
2409
2534
|
Schedule?: RouteDriverScheduleInterval[] | undefined;
|
|
2410
2535
|
}
|
|
2411
2536
|
/**
|
|
2412
|
-
* <p>
|
|
2537
|
+
* <p>Specifies strict exclusion options for the route calculation. This setting mandates that
|
|
2538
|
+
* the router will avoid any routes that include the specified options, rather than merely
|
|
2539
|
+
* attempting to minimize them.</p>
|
|
2413
2540
|
* @public
|
|
2414
2541
|
*/
|
|
2415
2542
|
export interface RouteExclusionOptions {
|
|
2416
2543
|
/**
|
|
2417
|
-
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
2544
|
+
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
2545
|
+
* codes.</p>
|
|
2418
2546
|
* @public
|
|
2419
2547
|
*/
|
|
2420
2548
|
Countries: string[] | undefined;
|
|
@@ -2456,7 +2584,9 @@ export type RouteLegAdditionalFeature = (typeof RouteLegAdditionalFeature)[keyof
|
|
|
2456
2584
|
*/
|
|
2457
2585
|
export interface RouteOriginOptions {
|
|
2458
2586
|
/**
|
|
2459
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
2587
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
2588
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
2589
|
+
* destination.</p>
|
|
2460
2590
|
* @public
|
|
2461
2591
|
*/
|
|
2462
2592
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -2518,20 +2648,22 @@ export type RouteSpanAdditionalFeature = (typeof RouteSpanAdditionalFeature)[key
|
|
|
2518
2648
|
/**
|
|
2519
2649
|
* <p>Type of the emission.</p>
|
|
2520
2650
|
* <p>
|
|
2521
|
-
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2651
|
+
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2652
|
+
* Euro6, EuroEev</code>
|
|
2522
2653
|
* </p>
|
|
2523
2654
|
* @public
|
|
2524
2655
|
*/
|
|
2525
2656
|
export interface RouteEmissionType {
|
|
2526
2657
|
/**
|
|
2527
|
-
* <p>The CO 2
|
|
2658
|
+
* <p>The CO 2 emission classes.</p>
|
|
2528
2659
|
* @public
|
|
2529
2660
|
*/
|
|
2530
2661
|
Co2EmissionClass?: string | undefined;
|
|
2531
2662
|
/**
|
|
2532
2663
|
* <p>Type of the emission.</p>
|
|
2533
2664
|
* <p>
|
|
2534
|
-
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2665
|
+
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2666
|
+
* Euro6, EuroEev</code>
|
|
2535
2667
|
* </p>
|
|
2536
2668
|
* @public
|
|
2537
2669
|
*/
|
|
@@ -2560,19 +2692,23 @@ export interface RouteTollOptions {
|
|
|
2560
2692
|
*/
|
|
2561
2693
|
AllTransponders?: boolean | undefined;
|
|
2562
2694
|
/**
|
|
2563
|
-
* <p>Specifies if the user has valid vignettes with access for all toll roads. If a user has
|
|
2695
|
+
* <p>Specifies if the user has valid vignettes with access for all toll roads. If a user has
|
|
2696
|
+
* a vignette for a toll road, then toll cost for that road is omitted since no further
|
|
2697
|
+
* payment is necessary.</p>
|
|
2564
2698
|
* @public
|
|
2565
2699
|
*/
|
|
2566
2700
|
AllVignettes?: boolean | undefined;
|
|
2567
2701
|
/**
|
|
2568
|
-
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
2702
|
+
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
2703
|
+
* request.</p>
|
|
2569
2704
|
* @public
|
|
2570
2705
|
*/
|
|
2571
2706
|
Currency?: string | undefined;
|
|
2572
2707
|
/**
|
|
2573
2708
|
* <p>Emission type of the vehicle for toll cost calculation.</p>
|
|
2574
2709
|
* <p>
|
|
2575
|
-
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2710
|
+
* <b>Valid values</b>: <code>Euro1, Euro2, Euro3, Euro4, Euro5,
|
|
2711
|
+
* Euro6, EuroEev</code>
|
|
2576
2712
|
* </p>
|
|
2577
2713
|
* @public
|
|
2578
2714
|
*/
|
|
@@ -2589,12 +2725,10 @@ export interface RouteTollOptions {
|
|
|
2589
2725
|
*/
|
|
2590
2726
|
export interface RouteTrafficOptions {
|
|
2591
2727
|
/**
|
|
2592
|
-
* <p>Duration for which flow
|
|
2593
|
-
*
|
|
2594
|
-
*
|
|
2595
|
-
*
|
|
2596
|
-
* Duration in seconds for which flow traffic event would be considered valid.
|
|
2597
|
-
* While flow traffic event is valid it will be used over the historical traffic data. </p>
|
|
2728
|
+
* <p>Duration for which flow traffic is considered valid. For this period, the flow traffic
|
|
2729
|
+
* is used over historical traffic data. Flow traffic refers to congestion, which changes very
|
|
2730
|
+
* quickly. Duration in seconds for which flow traffic event would be considered valid. While
|
|
2731
|
+
* flow traffic event is valid it will be used over the historical traffic data. </p>
|
|
2598
2732
|
* @public
|
|
2599
2733
|
*/
|
|
2600
2734
|
FlowEventThresholdOverride?: number | undefined;
|
|
@@ -2646,7 +2780,7 @@ export interface RouteVehicleLicensePlate {
|
|
|
2646
2780
|
LastCharacter?: string | undefined;
|
|
2647
2781
|
}
|
|
2648
2782
|
/**
|
|
2649
|
-
* <p>Travel mode options when the provided travel mode is
|
|
2783
|
+
* <p>Travel mode options when the provided travel mode is <code>Car</code>.</p>
|
|
2650
2784
|
* @public
|
|
2651
2785
|
*/
|
|
2652
2786
|
export interface RouteCarOptions {
|
|
@@ -2688,7 +2822,8 @@ export interface RoutePedestrianOptions {
|
|
|
2688
2822
|
Speed?: number | undefined;
|
|
2689
2823
|
}
|
|
2690
2824
|
/**
|
|
2691
|
-
* <p>Travel mode options when the provided travel mode is
|
|
2825
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
2826
|
+
* </p>
|
|
2692
2827
|
* @public
|
|
2693
2828
|
*/
|
|
2694
2829
|
export interface RouteScooterOptions {
|
|
@@ -2875,8 +3010,9 @@ export interface RouteTruckOptions {
|
|
|
2875
3010
|
TruckType?: RouteTruckType | undefined;
|
|
2876
3011
|
/**
|
|
2877
3012
|
* <p>The tunnel restriction code.</p>
|
|
2878
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
2879
|
-
* They relate to the types of dangerous goods that can be transported
|
|
3013
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
3014
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
3015
|
+
* through them.</p>
|
|
2880
3016
|
* <ul>
|
|
2881
3017
|
* <li>
|
|
2882
3018
|
* <p>
|
|
@@ -2943,7 +3079,9 @@ export interface RouteTruckOptions {
|
|
|
2943
3079
|
*/
|
|
2944
3080
|
TunnelRestrictionCode?: string | undefined;
|
|
2945
3081
|
/**
|
|
2946
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
3082
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
3083
|
+
* usage in countries where the differences in axle types or axle groups are not
|
|
3084
|
+
* distinguished.</p>
|
|
2947
3085
|
* <p>
|
|
2948
3086
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
2949
3087
|
* </p>
|
|
@@ -2951,7 +3089,8 @@ export interface RouteTruckOptions {
|
|
|
2951
3089
|
*/
|
|
2952
3090
|
WeightPerAxle?: number | undefined;
|
|
2953
3091
|
/**
|
|
2954
|
-
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
3092
|
+
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries
|
|
3093
|
+
* that have different regulations based on the axle group type.</p>
|
|
2955
3094
|
* <p>
|
|
2956
3095
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
2957
3096
|
* </p>
|
|
@@ -2983,7 +3122,12 @@ export interface RouteTravelModeOptions {
|
|
|
2983
3122
|
*/
|
|
2984
3123
|
Pedestrian?: RoutePedestrianOptions | undefined;
|
|
2985
3124
|
/**
|
|
2986
|
-
* <p>Travel mode options when the provided travel mode is
|
|
3125
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>
|
|
3126
|
+
* </p>
|
|
3127
|
+
* <note>
|
|
3128
|
+
* <p>When travel mode is set to <code>Scooter</code>, then the avoidance option
|
|
3129
|
+
* <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p>
|
|
3130
|
+
* </note>
|
|
2987
3131
|
* @public
|
|
2988
3132
|
*/
|
|
2989
3133
|
Scooter?: RouteScooterOptions | undefined;
|
|
@@ -3011,7 +3155,9 @@ export type RouteTravelStepType = (typeof RouteTravelStepType)[keyof typeof Rout
|
|
|
3011
3155
|
*/
|
|
3012
3156
|
export interface RouteWaypoint {
|
|
3013
3157
|
/**
|
|
3014
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
3158
|
+
* <p>Avoids actions for the provided distance. This is typically to consider for users in
|
|
3159
|
+
* moving vehicles who may not have sufficient time to make an action at an origin or a
|
|
3160
|
+
* destination.</p>
|
|
3015
3161
|
* @public
|
|
3016
3162
|
*/
|
|
3017
3163
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -3031,7 +3177,8 @@ export interface RouteWaypoint {
|
|
|
3031
3177
|
*/
|
|
3032
3178
|
Matching?: RouteMatchingOptions | undefined;
|
|
3033
3179
|
/**
|
|
3034
|
-
* <p>If the waypoint should not be treated as a stop. If yes, the waypoint is passed through
|
|
3180
|
+
* <p>If the waypoint should not be treated as a stop. If yes, the waypoint is passed through
|
|
3181
|
+
* and doesn't split the route into different legs.</p>
|
|
3035
3182
|
* @public
|
|
3036
3183
|
*/
|
|
3037
3184
|
PassThrough?: boolean | undefined;
|
|
@@ -3059,7 +3206,7 @@ export interface RouteWaypoint {
|
|
|
3059
3206
|
*/
|
|
3060
3207
|
export interface CalculateRoutesRequest {
|
|
3061
3208
|
/**
|
|
3062
|
-
* <p>Features that are allowed while calculating
|
|
3209
|
+
* <p>Features that are allowed while calculating a route.</p>
|
|
3063
3210
|
* @public
|
|
3064
3211
|
*/
|
|
3065
3212
|
Allow?: RouteAllowOptions | undefined;
|
|
@@ -3078,8 +3225,8 @@ export interface CalculateRoutesRequest {
|
|
|
3078
3225
|
*/
|
|
3079
3226
|
ArrivalTime?: string | undefined;
|
|
3080
3227
|
/**
|
|
3081
|
-
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
3082
|
-
* avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
3228
|
+
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis.
|
|
3229
|
+
* If an avoidance can't be satisfied for a particular case, it violates the avoidance and the
|
|
3083
3230
|
* returned response produces a notice for the violation.</p>
|
|
3084
3231
|
* @public
|
|
3085
3232
|
*/
|
|
@@ -3104,7 +3251,8 @@ export interface CalculateRoutesRequest {
|
|
|
3104
3251
|
*/
|
|
3105
3252
|
DepartureTime?: string | undefined;
|
|
3106
3253
|
/**
|
|
3107
|
-
* <p>The final position for the route. In the World Geodetic System (WGS 84) format:
|
|
3254
|
+
* <p>The final position for the route. In the World Geodetic System (WGS 84) format:
|
|
3255
|
+
* <code>[longitude, latitude]</code>.</p>
|
|
3108
3256
|
* @public
|
|
3109
3257
|
*/
|
|
3110
3258
|
Destination: number[] | undefined;
|
|
@@ -3137,29 +3285,35 @@ export interface CalculateRoutesRequest {
|
|
|
3137
3285
|
/**
|
|
3138
3286
|
* <p>List of languages for instructions within steps in the response.</p>
|
|
3139
3287
|
* <note>
|
|
3140
|
-
* <p>Instructions in the requested language are returned only if they are
|
|
3288
|
+
* <p>Instructions in the requested language are returned only if they are
|
|
3289
|
+
* available.</p>
|
|
3141
3290
|
* </note>
|
|
3142
3291
|
* @public
|
|
3143
3292
|
*/
|
|
3144
3293
|
Languages?: string[] | undefined;
|
|
3145
3294
|
/**
|
|
3146
|
-
* <p>A list of optional additional parameters such as timezone that can be requested for each
|
|
3295
|
+
* <p>A list of optional additional parameters such as timezone that can be requested for each
|
|
3296
|
+
* result.</p>
|
|
3147
3297
|
* <ul>
|
|
3148
3298
|
* <li>
|
|
3149
3299
|
* <p>
|
|
3150
|
-
* <code>Elevation</code>: Retrieves the elevation information for each
|
|
3300
|
+
* <code>Elevation</code>: Retrieves the elevation information for each
|
|
3301
|
+
* location.</p>
|
|
3151
3302
|
* </li>
|
|
3152
3303
|
* <li>
|
|
3153
3304
|
* <p>
|
|
3154
|
-
* <code>Incidents</code>: Provides information on traffic incidents along the
|
|
3305
|
+
* <code>Incidents</code>: Provides information on traffic incidents along the
|
|
3306
|
+
* route.</p>
|
|
3155
3307
|
* </li>
|
|
3156
3308
|
* <li>
|
|
3157
3309
|
* <p>
|
|
3158
|
-
* <code>PassThroughWaypoints</code>: Indicates waypoints that are passed through
|
|
3310
|
+
* <code>PassThroughWaypoints</code>: Indicates waypoints that are passed through
|
|
3311
|
+
* without stopping.</p>
|
|
3159
3312
|
* </li>
|
|
3160
3313
|
* <li>
|
|
3161
3314
|
* <p>
|
|
3162
|
-
* <code>Summary</code>: Returns a summary of the route, including distance and
|
|
3315
|
+
* <code>Summary</code>: Returns a summary of the route, including distance and
|
|
3316
|
+
* duration.</p>
|
|
3163
3317
|
* </li>
|
|
3164
3318
|
* <li>
|
|
3165
3319
|
* <p>
|
|
@@ -3167,15 +3321,18 @@ export interface CalculateRoutesRequest {
|
|
|
3167
3321
|
* </li>
|
|
3168
3322
|
* <li>
|
|
3169
3323
|
* <p>
|
|
3170
|
-
* <code>TravelStepInstructions</code>: Provides step-by-step instructions for travel
|
|
3324
|
+
* <code>TravelStepInstructions</code>: Provides step-by-step instructions for travel
|
|
3325
|
+
* along the route.</p>
|
|
3171
3326
|
* </li>
|
|
3172
3327
|
* <li>
|
|
3173
3328
|
* <p>
|
|
3174
|
-
* <code>TruckRoadTypes</code>: Returns information about road types suitable for
|
|
3329
|
+
* <code>TruckRoadTypes</code>: Returns information about road types suitable for
|
|
3330
|
+
* trucks.</p>
|
|
3175
3331
|
* </li>
|
|
3176
3332
|
* <li>
|
|
3177
3333
|
* <p>
|
|
3178
|
-
* <code>TypicalDuration</code>: Gives typical travel duration based on historical
|
|
3334
|
+
* <code>TypicalDuration</code>: Gives typical travel duration based on historical
|
|
3335
|
+
* data.</p>
|
|
3179
3336
|
* </li>
|
|
3180
3337
|
* <li>
|
|
3181
3338
|
* <p>
|
|
@@ -3186,21 +3343,22 @@ export interface CalculateRoutesRequest {
|
|
|
3186
3343
|
*/
|
|
3187
3344
|
LegAdditionalFeatures?: RouteLegAdditionalFeature[] | undefined;
|
|
3188
3345
|
/**
|
|
3189
|
-
* <p>Specifies the format of the geometry returned for each leg of the route. You can
|
|
3190
|
-
*
|
|
3346
|
+
* <p>Specifies the format of the geometry returned for each leg of the route. You can choose
|
|
3347
|
+
* between two different geometry encoding formats.</p>
|
|
3191
3348
|
* <p>
|
|
3192
|
-
* <code>FlexiblePolyline</code>: A compact and precise encoding format for the
|
|
3193
|
-
*
|
|
3349
|
+
* <code>FlexiblePolyline</code>: A compact and precise encoding format for the leg
|
|
3350
|
+
* geometry. For more information on the format, see the GitHub repository for <a href="https://github.com/heremaps/flexible-polyline">
|
|
3194
3351
|
* <code>FlexiblePolyline</code>
|
|
3195
3352
|
* </a>.</p>
|
|
3196
3353
|
* <p>
|
|
3197
|
-
* <code>Simple</code>: A less compact encoding,
|
|
3198
|
-
*
|
|
3354
|
+
* <code>Simple</code>: A less compact encoding, which is easier to decode but may be less
|
|
3355
|
+
* precise and result in larger payloads.</p>
|
|
3199
3356
|
* @public
|
|
3200
3357
|
*/
|
|
3201
3358
|
LegGeometryFormat?: GeometryFormat | undefined;
|
|
3202
3359
|
/**
|
|
3203
|
-
* <p>Maximum number of alternative routes to be provided in the response, if
|
|
3360
|
+
* <p>Maximum number of alternative routes to be provided in the response, if
|
|
3361
|
+
* available.</p>
|
|
3204
3362
|
* @public
|
|
3205
3363
|
*/
|
|
3206
3364
|
MaxAlternatives?: number | undefined;
|
|
@@ -3222,7 +3380,8 @@ export interface CalculateRoutesRequest {
|
|
|
3222
3380
|
*/
|
|
3223
3381
|
OriginOptions?: RouteOriginOptions | undefined;
|
|
3224
3382
|
/**
|
|
3225
|
-
* <p>A list of optional features such as SpeedLimit that can be requested for a Span. A span
|
|
3383
|
+
* <p>A list of optional features such as SpeedLimit that can be requested for a Span. A span
|
|
3384
|
+
* is a section of a Leg for which the requested features have the same values.</p>
|
|
3226
3385
|
* @public
|
|
3227
3386
|
*/
|
|
3228
3387
|
SpanAdditionalFeatures?: RouteSpanAdditionalFeature[] | undefined;
|
|
@@ -3237,8 +3396,8 @@ export interface CalculateRoutesRequest {
|
|
|
3237
3396
|
*/
|
|
3238
3397
|
Traffic?: RouteTrafficOptions | undefined;
|
|
3239
3398
|
/**
|
|
3240
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
3241
|
-
*
|
|
3399
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
3400
|
+
* of travel and road compatibility.</p>
|
|
3242
3401
|
* <p>Default Value: <code>Car</code>
|
|
3243
3402
|
* </p>
|
|
3244
3403
|
* @public
|
|
@@ -3250,9 +3409,9 @@ export interface CalculateRoutesRequest {
|
|
|
3250
3409
|
*/
|
|
3251
3410
|
TravelModeOptions?: RouteTravelModeOptions | undefined;
|
|
3252
3411
|
/**
|
|
3253
|
-
* <p>Type of step returned by the response.
|
|
3254
|
-
*
|
|
3255
|
-
*
|
|
3412
|
+
* <p>Type of step returned by the response. Default provides basic steps intended for web
|
|
3413
|
+
* based applications. TurnByTurn provides detailed instructions with more granularity
|
|
3414
|
+
* intended for a turn based navigation system.</p>
|
|
3256
3415
|
* @public
|
|
3257
3416
|
*/
|
|
3258
3417
|
TravelStepType?: RouteTravelStepType | undefined;
|
|
@@ -3288,7 +3447,8 @@ export declare const RouteNoticeImpact: {
|
|
|
3288
3447
|
*/
|
|
3289
3448
|
export type RouteNoticeImpact = (typeof RouteNoticeImpact)[keyof typeof RouteNoticeImpact];
|
|
3290
3449
|
/**
|
|
3291
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3450
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3451
|
+
* route calculation.</p>
|
|
3292
3452
|
* @public
|
|
3293
3453
|
*/
|
|
3294
3454
|
export interface RouteResponseNotice {
|
|
@@ -3298,7 +3458,8 @@ export interface RouteResponseNotice {
|
|
|
3298
3458
|
*/
|
|
3299
3459
|
Code: RouteResponseNoticeCode | undefined;
|
|
3300
3460
|
/**
|
|
3301
|
-
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
3461
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
3462
|
+
* impact notices must be evaluated further to determine the impact.</p>
|
|
3302
3463
|
* @public
|
|
3303
3464
|
*/
|
|
3304
3465
|
Impact?: RouteNoticeImpact | undefined;
|
|
@@ -3445,6 +3606,7 @@ export declare const RouteFerryNoticeCode: {
|
|
|
3445
3606
|
readonly ACCURATE_POLYLINE_UNAVAILABLE: "AccuratePolylineUnavailable";
|
|
3446
3607
|
readonly NO_SCHEDULE: "NoSchedule";
|
|
3447
3608
|
readonly OTHER: "Other";
|
|
3609
|
+
readonly SEASONAL_CLOSURE: "SeasonalClosure";
|
|
3448
3610
|
readonly VIOLATED_AVOID_FERRY: "ViolatedAvoidFerry";
|
|
3449
3611
|
readonly VIOLATED_AVOID_RAIL_FERRY: "ViolatedAvoidRailFerry";
|
|
3450
3612
|
};
|
|
@@ -3453,7 +3615,8 @@ export declare const RouteFerryNoticeCode: {
|
|
|
3453
3615
|
*/
|
|
3454
3616
|
export type RouteFerryNoticeCode = (typeof RouteFerryNoticeCode)[keyof typeof RouteFerryNoticeCode];
|
|
3455
3617
|
/**
|
|
3456
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3618
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3619
|
+
* route calculation.</p>
|
|
3457
3620
|
* @public
|
|
3458
3621
|
*/
|
|
3459
3622
|
export interface RouteFerryNotice {
|
|
@@ -3463,7 +3626,8 @@ export interface RouteFerryNotice {
|
|
|
3463
3626
|
*/
|
|
3464
3627
|
Code: RouteFerryNoticeCode | undefined;
|
|
3465
3628
|
/**
|
|
3466
|
-
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
3629
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
3630
|
+
* impact notices must be evaluated further to determine the impact.</p>
|
|
3467
3631
|
* @public
|
|
3468
3632
|
*/
|
|
3469
3633
|
Impact?: RouteNoticeImpact | undefined;
|
|
@@ -3490,7 +3654,8 @@ export interface RoutePassThroughPlace {
|
|
|
3490
3654
|
WaypointIndex?: number | undefined;
|
|
3491
3655
|
}
|
|
3492
3656
|
/**
|
|
3493
|
-
* <p>If the waypoint should be treated as a stop. If yes, the route is split up into
|
|
3657
|
+
* <p>If the waypoint should be treated as a stop. If yes, the route is split up into
|
|
3658
|
+
* different legs around the stop.</p>
|
|
3494
3659
|
* @public
|
|
3495
3660
|
*/
|
|
3496
3661
|
export interface RoutePassThroughWaypoint {
|
|
@@ -3524,7 +3689,7 @@ export interface LocalizedString {
|
|
|
3524
3689
|
Value: string | undefined;
|
|
3525
3690
|
}
|
|
3526
3691
|
/**
|
|
3527
|
-
* <p>Span
|
|
3692
|
+
* <p>Span computed for the requested SpanAdditionalFeatures.</p>
|
|
3528
3693
|
* @public
|
|
3529
3694
|
*/
|
|
3530
3695
|
export interface RouteFerrySpan {
|
|
@@ -3534,12 +3699,17 @@ export interface RouteFerrySpan {
|
|
|
3534
3699
|
*/
|
|
3535
3700
|
Country?: string | undefined;
|
|
3536
3701
|
/**
|
|
3537
|
-
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
3702
|
+
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
3703
|
+
* on a span split by other properties.</p>
|
|
3704
|
+
* <p>
|
|
3705
|
+
* <b>Unit</b>: <code>meters</code>
|
|
3706
|
+
* </p>
|
|
3538
3707
|
* @public
|
|
3539
3708
|
*/
|
|
3540
3709
|
Distance?: number | undefined;
|
|
3541
3710
|
/**
|
|
3542
|
-
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
3711
|
+
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
3712
|
+
* on a span split by other properties.</p>
|
|
3543
3713
|
* <p>
|
|
3544
3714
|
* <b>Unit</b>: <code>seconds</code>
|
|
3545
3715
|
* </p>
|
|
@@ -3557,7 +3727,8 @@ export interface RouteFerrySpan {
|
|
|
3557
3727
|
*/
|
|
3558
3728
|
Names?: LocalizedString[] | undefined;
|
|
3559
3729
|
/**
|
|
3560
|
-
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
3730
|
+
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
3731
|
+
* state.</p>
|
|
3561
3732
|
* @public
|
|
3562
3733
|
*/
|
|
3563
3734
|
Region?: string | undefined;
|
|
@@ -3582,12 +3753,14 @@ export interface RouteFerryOverviewSummary {
|
|
|
3582
3753
|
Duration: number | undefined;
|
|
3583
3754
|
}
|
|
3584
3755
|
/**
|
|
3585
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3756
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3757
|
+
* only portion of the journey is the same as the Distance within the Overview summary.</p>
|
|
3586
3758
|
* @public
|
|
3587
3759
|
*/
|
|
3588
3760
|
export interface RouteFerryTravelOnlySummary {
|
|
3589
3761
|
/**
|
|
3590
|
-
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
3762
|
+
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
3763
|
+
* possible to cover the leg.</p>
|
|
3591
3764
|
* <p>
|
|
3592
3765
|
* <b>Unit</b>: <code>seconds</code>
|
|
3593
3766
|
* </p>
|
|
@@ -3596,17 +3769,20 @@ export interface RouteFerryTravelOnlySummary {
|
|
|
3596
3769
|
Duration: number | undefined;
|
|
3597
3770
|
}
|
|
3598
3771
|
/**
|
|
3599
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3772
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3773
|
+
* only portion of the journey is the same as the Distance within the Overview summary.</p>
|
|
3600
3774
|
* @public
|
|
3601
3775
|
*/
|
|
3602
3776
|
export interface RouteFerrySummary {
|
|
3603
3777
|
/**
|
|
3604
|
-
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
3778
|
+
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
3779
|
+
* steps.</p>
|
|
3605
3780
|
* @public
|
|
3606
3781
|
*/
|
|
3607
3782
|
Overview?: RouteFerryOverviewSummary | undefined;
|
|
3608
3783
|
/**
|
|
3609
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3784
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
3785
|
+
* only portion of the journey is in meters</p>
|
|
3610
3786
|
* @public
|
|
3611
3787
|
*/
|
|
3612
3788
|
TravelOnly?: RouteFerryTravelOnlySummary | undefined;
|
|
@@ -3688,12 +3864,14 @@ export interface RouteFerryLegDetails {
|
|
|
3688
3864
|
*/
|
|
3689
3865
|
Departure: RouteFerryDeparture | undefined;
|
|
3690
3866
|
/**
|
|
3691
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3867
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
3868
|
+
* route calculation.</p>
|
|
3692
3869
|
* @public
|
|
3693
3870
|
*/
|
|
3694
3871
|
Notices: RouteFerryNotice[] | undefined;
|
|
3695
3872
|
/**
|
|
3696
|
-
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
3873
|
+
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
3874
|
+
* configured with the PassThrough option.</p>
|
|
3697
3875
|
* @public
|
|
3698
3876
|
*/
|
|
3699
3877
|
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
@@ -3732,7 +3910,8 @@ export interface RouteLegGeometry {
|
|
|
3732
3910
|
*/
|
|
3733
3911
|
LineString?: number[][] | undefined;
|
|
3734
3912
|
/**
|
|
3735
|
-
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
3913
|
+
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
3914
|
+
* format.</p>
|
|
3736
3915
|
* <note>
|
|
3737
3916
|
* <p>LineString and Polyline are mutually exclusive properties.</p>
|
|
3738
3917
|
* </note>
|
|
@@ -3849,7 +4028,8 @@ export declare const RoutePedestrianNoticeCode: {
|
|
|
3849
4028
|
*/
|
|
3850
4029
|
export type RoutePedestrianNoticeCode = (typeof RoutePedestrianNoticeCode)[keyof typeof RoutePedestrianNoticeCode];
|
|
3851
4030
|
/**
|
|
3852
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
4031
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
4032
|
+
* route calculation.</p>
|
|
3853
4033
|
* @public
|
|
3854
4034
|
*/
|
|
3855
4035
|
export interface RoutePedestrianNotice {
|
|
@@ -3859,7 +4039,8 @@ export interface RoutePedestrianNotice {
|
|
|
3859
4039
|
*/
|
|
3860
4040
|
Code: RoutePedestrianNoticeCode | undefined;
|
|
3861
4041
|
/**
|
|
3862
|
-
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
4042
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
4043
|
+
* impact notices must be evaluated further to determine the impact.</p>
|
|
3863
4044
|
* @public
|
|
3864
4045
|
*/
|
|
3865
4046
|
Impact?: RouteNoticeImpact | undefined;
|
|
@@ -4011,12 +4192,14 @@ export interface RoutePedestrianSpan {
|
|
|
4011
4192
|
*/
|
|
4012
4193
|
Country?: string | undefined;
|
|
4013
4194
|
/**
|
|
4014
|
-
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
4195
|
+
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
4196
|
+
* on a span split by other properties.</p>
|
|
4015
4197
|
* @public
|
|
4016
4198
|
*/
|
|
4017
4199
|
Distance?: number | undefined;
|
|
4018
4200
|
/**
|
|
4019
|
-
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
4201
|
+
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
4202
|
+
* on a span split by other properties.</p>
|
|
4020
4203
|
* <p>
|
|
4021
4204
|
* <b>Unit</b>: <code>seconds</code>
|
|
4022
4205
|
* </p>
|
|
@@ -4042,7 +4225,8 @@ export interface RoutePedestrianSpan {
|
|
|
4042
4225
|
*/
|
|
4043
4226
|
GeometryOffset?: number | undefined;
|
|
4044
4227
|
/**
|
|
4045
|
-
* <p>Incidents corresponding to the span. These index into the Incidents in the parent
|
|
4228
|
+
* <p>Incidents corresponding to the span. These index into the Incidents in the parent
|
|
4229
|
+
* Leg.</p>
|
|
4046
4230
|
* @public
|
|
4047
4231
|
*/
|
|
4048
4232
|
Incidents?: number[] | undefined;
|
|
@@ -4057,7 +4241,8 @@ export interface RoutePedestrianSpan {
|
|
|
4057
4241
|
*/
|
|
4058
4242
|
PedestrianAccess?: RouteSpanPedestrianAccessAttribute[] | undefined;
|
|
4059
4243
|
/**
|
|
4060
|
-
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
4244
|
+
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
4245
|
+
* state.</p>
|
|
4061
4246
|
* @public
|
|
4062
4247
|
*/
|
|
4063
4248
|
Region?: string | undefined;
|
|
@@ -4119,17 +4304,20 @@ export interface RoutePedestrianTravelOnlySummary {
|
|
|
4119
4304
|
Duration: number | undefined;
|
|
4120
4305
|
}
|
|
4121
4306
|
/**
|
|
4122
|
-
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
4307
|
+
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
4308
|
+
* steps.</p>
|
|
4123
4309
|
* @public
|
|
4124
4310
|
*/
|
|
4125
4311
|
export interface RoutePedestrianSummary {
|
|
4126
4312
|
/**
|
|
4127
|
-
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
4313
|
+
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
4314
|
+
* steps.</p>
|
|
4128
4315
|
* @public
|
|
4129
4316
|
*/
|
|
4130
4317
|
Overview?: RoutePedestrianOverviewSummary | undefined;
|
|
4131
4318
|
/**
|
|
4132
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
4319
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
4320
|
+
* only portion of the journey is in meters</p>
|
|
4133
4321
|
* @public
|
|
4134
4322
|
*/
|
|
4135
4323
|
TravelOnly?: RoutePedestrianTravelOnlySummary | undefined;
|
|
@@ -4331,7 +4519,8 @@ export interface RouteSignpostLabel {
|
|
|
4331
4519
|
Text?: LocalizedString | undefined;
|
|
4332
4520
|
}
|
|
4333
4521
|
/**
|
|
4334
|
-
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
4522
|
+
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
4523
|
+
* RouteSignpost for details of sub-attributes.</p>
|
|
4335
4524
|
* @public
|
|
4336
4525
|
*/
|
|
4337
4526
|
export interface RouteSignpost {
|
|
@@ -4460,7 +4649,8 @@ export interface RoutePedestrianTravelStep {
|
|
|
4460
4649
|
*/
|
|
4461
4650
|
RoundaboutPassStepDetails?: RouteRoundaboutPassStepDetails | undefined;
|
|
4462
4651
|
/**
|
|
4463
|
-
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
4652
|
+
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
4653
|
+
* RouteSignpost for details of sub-attributes.</p>
|
|
4464
4654
|
* @public
|
|
4465
4655
|
*/
|
|
4466
4656
|
Signpost?: RouteSignpost | undefined;
|
|
@@ -4491,12 +4681,14 @@ export interface RoutePedestrianLegDetails {
|
|
|
4491
4681
|
*/
|
|
4492
4682
|
Departure: RoutePedestrianDeparture | undefined;
|
|
4493
4683
|
/**
|
|
4494
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
4684
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
4685
|
+
* route calculation.</p>
|
|
4495
4686
|
* @public
|
|
4496
4687
|
*/
|
|
4497
4688
|
Notices: RoutePedestrianNotice[] | undefined;
|
|
4498
4689
|
/**
|
|
4499
|
-
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
4690
|
+
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
4691
|
+
* configured with the PassThrough option.</p>
|
|
4500
4692
|
* @public
|
|
4501
4693
|
*/
|
|
4502
4694
|
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
@@ -4522,6 +4714,7 @@ export interface RoutePedestrianLegDetails {
|
|
|
4522
4714
|
*/
|
|
4523
4715
|
export declare const RouteLegTravelMode: {
|
|
4524
4716
|
readonly CAR: "Car";
|
|
4717
|
+
readonly CAR_SHUTTLE_TRAIN: "CarShuttleTrain";
|
|
4525
4718
|
readonly FERRY: "Ferry";
|
|
4526
4719
|
readonly PEDESTRIAN: "Pedestrian";
|
|
4527
4720
|
readonly SCOOTER: "Scooter";
|
|
@@ -4658,11 +4851,10 @@ export interface RouteVehicleIncident {
|
|
|
4658
4851
|
*/
|
|
4659
4852
|
EndTime?: string | undefined;
|
|
4660
4853
|
/**
|
|
4661
|
-
* <p>Severity of the incident
|
|
4662
|
-
*
|
|
4663
|
-
*
|
|
4664
|
-
*
|
|
4665
|
-
* Low - Low on duration, for example slightly increased traffic</p>
|
|
4854
|
+
* <p>Severity of the incident Critical - The part of the route the incident affects is
|
|
4855
|
+
* unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor
|
|
4856
|
+
* impact on the leg duration, for example traffic jam Low - Low on duration, for example
|
|
4857
|
+
* slightly increased traffic</p>
|
|
4666
4858
|
* @public
|
|
4667
4859
|
*/
|
|
4668
4860
|
Severity?: RouteVehicleIncidentSeverity | undefined;
|
|
@@ -4766,13 +4958,13 @@ export interface RouteWeightConstraint {
|
|
|
4766
4958
|
Value: number | undefined;
|
|
4767
4959
|
}
|
|
4768
4960
|
/**
|
|
4769
|
-
* <p>This property contains a
|
|
4770
|
-
* summary of violated constraints.</p>
|
|
4961
|
+
* <p>This property contains a summary of violated constraints.</p>
|
|
4771
4962
|
* @public
|
|
4772
4963
|
*/
|
|
4773
4964
|
export interface RouteViolatedConstraints {
|
|
4774
4965
|
/**
|
|
4775
|
-
* <p>This restriction applies to truck cargo, where the resulting route excludes roads on
|
|
4966
|
+
* <p>This restriction applies to truck cargo, where the resulting route excludes roads on
|
|
4967
|
+
* which hazardous materials are prohibited from being transported.</p>
|
|
4776
4968
|
* @public
|
|
4777
4969
|
*/
|
|
4778
4970
|
AllHazardsRestricted?: boolean | undefined;
|
|
@@ -4871,8 +5063,8 @@ export interface RouteViolatedConstraints {
|
|
|
4871
5063
|
*/
|
|
4872
5064
|
TravelMode?: boolean | undefined;
|
|
4873
5065
|
/**
|
|
4874
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
4875
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
5066
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
5067
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
4876
5068
|
* <note>
|
|
4877
5069
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
4878
5070
|
* </note>
|
|
@@ -4886,8 +5078,9 @@ export interface RouteViolatedConstraints {
|
|
|
4886
5078
|
TruckType?: RouteTruckType | undefined;
|
|
4887
5079
|
/**
|
|
4888
5080
|
* <p>The tunnel restriction code.</p>
|
|
4889
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
4890
|
-
* They relate to the types of dangerous goods that can be transported
|
|
5081
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
5082
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
5083
|
+
* through them.</p>
|
|
4891
5084
|
* <ul>
|
|
4892
5085
|
* <li>
|
|
4893
5086
|
* <p>
|
|
@@ -4971,7 +5164,8 @@ export interface RouteVehicleNoticeDetail {
|
|
|
4971
5164
|
ViolatedConstraints?: RouteViolatedConstraints | undefined;
|
|
4972
5165
|
}
|
|
4973
5166
|
/**
|
|
4974
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
5167
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
5168
|
+
* route calculation.</p>
|
|
4975
5169
|
* @public
|
|
4976
5170
|
*/
|
|
4977
5171
|
export interface RouteVehicleNotice {
|
|
@@ -4986,7 +5180,8 @@ export interface RouteVehicleNotice {
|
|
|
4986
5180
|
*/
|
|
4987
5181
|
Details: RouteVehicleNoticeDetail[] | undefined;
|
|
4988
5182
|
/**
|
|
4989
|
-
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
5183
|
+
* <p>Impact corresponding to the issue. While Low impact notices can be safely ignored, High
|
|
5184
|
+
* impact notices must be evaluated further to determine the impact.</p>
|
|
4990
5185
|
* @public
|
|
4991
5186
|
*/
|
|
4992
5187
|
Impact?: RouteNoticeImpact | undefined;
|
|
@@ -5079,12 +5274,14 @@ export interface RouteVehicleSpan {
|
|
|
5079
5274
|
*/
|
|
5080
5275
|
Country?: string | undefined;
|
|
5081
5276
|
/**
|
|
5082
|
-
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
5277
|
+
* <p>Distance of the computed span. This feature doesn't split a span, but is always computed
|
|
5278
|
+
* on a span split by other properties.</p>
|
|
5083
5279
|
* @public
|
|
5084
5280
|
*/
|
|
5085
5281
|
Distance?: number | undefined;
|
|
5086
5282
|
/**
|
|
5087
|
-
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
5283
|
+
* <p>Duration of the computed span. This feature doesn't split a span, but is always computed
|
|
5284
|
+
* on a span split by other properties.</p>
|
|
5088
5285
|
* <p>
|
|
5089
5286
|
* <b>Unit</b>: <code>seconds</code>
|
|
5090
5287
|
* </p>
|
|
@@ -5105,7 +5302,8 @@ export interface RouteVehicleSpan {
|
|
|
5105
5302
|
*/
|
|
5106
5303
|
FunctionalClassification?: number | undefined;
|
|
5107
5304
|
/**
|
|
5108
|
-
* <p>Attributes corresponding to a gate. The gate is present at the end of the returned
|
|
5305
|
+
* <p>Attributes corresponding to a gate. The gate is present at the end of the returned
|
|
5306
|
+
* span.</p>
|
|
5109
5307
|
* @public
|
|
5110
5308
|
*/
|
|
5111
5309
|
Gate?: RouteSpanGateAttribute | undefined;
|
|
@@ -5115,7 +5313,8 @@ export interface RouteVehicleSpan {
|
|
|
5115
5313
|
*/
|
|
5116
5314
|
GeometryOffset?: number | undefined;
|
|
5117
5315
|
/**
|
|
5118
|
-
* <p>Incidents corresponding to the span. These index into the Incidents in the parent
|
|
5316
|
+
* <p>Incidents corresponding to the span. These index into the Incidents in the parent
|
|
5317
|
+
* Leg.</p>
|
|
5119
5318
|
* @public
|
|
5120
5319
|
*/
|
|
5121
5320
|
Incidents?: number[] | undefined;
|
|
@@ -5125,17 +5324,20 @@ export interface RouteVehicleSpan {
|
|
|
5125
5324
|
*/
|
|
5126
5325
|
Names?: LocalizedString[] | undefined;
|
|
5127
5326
|
/**
|
|
5128
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
5327
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
5328
|
+
* route calculation.</p>
|
|
5129
5329
|
* @public
|
|
5130
5330
|
*/
|
|
5131
5331
|
Notices?: number[] | undefined;
|
|
5132
5332
|
/**
|
|
5133
|
-
* <p>Attributes corresponding to a railway crossing. The gate is present at the end of the
|
|
5333
|
+
* <p>Attributes corresponding to a railway crossing. The gate is present at the end of the
|
|
5334
|
+
* returned span.</p>
|
|
5134
5335
|
* @public
|
|
5135
5336
|
*/
|
|
5136
5337
|
RailwayCrossing?: RouteSpanRailwayCrossingAttribute | undefined;
|
|
5137
5338
|
/**
|
|
5138
|
-
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
5339
|
+
* <p>2-3 letter Region code corresponding to the Span. This is either a province or a
|
|
5340
|
+
* state.</p>
|
|
5139
5341
|
* @public
|
|
5140
5342
|
*/
|
|
5141
5343
|
Region?: string | undefined;
|
|
@@ -5173,8 +5375,8 @@ export interface RouteVehicleSpan {
|
|
|
5173
5375
|
*/
|
|
5174
5376
|
TruckAccess?: RouteSpanTruckAccessAttribute[] | undefined;
|
|
5175
5377
|
/**
|
|
5176
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
5177
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
5378
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
5379
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
5178
5380
|
* <note>
|
|
5179
5381
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
5180
5382
|
* </note>
|
|
@@ -5201,7 +5403,8 @@ export interface RouteVehicleSpan {
|
|
|
5201
5403
|
*/
|
|
5202
5404
|
export interface RouteVehicleOverviewSummary {
|
|
5203
5405
|
/**
|
|
5204
|
-
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
5406
|
+
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
5407
|
+
* possible to cover the leg.</p>
|
|
5205
5408
|
* <p>
|
|
5206
5409
|
* <b>Unit</b>: <code>seconds</code>
|
|
5207
5410
|
* </p>
|
|
@@ -5236,7 +5439,8 @@ export interface RouteVehicleOverviewSummary {
|
|
|
5236
5439
|
*/
|
|
5237
5440
|
export interface RouteVehicleTravelOnlySummary {
|
|
5238
5441
|
/**
|
|
5239
|
-
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
5442
|
+
* <p>Total duration in free flowing traffic, which is the best case or shortest duration
|
|
5443
|
+
* possible to cover the leg.</p>
|
|
5240
5444
|
* <p>
|
|
5241
5445
|
* <b>Unit</b>: <code>seconds</code>
|
|
5242
5446
|
* </p>
|
|
@@ -5266,12 +5470,14 @@ export interface RouteVehicleTravelOnlySummary {
|
|
|
5266
5470
|
*/
|
|
5267
5471
|
export interface RouteVehicleSummary {
|
|
5268
5472
|
/**
|
|
5269
|
-
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
5473
|
+
* <p>Summarized details for the leg including before travel, travel and after travel
|
|
5474
|
+
* steps.</p>
|
|
5270
5475
|
* @public
|
|
5271
5476
|
*/
|
|
5272
5477
|
Overview?: RouteVehicleOverviewSummary | undefined;
|
|
5273
5478
|
/**
|
|
5274
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
5479
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
5480
|
+
* only portion of the journey is in meters</p>
|
|
5275
5481
|
* @public
|
|
5276
5482
|
*/
|
|
5277
5483
|
TravelOnly?: RouteVehicleTravelOnlySummary | undefined;
|
|
@@ -5314,7 +5520,8 @@ export interface RouteTollPriceValueRange {
|
|
|
5314
5520
|
*/
|
|
5315
5521
|
export interface RouteTollPrice {
|
|
5316
5522
|
/**
|
|
5317
|
-
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
5523
|
+
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
5524
|
+
* request.</p>
|
|
5318
5525
|
* @public
|
|
5319
5526
|
*/
|
|
5320
5527
|
Currency: string | undefined;
|
|
@@ -5332,7 +5539,8 @@ export interface RouteTollPrice {
|
|
|
5332
5539
|
*/
|
|
5333
5540
|
PerDuration?: number | undefined;
|
|
5334
5541
|
/**
|
|
5335
|
-
* <p>If the price is a range or an exact value. If any of the toll fares making up the route
|
|
5542
|
+
* <p>If the price is a range or an exact value. If any of the toll fares making up the route
|
|
5543
|
+
* is a range, the overall price is also a range.</p>
|
|
5336
5544
|
* @public
|
|
5337
5545
|
*/
|
|
5338
5546
|
Range: boolean | undefined;
|
|
@@ -5485,7 +5693,9 @@ export interface RouteTollRate {
|
|
|
5485
5693
|
Transponders: RouteTransponder[] | undefined;
|
|
5486
5694
|
}
|
|
5487
5695
|
/**
|
|
5488
|
-
* <p>Provides details about toll information along a route, including the payment sites,
|
|
5696
|
+
* <p>Provides details about toll information along a route, including the payment sites,
|
|
5697
|
+
* applicable toll rates, toll systems, and the country associated with the toll
|
|
5698
|
+
* collection.</p>
|
|
5489
5699
|
* @public
|
|
5490
5700
|
*/
|
|
5491
5701
|
export interface RouteToll {
|
|
@@ -5771,7 +5981,8 @@ export interface RouteVehicleTravelStep {
|
|
|
5771
5981
|
*/
|
|
5772
5982
|
RoundaboutPassStepDetails?: RouteRoundaboutPassStepDetails | undefined;
|
|
5773
5983
|
/**
|
|
5774
|
-
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
5984
|
+
* <p>Sign post information of the action, applicable only for TurnByTurn steps. See
|
|
5985
|
+
* RouteSignpost for details of sub-attributes.</p>
|
|
5775
5986
|
* @public
|
|
5776
5987
|
*/
|
|
5777
5988
|
Signpost?: RouteSignpost | undefined;
|
|
@@ -5828,12 +6039,14 @@ export interface RouteVehicleLegDetails {
|
|
|
5828
6039
|
*/
|
|
5829
6040
|
Incidents: RouteVehicleIncident[] | undefined;
|
|
5830
6041
|
/**
|
|
5831
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
6042
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
6043
|
+
* route calculation.</p>
|
|
5832
6044
|
* @public
|
|
5833
6045
|
*/
|
|
5834
6046
|
Notices: RouteVehicleNotice[] | undefined;
|
|
5835
6047
|
/**
|
|
5836
|
-
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
6048
|
+
* <p>Waypoints that were passed through during the leg. This includes the waypoints that were
|
|
6049
|
+
* configured with the PassThrough option.</p>
|
|
5837
6050
|
* @public
|
|
5838
6051
|
*/
|
|
5839
6052
|
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
@@ -5863,8 +6076,8 @@ export interface RouteVehicleLegDetails {
|
|
|
5863
6076
|
*/
|
|
5864
6077
|
TravelSteps: RouteVehicleTravelStep[] | undefined;
|
|
5865
6078
|
/**
|
|
5866
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
5867
|
-
* <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
6079
|
+
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to
|
|
6080
|
+
* Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p>
|
|
5868
6081
|
* <note>
|
|
5869
6082
|
* <p>There are currently no other supported values as of 26th April 2024.</p>
|
|
5870
6083
|
* </note>
|
|
@@ -5878,8 +6091,11 @@ export interface RouteVehicleLegDetails {
|
|
|
5878
6091
|
Zones: RouteZone[] | undefined;
|
|
5879
6092
|
}
|
|
5880
6093
|
/**
|
|
5881
|
-
* <p>A leg is a section of a route from one waypoint to the next. A leg could be of type
|
|
5882
|
-
* Legs of different types could occur together within a single
|
|
6094
|
+
* <p>A leg is a section of a route from one waypoint to the next. A leg could be of type
|
|
6095
|
+
* Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single
|
|
6096
|
+
* route. For example, a car employing the use of a Ferry will contain Vehicle legs
|
|
6097
|
+
* corresponding to journey on land, and Ferry legs corresponding to the journey via
|
|
6098
|
+
* Ferry.</p>
|
|
5883
6099
|
* @public
|
|
5884
6100
|
*/
|
|
5885
6101
|
export interface RouteLeg {
|
|
@@ -5905,8 +6121,8 @@ export interface RouteLeg {
|
|
|
5905
6121
|
*/
|
|
5906
6122
|
PedestrianLegDetails?: RoutePedestrianLegDetails | undefined;
|
|
5907
6123
|
/**
|
|
5908
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
5909
|
-
*
|
|
6124
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
6125
|
+
* of travel and road compatibility.</p>
|
|
5910
6126
|
* <p>Default Value: <code>Car</code>
|
|
5911
6127
|
* </p>
|
|
5912
6128
|
* @public
|
|
@@ -5924,7 +6140,8 @@ export interface RouteLeg {
|
|
|
5924
6140
|
VehicleLegDetails?: RouteVehicleLegDetails | undefined;
|
|
5925
6141
|
}
|
|
5926
6142
|
/**
|
|
5927
|
-
* <p>Important labels including names and route numbers that differentiate the current route
|
|
6143
|
+
* <p>Important labels including names and route numbers that differentiate the current route
|
|
6144
|
+
* from the alternatives presented.</p>
|
|
5928
6145
|
* @public
|
|
5929
6146
|
*/
|
|
5930
6147
|
export interface RouteMajorRoadLabel {
|
|
@@ -5945,7 +6162,8 @@ export interface RouteMajorRoadLabel {
|
|
|
5945
6162
|
*/
|
|
5946
6163
|
export interface RouteTollPriceSummary {
|
|
5947
6164
|
/**
|
|
5948
|
-
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
6165
|
+
* <p>Currency code corresponding to the price. This is the same as Currency specified in the
|
|
6166
|
+
* request.</p>
|
|
5949
6167
|
* @public
|
|
5950
6168
|
*/
|
|
5951
6169
|
Currency: string | undefined;
|
|
@@ -5955,7 +6173,8 @@ export interface RouteTollPriceSummary {
|
|
|
5955
6173
|
*/
|
|
5956
6174
|
Estimate: boolean | undefined;
|
|
5957
6175
|
/**
|
|
5958
|
-
* <p>If the price is a range or an exact value. If any of the toll fares making up the route
|
|
6176
|
+
* <p>If the price is a range or an exact value. If any of the toll fares making up the route
|
|
6177
|
+
* is a range, the overall price is also a range.</p>
|
|
5959
6178
|
* @public
|
|
5960
6179
|
*/
|
|
5961
6180
|
Range: boolean | undefined;
|
|
@@ -5983,7 +6202,8 @@ export interface RouteTollSummary {
|
|
|
5983
6202
|
Total?: RouteTollPriceSummary | undefined;
|
|
5984
6203
|
}
|
|
5985
6204
|
/**
|
|
5986
|
-
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
6205
|
+
* <p>Summarized details for the leg including travel steps only. The Distance for the travel
|
|
6206
|
+
* only portion of the journey is the same as the Distance within the Overview summary.</p>
|
|
5987
6207
|
* @public
|
|
5988
6208
|
*/
|
|
5989
6209
|
export interface RouteSummary {
|
|
@@ -6012,13 +6232,17 @@ export interface RouteSummary {
|
|
|
6012
6232
|
*/
|
|
6013
6233
|
export interface Route {
|
|
6014
6234
|
/**
|
|
6015
|
-
* <p>A leg is a section of a route from one waypoint to the next. A leg could be of type
|
|
6016
|
-
* Legs of different types could occur together within a single
|
|
6235
|
+
* <p>A leg is a section of a route from one waypoint to the next. A leg could be of type
|
|
6236
|
+
* Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single
|
|
6237
|
+
* route. For example, a car employing the use of a Ferry will contain Vehicle legs
|
|
6238
|
+
* corresponding to journey on land, and Ferry legs corresponding to the journey via
|
|
6239
|
+
* Ferry.</p>
|
|
6017
6240
|
* @public
|
|
6018
6241
|
*/
|
|
6019
6242
|
Legs: RouteLeg[] | undefined;
|
|
6020
6243
|
/**
|
|
6021
|
-
* <p>Important labels including names and route numbers that differentiate the current route
|
|
6244
|
+
* <p>Important labels including names and route numbers that differentiate the current route
|
|
6245
|
+
* from the alternatives presented.</p>
|
|
6022
6246
|
* @public
|
|
6023
6247
|
*/
|
|
6024
6248
|
MajorRoadLabels: RouteMajorRoadLabel[] | undefined;
|
|
@@ -6038,7 +6262,8 @@ export interface CalculateRoutesResponse {
|
|
|
6038
6262
|
*/
|
|
6039
6263
|
LegGeometryFormat: GeometryFormat | undefined;
|
|
6040
6264
|
/**
|
|
6041
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
6265
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
6266
|
+
* route calculation.</p>
|
|
6042
6267
|
* @public
|
|
6043
6268
|
*/
|
|
6044
6269
|
Notices: RouteResponseNotice[] | undefined;
|
|
@@ -6095,7 +6320,10 @@ export interface WaypointOptimizationAvoidanceArea {
|
|
|
6095
6320
|
Geometry: WaypointOptimizationAvoidanceAreaGeometry | undefined;
|
|
6096
6321
|
}
|
|
6097
6322
|
/**
|
|
6098
|
-
* <p>
|
|
6323
|
+
* <p>Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning
|
|
6324
|
+
* the router will try to honor the avoidance preferences but may still include restricted
|
|
6325
|
+
* areas if no feasible alternative route exists. If avoidance options are not followed, the
|
|
6326
|
+
* response will indicate that the avoidance criteria were violated.</p>
|
|
6099
6327
|
* @public
|
|
6100
6328
|
*/
|
|
6101
6329
|
export interface WaypointOptimizationAvoidanceOptions {
|
|
@@ -6140,6 +6368,51 @@ export interface WaypointOptimizationAvoidanceOptions {
|
|
|
6140
6368
|
*/
|
|
6141
6369
|
UTurns?: boolean | undefined;
|
|
6142
6370
|
}
|
|
6371
|
+
/**
|
|
6372
|
+
* @public
|
|
6373
|
+
* @enum
|
|
6374
|
+
*/
|
|
6375
|
+
export declare const WaypointOptimizationClusteringAlgorithm: {
|
|
6376
|
+
readonly DRIVING_DISTANCE: "DrivingDistance";
|
|
6377
|
+
readonly TOPOLOGY_SEGMENT: "TopologySegment";
|
|
6378
|
+
};
|
|
6379
|
+
/**
|
|
6380
|
+
* @public
|
|
6381
|
+
*/
|
|
6382
|
+
export type WaypointOptimizationClusteringAlgorithm = (typeof WaypointOptimizationClusteringAlgorithm)[keyof typeof WaypointOptimizationClusteringAlgorithm];
|
|
6383
|
+
/**
|
|
6384
|
+
* <p>Driving distance related options.</p>
|
|
6385
|
+
* @public
|
|
6386
|
+
*/
|
|
6387
|
+
export interface WaypointOptimizationDrivingDistanceOptions {
|
|
6388
|
+
/**
|
|
6389
|
+
* <p>DrivingDistance assigns all the waypoints that are within driving distance of each other
|
|
6390
|
+
* into a single cluster.</p>
|
|
6391
|
+
* @public
|
|
6392
|
+
*/
|
|
6393
|
+
DrivingDistance: number | undefined;
|
|
6394
|
+
}
|
|
6395
|
+
/**
|
|
6396
|
+
* <p>Options for WaypointOptimizationClustering.</p>
|
|
6397
|
+
* @public
|
|
6398
|
+
*/
|
|
6399
|
+
export interface WaypointOptimizationClusteringOptions {
|
|
6400
|
+
/**
|
|
6401
|
+
* <p>The algorithm to be used. <code>DrivingDistance</code> assigns all the waypoints that
|
|
6402
|
+
* are within driving distance of each other into a single cluster.
|
|
6403
|
+
* <code>TopologySegment</code> assigns all the waypoints that are within the same topology
|
|
6404
|
+
* segment into a single cluster. A Topology segment is a linear stretch of road between two
|
|
6405
|
+
* junctions.</p>
|
|
6406
|
+
* @public
|
|
6407
|
+
*/
|
|
6408
|
+
Algorithm: WaypointOptimizationClusteringAlgorithm | undefined;
|
|
6409
|
+
/**
|
|
6410
|
+
* <p>Driving distance options to be used when the clustering algorithm is
|
|
6411
|
+
* DrivingDistance.</p>
|
|
6412
|
+
* @public
|
|
6413
|
+
*/
|
|
6414
|
+
DrivingDistanceOptions?: WaypointOptimizationDrivingDistanceOptions | undefined;
|
|
6415
|
+
}
|
|
6143
6416
|
/**
|
|
6144
6417
|
* <p>Hours of entry.</p>
|
|
6145
6418
|
* @public
|
|
@@ -6183,7 +6456,8 @@ export interface WaypointOptimizationSideOfStreetOptions {
|
|
|
6183
6456
|
*/
|
|
6184
6457
|
Position: number[] | undefined;
|
|
6185
6458
|
/**
|
|
6186
|
-
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
6459
|
+
* <p>Strategy that defines when the side of street position should be used. AnyStreet will
|
|
6460
|
+
* always use the provided position.</p>
|
|
6187
6461
|
* <p>Default Value: <code>DividedStreetOnly</code>
|
|
6188
6462
|
* </p>
|
|
6189
6463
|
* @public
|
|
@@ -6216,7 +6490,8 @@ export interface WaypointOptimizationDestinationOptions {
|
|
|
6216
6490
|
*/
|
|
6217
6491
|
Id?: string | undefined;
|
|
6218
6492
|
/**
|
|
6219
|
-
* <p>Service time spent at the destination. At an appointment, the service time should be the
|
|
6493
|
+
* <p>Service time spent at the destination. At an appointment, the service time should be the
|
|
6494
|
+
* appointment duration.</p>
|
|
6220
6495
|
* <p>
|
|
6221
6496
|
* <b>Unit</b>: <code>seconds</code>
|
|
6222
6497
|
* </p>
|
|
@@ -6230,7 +6505,9 @@ export interface WaypointOptimizationDestinationOptions {
|
|
|
6230
6505
|
SideOfStreet?: WaypointOptimizationSideOfStreetOptions | undefined;
|
|
6231
6506
|
}
|
|
6232
6507
|
/**
|
|
6233
|
-
* <p>Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken
|
|
6508
|
+
* <p>Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken
|
|
6509
|
+
* after the short work duration. The short cycle can be repeated until you hit the long work
|
|
6510
|
+
* duration, at which point the long rest duration should be taken before restarting.</p>
|
|
6234
6511
|
* <p>
|
|
6235
6512
|
* <b>Unit</b>: <code>seconds</code>
|
|
6236
6513
|
* </p>
|
|
@@ -6301,7 +6578,9 @@ export type WaypointOptimizationServiceTimeTreatment = (typeof WaypointOptimizat
|
|
|
6301
6578
|
*/
|
|
6302
6579
|
export interface WaypointOptimizationDriverOptions {
|
|
6303
6580
|
/**
|
|
6304
|
-
* <p>Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken
|
|
6581
|
+
* <p>Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken
|
|
6582
|
+
* after the short work duration. The short cycle can be repeated until you hit the long work
|
|
6583
|
+
* duration, at which point the long rest duration should be taken before restarting.</p>
|
|
6305
6584
|
* @public
|
|
6306
6585
|
*/
|
|
6307
6586
|
RestCycles?: WaypointOptimizationRestCycles | undefined;
|
|
@@ -6312,18 +6591,22 @@ export interface WaypointOptimizationDriverOptions {
|
|
|
6312
6591
|
*/
|
|
6313
6592
|
RestProfile?: WaypointOptimizationRestProfile | undefined;
|
|
6314
6593
|
/**
|
|
6315
|
-
* <p>If the service time provided at a waypoint/destination should be considered as rest or
|
|
6594
|
+
* <p>If the service time provided at a waypoint/destination should be considered as rest or
|
|
6595
|
+
* work. This contributes to the total time breakdown returned within the response.</p>
|
|
6316
6596
|
* @public
|
|
6317
6597
|
*/
|
|
6318
6598
|
TreatServiceTimeAs?: WaypointOptimizationServiceTimeTreatment | undefined;
|
|
6319
6599
|
}
|
|
6320
6600
|
/**
|
|
6321
|
-
* <p>
|
|
6601
|
+
* <p>Specifies strict exclusion options for the route calculation. This setting mandates that
|
|
6602
|
+
* the router will avoid any routes that include the specified options, rather than merely
|
|
6603
|
+
* attempting to minimize them.</p>
|
|
6322
6604
|
* @public
|
|
6323
6605
|
*/
|
|
6324
6606
|
export interface WaypointOptimizationExclusionOptions {
|
|
6325
6607
|
/**
|
|
6326
|
-
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
6608
|
+
* <p>List of countries to be avoided defined by two-letter or three-letter country
|
|
6609
|
+
* codes.</p>
|
|
6327
6610
|
* @public
|
|
6328
6611
|
*/
|
|
6329
6612
|
Countries: string[] | undefined;
|
|
@@ -6341,7 +6624,7 @@ export declare const WaypointOptimizationSequencingObjective: {
|
|
|
6341
6624
|
*/
|
|
6342
6625
|
export type WaypointOptimizationSequencingObjective = (typeof WaypointOptimizationSequencingObjective)[keyof typeof WaypointOptimizationSequencingObjective];
|
|
6343
6626
|
/**
|
|
6344
|
-
* <p>
|
|
6627
|
+
* <p>Origin related options.</p>
|
|
6345
6628
|
* @public
|
|
6346
6629
|
*/
|
|
6347
6630
|
export interface WaypointOptimizationOriginOptions {
|
|
@@ -6484,8 +6767,9 @@ export interface WaypointOptimizationTruckOptions {
|
|
|
6484
6767
|
TruckType?: WaypointOptimizationTruckType | undefined;
|
|
6485
6768
|
/**
|
|
6486
6769
|
* <p>The tunnel restriction code.</p>
|
|
6487
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
6488
|
-
* They relate to the types of dangerous goods that can be transported
|
|
6770
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
6771
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
6772
|
+
* through them.</p>
|
|
6489
6773
|
* <ul>
|
|
6490
6774
|
* <li>
|
|
6491
6775
|
* <p>
|
|
@@ -6552,7 +6836,9 @@ export interface WaypointOptimizationTruckOptions {
|
|
|
6552
6836
|
*/
|
|
6553
6837
|
TunnelRestrictionCode?: string | undefined;
|
|
6554
6838
|
/**
|
|
6555
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
6839
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for
|
|
6840
|
+
* usage in countries where the differences in axle types or axle groups are not
|
|
6841
|
+
* distinguished.</p>
|
|
6556
6842
|
* <p>
|
|
6557
6843
|
* <b>Unit</b>: <code>Kilograms</code>
|
|
6558
6844
|
* </p>
|
|
@@ -6620,7 +6906,8 @@ export interface WaypointOptimizationWaypoint {
|
|
|
6620
6906
|
*/
|
|
6621
6907
|
Position: number[] | undefined;
|
|
6622
6908
|
/**
|
|
6623
|
-
* <p>Service time spent at the waypoint. At an appointment, the service time should be the
|
|
6909
|
+
* <p>Service time spent at the waypoint. At an appointment, the service time should be the
|
|
6910
|
+
* appointment duration.</p>
|
|
6624
6911
|
* <p>
|
|
6625
6912
|
* <b>Unit</b>: <code>seconds</code>
|
|
6626
6913
|
* </p>
|
|
@@ -6638,11 +6925,17 @@ export interface WaypointOptimizationWaypoint {
|
|
|
6638
6925
|
*/
|
|
6639
6926
|
export interface OptimizeWaypointsRequest {
|
|
6640
6927
|
/**
|
|
6641
|
-
* <p>Features that are avoided
|
|
6642
|
-
*
|
|
6928
|
+
* <p>Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be
|
|
6929
|
+
* satisfied for a particular case, this setting is ignored.</p>
|
|
6643
6930
|
* @public
|
|
6644
6931
|
*/
|
|
6645
6932
|
Avoid?: WaypointOptimizationAvoidanceOptions | undefined;
|
|
6933
|
+
/**
|
|
6934
|
+
* <p>Clustering allows you to specify how nearby waypoints can be clustered to improve the
|
|
6935
|
+
* optimized sequence.</p>
|
|
6936
|
+
* @public
|
|
6937
|
+
*/
|
|
6938
|
+
Clustering?: WaypointOptimizationClusteringOptions | undefined;
|
|
6646
6939
|
/**
|
|
6647
6940
|
* <p>Departure time from the waypoint.</p>
|
|
6648
6941
|
* <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code>
|
|
@@ -6706,8 +6999,8 @@ export interface OptimizeWaypointsRequest {
|
|
|
6706
6999
|
*/
|
|
6707
7000
|
Traffic?: WaypointOptimizationTrafficOptions | undefined;
|
|
6708
7001
|
/**
|
|
6709
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
6710
|
-
*
|
|
7002
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
7003
|
+
* of travel and road compatibility.</p>
|
|
6711
7004
|
* <p>Default Value: <code>Car</code>
|
|
6712
7005
|
* </p>
|
|
6713
7006
|
* @public
|
|
@@ -6725,7 +7018,8 @@ export interface OptimizeWaypointsRequest {
|
|
|
6725
7018
|
Waypoints?: WaypointOptimizationWaypoint[] | undefined;
|
|
6726
7019
|
}
|
|
6727
7020
|
/**
|
|
6728
|
-
* <p>This contains information such as distance and duration from one waypoint to the next
|
|
7021
|
+
* <p>This contains information such as distance and duration from one waypoint to the next
|
|
7022
|
+
* waypoint in the sequence.</p>
|
|
6729
7023
|
* @public
|
|
6730
7024
|
*/
|
|
6731
7025
|
export interface WaypointOptimizationConnection {
|
|
@@ -6838,6 +7132,11 @@ export interface WaypointOptimizationOptimizedWaypoint {
|
|
|
6838
7132
|
* @public
|
|
6839
7133
|
*/
|
|
6840
7134
|
ArrivalTime?: string | undefined;
|
|
7135
|
+
/**
|
|
7136
|
+
* <p>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.</p>
|
|
7137
|
+
* @public
|
|
7138
|
+
*/
|
|
7139
|
+
ClusterIndex?: number | undefined;
|
|
6841
7140
|
/**
|
|
6842
7141
|
* <p>Estimated time of departure from thr origin.</p>
|
|
6843
7142
|
* <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code>
|
|
@@ -6877,7 +7176,8 @@ export interface WaypointOptimizationTimeBreakdown {
|
|
|
6877
7176
|
*/
|
|
6878
7177
|
RestDuration: number | undefined;
|
|
6879
7178
|
/**
|
|
6880
|
-
* <p>Service time spent at the destination. At an appointment, the service time should be the
|
|
7179
|
+
* <p>Service time spent at the destination. At an appointment, the service time should be the
|
|
7180
|
+
* appointment duration.</p>
|
|
6881
7181
|
* <p>
|
|
6882
7182
|
* <b>Unit</b>: <code>seconds</code>
|
|
6883
7183
|
* </p>
|
|
@@ -6906,7 +7206,8 @@ export interface WaypointOptimizationTimeBreakdown {
|
|
|
6906
7206
|
*/
|
|
6907
7207
|
export interface OptimizeWaypointsResponse {
|
|
6908
7208
|
/**
|
|
6909
|
-
* <p>Details about the connection from one waypoint to the next, within the optimized
|
|
7209
|
+
* <p>Details about the connection from one waypoint to the next, within the optimized
|
|
7210
|
+
* sequence.</p>
|
|
6910
7211
|
* @public
|
|
6911
7212
|
*/
|
|
6912
7213
|
Connections: WaypointOptimizationConnection[] | undefined;
|
|
@@ -6924,7 +7225,8 @@ export interface OptimizeWaypointsResponse {
|
|
|
6924
7225
|
*/
|
|
6925
7226
|
Duration: number | undefined;
|
|
6926
7227
|
/**
|
|
6927
|
-
* <p>Returns waypoints that caused the optimization problem to fail, and the constraints that
|
|
7228
|
+
* <p>Returns waypoints that caused the optimization problem to fail, and the constraints that
|
|
7229
|
+
* were unsatisfied leading to the failure.</p>
|
|
6928
7230
|
* @public
|
|
6929
7231
|
*/
|
|
6930
7232
|
ImpedingWaypoints: WaypointOptimizationImpedingWaypoint[] | undefined;
|
|
@@ -7062,8 +7364,9 @@ export interface RoadSnapTruckOptions {
|
|
|
7062
7364
|
Trailer?: RoadSnapTrailerOptions | undefined;
|
|
7063
7365
|
/**
|
|
7064
7366
|
* <p>The tunnel restriction code.</p>
|
|
7065
|
-
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
7066
|
-
* They relate to the types of dangerous goods that can be transported
|
|
7367
|
+
* <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels
|
|
7368
|
+
* in Great Britain. They relate to the types of dangerous goods that can be transported
|
|
7369
|
+
* through them.</p>
|
|
7067
7370
|
* <ul>
|
|
7068
7371
|
* <li>
|
|
7069
7372
|
* <p>
|
|
@@ -7179,8 +7482,8 @@ export interface SnapToRoadsRequest {
|
|
|
7179
7482
|
*/
|
|
7180
7483
|
TracePoints: RoadSnapTracePoint[] | undefined;
|
|
7181
7484
|
/**
|
|
7182
|
-
* <p>Specifies the mode of transport when calculating a route.
|
|
7183
|
-
*
|
|
7485
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
|
|
7486
|
+
* of travel and road compatibility.</p>
|
|
7184
7487
|
* <p>Default Value: <code>Car</code>
|
|
7185
7488
|
* </p>
|
|
7186
7489
|
* @public
|
|
@@ -7210,7 +7513,8 @@ export declare const RoadSnapNoticeCode: {
|
|
|
7210
7513
|
*/
|
|
7211
7514
|
export type RoadSnapNoticeCode = (typeof RoadSnapNoticeCode)[keyof typeof RoadSnapNoticeCode];
|
|
7212
7515
|
/**
|
|
7213
|
-
* <p>Notices provide information around factors that may have influenced snapping in a manner
|
|
7516
|
+
* <p>Notices provide information around factors that may have influenced snapping in a manner
|
|
7517
|
+
* atypical to the standard use cases.</p>
|
|
7214
7518
|
* @public
|
|
7215
7519
|
*/
|
|
7216
7520
|
export interface RoadSnapNotice {
|
|
@@ -7244,7 +7548,8 @@ export interface RoadSnapSnappedGeometry {
|
|
|
7244
7548
|
*/
|
|
7245
7549
|
LineString?: number[][] | undefined;
|
|
7246
7550
|
/**
|
|
7247
|
-
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
7551
|
+
* <p>An ordered list of positions used to plot a route on a map in a lossy compression
|
|
7552
|
+
* format.</p>
|
|
7248
7553
|
* <note>
|
|
7249
7554
|
* <p>LineString and Polyline are mutually exclusive properties.</p>
|
|
7250
7555
|
* </note>
|
|
@@ -7268,7 +7573,8 @@ export interface RoadSnapSnappedTracePoint {
|
|
|
7268
7573
|
*/
|
|
7269
7574
|
OriginalPosition: number[] | undefined;
|
|
7270
7575
|
/**
|
|
7271
|
-
* <p>Snapped position of the TracePoint provided within the request, at the same index.
|
|
7576
|
+
* <p>Snapped position of the TracePoint provided within the request, at the same index.
|
|
7577
|
+
* </p>
|
|
7272
7578
|
* @public
|
|
7273
7579
|
*/
|
|
7274
7580
|
SnappedPosition: number[] | undefined;
|
|
@@ -7278,7 +7584,8 @@ export interface RoadSnapSnappedTracePoint {
|
|
|
7278
7584
|
*/
|
|
7279
7585
|
export interface SnapToRoadsResponse {
|
|
7280
7586
|
/**
|
|
7281
|
-
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
7587
|
+
* <p>Notices are additional information returned that indicate issues that occurred during
|
|
7588
|
+
* route calculation.</p>
|
|
7282
7589
|
* @public
|
|
7283
7590
|
*/
|
|
7284
7591
|
Notices: RoadSnapNotice[] | undefined;
|