@aws-sdk/client-geo-routes 3.1020.0 → 3.1022.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/dist-cjs/index.js +0 -3
- package/dist-cjs/schemas/schemas_0.js +3 -5
- package/dist-es/models/enums.js +0 -3
- package/dist-es/schemas/schemas_0.js +3 -5
- package/dist-types/commands/CalculateIsolinesCommand.d.ts +1 -1
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +1 -1
- package/dist-types/commands/CalculateRoutesCommand.d.ts +1 -1
- package/dist-types/commands/OptimizeWaypointsCommand.d.ts +1 -1
- package/dist-types/commands/SnapToRoadsCommand.d.ts +1 -1
- package/dist-types/models/enums.d.ts +0 -3
- package/dist-types/models/models_0.d.ts +307 -307
- package/dist-types/ts3.4/models/enums.d.ts +0 -3
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +6 -6
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import type { DayOfWeek, GeometryFormat, IsolineEngineType, IsolineHazardousCargoType, IsolineOptimizationObjective, IsolineTravelMode, IsolineTruckType, IsolineZoneCategory, MatchingStrategy, MeasurementSystem, RoadSnapHazardousCargoType, RoadSnapNoticeCode, RoadSnapTravelMode, RouteDirection, RouteEngineType, RouteFerryAfterTravelStepType, RouteFerryBeforeTravelStepType, RouteFerryNoticeCode, RouteFerryTravelStepType, RouteHazardousCargoType, RouteLegAdditionalFeature, RouteLegTravelMode, RouteLegType, RouteMatrixErrorCode, RouteMatrixHazardousCargoType, RouteMatrixTravelMode, RouteMatrixTruckType, RouteMatrixZoneCategory, RouteNoticeImpact, RoutePedestrianNoticeCode, RoutePedestrianTravelStepType, RouteResponseNoticeCode, RouteRoadType, RouteSideOfStreet, RouteSpanAdditionalFeature, RouteSpanCarAccessAttribute, RouteSpanGateAttribute, RouteSpanPedestrianAccessAttribute, RouteSpanRailwayCrossingAttribute, RouteSpanRoadAttribute, RouteSpanScooterAccessAttribute, RouteSpanTruckAccessAttribute, RouteSteeringDirection, RouteTollPassValidityPeriodType, RouteTollPaymentMethod, RouteTollVehicleCategory, RouteTravelMode, RouteTravelStepType, RouteTruckType, RouteTurnIntensity, RouteVehicleIncidentSeverity, RouteVehicleIncidentType, RouteVehicleNoticeCode, RouteVehicleTravelStepType, RouteWeightConstraintType, RouteZoneCategory, RoutingObjective, SideOfStreetMatchingStrategy, TrafficUsage, WaypointOptimizationClusteringAlgorithm, WaypointOptimizationConstraint, WaypointOptimizationHazardousCargoType, WaypointOptimizationSequencingObjective, WaypointOptimizationServiceTimeTreatment, WaypointOptimizationTravelMode, WaypointOptimizationTruckType } from "./enums";
|
|
2
2
|
/**
|
|
3
|
-
* <p>
|
|
3
|
+
* <p>Special road types or features that should be considered available for routing. For example, this attribute can be used to allow the use of HOV (high-occupancy vehicle) or HOT (high-occupancy toll) lanes, even if they would otherwise not be.</p>
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
6
6
|
export interface IsolineAllowOptions {
|
|
7
7
|
/**
|
|
8
|
-
* <p>
|
|
8
|
+
* <p>When true, allows the use of HOT (high-occupancy toll) lanes, which may affect travel times and reachable areas.</p> <p>Default value: <code>false</code> </p>
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
11
|
Hot?: boolean | undefined;
|
|
12
12
|
/**
|
|
13
|
-
* <p>
|
|
13
|
+
* <p>When true, allows the use of HOV (high-occupancy vehicle) lanes, which may affect travel times and reachable areas.</p> <p>Default value: <code>false</code> </p>
|
|
14
14
|
* @public
|
|
15
15
|
*/
|
|
16
16
|
Hov?: boolean | undefined;
|
|
@@ -42,464 +42,464 @@ export interface PolylineCorridor {
|
|
|
42
42
|
*/
|
|
43
43
|
Polyline: string | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>
|
|
45
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
46
46
|
* @public
|
|
47
47
|
*/
|
|
48
48
|
Radius: number | undefined;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* <p>
|
|
51
|
+
* <p>Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible.</p>
|
|
52
52
|
* @public
|
|
53
53
|
*/
|
|
54
54
|
export interface IsolineAvoidanceAreaGeometry {
|
|
55
55
|
/**
|
|
56
|
-
* <p>
|
|
56
|
+
* <p>A rectangular area defined by its southwest and northeast corners: <code>[min longitude, min latitude, max longitude, max latitude]</code>.</p>
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
59
|
BoundingBox?: number[] | undefined;
|
|
60
60
|
/**
|
|
61
|
-
* <p>
|
|
61
|
+
* <p>A buffer zone around a line, defined by a series of coordinates and a radius in meters.</p>
|
|
62
62
|
* @public
|
|
63
63
|
*/
|
|
64
64
|
Corridor?: Corridor | undefined;
|
|
65
65
|
/**
|
|
66
|
-
* <p>A list of
|
|
66
|
+
* <p>A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.</p>
|
|
67
67
|
* @public
|
|
68
68
|
*/
|
|
69
69
|
Polygon?: number[][][] | undefined;
|
|
70
70
|
/**
|
|
71
|
-
* <p>
|
|
71
|
+
* <p>A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p>
|
|
72
72
|
* @public
|
|
73
73
|
*/
|
|
74
74
|
PolylineCorridor?: PolylineCorridor | undefined;
|
|
75
75
|
/**
|
|
76
|
-
* <p>A
|
|
76
|
+
* <p>A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p>
|
|
77
77
|
* @public
|
|
78
78
|
*/
|
|
79
79
|
PolylinePolygon?: string[] | undefined;
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
|
-
* <p>
|
|
82
|
+
* <p>Defines an area to avoid when calculating routes. Consists of a primary geometry to avoid, with the ability to specify exception areas within that geometry where travel is permitted.</p>
|
|
83
83
|
* @public
|
|
84
84
|
*/
|
|
85
85
|
export interface IsolineAvoidanceArea {
|
|
86
86
|
/**
|
|
87
|
-
* <p>
|
|
87
|
+
* <p>Areas within the primary avoidance geometry where travel is allowed. For example, you might want to avoid a neighborhood but allow travel on a major road that passes through it.</p>
|
|
88
88
|
* @public
|
|
89
89
|
*/
|
|
90
90
|
Except?: IsolineAvoidanceAreaGeometry[] | undefined;
|
|
91
91
|
/**
|
|
92
|
-
* <p>
|
|
92
|
+
* <p>The primary area to avoid, specified using a bounding box, corridor, polygon, or polyline corridor.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
95
|
Geometry: IsolineAvoidanceAreaGeometry | undefined;
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* <p>
|
|
98
|
+
* <p>Types of regulated zones that may affect routing.</p>
|
|
99
99
|
* @public
|
|
100
100
|
*/
|
|
101
101
|
export interface IsolineAvoidanceZoneCategory {
|
|
102
102
|
/**
|
|
103
|
-
* <p>
|
|
103
|
+
* <p>The type of regulated zone: <code>CongestionPricing</code> for toll zones based on traffic levels, <code>Environmental</code> for low-emission zones, or <code>Vignette</code> for areas requiring special permits or stickers.</p>
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
106
|
Category?: IsolineZoneCategory | undefined;
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
|
-
* <p>
|
|
109
|
+
* <p>Specifies features of the road network to avoid when calculating reachable areas. These preferences guide route calculations but may be overridden when no reasonable alternative exists. For example, if avoiding toll roads would make an area unreachable, toll roads may still be used.</p> <p>Avoidance options include physical features (like ferries and tunnels), road characteristics (like dirt roads and highways), and regulated areas (like congestion zones). They can be combined to match specific routing needs, such as avoiding both toll roads and ferries.</p>
|
|
110
110
|
* @public
|
|
111
111
|
*/
|
|
112
112
|
export interface IsolineAvoidanceOptions {
|
|
113
113
|
/**
|
|
114
|
-
* <p>
|
|
114
|
+
* <p>Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.</p>
|
|
115
115
|
* @public
|
|
116
116
|
*/
|
|
117
117
|
Areas?: IsolineAvoidanceArea[] | undefined;
|
|
118
118
|
/**
|
|
119
|
-
* <p>
|
|
119
|
+
* <p>Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.</p>
|
|
120
120
|
* @public
|
|
121
121
|
*/
|
|
122
122
|
CarShuttleTrains?: boolean | undefined;
|
|
123
123
|
/**
|
|
124
|
-
* <p>
|
|
124
|
+
* <p>Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included.</p>
|
|
125
125
|
* @public
|
|
126
126
|
*/
|
|
127
127
|
ControlledAccessHighways?: boolean | undefined;
|
|
128
128
|
/**
|
|
129
|
-
* <p>
|
|
129
|
+
* <p>Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.</p>
|
|
130
130
|
* @public
|
|
131
131
|
*/
|
|
132
132
|
DirtRoads?: boolean | undefined;
|
|
133
133
|
/**
|
|
134
|
-
* <p>
|
|
134
|
+
* <p>Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.</p>
|
|
135
135
|
* @public
|
|
136
136
|
*/
|
|
137
137
|
Ferries?: boolean | undefined;
|
|
138
138
|
/**
|
|
139
|
-
* <p>
|
|
139
|
+
* <p>Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists.</p>
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
142
|
SeasonalClosure?: boolean | undefined;
|
|
143
143
|
/**
|
|
144
|
-
* <p>
|
|
144
|
+
* <p>Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included.</p>
|
|
145
145
|
* @public
|
|
146
146
|
*/
|
|
147
147
|
TollRoads?: boolean | undefined;
|
|
148
148
|
/**
|
|
149
|
-
* <p>
|
|
149
|
+
* <p>Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists.</p>
|
|
150
150
|
* @public
|
|
151
151
|
*/
|
|
152
152
|
TollTransponders?: boolean | undefined;
|
|
153
153
|
/**
|
|
154
|
-
* <p>
|
|
154
|
+
* <p>For truck travel modes, indicates specific road classification types in Sweden (<code> BK1</code> through <code>BK4</code>) and Mexico (<code>A2, A4, B2, B4, C, D, ET2, ET4</code>) to avoid where possible. These road types may still be used if no reasonable alternative exists.</p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>
|
|
155
155
|
* @public
|
|
156
156
|
*/
|
|
157
157
|
TruckRoadTypes?: string[] | undefined;
|
|
158
158
|
/**
|
|
159
|
-
* <p>
|
|
159
|
+
* <p>Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.</p>
|
|
160
160
|
* @public
|
|
161
161
|
*/
|
|
162
162
|
Tunnels?: boolean | undefined;
|
|
163
163
|
/**
|
|
164
|
-
* <p>
|
|
164
|
+
* <p>Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists.</p>
|
|
165
165
|
* @public
|
|
166
166
|
*/
|
|
167
167
|
UTurns?: boolean | undefined;
|
|
168
168
|
/**
|
|
169
|
-
* <p>
|
|
169
|
+
* <p>Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.</p>
|
|
170
170
|
* @public
|
|
171
171
|
*/
|
|
172
172
|
ZoneCategories?: IsolineAvoidanceZoneCategory[] | undefined;
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
|
-
* <p>
|
|
175
|
+
* <p>Controls how origin and destination points are matched to the road network when they don't fall exactly on a road. Matching options help ensure realistic routing by connecting points to appropriate roads.</p>
|
|
176
176
|
* @public
|
|
177
177
|
*/
|
|
178
178
|
export interface IsolineMatchingOptions {
|
|
179
179
|
/**
|
|
180
|
-
* <p>
|
|
180
|
+
* <p>The expected street name near the point. Helps disambiguate matching when multiple roads are within range.</p>
|
|
181
181
|
* @public
|
|
182
182
|
*/
|
|
183
183
|
NameHint?: string | undefined;
|
|
184
184
|
/**
|
|
185
|
-
* <p>
|
|
185
|
+
* <p>The maximum distance in meters that a point can be from a road while still being considered "on" that road. Points further than this distance require explicit matching.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
186
186
|
* @public
|
|
187
187
|
*/
|
|
188
188
|
OnRoadThreshold?: number | undefined;
|
|
189
189
|
/**
|
|
190
|
-
* <p>
|
|
190
|
+
* <p>The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified <code>Strategy</code> </p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
191
191
|
* @public
|
|
192
192
|
*/
|
|
193
193
|
Radius?: number | undefined;
|
|
194
194
|
/**
|
|
195
|
-
* <p>
|
|
195
|
+
* <p>Determines how points are matched to the road network. <code>MatchAny</code> finds the nearest viable road segment, while <code>MatchMostSignificantRoad</code> prioritizes major roads.</p>
|
|
196
196
|
* @public
|
|
197
197
|
*/
|
|
198
198
|
Strategy?: MatchingStrategy | undefined;
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* <p>
|
|
201
|
+
* <p>Controls how points are matched to specific sides of streets. This is important when the side of the street matters for accessibility - for example, when building entrances or parking lot access points can only be reached from one side of a divided road.</p>
|
|
202
202
|
* @public
|
|
203
203
|
*/
|
|
204
204
|
export interface IsolineSideOfStreetOptions {
|
|
205
205
|
/**
|
|
206
|
-
* <p>
|
|
206
|
+
* <p>The <code>[longitude, latitude]</code> coordinates of the point that should be matched to a specific side of the street.</p>
|
|
207
207
|
* @public
|
|
208
208
|
*/
|
|
209
209
|
Position: number[] | undefined;
|
|
210
210
|
/**
|
|
211
|
-
* <p>
|
|
211
|
+
* <p>Controls whether side-of-street matching is applied to any street (<code>AnyStreet</code>) or only to divided roads (<code>DividedStreetOnly</code>). This is important when the exact side of the street matters - for example, if a building entrance is only accessible from one side of a divided highway, or if a parking lot can only be entered from northbound lanes. Without correct side-of-street matching, travel time estimates may be inaccurate because they don't account for necessary U-turns or detours to reach the correct side.</p> <p>Default value: <code>DividedStreetOnly</code> </p>
|
|
212
212
|
* @public
|
|
213
213
|
*/
|
|
214
214
|
UseWith?: SideOfStreetMatchingStrategy | undefined;
|
|
215
215
|
}
|
|
216
216
|
/**
|
|
217
|
-
* <p>
|
|
217
|
+
* <p>Options that control how the destination point is interpreted and matched to the road network when calculating reachable areas. This affects which roads are considered accessible near the destination and how the final approach is calculated.</p>
|
|
218
218
|
* @public
|
|
219
219
|
*/
|
|
220
220
|
export interface IsolineDestinationOptions {
|
|
221
221
|
/**
|
|
222
|
-
* <p>
|
|
222
|
+
* <p>The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.</p>
|
|
223
223
|
* @public
|
|
224
224
|
*/
|
|
225
225
|
AvoidActionsForDistance?: number | undefined;
|
|
226
226
|
/**
|
|
227
|
-
* <p>
|
|
227
|
+
* <p>The initial direction of travel in degrees (0-360, where 0 is north). This can affect which road segments are considered accessible from the starting point.</p>
|
|
228
228
|
* @public
|
|
229
229
|
*/
|
|
230
230
|
Heading?: number | undefined;
|
|
231
231
|
/**
|
|
232
|
-
* <p>
|
|
232
|
+
* <p>Controls how the destination point is matched to the road network, including search radius and name-based matching preferences.</p>
|
|
233
233
|
* @public
|
|
234
234
|
*/
|
|
235
235
|
Matching?: IsolineMatchingOptions | undefined;
|
|
236
236
|
/**
|
|
237
|
-
* <p>
|
|
237
|
+
* <p>Specifies which side of the street should be considered accessible, which is important when building entrances or parking access points are only reachable from one side of the road.</p>
|
|
238
238
|
* @public
|
|
239
239
|
*/
|
|
240
240
|
SideOfStreet?: IsolineSideOfStreetOptions | undefined;
|
|
241
241
|
}
|
|
242
242
|
/**
|
|
243
|
-
* <p>
|
|
243
|
+
* <p>Controls the detail level and smoothness of generated isolines. More detailed isolines provide better visual representation of reachable areas but require more processing time and result in larger responses.</p>
|
|
244
244
|
* @public
|
|
245
245
|
*/
|
|
246
246
|
export interface IsolineGranularityOptions {
|
|
247
247
|
/**
|
|
248
|
-
* <p>
|
|
248
|
+
* <p>The maximum number of points used to define each isoline. Higher values create smoother, more detailed shapes.</p>
|
|
249
249
|
* @public
|
|
250
250
|
*/
|
|
251
251
|
MaxPoints?: number | undefined;
|
|
252
252
|
/**
|
|
253
|
-
* <p>
|
|
253
|
+
* <p>The maximum distance in meters between points along the isoline. Smaller values create more detailed shapes.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
254
254
|
* @public
|
|
255
255
|
*/
|
|
256
256
|
MaxResolution?: number | undefined;
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
|
-
* <p>
|
|
259
|
+
* <p>Options that control how the origin point is interpreted when calculating reachable areas. These options affect which roads are considered accessible from the starting point and how initial routing decisions are made.</p>
|
|
260
260
|
* @public
|
|
261
261
|
*/
|
|
262
262
|
export interface IsolineOriginOptions {
|
|
263
263
|
/**
|
|
264
|
-
* <p>
|
|
264
|
+
* <p>The distance in meters from the origin point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the starting point.</p>
|
|
265
265
|
* @public
|
|
266
266
|
*/
|
|
267
267
|
AvoidActionsForDistance?: number | undefined;
|
|
268
268
|
/**
|
|
269
|
-
* <p>
|
|
269
|
+
* <p>Initial direction of travel in degrees (0-360, where 0 is north). This affects which road segments are considered accessible from the starting point and is particularly useful when the origin is on a divided road or at a complex intersection.</p>
|
|
270
270
|
* @public
|
|
271
271
|
*/
|
|
272
272
|
Heading?: number | undefined;
|
|
273
273
|
/**
|
|
274
|
-
* <p>
|
|
274
|
+
* <p>Controls how the origin point is matched to the road network, including search radius and matching strategy.</p>
|
|
275
275
|
* @public
|
|
276
276
|
*/
|
|
277
277
|
Matching?: IsolineMatchingOptions | undefined;
|
|
278
278
|
/**
|
|
279
|
-
* <p>
|
|
279
|
+
* <p>Controls which side of the street is considered accessible from the origin point, particularly important for divided roads where building entrances or parking access may only be available from one direction.</p>
|
|
280
280
|
* @public
|
|
281
281
|
*/
|
|
282
282
|
SideOfStreet?: IsolineSideOfStreetOptions | undefined;
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* <p>
|
|
285
|
+
* <p>Specifies the time or distance limits used to calculate reachable areas. You can provide up to five thresholds for a single type to generate multiple isolines in a single request. For example, you might request areas reachable within 5, 10, and 15 minutes, or within 1, 2, and 5 kilometers.</p>
|
|
286
286
|
* @public
|
|
287
287
|
*/
|
|
288
288
|
export interface IsolineThresholds {
|
|
289
289
|
/**
|
|
290
|
-
* <p>
|
|
290
|
+
* <p>List of travel distances in meters. For example, [1000, 2000, 5000] would calculate areas reachable within 1, 2, and 5 kilometers.</p>
|
|
291
291
|
* @public
|
|
292
292
|
*/
|
|
293
293
|
Distance?: number[] | undefined;
|
|
294
294
|
/**
|
|
295
|
-
* <p>
|
|
295
|
+
* <p>List of travel times in seconds. For example, [300, 600, 900] would calculate areas reachable within 5, 10, and 15 minutes.</p>
|
|
296
296
|
* @public
|
|
297
297
|
*/
|
|
298
298
|
Time?: number[] | undefined;
|
|
299
299
|
}
|
|
300
300
|
/**
|
|
301
|
-
* <p>
|
|
301
|
+
* <p>Controls how real-time and historical traffic data is used when calculating reachable areas. This affects both the size and shape of isolines by accounting for expected travel speeds based on congestion patterns.</p>
|
|
302
302
|
* @public
|
|
303
303
|
*/
|
|
304
304
|
export interface IsolineTrafficOptions {
|
|
305
305
|
/**
|
|
306
|
-
* <p>
|
|
306
|
+
* <p>The duration in seconds that real-time congestion data is considered valid before reverting to historical traffic patterns. This helps balance between using current conditions and more predictable historical data when calculating travel times.</p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
307
307
|
* @public
|
|
308
308
|
*/
|
|
309
309
|
FlowEventThresholdOverride?: number | undefined;
|
|
310
310
|
/**
|
|
311
|
-
* <p>
|
|
311
|
+
* <p>Controls whether traffic data is used in calculations. <code>UseTrafficData</code> considers both real-time congestion and historical patterns, while <code>IgnoreTrafficData</code> calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.</p> <p>Default value: <code>UseTrafficData</code> </p>
|
|
312
312
|
* @public
|
|
313
313
|
*/
|
|
314
314
|
Usage?: TrafficUsage | undefined;
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
|
-
* <p>
|
|
317
|
+
* <p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>
|
|
318
318
|
* @public
|
|
319
319
|
*/
|
|
320
320
|
export interface IsolineVehicleLicensePlate {
|
|
321
321
|
/**
|
|
322
|
-
* <p>The last character of the
|
|
322
|
+
* <p>The last character of the vehicle's license plate. Used to determine road access restrictions in regions with license plate-based traffic management systems.</p>
|
|
323
323
|
* @public
|
|
324
324
|
*/
|
|
325
325
|
LastCharacter?: string | undefined;
|
|
326
326
|
}
|
|
327
327
|
/**
|
|
328
|
-
* <p>
|
|
328
|
+
* <p>Vehicle characteristics and preferences that affect routing for passenger cars. This includes vehicle type, occupancy, and speed restrictions that may influence which roads can be used and expected travel times.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
331
|
export interface IsolineCarOptions {
|
|
332
332
|
/**
|
|
333
|
-
* <p>
|
|
333
|
+
* <p>The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.</p> <ul> <li> <p> <code>INTERNAL_COMBUSTION</code>—Standard gasoline or diesel engine.</p> </li> <li> <p> <code>ELECTRIC</code>—Battery electric vehicle.</p> </li> <li> <p> <code>PLUGIN_HYBRID</code>—Combination of electric and internal combustion engines with plug-in charging capability.</p> </li> </ul>
|
|
334
334
|
* @public
|
|
335
335
|
*/
|
|
336
336
|
EngineType?: IsolineEngineType | undefined;
|
|
337
337
|
/**
|
|
338
|
-
* <p>
|
|
338
|
+
* <p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>
|
|
339
339
|
* @public
|
|
340
340
|
*/
|
|
341
341
|
LicensePlate?: IsolineVehicleLicensePlate | undefined;
|
|
342
342
|
/**
|
|
343
|
-
* <p>
|
|
343
|
+
* <p>The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
344
344
|
* @public
|
|
345
345
|
*/
|
|
346
346
|
MaxSpeed?: number | undefined;
|
|
347
347
|
/**
|
|
348
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
348
|
+
* <p>The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.</p> <p>Default value: <code>1</code> </p>
|
|
349
349
|
* @public
|
|
350
350
|
*/
|
|
351
351
|
Occupancy?: number | undefined;
|
|
352
352
|
}
|
|
353
353
|
/**
|
|
354
|
-
* <p>
|
|
354
|
+
* <p>Vehicle characteristics that affect which roads and paths can be used when calculating reachable areas for scooters. This includes areas such as bike lanes, shared paths, and roads where scooters are permitted.</p>
|
|
355
355
|
* @public
|
|
356
356
|
*/
|
|
357
357
|
export interface IsolineScooterOptions {
|
|
358
358
|
/**
|
|
359
|
-
* <p>
|
|
359
|
+
* <p>The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.</p> <ul> <li> <p> <code>INTERNAL_COMBUSTION</code>—Standard gasoline or diesel engine.</p> </li> <li> <p> <code>ELECTRIC</code>—Battery electric vehicle.</p> </li> <li> <p> <code>PLUGIN_HYBRID</code>—Combination of electric and internal combustion engines with plug-in charging capability.</p> </li> </ul>
|
|
360
360
|
* @public
|
|
361
361
|
*/
|
|
362
362
|
EngineType?: IsolineEngineType | undefined;
|
|
363
363
|
/**
|
|
364
|
-
* <p>
|
|
364
|
+
* <p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>
|
|
365
365
|
* @public
|
|
366
366
|
*/
|
|
367
367
|
LicensePlate?: IsolineVehicleLicensePlate | undefined;
|
|
368
368
|
/**
|
|
369
|
-
* <p>
|
|
369
|
+
* <p>The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
370
370
|
* @public
|
|
371
371
|
*/
|
|
372
372
|
MaxSpeed?: number | undefined;
|
|
373
373
|
/**
|
|
374
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
374
|
+
* <p>The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.</p> <p>Default value: <code>1</code> </p>
|
|
375
375
|
* @public
|
|
376
376
|
*/
|
|
377
377
|
Occupancy?: number | undefined;
|
|
378
378
|
}
|
|
379
379
|
/**
|
|
380
|
-
* <p>
|
|
380
|
+
* <p>Additional specifications when the vehicle includes one or more trailers.</p>
|
|
381
381
|
* @public
|
|
382
382
|
*/
|
|
383
383
|
export interface IsolineTrailerOptions {
|
|
384
384
|
/**
|
|
385
|
-
* <p>
|
|
385
|
+
* <p>The total number of axles across all trailers. Used for weight distribution calculations and road restrictions.</p>
|
|
386
386
|
* @public
|
|
387
387
|
*/
|
|
388
388
|
AxleCount?: number | undefined;
|
|
389
389
|
/**
|
|
390
|
-
* <p>
|
|
390
|
+
* <p>The number of trailers being pulled. Affects which roads can be used based on local regulations.</p> <p>Default value: <code>0</code> </p>
|
|
391
391
|
* @public
|
|
392
392
|
*/
|
|
393
393
|
TrailerCount?: number | undefined;
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
|
-
* <p>Specifies the total weight for
|
|
396
|
+
* <p>Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
397
397
|
* @public
|
|
398
398
|
*/
|
|
399
399
|
export interface WeightPerAxleGroup {
|
|
400
400
|
/**
|
|
401
|
-
* <p>
|
|
401
|
+
* <p>Total weight in kilograms for single axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
402
402
|
* @public
|
|
403
403
|
*/
|
|
404
404
|
Single?: number | undefined;
|
|
405
405
|
/**
|
|
406
|
-
* <p>
|
|
406
|
+
* <p>Total weight in kilograms for tandem (two adjacent) axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
407
407
|
* @public
|
|
408
408
|
*/
|
|
409
409
|
Tandem?: number | undefined;
|
|
410
410
|
/**
|
|
411
|
-
* <p>
|
|
411
|
+
* <p>Total weight in kilograms for triple (three adjacent) axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
412
412
|
* @public
|
|
413
413
|
*/
|
|
414
414
|
Triple?: number | undefined;
|
|
415
415
|
/**
|
|
416
|
-
* <p>
|
|
416
|
+
* <p>Total weight in kilograms for quad (four adjacent) axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
417
417
|
* @public
|
|
418
418
|
*/
|
|
419
419
|
Quad?: number | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* <p>
|
|
421
|
+
* <p>Total weight in kilograms for quint (five adjacent) axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
422
422
|
* @public
|
|
423
423
|
*/
|
|
424
424
|
Quint?: number | undefined;
|
|
425
425
|
}
|
|
426
426
|
/**
|
|
427
|
-
* <p>
|
|
427
|
+
* <p>Vehicle characteristics and restrictions that affect which roads can be used when calculating reachable areas for trucks. These details ensure that routes respect physical limitations and legal requirements.</p> <p>These apply when the provided travel mode is <code>Truck</code> </p>
|
|
428
428
|
* @public
|
|
429
429
|
*/
|
|
430
430
|
export interface IsolineTruckOptions {
|
|
431
431
|
/**
|
|
432
|
-
* <p>
|
|
432
|
+
* <p>The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.</p>
|
|
433
433
|
* @public
|
|
434
434
|
*/
|
|
435
435
|
AxleCount?: number | undefined;
|
|
436
436
|
/**
|
|
437
|
-
* <p>
|
|
437
|
+
* <p>The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.</p> <ul> <li> <p> <code>INTERNAL_COMBUSTION</code>—Standard gasoline or diesel engine.</p> </li> <li> <p> <code>ELECTRIC</code>—Battery electric vehicle.</p> </li> <li> <p> <code>PLUGIN_HYBRID</code>—Combination of electric and internal combustion engines with plug-in charging capability.</p> </li> </ul>
|
|
438
438
|
* @public
|
|
439
439
|
*/
|
|
440
440
|
EngineType?: IsolineEngineType | undefined;
|
|
441
441
|
/**
|
|
442
|
-
* <p>
|
|
442
|
+
* <p>The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
443
443
|
* @public
|
|
444
444
|
*/
|
|
445
445
|
GrossWeight?: number | undefined;
|
|
446
446
|
/**
|
|
447
|
-
* <p>
|
|
447
|
+
* <p>Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.</p> <ul> <li> <p> <code>Combustible</code>—Materials that can burn readily</p> </li> <li> <p> <code>Corrosive</code>—Materials that can destroy or irreversibly damage other substances</p> </li> <li> <p> <code>Explosive</code>—Materials that can produce an explosion by chemical reaction</p> </li> <li> <p> <code>Flammable</code>—Materials that can easily ignite</p> </li> <li> <p> <code>Gas</code>—Hazardous materials in gaseous form</p> </li> <li> <p> <code>HarmfulToWater</code>—Materials that pose a risk to water sources if released</p> </li> <li> <p> <code>Organic</code>—Hazardous organic compounds</p> </li> <li> <p> <code>Other</code>—Hazardous materials not covered by other categories</p> </li> <li> <p> <code>Poison</code>—Toxic materials</p> </li> <li> <p> <code>PoisonousInhalation</code>—Materials that are toxic when inhaled</p> </li> <li> <p> <code>Radioactive</code>—Materials that emit ionizing radiation</p> </li> </ul>
|
|
448
448
|
* @public
|
|
449
449
|
*/
|
|
450
450
|
HazardousCargos?: IsolineHazardousCargoType[] | undefined;
|
|
451
451
|
/**
|
|
452
|
-
* <p>
|
|
452
|
+
* <p>The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>
|
|
453
453
|
* @public
|
|
454
454
|
*/
|
|
455
455
|
Height?: number | undefined;
|
|
456
456
|
/**
|
|
457
|
-
* <p>
|
|
457
|
+
* <p>The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>
|
|
458
458
|
* @public
|
|
459
459
|
*/
|
|
460
460
|
HeightAboveFirstAxle?: number | undefined;
|
|
461
461
|
/**
|
|
462
|
-
* <p>
|
|
462
|
+
* <p>The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>
|
|
463
463
|
* @public
|
|
464
464
|
*/
|
|
465
465
|
KpraLength?: number | undefined;
|
|
466
466
|
/**
|
|
467
|
-
* <p>
|
|
467
|
+
* <p>The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>
|
|
468
468
|
* @public
|
|
469
469
|
*/
|
|
470
470
|
Length?: number | undefined;
|
|
471
471
|
/**
|
|
472
|
-
* <p>
|
|
472
|
+
* <p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
475
|
LicensePlate?: IsolineVehicleLicensePlate | undefined;
|
|
476
476
|
/**
|
|
477
|
-
* <p>
|
|
477
|
+
* <p>The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
478
478
|
* @public
|
|
479
479
|
*/
|
|
480
480
|
MaxSpeed?: number | undefined;
|
|
481
481
|
/**
|
|
482
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
482
|
+
* <p>The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.</p> <p>Default value: <code>1</code> </p>
|
|
483
483
|
* @public
|
|
484
484
|
*/
|
|
485
485
|
Occupancy?: number | undefined;
|
|
486
486
|
/**
|
|
487
|
-
* <p>
|
|
487
|
+
* <p>The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
488
488
|
* @public
|
|
489
489
|
*/
|
|
490
490
|
PayloadCapacity?: number | undefined;
|
|
491
491
|
/**
|
|
492
|
-
* <p>
|
|
492
|
+
* <p>The total number of tires on the vehicle.</p>
|
|
493
493
|
* @public
|
|
494
494
|
*/
|
|
495
495
|
TireCount?: number | undefined;
|
|
496
496
|
/**
|
|
497
|
-
* <p>
|
|
497
|
+
* <p>Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.</p>
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
500
|
Trailer?: IsolineTrailerOptions | undefined;
|
|
501
501
|
/**
|
|
502
|
-
* <p>
|
|
502
|
+
* <p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck </code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>
|
|
503
503
|
* @public
|
|
504
504
|
*/
|
|
505
505
|
TruckType?: IsolineTruckType | undefined;
|
|
@@ -509,38 +509,38 @@ export interface IsolineTruckOptions {
|
|
|
509
509
|
*/
|
|
510
510
|
TunnelRestrictionCode?: string | undefined;
|
|
511
511
|
/**
|
|
512
|
-
* <p>
|
|
512
|
+
* <p>The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
513
513
|
* @public
|
|
514
514
|
*/
|
|
515
515
|
WeightPerAxle?: number | undefined;
|
|
516
516
|
/**
|
|
517
|
-
* <p>Specifies the total weight for
|
|
517
|
+
* <p>Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
518
518
|
* @public
|
|
519
519
|
*/
|
|
520
520
|
WeightPerAxleGroup?: WeightPerAxleGroup | undefined;
|
|
521
521
|
/**
|
|
522
|
-
* <p>
|
|
522
|
+
* <p>The vehicle width in centimeters. Used to avoid routes with width restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>
|
|
523
523
|
* @public
|
|
524
524
|
*/
|
|
525
525
|
Width?: number | undefined;
|
|
526
526
|
}
|
|
527
527
|
/**
|
|
528
|
-
* <p>
|
|
528
|
+
* <p>Mode-specific routing options that further refine how reachable areas are calculated. Options are only considered when they match the selected travel mode.</p>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
531
|
export interface IsolineTravelModeOptions {
|
|
532
532
|
/**
|
|
533
|
-
* <p>
|
|
533
|
+
* <p>Options specific to passenger vehicle routing (<code>Car</code>, such as vehicle characteristics and license plate restrictions.</p>
|
|
534
534
|
* @public
|
|
535
535
|
*/
|
|
536
536
|
Car?: IsolineCarOptions | undefined;
|
|
537
537
|
/**
|
|
538
|
-
* <p>
|
|
538
|
+
* <p>Options specific to scooter routing (<code>Scooter</code>, such as vehicle characteristics and license plate restrictions.</p> <note> <p>When using the <code>Scooter</code> travel mode, controlled-access highways are automatically avoided unless explicitly allowed.</p> </note>
|
|
539
539
|
* @public
|
|
540
540
|
*/
|
|
541
541
|
Scooter?: IsolineScooterOptions | undefined;
|
|
542
542
|
/**
|
|
543
|
-
* <p>
|
|
543
|
+
* <p>Options specific to commercial truck routing (<code>Truck</code>, including vehicle dimensions, weight limits, and hazardous cargo specifications.</p>
|
|
544
544
|
* @public
|
|
545
545
|
*/
|
|
546
546
|
Truck?: IsolineTruckOptions | undefined;
|
|
@@ -550,171 +550,171 @@ export interface IsolineTravelModeOptions {
|
|
|
550
550
|
*/
|
|
551
551
|
export interface CalculateIsolinesRequest {
|
|
552
552
|
/**
|
|
553
|
-
* <p>
|
|
553
|
+
* <p>Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.</p>
|
|
554
554
|
* @public
|
|
555
555
|
*/
|
|
556
556
|
Allow?: IsolineAllowOptions | undefined;
|
|
557
557
|
/**
|
|
558
|
-
* <p>
|
|
558
|
+
* <p>Determine areas from which <code>Destination</code> can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with <code>DepartureTime</code> or <code>DepartNow</code>. Specified as an ISO-8601 timestamp with timezone offset.</p> <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
561
|
ArrivalTime?: string | undefined;
|
|
562
562
|
/**
|
|
563
|
-
* <p>
|
|
563
|
+
* <p>Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.</p>
|
|
564
564
|
* @public
|
|
565
565
|
*/
|
|
566
566
|
Avoid?: IsolineAvoidanceOptions | undefined;
|
|
567
567
|
/**
|
|
568
|
-
* <p>
|
|
568
|
+
* <p>When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with <code>DepartureTime</code> or <code>ArrivalTime</code>.</p>
|
|
569
569
|
* @public
|
|
570
570
|
*/
|
|
571
571
|
DepartNow?: boolean | undefined;
|
|
572
572
|
/**
|
|
573
|
-
* <p>
|
|
573
|
+
* <p>Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with <code>ArrivalTime</code> or <code>DepartNow</code>. Specified as an ISO-8601 timestamp with timezone offset.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
574
574
|
* @public
|
|
575
575
|
*/
|
|
576
576
|
DepartureTime?: string | undefined;
|
|
577
577
|
/**
|
|
578
|
-
* <p>
|
|
578
|
+
* <p>An optional destination point, specified as <code>[longitude, latitude]</code> coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either <code>Origin</code> or <code>Destination</code> must be provided.</p>
|
|
579
579
|
* @public
|
|
580
580
|
*/
|
|
581
581
|
Destination?: number[] | undefined;
|
|
582
582
|
/**
|
|
583
|
-
* <p>
|
|
583
|
+
* <p>Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.</p>
|
|
584
584
|
* @public
|
|
585
585
|
*/
|
|
586
586
|
DestinationOptions?: IsolineDestinationOptions | undefined;
|
|
587
587
|
/**
|
|
588
|
-
* <p>The format of the returned IsolineGeometry. </p> <p>Default
|
|
588
|
+
* <p>The format of the returned IsolineGeometry. </p> <p>Default value:<code>FlexiblePolyline</code> </p>
|
|
589
589
|
* @public
|
|
590
590
|
*/
|
|
591
591
|
IsolineGeometryFormat?: GeometryFormat | undefined;
|
|
592
592
|
/**
|
|
593
|
-
* <p>
|
|
593
|
+
* <p>Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.</p>
|
|
594
594
|
* @public
|
|
595
595
|
*/
|
|
596
596
|
IsolineGranularity?: IsolineGranularityOptions | undefined;
|
|
597
597
|
/**
|
|
598
|
-
* <p>
|
|
598
|
+
* <p>An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.</p>
|
|
599
599
|
* @public
|
|
600
600
|
*/
|
|
601
601
|
Key?: string | undefined;
|
|
602
602
|
/**
|
|
603
|
-
* <p>
|
|
603
|
+
* <p>Controls the trade-off between calculation speed and isoline precision. Choose <code> FastCalculation</code> for quicker results with less detail, <code>AccurateCalculation</code> for more precise results, or <code>BalancedCalculation</code> for a middle ground.</p> <p>Default value: <code>BalancedCalculation</code> </p>
|
|
604
604
|
* @public
|
|
605
605
|
*/
|
|
606
606
|
OptimizeIsolineFor?: IsolineOptimizationObjective | undefined;
|
|
607
607
|
/**
|
|
608
|
-
* <p>
|
|
608
|
+
* <p>Determines whether routes prioritize shortest travel time (<code>FastestRoute</code>) or shortest physical distance (<code>ShortestRoute</code>) when calculating reachable areas.</p> <p>Default value: <code>FastestRoute</code> </p>
|
|
609
609
|
* @public
|
|
610
610
|
*/
|
|
611
611
|
OptimizeRoutingFor?: RoutingObjective | undefined;
|
|
612
612
|
/**
|
|
613
|
-
* <p>The
|
|
613
|
+
* <p>The starting point for isoline calculations, specified as <code>[longitude, latitude]</code> coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either <code>Origin</code> or <code>Destination</code> must be provided.</p>
|
|
614
614
|
* @public
|
|
615
615
|
*/
|
|
616
616
|
Origin?: number[] | undefined;
|
|
617
617
|
/**
|
|
618
|
-
* <p>
|
|
618
|
+
* <p>Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.</p>
|
|
619
619
|
* @public
|
|
620
620
|
*/
|
|
621
621
|
OriginOptions?: IsolineOriginOptions | undefined;
|
|
622
622
|
/**
|
|
623
|
-
* <p>
|
|
623
|
+
* <p>The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.</p> <p>You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
624
624
|
* @public
|
|
625
625
|
*/
|
|
626
626
|
Thresholds: IsolineThresholds | undefined;
|
|
627
627
|
/**
|
|
628
|
-
* <p>Traffic
|
|
628
|
+
* <p>Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.</p>
|
|
629
629
|
* @public
|
|
630
630
|
*/
|
|
631
631
|
Traffic?: IsolineTrafficOptions | undefined;
|
|
632
632
|
/**
|
|
633
|
-
* <p>
|
|
633
|
+
* <p>The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.</p> <ul> <li> <p> <code>Car</code>—Standard passenger vehicle routing using roads accessible to cars</p> </li> <li> <p> <code>Pedestrian</code>—Walking routes using pedestrian paths, sidewalks, and crossings</p> </li> <li> <p> <code>Scooter</code>—Light two-wheeled vehicle routing using roads and paths accessible to scooters</p> </li> <li> <p> <code>Truck</code>—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations</p> </li> </ul> <note> <p>The mode <code>Scooter</code> also applies to motorcycles; set this to <code>Scooter</code> when calculating isolines for motorcycles.</p> </note> <p>Default value: <code>Car</code> </p>
|
|
634
634
|
* @public
|
|
635
635
|
*/
|
|
636
636
|
TravelMode?: IsolineTravelMode | undefined;
|
|
637
637
|
/**
|
|
638
|
-
* <p>
|
|
638
|
+
* <p>Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.</p> <p>For example:</p> <ul> <li> <p>For trucks (<code>Truck</code>), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle</p> </li> <li> <p>For cars (<code>Car</code>), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas</p> </li> <li> <p>For scooters (<code>Scooter</code>), specify engine type and speed limitations to more accurately model their travel capabilities</p> </li> </ul> <p>Without these options, calculations use default assumptions that may not match your specific use case.</p>
|
|
639
639
|
* @public
|
|
640
640
|
*/
|
|
641
641
|
TravelModeOptions?: IsolineTravelModeOptions | undefined;
|
|
642
642
|
}
|
|
643
643
|
/**
|
|
644
|
-
* <p>
|
|
644
|
+
* <p>Represents the geometry of connections between non-contiguous parts of an isoline. These connections can be provided in either coordinate pairs (LineString) or encoded (Polyline) format, matching the format specified in the request.</p>
|
|
645
645
|
* @public
|
|
646
646
|
*/
|
|
647
647
|
export interface IsolineConnectionGeometry {
|
|
648
648
|
/**
|
|
649
|
-
* <p>
|
|
649
|
+
* <p>A series of <code>[longitude, latitude]</code> coordinate pairs defining the connection path when <code>Simple</code> geometry format is requested. These coordinates can be directly used as the coordinates array in a GeoJSON LineString without transformation.</p> <note> <p>LineString and Polyline are mutually exclusive properties.</p> </note>
|
|
650
650
|
* @public
|
|
651
651
|
*/
|
|
652
652
|
LineString?: number[][] | undefined;
|
|
653
653
|
/**
|
|
654
|
-
* <p>An
|
|
654
|
+
* <p>An encoded representation of the connection path when <code>FlexiblePolyline</code> geometry format is requested. This provides a more compact representation suitable for transmission and storage. To convert to GeoJSON, first decode to obtain coordinate pairs, then use those coordinates as the coordinates array in a GeoJSON LineString.</p> <note> <p>LineString and Polyline are mutually exclusive properties.</p> </note>
|
|
655
655
|
* @public
|
|
656
656
|
*/
|
|
657
657
|
Polyline?: string | undefined;
|
|
658
658
|
}
|
|
659
659
|
/**
|
|
660
|
-
* <p>
|
|
660
|
+
* <p>Represents a segment of the transportation network that connects separate parts of a reachable area. These connections show how discontinuous areas are linked, such as by ferry routes or bridges crossing unroutable terrain.</p>
|
|
661
661
|
* @public
|
|
662
662
|
*/
|
|
663
663
|
export interface IsolineConnection {
|
|
664
664
|
/**
|
|
665
|
-
* <p>
|
|
665
|
+
* <p>The index of the starting polygon in the isoline's <code>Geometries</code> list.</p>
|
|
666
666
|
* @public
|
|
667
667
|
*/
|
|
668
668
|
FromPolygonIndex: number | undefined;
|
|
669
669
|
/**
|
|
670
|
-
* <p>The
|
|
670
|
+
* <p>The shape of the connection, representing the actual path through the transportation network that links the polygons.</p>
|
|
671
671
|
* @public
|
|
672
672
|
*/
|
|
673
673
|
Geometry: IsolineConnectionGeometry | undefined;
|
|
674
674
|
/**
|
|
675
|
-
* <p>
|
|
675
|
+
* <p>The index of the ending polygon in the isoline's <code>Geometries</code> list.</p>
|
|
676
676
|
* @public
|
|
677
677
|
*/
|
|
678
678
|
ToPolygonIndex: number | undefined;
|
|
679
679
|
}
|
|
680
680
|
/**
|
|
681
|
-
* <p>
|
|
681
|
+
* <p>Represents the shape of a reachable area. The geometry can be provided either as coordinate pairs (<code>Polygon</code>) or in encoded format (<code>PolylinePolygon</code>), matching the format specified in the request.</p>
|
|
682
682
|
* @public
|
|
683
683
|
*/
|
|
684
684
|
export interface IsolineShapeGeometry {
|
|
685
685
|
/**
|
|
686
|
-
* <p>A
|
|
686
|
+
* <p>A series of coordinate rings defining the reachable area when Simple geometry format is requested. Each ring is a list of <code>[longitude, latitude]</code> coordinate pairs. The first ring defines the outer boundary; subsequent rings define holes representing unreachable areas.</p> <note> <p>Polygon and PolylinePolygon are mutually exclusive properties.</p> </note>
|
|
687
687
|
* @public
|
|
688
688
|
*/
|
|
689
689
|
Polygon?: number[][][] | undefined;
|
|
690
690
|
/**
|
|
691
|
-
* <p>
|
|
691
|
+
* <p>An encoded representation of the reachable area when FlexiblePolyline geometry format is requested. Provides a compact representation suitable for transmission and storage. The first string defines the outer boundary; subsequent strings define holes representing unreachable areas. For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p> <note> <p>Polygon and PolylinePolygon are mutually exclusive properties.</p> </note>
|
|
692
692
|
* @public
|
|
693
693
|
*/
|
|
694
694
|
PolylinePolygon?: string[] | undefined;
|
|
695
695
|
}
|
|
696
696
|
/**
|
|
697
|
-
* <p>
|
|
697
|
+
* <p>Represents a single reachable area calculated for a specific threshold.</p>
|
|
698
698
|
* @public
|
|
699
699
|
*/
|
|
700
700
|
export interface Isoline {
|
|
701
701
|
/**
|
|
702
|
-
* <p>
|
|
702
|
+
* <p>Lines connecting separate parts of the reachable area that can be reached within the same threshold. These occur when areas are reachable but not contiguous, such as when separated by water or unroutable areas. When present, these lines represent actual transportation network segments (such as ferry routes or bridges) that connect the separated areas.</p>
|
|
703
703
|
* @public
|
|
704
704
|
*/
|
|
705
705
|
Connections: IsolineConnection[] | undefined;
|
|
706
706
|
/**
|
|
707
|
-
* <p>
|
|
707
|
+
* <p>The travel distance in meters used to calculate this isoline, if distance-based thresholds were specified in the request.</p>
|
|
708
708
|
* @public
|
|
709
709
|
*/
|
|
710
710
|
DistanceThreshold?: number | undefined;
|
|
711
711
|
/**
|
|
712
|
-
* <p>
|
|
712
|
+
* <p>The shapes that define the reachable area, provided in the requested geometry format.</p>
|
|
713
713
|
* @public
|
|
714
714
|
*/
|
|
715
715
|
Geometries: IsolineShapeGeometry[] | undefined;
|
|
716
716
|
/**
|
|
717
|
-
* <p>
|
|
717
|
+
* <p>The travel time in seconds used to calculate this isoline, if time-based thresholds were specified in the request.</p>
|
|
718
718
|
* @public
|
|
719
719
|
*/
|
|
720
720
|
TimeThreshold?: number | undefined;
|
|
@@ -724,37 +724,37 @@ export interface Isoline {
|
|
|
724
724
|
*/
|
|
725
725
|
export interface CalculateIsolinesResponse {
|
|
726
726
|
/**
|
|
727
|
-
* <p>Time of arrival at the destination. This
|
|
727
|
+
* <p>Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the <code>Destination</code> and <code>ArrivalTime</code> attributes were provided in the request.</p> <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
728
728
|
* @public
|
|
729
729
|
*/
|
|
730
730
|
ArrivalTime?: string | undefined;
|
|
731
731
|
/**
|
|
732
|
-
* <p>Time of departure from
|
|
732
|
+
* <p>Time of departure from the origin, used for traffic calculations. This attribute is returned when <code>Origin</code> was provided in the request and either a specific departure time was requested (<code>DepartureTime</code>) or <code>DepartNow</code> was set to true.</p> <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
733
733
|
* @public
|
|
734
734
|
*/
|
|
735
735
|
DepartureTime?: string | undefined;
|
|
736
736
|
/**
|
|
737
|
-
* <p>The format of the returned
|
|
737
|
+
* <p>The format of the returned geometries, matching the format specified in the request. Either <code> FlexiblePolyline</code> for compact encoding or <code>Simple</code> for GeoJSON-compatible coordinates.</p> <p>Default value:<code>FlexiblePolyline</code> </p>
|
|
738
738
|
* @public
|
|
739
739
|
*/
|
|
740
740
|
IsolineGeometryFormat: GeometryFormat | undefined;
|
|
741
741
|
/**
|
|
742
|
-
* <p>
|
|
742
|
+
* <p>Reachable areas, or isolines, for each threshold specified in the request.</p>
|
|
743
743
|
* @public
|
|
744
744
|
*/
|
|
745
745
|
Isolines: Isoline[] | undefined;
|
|
746
746
|
/**
|
|
747
|
-
* <p>The pricing bucket
|
|
747
|
+
* <p>The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.</p>
|
|
748
748
|
* @public
|
|
749
749
|
*/
|
|
750
750
|
PricingBucket: string | undefined;
|
|
751
751
|
/**
|
|
752
|
-
* <p>
|
|
752
|
+
* <p>The actual point on the road network used for calculations, which may differ from the requested destination if <code>Destination</code> was not directly on a road.</p>
|
|
753
753
|
* @public
|
|
754
754
|
*/
|
|
755
755
|
SnappedDestination?: number[] | undefined;
|
|
756
756
|
/**
|
|
757
|
-
* <p>
|
|
757
|
+
* <p>The actual point on the road network used for calculations, which may differ from the requested origin if <code>Origin</code> was not directly on a road.</p>
|
|
758
758
|
* @public
|
|
759
759
|
*/
|
|
760
760
|
SnappedOrigin?: number[] | undefined;
|
|
@@ -807,7 +807,7 @@ export interface RouteMatrixAvoidanceAreaGeometry {
|
|
|
807
807
|
*/
|
|
808
808
|
Polygon?: number[][][] | undefined;
|
|
809
809
|
/**
|
|
810
|
-
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/
|
|
810
|
+
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p>
|
|
811
811
|
* @public
|
|
812
812
|
*/
|
|
813
813
|
PolylinePolygon?: string[] | undefined;
|
|
@@ -911,7 +911,7 @@ export interface RouteMatrixMatchingOptions {
|
|
|
911
911
|
*/
|
|
912
912
|
OnRoadThreshold?: number | undefined;
|
|
913
913
|
/**
|
|
914
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>
|
|
914
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
915
915
|
* @public
|
|
916
916
|
*/
|
|
917
917
|
Radius?: number | undefined;
|
|
@@ -927,12 +927,12 @@ export interface RouteMatrixMatchingOptions {
|
|
|
927
927
|
*/
|
|
928
928
|
export interface RouteMatrixSideOfStreetOptions {
|
|
929
929
|
/**
|
|
930
|
-
* <p>Position
|
|
930
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
931
931
|
* @public
|
|
932
932
|
*/
|
|
933
933
|
Position: number[] | undefined;
|
|
934
934
|
/**
|
|
935
|
-
* <p>Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.</p> <p>Default
|
|
935
|
+
* <p>Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.</p> <p>Default value: <code>DividedStreetOnly</code> </p>
|
|
936
936
|
* @public
|
|
937
937
|
*/
|
|
938
938
|
UseWith?: SideOfStreetMatchingStrategy | undefined;
|
|
@@ -969,12 +969,12 @@ export interface RouteMatrixDestinationOptions {
|
|
|
969
969
|
*/
|
|
970
970
|
export interface RouteMatrixDestination {
|
|
971
971
|
/**
|
|
972
|
-
* <p>Destination related options
|
|
972
|
+
* <p> Destination related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
973
973
|
* @public
|
|
974
974
|
*/
|
|
975
975
|
Options?: RouteMatrixDestinationOptions | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* <p>Position
|
|
977
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
978
978
|
* @public
|
|
979
979
|
*/
|
|
980
980
|
Position: number[] | undefined;
|
|
@@ -1017,17 +1017,17 @@ export interface RouteMatrixOriginOptions {
|
|
|
1017
1017
|
SideOfStreet?: RouteMatrixSideOfStreetOptions | undefined;
|
|
1018
1018
|
}
|
|
1019
1019
|
/**
|
|
1020
|
-
* <p>The start position for the route.</p>
|
|
1020
|
+
* <p>The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
1021
1021
|
* @public
|
|
1022
1022
|
*/
|
|
1023
1023
|
export interface RouteMatrixOrigin {
|
|
1024
1024
|
/**
|
|
1025
|
-
* <p>Origin related options
|
|
1025
|
+
* <p> Origin related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1026
1026
|
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
Options?: RouteMatrixOriginOptions | undefined;
|
|
1029
1029
|
/**
|
|
1030
|
-
* <p>Position
|
|
1030
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
1031
1031
|
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
Position: number[] | undefined;
|
|
@@ -1054,7 +1054,7 @@ export interface RouteMatrixAutoCircle {
|
|
|
1054
1054
|
*/
|
|
1055
1055
|
export interface Circle {
|
|
1056
1056
|
/**
|
|
1057
|
-
* <p>Center of the Circle
|
|
1057
|
+
* <p>Center of the Circle in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <p>Example: <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>. </p>
|
|
1058
1058
|
* @public
|
|
1059
1059
|
*/
|
|
1060
1060
|
Center: number[] | undefined;
|
|
@@ -1117,7 +1117,7 @@ export interface RouteMatrixTrafficOptions {
|
|
|
1117
1117
|
*/
|
|
1118
1118
|
FlowEventThresholdOverride?: number | undefined;
|
|
1119
1119
|
/**
|
|
1120
|
-
* <p>Determines if traffic should be used or ignored while calculating the route.</p> <p>Default
|
|
1120
|
+
* <p>Determines if traffic should be used or ignored while calculating the route.</p> <p>Default value: <code>UseTrafficData</code> </p>
|
|
1121
1121
|
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
Usage?: TrafficUsage | undefined;
|
|
@@ -1144,18 +1144,18 @@ export interface RouteMatrixCarOptions {
|
|
|
1144
1144
|
*/
|
|
1145
1145
|
LicensePlate?: RouteMatrixVehicleLicensePlate | undefined;
|
|
1146
1146
|
/**
|
|
1147
|
-
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>
|
|
1147
|
+
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1148
1148
|
* @public
|
|
1149
1149
|
*/
|
|
1150
1150
|
MaxSpeed?: number | undefined;
|
|
1151
1151
|
/**
|
|
1152
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
1152
|
+
* <p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>
|
|
1153
1153
|
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
Occupancy?: number | undefined;
|
|
1156
1156
|
}
|
|
1157
1157
|
/**
|
|
1158
|
-
* <p>Travel mode options when the provided travel mode is <code>Scooter</code
|
|
1158
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>.</p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
export interface RouteMatrixScooterOptions {
|
|
@@ -1165,12 +1165,12 @@ export interface RouteMatrixScooterOptions {
|
|
|
1165
1165
|
*/
|
|
1166
1166
|
LicensePlate?: RouteMatrixVehicleLicensePlate | undefined;
|
|
1167
1167
|
/**
|
|
1168
|
-
* <p>Maximum speed.</p> <p> <b>Unit</b>: <code>
|
|
1168
|
+
* <p>Maximum speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1169
1169
|
* @public
|
|
1170
1170
|
*/
|
|
1171
1171
|
MaxSpeed?: number | undefined;
|
|
1172
1172
|
/**
|
|
1173
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
1173
|
+
* <p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>
|
|
1174
1174
|
* @public
|
|
1175
1175
|
*/
|
|
1176
1176
|
Occupancy?: number | undefined;
|
|
@@ -1181,13 +1181,13 @@ export interface RouteMatrixScooterOptions {
|
|
|
1181
1181
|
*/
|
|
1182
1182
|
export interface RouteMatrixTrailerOptions {
|
|
1183
1183
|
/**
|
|
1184
|
-
* <p>Number of trailers attached to the vehicle.</p> <p>Default
|
|
1184
|
+
* <p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>
|
|
1185
1185
|
* @public
|
|
1186
1186
|
*/
|
|
1187
1187
|
TrailerCount?: number | undefined;
|
|
1188
1188
|
}
|
|
1189
1189
|
/**
|
|
1190
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1190
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
1191
1191
|
* @public
|
|
1192
1192
|
*/
|
|
1193
1193
|
export interface RouteMatrixTruckOptions {
|
|
@@ -1197,7 +1197,7 @@ export interface RouteMatrixTruckOptions {
|
|
|
1197
1197
|
*/
|
|
1198
1198
|
AxleCount?: number | undefined;
|
|
1199
1199
|
/**
|
|
1200
|
-
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>
|
|
1200
|
+
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
1201
1201
|
* @public
|
|
1202
1202
|
*/
|
|
1203
1203
|
GrossWeight?: number | undefined;
|
|
@@ -1227,12 +1227,12 @@ export interface RouteMatrixTruckOptions {
|
|
|
1227
1227
|
*/
|
|
1228
1228
|
LicensePlate?: RouteMatrixVehicleLicensePlate | undefined;
|
|
1229
1229
|
/**
|
|
1230
|
-
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>
|
|
1230
|
+
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1231
1231
|
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
MaxSpeed?: number | undefined;
|
|
1234
1234
|
/**
|
|
1235
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
1235
|
+
* <p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>
|
|
1236
1236
|
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
Occupancy?: number | undefined;
|
|
@@ -1247,7 +1247,7 @@ export interface RouteMatrixTruckOptions {
|
|
|
1247
1247
|
*/
|
|
1248
1248
|
Trailer?: RouteMatrixTrailerOptions | undefined;
|
|
1249
1249
|
/**
|
|
1250
|
-
* <p>
|
|
1250
|
+
* <p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>
|
|
1251
1251
|
* @public
|
|
1252
1252
|
*/
|
|
1253
1253
|
TruckType?: RouteMatrixTruckType | undefined;
|
|
@@ -1257,7 +1257,7 @@ export interface RouteMatrixTruckOptions {
|
|
|
1257
1257
|
*/
|
|
1258
1258
|
TunnelRestrictionCode?: string | undefined;
|
|
1259
1259
|
/**
|
|
1260
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>
|
|
1260
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
1261
1261
|
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
WeightPerAxle?: number | undefined;
|
|
@@ -1278,17 +1278,17 @@ export interface RouteMatrixTruckOptions {
|
|
|
1278
1278
|
*/
|
|
1279
1279
|
export interface RouteMatrixTravelModeOptions {
|
|
1280
1280
|
/**
|
|
1281
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1281
|
+
* <p>Travel mode options when the provided travel mode is <code>Car</code>.</p>
|
|
1282
1282
|
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
Car?: RouteMatrixCarOptions | undefined;
|
|
1285
1285
|
/**
|
|
1286
|
-
* <p>Travel mode options when the provided travel mode is <code>Scooter</code
|
|
1286
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>. </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>
|
|
1287
1287
|
* @public
|
|
1288
1288
|
*/
|
|
1289
1289
|
Scooter?: RouteMatrixScooterOptions | undefined;
|
|
1290
1290
|
/**
|
|
1291
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1291
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
1292
1292
|
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
Truck?: RouteMatrixTruckOptions | undefined;
|
|
@@ -1303,7 +1303,7 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
Allow?: RouteMatrixAllowOptions | undefined;
|
|
1305
1305
|
/**
|
|
1306
|
-
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation
|
|
1306
|
+
* <p> Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>TollRoads</code>, <code>Ferries</code>, and <code>ControlledAccessHighways</code>. </p>
|
|
1307
1307
|
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
Avoid?: RouteMatrixAvoidanceOptions | undefined;
|
|
@@ -1313,17 +1313,17 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1313
1313
|
*/
|
|
1314
1314
|
DepartNow?: boolean | undefined;
|
|
1315
1315
|
/**
|
|
1316
|
-
* <p>Time of departure from
|
|
1316
|
+
* <p>Time of departure from the origin.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
1317
1317
|
* @public
|
|
1318
1318
|
*/
|
|
1319
1319
|
DepartureTime?: string | undefined;
|
|
1320
1320
|
/**
|
|
1321
|
-
* <p>List of destinations for the route.</p> <note> <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.
|
|
1321
|
+
* <p>List of destinations for the route.</p> <note> <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. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </note>
|
|
1322
1322
|
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
Destinations: RouteMatrixDestination[] | undefined;
|
|
1325
1325
|
/**
|
|
1326
|
-
* <p>Features to be strictly excluded while calculating the route
|
|
1326
|
+
* <p> Features to be strictly excluded while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1327
1327
|
* @public
|
|
1328
1328
|
*/
|
|
1329
1329
|
Exclude?: RouteMatrixExclusionOptions | undefined;
|
|
@@ -1333,32 +1333,32 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1333
1333
|
*/
|
|
1334
1334
|
Key?: string | undefined;
|
|
1335
1335
|
/**
|
|
1336
|
-
* <p>
|
|
1336
|
+
* <p>Controls the trade-off between finding the shortest travel time (<code>FastestRoute</code>) and the shortest distance (<code>ShortestRoute</code>) when calculating reachable areas.</p> <p>Default value: <code>FastestRoute</code> </p>
|
|
1337
1337
|
* @public
|
|
1338
1338
|
*/
|
|
1339
1339
|
OptimizeRoutingFor?: RoutingObjective | undefined;
|
|
1340
1340
|
/**
|
|
1341
|
-
* <p>The position in
|
|
1341
|
+
* <p>The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].</p> <note> <p>Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html">Routes pricing</a> in the <i>Amazon Location Service Developer Guide</i>.</p> </note>
|
|
1342
1342
|
* @public
|
|
1343
1343
|
*/
|
|
1344
1344
|
Origins: RouteMatrixOrigin[] | undefined;
|
|
1345
1345
|
/**
|
|
1346
|
-
* <p>Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid
|
|
1346
|
+
* <p> Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Unbounded</code> set to <code>true</code>. </p> <p>Default value: <code>Unbounded set to true</code> </p> <note> <p>When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.</p> </note>
|
|
1347
1347
|
* @public
|
|
1348
1348
|
*/
|
|
1349
|
-
RoutingBoundary
|
|
1349
|
+
RoutingBoundary?: RouteMatrixBoundary | undefined;
|
|
1350
1350
|
/**
|
|
1351
|
-
* <p>Traffic related options
|
|
1351
|
+
* <p> Traffic related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1352
1352
|
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
Traffic?: RouteMatrixTrafficOptions | undefined;
|
|
1355
1355
|
/**
|
|
1356
|
-
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility
|
|
1356
|
+
* <p> Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Car</code>, <code>Pedestrian</code>, and <code>Scooter</code>. </p> <p>Default value: <code>Car</code> </p>
|
|
1357
1357
|
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
TravelMode?: RouteMatrixTravelMode | undefined;
|
|
1360
1360
|
/**
|
|
1361
|
-
* <p>Travel mode related options for the provided travel mode
|
|
1361
|
+
* <p> Travel mode related options for the provided travel mode. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1362
1362
|
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
TravelModeOptions?: RouteMatrixTravelModeOptions | undefined;
|
|
@@ -1451,7 +1451,7 @@ export interface RouteAvoidanceAreaGeometry {
|
|
|
1451
1451
|
*/
|
|
1452
1452
|
PolylineCorridor?: PolylineCorridor | undefined;
|
|
1453
1453
|
/**
|
|
1454
|
-
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/
|
|
1454
|
+
* <p>A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p>
|
|
1455
1455
|
* @public
|
|
1456
1456
|
*/
|
|
1457
1457
|
PolylinePolygon?: string[] | undefined;
|
|
@@ -1473,7 +1473,7 @@ export interface RouteAvoidanceArea {
|
|
|
1473
1473
|
Geometry: RouteAvoidanceAreaGeometry | undefined;
|
|
1474
1474
|
}
|
|
1475
1475
|
/**
|
|
1476
|
-
* <p>Zone categories to be avoided
|
|
1476
|
+
* <p> Zone categories to be avoided. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1477
1477
|
* @public
|
|
1478
1478
|
*/
|
|
1479
1479
|
export interface RouteAvoidanceZoneCategory {
|
|
@@ -1489,12 +1489,12 @@ export interface RouteAvoidanceZoneCategory {
|
|
|
1489
1489
|
*/
|
|
1490
1490
|
export interface RouteAvoidanceOptions {
|
|
1491
1491
|
/**
|
|
1492
|
-
* <p>Areas to be avoided
|
|
1492
|
+
* <p> Areas to be avoided. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1493
1493
|
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
Areas?: RouteAvoidanceArea[] | undefined;
|
|
1496
1496
|
/**
|
|
1497
|
-
* <p>Avoid car-shuttle-trains while calculating the route
|
|
1497
|
+
* <p> Avoid car-shuttle-trains while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1498
1498
|
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
CarShuttleTrains?: boolean | undefined;
|
|
@@ -1504,7 +1504,7 @@ export interface RouteAvoidanceOptions {
|
|
|
1504
1504
|
*/
|
|
1505
1505
|
ControlledAccessHighways?: boolean | undefined;
|
|
1506
1506
|
/**
|
|
1507
|
-
* <p>Avoid dirt roads while calculating the route
|
|
1507
|
+
* <p> Avoid dirt roads while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1508
1508
|
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
DirtRoads?: boolean | undefined;
|
|
@@ -1514,7 +1514,7 @@ export interface RouteAvoidanceOptions {
|
|
|
1514
1514
|
*/
|
|
1515
1515
|
Ferries?: boolean | undefined;
|
|
1516
1516
|
/**
|
|
1517
|
-
* <p>Avoid roads that have seasonal closure while calculating the route
|
|
1517
|
+
* <p> Avoid roads that have seasonal closure while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1518
1518
|
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
SeasonalClosure?: boolean | undefined;
|
|
@@ -1524,27 +1524,27 @@ export interface RouteAvoidanceOptions {
|
|
|
1524
1524
|
*/
|
|
1525
1525
|
TollRoads?: boolean | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* <p>Avoids roads where the specified toll transponders are the only mode of payment
|
|
1527
|
+
* <p> Avoids roads where the specified toll transponders are the only mode of payment. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1528
1528
|
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
TollTransponders?: boolean | undefined;
|
|
1531
1531
|
/**
|
|
1532
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico
|
|
1532
|
+
* <p> Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>
|
|
1533
1533
|
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
TruckRoadTypes?: string[] | undefined;
|
|
1536
1536
|
/**
|
|
1537
|
-
* <p>Avoid tunnels while calculating the route
|
|
1537
|
+
* <p> Avoid tunnels while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1538
1538
|
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
Tunnels?: boolean | undefined;
|
|
1541
1541
|
/**
|
|
1542
|
-
* <p>Avoid U-turns for calculation on highways and motorways
|
|
1542
|
+
* <p> Avoid U-turns for calculation on highways and motorways. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1543
1543
|
* @public
|
|
1544
1544
|
*/
|
|
1545
1545
|
UTurns?: boolean | undefined;
|
|
1546
1546
|
/**
|
|
1547
|
-
* <p>Zone categories to be avoided
|
|
1547
|
+
* <p> Zone categories to be avoided. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1548
1548
|
* @public
|
|
1549
1549
|
*/
|
|
1550
1550
|
ZoneCategories?: RouteAvoidanceZoneCategory[] | undefined;
|
|
@@ -1565,7 +1565,7 @@ export interface RouteMatchingOptions {
|
|
|
1565
1565
|
*/
|
|
1566
1566
|
OnRoadThreshold?: number | undefined;
|
|
1567
1567
|
/**
|
|
1568
|
-
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>
|
|
1568
|
+
* <p>Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.</p> <p> <b>Unit</b>: <code>meters</code> </p>
|
|
1569
1569
|
* @public
|
|
1570
1570
|
*/
|
|
1571
1571
|
Radius?: number | undefined;
|
|
@@ -1581,12 +1581,12 @@ export interface RouteMatchingOptions {
|
|
|
1581
1581
|
*/
|
|
1582
1582
|
export interface RouteSideOfStreetOptions {
|
|
1583
1583
|
/**
|
|
1584
|
-
* <p>Position
|
|
1584
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
1585
1585
|
* @public
|
|
1586
1586
|
*/
|
|
1587
1587
|
Position: number[] | undefined;
|
|
1588
1588
|
/**
|
|
1589
|
-
* <p>Strategy that defines when the side of street position should be used.</p> <p>Default
|
|
1589
|
+
* <p>Strategy that defines when the side of street position should be used.</p> <p>Default value: <code>DividedStreetOnly</code> </p>
|
|
1590
1590
|
* @public
|
|
1591
1591
|
*/
|
|
1592
1592
|
UseWith?: SideOfStreetMatchingStrategy | undefined;
|
|
@@ -1597,7 +1597,7 @@ export interface RouteSideOfStreetOptions {
|
|
|
1597
1597
|
*/
|
|
1598
1598
|
export interface RouteDestinationOptions {
|
|
1599
1599
|
/**
|
|
1600
|
-
* <p>
|
|
1600
|
+
* <p>The distance in meters from the destination point within which certain routing actions (such as U-turns or left turns across traffic) are restricted. This helps generate more practical routes by avoiding potentially dangerous maneuvers near the endpoint.</p>
|
|
1601
1601
|
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
AvoidActionsForDistance?: number | undefined;
|
|
@@ -1754,7 +1754,7 @@ export interface RouteTrafficOptions {
|
|
|
1754
1754
|
*/
|
|
1755
1755
|
FlowEventThresholdOverride?: number | undefined;
|
|
1756
1756
|
/**
|
|
1757
|
-
* <p>
|
|
1757
|
+
* <p>Specifies how traffic data should be used when calculating routes.</p> <p>Default Value: <code>UseTrafficData</code> </p> <note> <p>Traffic data usage depends on the time parameters in your route request:</p> <ul> <li> <p>When <code>Usage</code> is set to <code>UseTrafficData</code>:</p> <ul> <li> <p>If <code>DepartNow</code> is set to <code>true</code>, or if you specify <code>DepartureTime</code> or <code>ArrivalTime</code>, then all traffic data is considered (including live traffic and closures).</p> </li> <li> <p>If <code>DepartNow</code>, <code>DepartureTime</code>, and <code>ArrivalTime</code> are all unspecified, then only long-term closures are considered, regardless of this setting.</p> </li> </ul> </li> <li> <p>When <code>Usage</code> is set to <code>IgnoreTrafficData</code>, then all traffic data is ignored regardless of the time parameters in your route request.</p> </li> </ul> </note>
|
|
1758
1758
|
* @public
|
|
1759
1759
|
*/
|
|
1760
1760
|
Usage?: TrafficUsage | undefined;
|
|
@@ -1771,12 +1771,12 @@ export interface RouteVehicleLicensePlate {
|
|
|
1771
1771
|
LastCharacter?: string | undefined;
|
|
1772
1772
|
}
|
|
1773
1773
|
/**
|
|
1774
|
-
* <p>Travel mode options when the provided travel mode is <code>Car</code
|
|
1774
|
+
* <p> Travel mode options when the provided travel mode is <code>Car</code>. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>LicensePlate</code> options. </p>
|
|
1775
1775
|
* @public
|
|
1776
1776
|
*/
|
|
1777
1777
|
export interface RouteCarOptions {
|
|
1778
1778
|
/**
|
|
1779
|
-
* <p>Engine type of the vehicle
|
|
1779
|
+
* <p> Engine type of the vehicle. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1780
1780
|
* @public
|
|
1781
1781
|
*/
|
|
1782
1782
|
EngineType?: RouteEngineType | undefined;
|
|
@@ -1786,18 +1786,18 @@ export interface RouteCarOptions {
|
|
|
1786
1786
|
*/
|
|
1787
1787
|
LicensePlate?: RouteVehicleLicensePlate | undefined;
|
|
1788
1788
|
/**
|
|
1789
|
-
* <p>Maximum speed specified
|
|
1789
|
+
* <p> Maximum speed specified. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1790
1790
|
* @public
|
|
1791
1791
|
*/
|
|
1792
1792
|
MaxSpeed?: number | undefined;
|
|
1793
1793
|
/**
|
|
1794
|
-
* <p>The number of occupants in the vehicle
|
|
1794
|
+
* <p> The number of occupants in the vehicle. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Default value: <code>1</code> </p>
|
|
1795
1795
|
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
Occupancy?: number | undefined;
|
|
1798
1798
|
}
|
|
1799
1799
|
/**
|
|
1800
|
-
* <p>Options related to the pedestrian
|
|
1800
|
+
* <p> Options related to the pedestrian. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1801
1801
|
* @public
|
|
1802
1802
|
*/
|
|
1803
1803
|
export interface RoutePedestrianOptions {
|
|
@@ -1808,12 +1808,12 @@ export interface RoutePedestrianOptions {
|
|
|
1808
1808
|
Speed?: number | undefined;
|
|
1809
1809
|
}
|
|
1810
1810
|
/**
|
|
1811
|
-
* <p>Travel mode options when the provided travel mode is <code>Scooter</code> </p>
|
|
1811
|
+
* <p> Travel mode options when the provided travel mode is <code>Scooter</code>. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>LicensePlate</code> options. </p>
|
|
1812
1812
|
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
export interface RouteScooterOptions {
|
|
1815
1815
|
/**
|
|
1816
|
-
* <p>Engine type of the vehicle
|
|
1816
|
+
* <p> Engine type of the vehicle. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1817
1817
|
* @public
|
|
1818
1818
|
*/
|
|
1819
1819
|
EngineType?: RouteEngineType | undefined;
|
|
@@ -1823,12 +1823,12 @@ export interface RouteScooterOptions {
|
|
|
1823
1823
|
*/
|
|
1824
1824
|
LicensePlate?: RouteVehicleLicensePlate | undefined;
|
|
1825
1825
|
/**
|
|
1826
|
-
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>
|
|
1826
|
+
* <p> Maximum speed Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1827
1827
|
* @public
|
|
1828
1828
|
*/
|
|
1829
1829
|
MaxSpeed?: number | undefined;
|
|
1830
1830
|
/**
|
|
1831
|
-
* <p>The number of occupants in the vehicle
|
|
1831
|
+
* <p> The number of occupants in the vehicle. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Default value: <code>1</code> </p>
|
|
1832
1832
|
* @public
|
|
1833
1833
|
*/
|
|
1834
1834
|
Occupancy?: number | undefined;
|
|
@@ -1844,13 +1844,13 @@ export interface RouteTrailerOptions {
|
|
|
1844
1844
|
*/
|
|
1845
1845
|
AxleCount?: number | undefined;
|
|
1846
1846
|
/**
|
|
1847
|
-
* <p>Number of trailers attached to the vehicle.</p> <p>Default
|
|
1847
|
+
* <p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>
|
|
1848
1848
|
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
TrailerCount?: number | undefined;
|
|
1851
1851
|
}
|
|
1852
1852
|
/**
|
|
1853
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1853
|
+
* <p> Travel mode options when the provided travel mode is <code>Truck</code>. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1854
1854
|
* @public
|
|
1855
1855
|
*/
|
|
1856
1856
|
export interface RouteTruckOptions {
|
|
@@ -1865,7 +1865,7 @@ export interface RouteTruckOptions {
|
|
|
1865
1865
|
*/
|
|
1866
1866
|
EngineType?: RouteEngineType | undefined;
|
|
1867
1867
|
/**
|
|
1868
|
-
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>
|
|
1868
|
+
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
1869
1869
|
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
GrossWeight?: number | undefined;
|
|
@@ -1900,12 +1900,12 @@ export interface RouteTruckOptions {
|
|
|
1900
1900
|
*/
|
|
1901
1901
|
LicensePlate?: RouteVehicleLicensePlate | undefined;
|
|
1902
1902
|
/**
|
|
1903
|
-
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>
|
|
1903
|
+
* <p>Maximum speed</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
1904
1904
|
* @public
|
|
1905
1905
|
*/
|
|
1906
1906
|
MaxSpeed?: number | undefined;
|
|
1907
1907
|
/**
|
|
1908
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
1908
|
+
* <p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>
|
|
1909
1909
|
* @public
|
|
1910
1910
|
*/
|
|
1911
1911
|
Occupancy?: number | undefined;
|
|
@@ -1925,7 +1925,7 @@ export interface RouteTruckOptions {
|
|
|
1925
1925
|
*/
|
|
1926
1926
|
Trailer?: RouteTrailerOptions | undefined;
|
|
1927
1927
|
/**
|
|
1928
|
-
* <p>
|
|
1928
|
+
* <p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>
|
|
1929
1929
|
* @public
|
|
1930
1930
|
*/
|
|
1931
1931
|
TruckType?: RouteTruckType | undefined;
|
|
@@ -1935,12 +1935,12 @@ export interface RouteTruckOptions {
|
|
|
1935
1935
|
*/
|
|
1936
1936
|
TunnelRestrictionCode?: string | undefined;
|
|
1937
1937
|
/**
|
|
1938
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>
|
|
1938
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
1939
1939
|
* @public
|
|
1940
1940
|
*/
|
|
1941
1941
|
WeightPerAxle?: number | undefined;
|
|
1942
1942
|
/**
|
|
1943
|
-
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.</p> <p> <b>Unit</b>: <code>
|
|
1943
|
+
* <p>Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
1944
1944
|
* @public
|
|
1945
1945
|
*/
|
|
1946
1946
|
WeightPerAxleGroup?: WeightPerAxleGroup | undefined;
|
|
@@ -1956,22 +1956,22 @@ export interface RouteTruckOptions {
|
|
|
1956
1956
|
*/
|
|
1957
1957
|
export interface RouteTravelModeOptions {
|
|
1958
1958
|
/**
|
|
1959
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1959
|
+
* <p>Travel mode options when the provided travel mode is <code>Car</code>.</p>
|
|
1960
1960
|
* @public
|
|
1961
1961
|
*/
|
|
1962
1962
|
Car?: RouteCarOptions | undefined;
|
|
1963
1963
|
/**
|
|
1964
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1964
|
+
* <p>Travel mode options when the provided travel mode is <code>Pedestrian</code>.</p>
|
|
1965
1965
|
* @public
|
|
1966
1966
|
*/
|
|
1967
1967
|
Pedestrian?: RoutePedestrianOptions | undefined;
|
|
1968
1968
|
/**
|
|
1969
|
-
* <p>Travel mode options when the provided travel mode is <code>Scooter</code
|
|
1969
|
+
* <p>Travel mode options when the provided travel mode is <code>Scooter</code>. </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>
|
|
1970
1970
|
* @public
|
|
1971
1971
|
*/
|
|
1972
1972
|
Scooter?: RouteScooterOptions | undefined;
|
|
1973
1973
|
/**
|
|
1974
|
-
* <p>Travel mode options when the provided travel mode is
|
|
1974
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
1975
1975
|
* @public
|
|
1976
1976
|
*/
|
|
1977
1977
|
Truck?: RouteTruckOptions | undefined;
|
|
@@ -1982,42 +1982,42 @@ export interface RouteTravelModeOptions {
|
|
|
1982
1982
|
*/
|
|
1983
1983
|
export interface RouteWaypoint {
|
|
1984
1984
|
/**
|
|
1985
|
-
* <p>Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination
|
|
1985
|
+
* <p> Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1986
1986
|
* @public
|
|
1987
1987
|
*/
|
|
1988
1988
|
AvoidActionsForDistance?: number | undefined;
|
|
1989
1989
|
/**
|
|
1990
|
-
* <p>Avoid U-turns for calculation on highways and motorways
|
|
1990
|
+
* <p> Avoid U-turns for calculation on highways and motorways. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1991
1991
|
* @public
|
|
1992
1992
|
*/
|
|
1993
1993
|
AvoidUTurns?: boolean | undefined;
|
|
1994
1994
|
/**
|
|
1995
|
-
* <p>GPS Heading at the position
|
|
1995
|
+
* <p> GPS Heading at the position. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
1996
1996
|
* @public
|
|
1997
1997
|
*/
|
|
1998
1998
|
Heading?: number | undefined;
|
|
1999
1999
|
/**
|
|
2000
|
-
* <p>Options to configure matching the provided position to the road network
|
|
2000
|
+
* <p> Options to configure matching the provided position to the road network. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2001
2001
|
* @public
|
|
2002
2002
|
*/
|
|
2003
2003
|
Matching?: RouteMatchingOptions | undefined;
|
|
2004
2004
|
/**
|
|
2005
|
-
* <p>If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs
|
|
2005
|
+
* <p> If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2006
2006
|
* @public
|
|
2007
2007
|
*/
|
|
2008
2008
|
PassThrough?: boolean | undefined;
|
|
2009
2009
|
/**
|
|
2010
|
-
* <p>Position
|
|
2010
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
2011
2011
|
* @public
|
|
2012
2012
|
*/
|
|
2013
2013
|
Position: number[] | undefined;
|
|
2014
2014
|
/**
|
|
2015
|
-
* <p>Options to configure matching the provided position to a side of the street
|
|
2015
|
+
* <p> Options to configure matching the provided position to a side of the street. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
2018
|
SideOfStreet?: RouteSideOfStreetOptions | undefined;
|
|
2019
2019
|
/**
|
|
2020
|
-
* <p>Duration of the stop
|
|
2020
|
+
* <p> Duration of the stop. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p> <b>Unit</b>: <code>seconds</code> </p>
|
|
2021
2021
|
* @public
|
|
2022
2022
|
*/
|
|
2023
2023
|
StopDuration?: number | undefined;
|
|
@@ -2027,17 +2027,17 @@ export interface RouteWaypoint {
|
|
|
2027
2027
|
*/
|
|
2028
2028
|
export interface CalculateRoutesRequest {
|
|
2029
2029
|
/**
|
|
2030
|
-
* <p>Features that are allowed while calculating a route
|
|
2030
|
+
* <p> Features that are allowed while calculating a route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2031
2031
|
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
Allow?: RouteAllowOptions | undefined;
|
|
2034
2034
|
/**
|
|
2035
|
-
* <p>Time of arrival at the destination
|
|
2035
|
+
* <p> Time of arrival at the destination. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
2036
2036
|
* @public
|
|
2037
2037
|
*/
|
|
2038
2038
|
ArrivalTime?: string | undefined;
|
|
2039
2039
|
/**
|
|
2040
|
-
* <p>Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation
|
|
2040
|
+
* <p> Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>ControlledAccessHighways</code>, <code>Ferries</code>, and <code>TollRoads</code> </p>
|
|
2041
2041
|
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
Avoid?: RouteAvoidanceOptions | undefined;
|
|
@@ -2047,7 +2047,7 @@ export interface CalculateRoutesRequest {
|
|
|
2047
2047
|
*/
|
|
2048
2048
|
DepartNow?: boolean | undefined;
|
|
2049
2049
|
/**
|
|
2050
|
-
* <p>Time of departure from
|
|
2050
|
+
* <p>Time of departure from the origin.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
2051
2051
|
* @public
|
|
2052
2052
|
*/
|
|
2053
2053
|
DepartureTime?: string | undefined;
|
|
@@ -2057,17 +2057,17 @@ export interface CalculateRoutesRequest {
|
|
|
2057
2057
|
*/
|
|
2058
2058
|
Destination: number[] | undefined;
|
|
2059
2059
|
/**
|
|
2060
|
-
* <p>Destination related options
|
|
2060
|
+
* <p> Destination related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2061
2061
|
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
DestinationOptions?: RouteDestinationOptions | undefined;
|
|
2064
2064
|
/**
|
|
2065
|
-
* <p>Driver related options
|
|
2065
|
+
* <p> Driver related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2066
2066
|
* @public
|
|
2067
2067
|
*/
|
|
2068
2068
|
Driver?: RouteDriverOptions | undefined;
|
|
2069
2069
|
/**
|
|
2070
|
-
* <p>Features to be strictly excluded while calculating the route
|
|
2070
|
+
* <p> Features to be strictly excluded while calculating the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2071
2071
|
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
Exclude?: RouteExclusionOptions | undefined;
|
|
@@ -2082,72 +2082,72 @@ export interface CalculateRoutesRequest {
|
|
|
2082
2082
|
*/
|
|
2083
2083
|
Key?: string | undefined;
|
|
2084
2084
|
/**
|
|
2085
|
-
* <p>List of languages for instructions within steps in the response
|
|
2085
|
+
* <p> List of languages for instructions within steps in the response. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>Instructions in the requested language are returned only if they are available.</p> </note>
|
|
2086
2086
|
* @public
|
|
2087
2087
|
*/
|
|
2088
2088
|
Languages?: string[] | undefined;
|
|
2089
2089
|
/**
|
|
2090
|
-
* <p>A list of optional additional parameters such as timezone that can be requested for each result
|
|
2090
|
+
* <p> A list of optional additional parameters such as timezone that can be requested for each result. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>PassThroughWaypoints</code>, <code>Summary</code>, and <code>TravelStepInstructions</code> </p> <ul> <li> <p> <code>Elevation</code>: Retrieves the elevation information for each location.</p> </li> <li> <p> <code>Incidents</code>: Provides information on traffic incidents along the route.</p> </li> <li> <p> <code>PassThroughWaypoints</code>: Indicates waypoints that are passed through without stopping.</p> </li> <li> <p> <code>Summary</code>: Returns a summary of the route, including distance and duration.</p> </li> <li> <p> <code>Tolls</code>: Supplies toll cost information along the route.</p> </li> <li> <p> <code>TravelStepInstructions</code>: Provides step-by-step instructions for travel along the route.</p> </li> <li> <p> <code>TruckRoadTypes</code>: Returns information about road types suitable for trucks.</p> </li> <li> <p> <code>TypicalDuration</code>: Gives typical travel duration based on historical data.</p> </li> <li> <p> <code>Zones</code>: Specifies the time zone information for each waypoint.</p> </li> </ul>
|
|
2091
2091
|
* @public
|
|
2092
2092
|
*/
|
|
2093
2093
|
LegAdditionalFeatures?: RouteLegAdditionalFeature[] | undefined;
|
|
2094
2094
|
/**
|
|
2095
|
-
* <p>Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.</p> <p> <code>FlexiblePolyline</code>: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for <a href="https://github.com/
|
|
2095
|
+
* <p>Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.</p> <p> <code>FlexiblePolyline</code>: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for <a href="https://github.com/aws-geospatial/polyline">https://github.com/aws-geospatial/polyline</a>.</p> <p> <code>Simple</code>: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.</p>
|
|
2096
2096
|
* @public
|
|
2097
2097
|
*/
|
|
2098
2098
|
LegGeometryFormat?: GeometryFormat | undefined;
|
|
2099
2099
|
/**
|
|
2100
|
-
* <p>Maximum number of alternative routes to be provided in the response, if available
|
|
2100
|
+
* <p>Maximum number of alternative routes to be provided in the response, if available. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only up to 3 alternative routes. </p>
|
|
2101
2101
|
* @public
|
|
2102
2102
|
*/
|
|
2103
2103
|
MaxAlternatives?: number | undefined;
|
|
2104
2104
|
/**
|
|
2105
|
-
* <p>
|
|
2105
|
+
* <p>Controls the trade-off between achieving the shortest travel time (<code>FastestRoute</code>) and achieving the shortest physical distance ((<code>ShortestRoute</code>) when calculating each route in the matrix.</p> <p>Default value: <code>FastestRoute</code> </p>
|
|
2106
2106
|
* @public
|
|
2107
2107
|
*/
|
|
2108
2108
|
OptimizeRoutingFor?: RoutingObjective | undefined;
|
|
2109
2109
|
/**
|
|
2110
|
-
* <p>The start position for the route.</p>
|
|
2110
|
+
* <p>The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
2111
2111
|
* @public
|
|
2112
2112
|
*/
|
|
2113
2113
|
Origin: number[] | undefined;
|
|
2114
2114
|
/**
|
|
2115
|
-
* <p>
|
|
2115
|
+
* <p> Specifies how the origin point should be matched to the road network and any routing constraints that apply when the traveler is departing the origin. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2116
2116
|
* @public
|
|
2117
2117
|
*/
|
|
2118
2118
|
OriginOptions?: RouteOriginOptions | undefined;
|
|
2119
2119
|
/**
|
|
2120
|
-
* <p>A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values
|
|
2120
|
+
* <p> A list of optional features such as <code>SpeedLimit</code> that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2121
2121
|
* @public
|
|
2122
2122
|
*/
|
|
2123
2123
|
SpanAdditionalFeatures?: RouteSpanAdditionalFeature[] | undefined;
|
|
2124
2124
|
/**
|
|
2125
|
-
* <p>Toll related options
|
|
2125
|
+
* <p> Toll related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2126
2126
|
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
Tolls?: RouteTollOptions | undefined;
|
|
2129
2129
|
/**
|
|
2130
|
-
* <p>Traffic related options
|
|
2130
|
+
* <p> Traffic related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2131
2131
|
* @public
|
|
2132
2132
|
*/
|
|
2133
2133
|
Traffic?: RouteTrafficOptions | undefined;
|
|
2134
2134
|
/**
|
|
2135
|
-
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility
|
|
2135
|
+
* <p> Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Car</code>, <code>Pedestrian</code>, and <code>Scooter</code> values. </p> <p>Default value: <code>Car</code> </p>
|
|
2136
2136
|
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
TravelMode?: RouteTravelMode | undefined;
|
|
2139
2139
|
/**
|
|
2140
|
-
* <p>Travel mode related options for the provided travel mode
|
|
2140
|
+
* <p> Travel mode related options for the provided travel mode. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only <code>Car</code> and <code>Pedestrian</code> travel mode options. </p>
|
|
2141
2141
|
* @public
|
|
2142
2142
|
*/
|
|
2143
2143
|
TravelModeOptions?: RouteTravelModeOptions | undefined;
|
|
2144
2144
|
/**
|
|
2145
|
-
* <p>Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system
|
|
2145
|
+
* <p>Type of step returned by the response. <code>Default</code> provides basic steps intended for web based applications. <code>TurnByTurn</code> provides detailed instructions with more granularity intended for a turn based navigation system. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions <code>Default</code> does not return any steps. </p>
|
|
2146
2146
|
* @public
|
|
2147
2147
|
*/
|
|
2148
2148
|
TravelStepType?: RouteTravelStepType | undefined;
|
|
2149
2149
|
/**
|
|
2150
|
-
* <p>List of waypoints between the Origin and Destination
|
|
2150
|
+
* <p> List of waypoints between the Origin and Destination. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions max length is <code>100</code>. </p> <p>Max length: <code>23</code> </p>
|
|
2151
2151
|
* @public
|
|
2152
2152
|
*/
|
|
2153
2153
|
Waypoints?: RouteWaypoint[] | undefined;
|
|
@@ -2205,7 +2205,7 @@ export interface RouteFerryPlace {
|
|
|
2205
2205
|
*/
|
|
2206
2206
|
OriginalPosition?: number[] | undefined;
|
|
2207
2207
|
/**
|
|
2208
|
-
* <p>Position
|
|
2208
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
2209
2209
|
* @public
|
|
2210
2210
|
*/
|
|
2211
2211
|
Position: number[] | undefined;
|
|
@@ -2295,7 +2295,7 @@ export interface RoutePassThroughPlace {
|
|
|
2295
2295
|
*/
|
|
2296
2296
|
OriginalPosition?: number[] | undefined;
|
|
2297
2297
|
/**
|
|
2298
|
-
* <p>Position
|
|
2298
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
2299
2299
|
* @public
|
|
2300
2300
|
*/
|
|
2301
2301
|
Position: number[] | undefined;
|
|
@@ -2448,7 +2448,7 @@ export interface RouteFerryTravelStep {
|
|
|
2448
2448
|
Type: RouteFerryTravelStepType | undefined;
|
|
2449
2449
|
}
|
|
2450
2450
|
/**
|
|
2451
|
-
* <p>FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific</p>
|
|
2451
|
+
* <p> FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel. </p>
|
|
2452
2452
|
* @public
|
|
2453
2453
|
*/
|
|
2454
2454
|
export interface RouteFerryLegDetails {
|
|
@@ -2535,7 +2535,7 @@ export interface RoutePedestrianPlace {
|
|
|
2535
2535
|
*/
|
|
2536
2536
|
OriginalPosition?: number[] | undefined;
|
|
2537
2537
|
/**
|
|
2538
|
-
* <p>Position
|
|
2538
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
2539
2539
|
* @public
|
|
2540
2540
|
*/
|
|
2541
2541
|
Position: number[] | undefined;
|
|
@@ -2599,12 +2599,12 @@ export interface RoutePedestrianNotice {
|
|
|
2599
2599
|
Impact?: RouteNoticeImpact | undefined;
|
|
2600
2600
|
}
|
|
2601
2601
|
/**
|
|
2602
|
-
* <p>Details about the dynamic speed.</p> <p> <b>Unit</b>: <code>
|
|
2602
|
+
* <p>Details about the dynamic speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2603
2603
|
* @public
|
|
2604
2604
|
*/
|
|
2605
2605
|
export interface RouteSpanDynamicSpeedDetails {
|
|
2606
2606
|
/**
|
|
2607
|
-
* <p>Estimated speed while traversing the span without traffic congestion.</p> <p> <b>Unit</b>: <code>
|
|
2607
|
+
* <p>Estimated speed while traversing the span without traffic congestion.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2608
2608
|
* @public
|
|
2609
2609
|
*/
|
|
2610
2610
|
BestCaseSpeed?: number | undefined;
|
|
@@ -2614,7 +2614,7 @@ export interface RouteSpanDynamicSpeedDetails {
|
|
|
2614
2614
|
*/
|
|
2615
2615
|
TurnDuration?: number | undefined;
|
|
2616
2616
|
/**
|
|
2617
|
-
* <p>Estimated speed while traversing the span under typical traffic congestion.</p> <p> <b>Unit</b>: <code>
|
|
2617
|
+
* <p>Estimated speed while traversing the span under typical traffic congestion.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2618
2618
|
* @public
|
|
2619
2619
|
*/
|
|
2620
2620
|
TypicalSpeed?: number | undefined;
|
|
@@ -2641,12 +2641,12 @@ export interface RouteNumber {
|
|
|
2641
2641
|
Value: string | undefined;
|
|
2642
2642
|
}
|
|
2643
2643
|
/**
|
|
2644
|
-
* <p>Details about the speed limit corresponding to the span.</p> <p> <b>Unit</b>: <code>
|
|
2644
|
+
* <p>Details about the speed limit corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2645
2645
|
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
export interface RouteSpanSpeedLimitDetails {
|
|
2648
2648
|
/**
|
|
2649
|
-
* <p>Maximum speed.</p> <p> <b>Unit</b>: <code>
|
|
2649
|
+
* <p>Maximum speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2650
2650
|
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
MaxSpeed?: number | undefined;
|
|
@@ -2682,12 +2682,12 @@ export interface RoutePedestrianSpan {
|
|
|
2682
2682
|
*/
|
|
2683
2683
|
Duration?: number | undefined;
|
|
2684
2684
|
/**
|
|
2685
|
-
* <p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>
|
|
2685
|
+
* <p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2686
2686
|
* @public
|
|
2687
2687
|
*/
|
|
2688
2688
|
DynamicSpeed?: RouteSpanDynamicSpeedDetails | undefined;
|
|
2689
2689
|
/**
|
|
2690
|
-
* <p>
|
|
2690
|
+
* <p>A numerical value indicating the functional classification of the road segment corresponding to the span.</p> <p>Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:</p> <ol> <li> <p>Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.</p> </li> <li> <p>Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.</p> </li> <li> <p>Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.</p> </li> <li> <p>Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.</p> </li> <li> <p>Roads with volume and traffic movement below the level of any other functional class.</p> </li> </ol>
|
|
2691
2691
|
* @public
|
|
2692
2692
|
*/
|
|
2693
2693
|
FunctionalClassification?: number | undefined;
|
|
@@ -2727,7 +2727,7 @@ export interface RoutePedestrianSpan {
|
|
|
2727
2727
|
*/
|
|
2728
2728
|
RouteNumbers?: RouteNumber[] | undefined;
|
|
2729
2729
|
/**
|
|
2730
|
-
* <p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>
|
|
2730
|
+
* <p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
2731
2731
|
* @public
|
|
2732
2732
|
*/
|
|
2733
2733
|
SpeedLimit?: RouteSpanSpeedLimitDetails | undefined;
|
|
@@ -3071,7 +3071,7 @@ export interface RoutePedestrianLegDetails {
|
|
|
3071
3071
|
*/
|
|
3072
3072
|
Departure: RoutePedestrianDeparture | undefined;
|
|
3073
3073
|
/**
|
|
3074
|
-
* <p>Notices are additional information returned that indicate issues that occurred during route calculation
|
|
3074
|
+
* <p> Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
3075
3075
|
* @public
|
|
3076
3076
|
*/
|
|
3077
3077
|
Notices: RoutePedestrianNotice[] | undefined;
|
|
@@ -3081,7 +3081,7 @@ export interface RoutePedestrianLegDetails {
|
|
|
3081
3081
|
*/
|
|
3082
3082
|
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
3083
3083
|
/**
|
|
3084
|
-
* <p>Spans that were computed for the requested SpanAdditionalFeatures
|
|
3084
|
+
* <p> Spans that were computed for the requested SpanAdditionalFeatures. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
3085
3085
|
* @public
|
|
3086
3086
|
*/
|
|
3087
3087
|
Spans: RoutePedestrianSpan[] | undefined;
|
|
@@ -3112,7 +3112,7 @@ export interface RouteVehiclePlace {
|
|
|
3112
3112
|
*/
|
|
3113
3113
|
OriginalPosition?: number[] | undefined;
|
|
3114
3114
|
/**
|
|
3115
|
-
* <p>Position
|
|
3115
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
3116
3116
|
* @public
|
|
3117
3117
|
*/
|
|
3118
3118
|
Position: number[] | undefined;
|
|
@@ -3207,7 +3207,7 @@ export interface RouteNoticeDetailRange {
|
|
|
3207
3207
|
Max?: number | undefined;
|
|
3208
3208
|
}
|
|
3209
3209
|
/**
|
|
3210
|
-
* <p>The weight constraint for the route.</p> <p> <b>Unit</b>: <code>
|
|
3210
|
+
* <p>The weight constraint for the route.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
3211
3211
|
* @public
|
|
3212
3212
|
*/
|
|
3213
3213
|
export interface RouteWeightConstraint {
|
|
@@ -3217,7 +3217,7 @@ export interface RouteWeightConstraint {
|
|
|
3217
3217
|
*/
|
|
3218
3218
|
Type: RouteWeightConstraintType | undefined;
|
|
3219
3219
|
/**
|
|
3220
|
-
* <p>The constraint value.</p> <p> <b>Unit</b>: <code>
|
|
3220
|
+
* <p>The constraint value.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
3221
3221
|
* @public
|
|
3222
3222
|
*/
|
|
3223
3223
|
Value: number | undefined;
|
|
@@ -3263,17 +3263,17 @@ export interface RouteViolatedConstraints {
|
|
|
3263
3263
|
*/
|
|
3264
3264
|
MaxPayloadCapacity?: number | undefined;
|
|
3265
3265
|
/**
|
|
3266
|
-
* <p>The maximum weight of the route.</p> <p> <b>Unit</b>: <code>
|
|
3266
|
+
* <p>The maximum weight of the route.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
3267
3267
|
* @public
|
|
3268
3268
|
*/
|
|
3269
3269
|
MaxWeight?: RouteWeightConstraint | undefined;
|
|
3270
3270
|
/**
|
|
3271
|
-
* <p>The maximum weight per axle of the vehicle.</p> <p> <b>Unit</b>: <code>
|
|
3271
|
+
* <p>The maximum weight per axle of the vehicle.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
3272
3272
|
* @public
|
|
3273
3273
|
*/
|
|
3274
3274
|
MaxWeightPerAxle?: number | undefined;
|
|
3275
3275
|
/**
|
|
3276
|
-
* <p>The maximum weight per axle group of the vehicle.</p> <p> <b>Unit</b>: <code>
|
|
3276
|
+
* <p>The maximum weight per axle group of the vehicle.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
3277
3277
|
* @public
|
|
3278
3278
|
*/
|
|
3279
3279
|
MaxWeightPerAxleGroup?: WeightPerAxleGroup | undefined;
|
|
@@ -3283,7 +3283,7 @@ export interface RouteViolatedConstraints {
|
|
|
3283
3283
|
*/
|
|
3284
3284
|
MaxWidth?: number | undefined;
|
|
3285
3285
|
/**
|
|
3286
|
-
* <p>The number of occupants in the vehicle.</p> <p>Default
|
|
3286
|
+
* <p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>
|
|
3287
3287
|
* @public
|
|
3288
3288
|
*/
|
|
3289
3289
|
Occupancy?: RouteNoticeDetailRange | undefined;
|
|
@@ -3298,7 +3298,7 @@ export interface RouteViolatedConstraints {
|
|
|
3298
3298
|
*/
|
|
3299
3299
|
TimeDependent?: boolean | undefined;
|
|
3300
3300
|
/**
|
|
3301
|
-
* <p>Number of trailers attached to the vehicle.</p> <p>Default
|
|
3301
|
+
* <p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>
|
|
3302
3302
|
* @public
|
|
3303
3303
|
*/
|
|
3304
3304
|
TrailerCount?: RouteNoticeDetailRange | undefined;
|
|
@@ -3313,7 +3313,7 @@ export interface RouteViolatedConstraints {
|
|
|
3313
3313
|
*/
|
|
3314
3314
|
TruckRoadType?: string | undefined;
|
|
3315
3315
|
/**
|
|
3316
|
-
* <p>
|
|
3316
|
+
* <p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>
|
|
3317
3317
|
* @public
|
|
3318
3318
|
*/
|
|
3319
3319
|
TruckType?: RouteTruckType | undefined;
|
|
@@ -3391,12 +3391,12 @@ export interface RouteVehicleSpan {
|
|
|
3391
3391
|
*/
|
|
3392
3392
|
Duration?: number | undefined;
|
|
3393
3393
|
/**
|
|
3394
|
-
* <p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>
|
|
3394
|
+
* <p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
3395
3395
|
* @public
|
|
3396
3396
|
*/
|
|
3397
3397
|
DynamicSpeed?: RouteSpanDynamicSpeedDetails | undefined;
|
|
3398
3398
|
/**
|
|
3399
|
-
* <p>
|
|
3399
|
+
* <p>A numerical value indicating the functional classification of the road segment corresponding to the span.</p> <p>Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:</p> <ol> <li> <p>Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.</p> </li> <li> <p>Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.</p> </li> <li> <p>Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.</p> </li> <li> <p>Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.</p> </li> <li> <p>Roads with volume and traffic movement below the level of any other functional class.</p> </li> </ol>
|
|
3400
3400
|
* @public
|
|
3401
3401
|
*/
|
|
3402
3402
|
FunctionalClassification?: number | undefined;
|
|
@@ -3451,7 +3451,7 @@ export interface RouteVehicleSpan {
|
|
|
3451
3451
|
*/
|
|
3452
3452
|
ScooterAccess?: RouteSpanScooterAccessAttribute[] | undefined;
|
|
3453
3453
|
/**
|
|
3454
|
-
* <p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>
|
|
3454
|
+
* <p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
3455
3455
|
* @public
|
|
3456
3456
|
*/
|
|
3457
3457
|
SpeedLimit?: RouteSpanSpeedLimitDetails | undefined;
|
|
@@ -3555,7 +3555,7 @@ export interface RouteTollPaymentSite {
|
|
|
3555
3555
|
*/
|
|
3556
3556
|
Name?: string | undefined;
|
|
3557
3557
|
/**
|
|
3558
|
-
* <p>Position
|
|
3558
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
3559
3559
|
* @public
|
|
3560
3560
|
*/
|
|
3561
3561
|
Position: number[] | undefined;
|
|
@@ -4026,12 +4026,12 @@ export interface RouteVehicleLegDetails {
|
|
|
4026
4026
|
*/
|
|
4027
4027
|
Departure: RouteVehicleDeparture | undefined;
|
|
4028
4028
|
/**
|
|
4029
|
-
* <p>Incidents corresponding to this leg of the route
|
|
4029
|
+
* <p> Incidents corresponding to this leg of the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4030
4030
|
* @public
|
|
4031
4031
|
*/
|
|
4032
4032
|
Incidents: RouteVehicleIncident[] | undefined;
|
|
4033
4033
|
/**
|
|
4034
|
-
* <p>Notices are additional information returned that indicate issues that occurred during route calculation
|
|
4034
|
+
* <p> Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4035
4035
|
* @public
|
|
4036
4036
|
*/
|
|
4037
4037
|
Notices: RouteVehicleNotice[] | undefined;
|
|
@@ -4041,7 +4041,7 @@ export interface RouteVehicleLegDetails {
|
|
|
4041
4041
|
*/
|
|
4042
4042
|
PassThroughWaypoints: RoutePassThroughWaypoint[] | undefined;
|
|
4043
4043
|
/**
|
|
4044
|
-
* <p>Spans that were computed for the requested SpanAdditionalFeatures
|
|
4044
|
+
* <p> Spans that were computed for the requested SpanAdditionalFeatures. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4045
4045
|
* @public
|
|
4046
4046
|
*/
|
|
4047
4047
|
Spans: RouteVehicleSpan[] | undefined;
|
|
@@ -4051,12 +4051,12 @@ export interface RouteVehicleLegDetails {
|
|
|
4051
4051
|
*/
|
|
4052
4052
|
Summary?: RouteVehicleSummary | undefined;
|
|
4053
4053
|
/**
|
|
4054
|
-
* <p>Toll related options
|
|
4054
|
+
* <p> Toll related options. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4055
4055
|
* @public
|
|
4056
4056
|
*/
|
|
4057
4057
|
Tolls: RouteToll[] | undefined;
|
|
4058
4058
|
/**
|
|
4059
|
-
* <p>Toll systems are authorities that collect payments for the toll
|
|
4059
|
+
* <p> Toll systems are authorities that collect payments for the toll. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4060
4060
|
* @public
|
|
4061
4061
|
*/
|
|
4062
4062
|
TollSystems: RouteTollSystem[] | undefined;
|
|
@@ -4066,12 +4066,12 @@ export interface RouteVehicleLegDetails {
|
|
|
4066
4066
|
*/
|
|
4067
4067
|
TravelSteps: RouteVehicleTravelStep[] | undefined;
|
|
4068
4068
|
/**
|
|
4069
|
-
* <p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico
|
|
4069
|
+
* <p> Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>
|
|
4070
4070
|
* @public
|
|
4071
4071
|
*/
|
|
4072
4072
|
TruckRoadTypes: string[] | undefined;
|
|
4073
4073
|
/**
|
|
4074
|
-
* <p>Zones corresponding to this leg of the route
|
|
4074
|
+
* <p> Zones corresponding to this leg of the route. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4075
4075
|
* @public
|
|
4076
4076
|
*/
|
|
4077
4077
|
Zones: RouteZone[] | undefined;
|
|
@@ -4082,7 +4082,7 @@ export interface RouteVehicleLegDetails {
|
|
|
4082
4082
|
*/
|
|
4083
4083
|
export interface RouteLeg {
|
|
4084
4084
|
/**
|
|
4085
|
-
* <p>FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific</p>
|
|
4085
|
+
* <p> FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific to ferry travel. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4086
4086
|
* @public
|
|
4087
4087
|
*/
|
|
4088
4088
|
FerryLegDetails?: RouteFerryLegDetails | undefined;
|
|
@@ -4092,7 +4092,7 @@ export interface RouteLeg {
|
|
|
4092
4092
|
*/
|
|
4093
4093
|
Geometry: RouteLegGeometry | undefined;
|
|
4094
4094
|
/**
|
|
4095
|
-
* <p>List of languages for instructions within steps in the response
|
|
4095
|
+
* <p> List of languages for instructions within steps in the response. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4096
4096
|
* @public
|
|
4097
4097
|
*/
|
|
4098
4098
|
Language?: string | undefined;
|
|
@@ -4102,7 +4102,7 @@ export interface RouteLeg {
|
|
|
4102
4102
|
*/
|
|
4103
4103
|
PedestrianLegDetails?: RoutePedestrianLegDetails | undefined;
|
|
4104
4104
|
/**
|
|
4105
|
-
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default
|
|
4105
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default value: <code>Car</code> </p>
|
|
4106
4106
|
* @public
|
|
4107
4107
|
*/
|
|
4108
4108
|
TravelMode: RouteLegTravelMode | undefined;
|
|
@@ -4227,7 +4227,7 @@ export interface CalculateRoutesResponse {
|
|
|
4227
4227
|
*/
|
|
4228
4228
|
LegGeometryFormat: GeometryFormat | undefined;
|
|
4229
4229
|
/**
|
|
4230
|
-
* <p>Notices are additional information returned that indicate issues that occurred during route calculation
|
|
4230
|
+
* <p> Notices are additional information returned that indicate issues that occurred during route calculation. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
4231
4231
|
* @public
|
|
4232
4232
|
*/
|
|
4233
4233
|
Notices: RouteResponseNotice[] | undefined;
|
|
@@ -4375,12 +4375,12 @@ export interface WaypointOptimizationAccessHours {
|
|
|
4375
4375
|
*/
|
|
4376
4376
|
export interface WaypointOptimizationSideOfStreetOptions {
|
|
4377
4377
|
/**
|
|
4378
|
-
* <p>Position
|
|
4378
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4379
4379
|
* @public
|
|
4380
4380
|
*/
|
|
4381
4381
|
Position: number[] | undefined;
|
|
4382
4382
|
/**
|
|
4383
|
-
* <p>Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.</p> <p>Default
|
|
4383
|
+
* <p>Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.</p> <p>Default value: <code>DividedStreetOnly</code> </p>
|
|
4384
4384
|
* @public
|
|
4385
4385
|
*/
|
|
4386
4386
|
UseWith?: SideOfStreetMatchingStrategy | undefined;
|
|
@@ -4513,7 +4513,7 @@ export interface WaypointOptimizationOriginOptions {
|
|
|
4513
4513
|
*/
|
|
4514
4514
|
export interface WaypointOptimizationTrafficOptions {
|
|
4515
4515
|
/**
|
|
4516
|
-
* <p>Determines if traffic should be used or ignored while calculating the route.</p> <p>Default
|
|
4516
|
+
* <p>Determines if traffic should be used or ignored while calculating the route.</p> <p>Default value: <code>UseTrafficData</code> </p>
|
|
4517
4517
|
* @public
|
|
4518
4518
|
*/
|
|
4519
4519
|
Usage?: TrafficUsage | undefined;
|
|
@@ -4524,7 +4524,7 @@ export interface WaypointOptimizationTrafficOptions {
|
|
|
4524
4524
|
*/
|
|
4525
4525
|
export interface WaypointOptimizationPedestrianOptions {
|
|
4526
4526
|
/**
|
|
4527
|
-
* <p>Walking speed.</p> <p> <b>Unit</b>: <code>
|
|
4527
|
+
* <p>Walking speed.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
4528
4528
|
* @public
|
|
4529
4529
|
*/
|
|
4530
4530
|
Speed?: number | undefined;
|
|
@@ -4535,18 +4535,18 @@ export interface WaypointOptimizationPedestrianOptions {
|
|
|
4535
4535
|
*/
|
|
4536
4536
|
export interface WaypointOptimizationTrailerOptions {
|
|
4537
4537
|
/**
|
|
4538
|
-
* <p>Number of trailers attached to the vehicle.</p> <p>Default
|
|
4538
|
+
* <p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>
|
|
4539
4539
|
* @public
|
|
4540
4540
|
*/
|
|
4541
4541
|
TrailerCount?: number | undefined;
|
|
4542
4542
|
}
|
|
4543
4543
|
/**
|
|
4544
|
-
* <p>Travel mode options when the provided travel mode is
|
|
4544
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
4545
4545
|
* @public
|
|
4546
4546
|
*/
|
|
4547
4547
|
export interface WaypointOptimizationTruckOptions {
|
|
4548
4548
|
/**
|
|
4549
|
-
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>
|
|
4549
|
+
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
4550
4550
|
* @public
|
|
4551
4551
|
*/
|
|
4552
4552
|
GrossWeight?: number | undefined;
|
|
@@ -4571,7 +4571,7 @@ export interface WaypointOptimizationTruckOptions {
|
|
|
4571
4571
|
*/
|
|
4572
4572
|
Trailer?: WaypointOptimizationTrailerOptions | undefined;
|
|
4573
4573
|
/**
|
|
4574
|
-
* <p>
|
|
4574
|
+
* <p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>
|
|
4575
4575
|
* @public
|
|
4576
4576
|
*/
|
|
4577
4577
|
TruckType?: WaypointOptimizationTruckType | undefined;
|
|
@@ -4581,7 +4581,7 @@ export interface WaypointOptimizationTruckOptions {
|
|
|
4581
4581
|
*/
|
|
4582
4582
|
TunnelRestrictionCode?: string | undefined;
|
|
4583
4583
|
/**
|
|
4584
|
-
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>
|
|
4584
|
+
* <p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
4585
4585
|
* @public
|
|
4586
4586
|
*/
|
|
4587
4587
|
WeightPerAxle?: number | undefined;
|
|
@@ -4597,12 +4597,12 @@ export interface WaypointOptimizationTruckOptions {
|
|
|
4597
4597
|
*/
|
|
4598
4598
|
export interface WaypointOptimizationTravelModeOptions {
|
|
4599
4599
|
/**
|
|
4600
|
-
* <p>Travel mode options when the provided travel mode is
|
|
4600
|
+
* <p>Travel mode options when the provided travel mode is <code>Pedestrian</code>.</p>
|
|
4601
4601
|
* @public
|
|
4602
4602
|
*/
|
|
4603
4603
|
Pedestrian?: WaypointOptimizationPedestrianOptions | undefined;
|
|
4604
4604
|
/**
|
|
4605
|
-
* <p>Travel mode options when the provided travel mode is
|
|
4605
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
4606
4606
|
* @public
|
|
4607
4607
|
*/
|
|
4608
4608
|
Truck?: WaypointOptimizationTruckOptions | undefined;
|
|
@@ -4638,7 +4638,7 @@ export interface WaypointOptimizationWaypoint {
|
|
|
4638
4638
|
*/
|
|
4639
4639
|
Id?: string | undefined;
|
|
4640
4640
|
/**
|
|
4641
|
-
* <p>Position
|
|
4641
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4642
4642
|
* @public
|
|
4643
4643
|
*/
|
|
4644
4644
|
Position: number[] | undefined;
|
|
@@ -4698,12 +4698,12 @@ export interface OptimizeWaypointsRequest {
|
|
|
4698
4698
|
*/
|
|
4699
4699
|
Key?: string | undefined;
|
|
4700
4700
|
/**
|
|
4701
|
-
* <p>Specifies the optimization criteria for the calculated sequence.</p> <p>Default
|
|
4701
|
+
* <p>Specifies the optimization criteria for the calculated sequence.</p> <p>Default value: <code>FastestRoute</code>.</p>
|
|
4702
4702
|
* @public
|
|
4703
4703
|
*/
|
|
4704
4704
|
OptimizeSequencingFor?: WaypointOptimizationSequencingObjective | undefined;
|
|
4705
4705
|
/**
|
|
4706
|
-
* <p>The start position for the route.</p>
|
|
4706
|
+
* <p>The start position for the route in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4707
4707
|
* @public
|
|
4708
4708
|
*/
|
|
4709
4709
|
Origin: number[] | undefined;
|
|
@@ -4718,7 +4718,7 @@ export interface OptimizeWaypointsRequest {
|
|
|
4718
4718
|
*/
|
|
4719
4719
|
Traffic?: WaypointOptimizationTrafficOptions | undefined;
|
|
4720
4720
|
/**
|
|
4721
|
-
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default
|
|
4721
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default value: <code>Car</code> </p>
|
|
4722
4722
|
* @public
|
|
4723
4723
|
*/
|
|
4724
4724
|
TravelMode?: WaypointOptimizationTravelMode | undefined;
|
|
@@ -4801,7 +4801,7 @@ export interface WaypointOptimizationImpedingWaypoint {
|
|
|
4801
4801
|
*/
|
|
4802
4802
|
Id: string | undefined;
|
|
4803
4803
|
/**
|
|
4804
|
-
* <p>Position
|
|
4804
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4805
4805
|
* @public
|
|
4806
4806
|
*/
|
|
4807
4807
|
Position: number[] | undefined;
|
|
@@ -4822,7 +4822,7 @@ export interface WaypointOptimizationOptimizedWaypoint {
|
|
|
4822
4822
|
*/
|
|
4823
4823
|
ClusterIndex?: number | undefined;
|
|
4824
4824
|
/**
|
|
4825
|
-
* <p>Estimated time of departure from
|
|
4825
|
+
* <p>Estimated time of departure from the origin.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>
|
|
4826
4826
|
* @public
|
|
4827
4827
|
*/
|
|
4828
4828
|
DepartureTime: string | undefined;
|
|
@@ -4832,7 +4832,7 @@ export interface WaypointOptimizationOptimizedWaypoint {
|
|
|
4832
4832
|
*/
|
|
4833
4833
|
Id: string | undefined;
|
|
4834
4834
|
/**
|
|
4835
|
-
* <p>Position
|
|
4835
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4836
4836
|
* @public
|
|
4837
4837
|
*/
|
|
4838
4838
|
Position: number[] | undefined;
|
|
@@ -4914,12 +4914,12 @@ export interface RoadSnapTracePoint {
|
|
|
4914
4914
|
*/
|
|
4915
4915
|
Heading?: number | undefined;
|
|
4916
4916
|
/**
|
|
4917
|
-
* <p>Position
|
|
4917
|
+
* <p>Position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
|
|
4918
4918
|
* @public
|
|
4919
4919
|
*/
|
|
4920
4920
|
Position: number[] | undefined;
|
|
4921
4921
|
/**
|
|
4922
|
-
* <p>Speed at the specified trace point .</p> <p> <b>Unit</b>: <code>
|
|
4922
|
+
* <p>Speed at the specified trace point .</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>
|
|
4923
4923
|
* @public
|
|
4924
4924
|
*/
|
|
4925
4925
|
Speed?: number | undefined;
|
|
@@ -4935,18 +4935,18 @@ export interface RoadSnapTracePoint {
|
|
|
4935
4935
|
*/
|
|
4936
4936
|
export interface RoadSnapTrailerOptions {
|
|
4937
4937
|
/**
|
|
4938
|
-
* <p>Number of trailers attached to the vehicle.</p> <p>Default
|
|
4938
|
+
* <p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>
|
|
4939
4939
|
* @public
|
|
4940
4940
|
*/
|
|
4941
4941
|
TrailerCount?: number | undefined;
|
|
4942
4942
|
}
|
|
4943
4943
|
/**
|
|
4944
|
-
* <p>Travel mode options when the provided travel mode is
|
|
4944
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
4945
4945
|
* @public
|
|
4946
4946
|
*/
|
|
4947
4947
|
export interface RoadSnapTruckOptions {
|
|
4948
4948
|
/**
|
|
4949
|
-
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>
|
|
4949
|
+
* <p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>
|
|
4950
4950
|
* @public
|
|
4951
4951
|
*/
|
|
4952
4952
|
GrossWeight?: number | undefined;
|
|
@@ -4976,7 +4976,7 @@ export interface RoadSnapTruckOptions {
|
|
|
4976
4976
|
*/
|
|
4977
4977
|
TunnelRestrictionCode?: string | undefined;
|
|
4978
4978
|
/**
|
|
4979
|
-
* <p>Width of the vehicle in
|
|
4979
|
+
* <p>Width of the vehicle in centimeters.</p>
|
|
4980
4980
|
* @public
|
|
4981
4981
|
*/
|
|
4982
4982
|
Width?: number | undefined;
|
|
@@ -4987,7 +4987,7 @@ export interface RoadSnapTruckOptions {
|
|
|
4987
4987
|
*/
|
|
4988
4988
|
export interface RoadSnapTravelModeOptions {
|
|
4989
4989
|
/**
|
|
4990
|
-
* <p>Travel mode options when the provided travel mode is
|
|
4990
|
+
* <p>Travel mode options when the provided travel mode is <code>Truck</code>.</p>
|
|
4991
4991
|
* @public
|
|
4992
4992
|
*/
|
|
4993
4993
|
Truck?: RoadSnapTruckOptions | undefined;
|
|
@@ -5002,7 +5002,7 @@ export interface SnapToRoadsRequest {
|
|
|
5002
5002
|
*/
|
|
5003
5003
|
Key?: string | undefined;
|
|
5004
5004
|
/**
|
|
5005
|
-
* <p>Chooses what the returned SnappedGeometry format should be.</p> <p>Default
|
|
5005
|
+
* <p>Chooses what the returned SnappedGeometry format should be.</p> <p>Default value: <code>FlexiblePolyline</code> </p>
|
|
5006
5006
|
* @public
|
|
5007
5007
|
*/
|
|
5008
5008
|
SnappedGeometryFormat?: GeometryFormat | undefined;
|
|
@@ -5017,7 +5017,7 @@ export interface SnapToRoadsRequest {
|
|
|
5017
5017
|
*/
|
|
5018
5018
|
TracePoints: RoadSnapTracePoint[] | undefined;
|
|
5019
5019
|
/**
|
|
5020
|
-
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default
|
|
5020
|
+
* <p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default value: <code>Car</code> </p>
|
|
5021
5021
|
* @public
|
|
5022
5022
|
*/
|
|
5023
5023
|
TravelMode?: RoadSnapTravelMode | undefined;
|