@aws-sdk/client-location 3.81.0 → 3.86.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/CHANGELOG.md +30 -0
- package/README.md +2 -0
- package/dist-cjs/pagination/ListGeofencesPaginator.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1 -0
- package/dist-es/pagination/ListGeofencesPaginator.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -1
- package/dist-types/Location.d.ts +65 -54
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +4 -0
- package/dist-types/commands/CalculateRouteCommand.d.ts +7 -5
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +19 -17
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +9 -8
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -2
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +11 -9
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +413 -350
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,36 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.86.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.85.0...v3.86.0) (2022-05-06)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **client-location:** Amazon Location Service now includes a MaxResults parameter for ListGeofences requests. ([5c0e234](https://github.com/aws/aws-sdk-js-v3/commit/5c0e234f03c9ea3748229dd87ca8fed349b36ea3))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
# [3.85.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.84.0...v3.85.0) (2022-05-05)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **codegen:** add codegen indicator comment to all generated files ([#3592](https://github.com/aws/aws-sdk-js-v3/issues/3592)) ([567a530](https://github.com/aws/aws-sdk-js-v3/commit/567a5304232fcc1f9db3fd3df545054de8336b4b))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
# [3.82.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.81.0...v3.82.0) (2022-05-02)
|
|
29
|
+
|
|
30
|
+
**Note:** Version bump only for package @aws-sdk/client-location
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
6
36
|
# [3.81.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.80.0...v3.81.0) (2022-04-29)
|
|
7
37
|
|
|
8
38
|
**Note:** Version bump only for package @aws-sdk/client-location
|
package/README.md
CHANGED
|
@@ -16,6 +16,7 @@ async function* paginateListGeofences(config, input, ...additionalArguments) {
|
|
|
16
16
|
let page;
|
|
17
17
|
while (hasNext) {
|
|
18
18
|
input.NextToken = token;
|
|
19
|
+
input["MaxResults"] = config.pageSize;
|
|
19
20
|
if (config.client instanceof Location_1.Location) {
|
|
20
21
|
page = await makePagedRequest(config.client, input, ...additionalArguments);
|
|
21
22
|
}
|
|
@@ -1393,6 +1393,7 @@ const serializeAws_restJson1ListGeofencesCommand = async (input, context) => {
|
|
|
1393
1393
|
}
|
|
1394
1394
|
let body;
|
|
1395
1395
|
body = JSON.stringify({
|
|
1396
|
+
...(input.MaxResults !== undefined && input.MaxResults !== null && { MaxResults: input.MaxResults }),
|
|
1396
1397
|
...(input.NextToken !== undefined && input.NextToken !== null && { NextToken: input.NextToken }),
|
|
1397
1398
|
});
|
|
1398
1399
|
let { hostname: resolvedHostname } = await context.endpoint();
|
|
@@ -46,6 +46,7 @@ export function paginateListGeofences(config, input) {
|
|
|
46
46
|
case 1:
|
|
47
47
|
if (!hasNext) return [3, 9];
|
|
48
48
|
input.NextToken = token;
|
|
49
|
+
input["MaxResults"] = config.pageSize;
|
|
49
50
|
if (!(config.client instanceof Location)) return [3, 3];
|
|
50
51
|
return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
|
|
51
52
|
case 2:
|
|
@@ -1551,7 +1551,7 @@ export var serializeAws_restJson1ListGeofencesCommand = function (input, context
|
|
|
1551
1551
|
else {
|
|
1552
1552
|
throw new Error("No value provided for input HTTP label: CollectionName.");
|
|
1553
1553
|
}
|
|
1554
|
-
body = JSON.stringify(__assign({}, (input.NextToken !== undefined && input.NextToken !== null && { NextToken: input.NextToken })));
|
|
1554
|
+
body = JSON.stringify(__assign(__assign({}, (input.MaxResults !== undefined && input.MaxResults !== null && { MaxResults: input.MaxResults })), (input.NextToken !== undefined && input.NextToken !== null && { NextToken: input.NextToken })));
|
|
1555
1555
|
return [4, context.endpoint()];
|
|
1556
1556
|
case 2:
|
|
1557
1557
|
resolvedHostname = (_c.sent()).hostname;
|
package/dist-types/Location.d.ts
CHANGED
|
@@ -109,6 +109,10 @@ export declare class Location extends LocationClient {
|
|
|
109
109
|
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
110
110
|
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
111
111
|
* </note>
|
|
112
|
+
* <note>
|
|
113
|
+
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
|
|
114
|
+
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
|
|
115
|
+
* </note>
|
|
112
116
|
*/
|
|
113
117
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<BatchEvaluateGeofencesCommandOutput>;
|
|
114
118
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
|
|
@@ -162,8 +166,9 @@ export declare class Location extends LocationClient {
|
|
|
162
166
|
* <ul>
|
|
163
167
|
* <li>
|
|
164
168
|
* <p>
|
|
165
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
166
|
-
*
|
|
169
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
170
|
+
* departure time</a> using either <code>DepartureTime</code> or
|
|
171
|
+
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
167
172
|
* data at the given time. </p>
|
|
168
173
|
* <note>
|
|
169
174
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
@@ -173,9 +178,10 @@ export declare class Location extends LocationClient {
|
|
|
173
178
|
* </li>
|
|
174
179
|
* <li>
|
|
175
180
|
* <p>
|
|
176
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
177
|
-
*
|
|
178
|
-
*
|
|
181
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
182
|
+
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
183
|
+
* the routes. This also lets you specify additional route preferences in
|
|
184
|
+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
179
185
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
180
186
|
* </li>
|
|
181
187
|
* </ul>
|
|
@@ -185,30 +191,31 @@ export declare class Location extends LocationClient {
|
|
|
185
191
|
calculateRoute(args: CalculateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
|
|
186
192
|
/**
|
|
187
193
|
* <p>
|
|
188
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
194
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route
|
|
195
|
+
* matrix</a> given the following required parameters:
|
|
196
|
+
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
197
|
+
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
192
198
|
* travel distance from each departure position to each destination position in the
|
|
193
|
-
* request. For example, given departure positions A and B, and destination positions
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
*
|
|
199
|
+
* request. For example, given departure positions A and B, and destination positions X and
|
|
200
|
+
* Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to
|
|
201
|
+
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
202
|
+
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
203
|
+
* number of <code>DestinationPositions</code>.</p>
|
|
198
204
|
* <note>
|
|
199
|
-
* <p>Your account is charged for each route calculated, not the number of
|
|
205
|
+
* <p>Your account is charged for each route calculated, not the number of
|
|
206
|
+
* requests.</p>
|
|
200
207
|
* </note>
|
|
201
208
|
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
202
|
-
*
|
|
209
|
+
* route calculator resource</a>.</p>
|
|
203
210
|
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
204
211
|
* to travel with the best traffic conditions when calculating routes.</p>
|
|
205
212
|
* <p>Additional options include:</p>
|
|
206
213
|
* <ul>
|
|
207
214
|
* <li>
|
|
208
215
|
* <p>
|
|
209
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
|
|
210
|
-
*
|
|
211
|
-
*
|
|
216
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
|
|
217
|
+
* departure time</a> using either <code>DepartureTime</code> or
|
|
218
|
+
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
212
219
|
* data at the given time. </p>
|
|
213
220
|
* <note>
|
|
214
221
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
@@ -218,9 +225,10 @@ export declare class Location extends LocationClient {
|
|
|
218
225
|
* </li>
|
|
219
226
|
* <li>
|
|
220
227
|
* <p>
|
|
221
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
222
|
-
*
|
|
223
|
-
*
|
|
228
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
229
|
+
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
230
|
+
* the routes. This also lets you specify additional route preferences in
|
|
231
|
+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
224
232
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
225
233
|
* </li>
|
|
226
234
|
* </ul>
|
|
@@ -249,15 +257,16 @@ export declare class Location extends LocationClient {
|
|
|
249
257
|
createMap(args: CreateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
|
|
250
258
|
/**
|
|
251
259
|
* <p>Creates a place index resource in your AWS account. Use a place index resource to
|
|
252
|
-
* geocode addresses and other text queries by using the
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
260
|
+
* geocode addresses and other text queries by using the
|
|
261
|
+
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
262
|
+
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
263
|
+
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
264
|
+
* <note>
|
|
256
265
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
266
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
267
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
268
|
+
* service terms</a> for more details.</p>
|
|
269
|
+
* </note>
|
|
261
270
|
*/
|
|
262
271
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlaceIndexCommandOutput>;
|
|
263
272
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
@@ -271,7 +280,7 @@ export declare class Location extends LocationClient {
|
|
|
271
280
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
272
281
|
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
273
282
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
274
|
-
*
|
|
283
|
+
* service terms</a> for more details.</p>
|
|
275
284
|
* </note>
|
|
276
285
|
*/
|
|
277
286
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCalculatorCommandOutput>;
|
|
@@ -306,9 +315,9 @@ export declare class Location extends LocationClient {
|
|
|
306
315
|
deleteMap(args: DeleteMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
|
|
307
316
|
/**
|
|
308
317
|
* <p>Deletes a place index resource from your AWS account.</p>
|
|
309
|
-
*
|
|
318
|
+
* <note>
|
|
310
319
|
* <p>This operation deletes the resource permanently.</p>
|
|
311
|
-
*
|
|
320
|
+
* </note>
|
|
312
321
|
*/
|
|
313
322
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeletePlaceIndexCommandOutput>;
|
|
314
323
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
|
|
@@ -317,7 +326,7 @@ export declare class Location extends LocationClient {
|
|
|
317
326
|
* <p>Deletes a route calculator resource from your AWS account.</p>
|
|
318
327
|
* <note>
|
|
319
328
|
* <p>This operation deletes the resource permanently.</p>
|
|
320
|
-
*
|
|
329
|
+
* </note>
|
|
321
330
|
*/
|
|
322
331
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRouteCalculatorCommandOutput>;
|
|
323
332
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
|
|
@@ -494,38 +503,40 @@ export declare class Location extends LocationClient {
|
|
|
494
503
|
putGeofence(args: PutGeofenceCommandInput, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
|
|
495
504
|
putGeofence(args: PutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
|
|
496
505
|
/**
|
|
497
|
-
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
|
|
498
|
-
*
|
|
506
|
+
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
|
|
507
|
+
* search for Places or points of interest near a given position.</p>
|
|
499
508
|
*/
|
|
500
509
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForPositionCommandOutput>;
|
|
501
510
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
502
511
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
503
512
|
/**
|
|
504
513
|
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
* <p>You can search for suggested place names near a specified position by using
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
+
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
|
|
515
|
+
* fuzzy matching.</p>
|
|
516
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
517
|
+
* bias your search toward a specific position on the globe.</p>
|
|
518
|
+
* <note>
|
|
519
|
+
* <p>You can search for suggested place names near a specified position by using
|
|
520
|
+
* <code>BiasPosition</code>, or filter results within a bounding box by using
|
|
521
|
+
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
|
|
522
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
|
|
523
|
+
* returns an error.</p>
|
|
524
|
+
* </note>
|
|
514
525
|
*/
|
|
515
526
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
516
527
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
517
528
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
518
529
|
/**
|
|
519
530
|
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
531
|
+
* search for Places or points of interest. </p>
|
|
532
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
533
|
+
* bias your search toward a specific position on the globe.</p>
|
|
534
|
+
* <note>
|
|
535
|
+
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
536
|
+
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
|
|
537
|
+
* both parameters simultaneously returns an error.</p>
|
|
538
|
+
* </note>
|
|
539
|
+
* <p>Search results are returned in order of highest to lowest relevance.</p>
|
|
529
540
|
*/
|
|
530
541
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForTextCommandOutput>;
|
|
531
542
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
@@ -32,6 +32,10 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen
|
|
|
32
32
|
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
33
33
|
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
34
34
|
* </note>
|
|
35
|
+
* <note>
|
|
36
|
+
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
|
|
37
|
+
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
|
|
38
|
+
* </note>
|
|
35
39
|
* @example
|
|
36
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
41
|
* ```javascript
|
|
@@ -18,8 +18,9 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
|
|
|
18
18
|
* <ul>
|
|
19
19
|
* <li>
|
|
20
20
|
* <p>
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
22
|
-
*
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
22
|
+
* departure time</a> using either <code>DepartureTime</code> or
|
|
23
|
+
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
23
24
|
* data at the given time. </p>
|
|
24
25
|
* <note>
|
|
25
26
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
@@ -29,9 +30,10 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
|
|
|
29
30
|
* </li>
|
|
30
31
|
* <li>
|
|
31
32
|
* <p>
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
34
|
+
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
35
|
+
* the routes. This also lets you specify additional route preferences in
|
|
36
|
+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
35
37
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
36
38
|
* </li>
|
|
37
39
|
* </ul>
|
|
@@ -8,30 +8,31 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>
|
|
11
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route
|
|
12
|
+
* matrix</a> given the following required parameters:
|
|
13
|
+
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
14
|
+
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
15
15
|
* travel distance from each departure position to each destination position in the
|
|
16
|
-
* request. For example, given departure positions A and B, and destination positions
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
16
|
+
* request. For example, given departure positions A and B, and destination positions X and
|
|
17
|
+
* Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to
|
|
18
|
+
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
19
|
+
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
20
|
+
* number of <code>DestinationPositions</code>.</p>
|
|
21
21
|
* <note>
|
|
22
|
-
* <p>Your account is charged for each route calculated, not the number of
|
|
22
|
+
* <p>Your account is charged for each route calculated, not the number of
|
|
23
|
+
* requests.</p>
|
|
23
24
|
* </note>
|
|
24
25
|
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
25
|
-
*
|
|
26
|
+
* route calculator resource</a>.</p>
|
|
26
27
|
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
27
28
|
* to travel with the best traffic conditions when calculating routes.</p>
|
|
28
29
|
* <p>Additional options include:</p>
|
|
29
30
|
* <ul>
|
|
30
31
|
* <li>
|
|
31
32
|
* <p>
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
|
|
34
|
+
* departure time</a> using either <code>DepartureTime</code> or
|
|
35
|
+
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
35
36
|
* data at the given time. </p>
|
|
36
37
|
* <note>
|
|
37
38
|
* <p>You can't specify both <code>DepartureTime</code> and
|
|
@@ -41,9 +42,10 @@ export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixR
|
|
|
41
42
|
* </li>
|
|
42
43
|
* <li>
|
|
43
44
|
* <p>
|
|
44
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
45
|
-
*
|
|
46
|
-
*
|
|
45
|
+
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
46
|
+
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
47
|
+
* the routes. This also lets you specify additional route preferences in
|
|
48
|
+
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
47
49
|
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
48
50
|
* </li>
|
|
49
51
|
* </ul>
|
|
@@ -8,15 +8,16 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a place index resource in your AWS account. Use a place index resource to
|
|
11
|
-
* geocode addresses and other text queries by using the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
11
|
+
* geocode addresses and other text queries by using the
|
|
12
|
+
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
13
|
+
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
14
|
+
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
15
|
+
* <note>
|
|
15
16
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
18
|
+
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
19
|
+
* service terms</a> for more details.</p>
|
|
20
|
+
* </note>
|
|
20
21
|
* @example
|
|
21
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
23
|
* ```javascript
|
|
@@ -15,7 +15,7 @@ export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculato
|
|
|
15
15
|
* <p>If your application is tracking or routing assets you use in your business, such
|
|
16
16
|
* as delivery vehicles or employees, you may only use HERE as your geolocation
|
|
17
17
|
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">AWS
|
|
18
|
-
*
|
|
18
|
+
* service terms</a> for more details.</p>
|
|
19
19
|
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,9 +8,9 @@ export interface DeletePlaceIndexCommandOutput extends DeletePlaceIndexResponse,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes a place index resource from your AWS account.</p>
|
|
11
|
-
*
|
|
11
|
+
* <note>
|
|
12
12
|
* <p>This operation deletes the resource permanently.</p>
|
|
13
|
-
*
|
|
13
|
+
* </note>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface DeleteRouteCalculatorCommandOutput extends DeleteRouteCalculato
|
|
|
10
10
|
* <p>Deletes a route calculator resource from your AWS account.</p>
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This operation deletes the resource permanently.</p>
|
|
13
|
-
*
|
|
13
|
+
* </note>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface SearchPlaceIndexForPositionCommandInput extends SearchPlaceInde
|
|
|
7
7
|
export interface SearchPlaceIndexForPositionCommandOutput extends SearchPlaceIndexForPositionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
|
|
11
|
-
*
|
|
10
|
+
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
|
|
11
|
+
* search for Places or points of interest near a given position.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -8,15 +8,17 @@ export interface SearchPlaceIndexForSuggestionsCommandOutput extends SearchPlace
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <p>You can search for suggested place names near a specified position by using
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
11
|
+
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
|
|
12
|
+
* fuzzy matching.</p>
|
|
13
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
14
|
+
* bias your search toward a specific position on the globe.</p>
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>You can search for suggested place names near a specified position by using
|
|
17
|
+
* <code>BiasPosition</code>, or filter results within a bounding box by using
|
|
18
|
+
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
|
|
19
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
|
|
20
|
+
* returns an error.</p>
|
|
21
|
+
* </note>
|
|
20
22
|
* @example
|
|
21
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
24
|
* ```javascript
|
|
@@ -8,15 +8,15 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
11
|
+
* search for Places or points of interest. </p>
|
|
12
|
+
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
13
|
+
* bias your search toward a specific position on the globe.</p>
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
16
|
+
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
|
|
17
|
+
* both parameters simultaneously returns an error.</p>
|
|
18
|
+
* </note>
|
|
19
|
+
* <p>Search results are returned in order of highest to lowest relevance.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|