@aws-sdk/client-location 3.141.0 → 3.146.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.
@@ -53,7 +53,7 @@ import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput }
53
53
  import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
54
54
  import { LocationClient } from "./LocationClient";
55
55
  /**
56
- * Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
56
+ * <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
57
57
  */
58
58
  export declare class Location extends LocationClient {
59
59
  /**
@@ -183,6 +183,10 @@ export declare class Location extends LocationClient {
183
183
  * the routes. This also lets you specify additional route preferences in
184
184
  * <code>CarModeOptions</code> if traveling by <code>Car</code>, or
185
185
  * <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
186
+ * <note>
187
+ * <p>If you specify <code>walking</code> for the travel mode and your data
188
+ * provider is Esri, the start and destination must be within 40km.</p>
189
+ * </note>
186
190
  * </li>
187
191
  * </ul>
188
192
  */
@@ -178,7 +178,7 @@ declare type LocationClientResolvedConfigType = __SmithyResolvedConfiguration<__
178
178
  export interface LocationClientResolvedConfig extends LocationClientResolvedConfigType {
179
179
  }
180
180
  /**
181
- * Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing
181
+ * <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
182
182
  */
183
183
  export declare class LocationClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, LocationClientResolvedConfig> {
184
184
  /**
@@ -35,6 +35,10 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
35
35
  * the routes. This also lets you specify additional route preferences in
36
36
  * <code>CarModeOptions</code> if traveling by <code>Car</code>, or
37
37
  * <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
38
+ * <note>
39
+ * <p>If you specify <code>walking</code> for the travel mode and your data
40
+ * provider is Esri, the start and destination must be within 40km.</p>
41
+ * </note>
38
42
  * </li>
39
43
  * </ul>
40
44
  * @example
@@ -368,8 +368,25 @@ export interface BatchGetDevicePositionResponse {
368
368
  */
369
369
  DevicePositions: DevicePosition[] | undefined;
370
370
  }
371
+ /**
372
+ * <p>A circle on the earth, as defined by a center point and a radius.</p>
373
+ */
374
+ export interface Circle {
375
+ /**
376
+ * <p>A single point geometry, specifying the center of the circle, using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
377
+ * coordinates, in the form <code>[longitude, latitude]</code>.</p>
378
+ */
379
+ Center: number[] | undefined;
380
+ /**
381
+ * <p>The radius of the circle in meters. Must be greater than zero and no
382
+ * larger than 100,000 (100 kilometers).</p>
383
+ */
384
+ Radius: number | undefined;
385
+ }
371
386
  /**
372
387
  * <p>Contains the geofence geometry details.</p>
388
+ * <p>A geofence geometry is made up of either a polygon or a circle. Can be either a
389
+ * polygon or a circle. Including both will return a validation error.</p>
373
390
  * <note>
374
391
  * <p>Amazon Location doesn't currently support polygons with holes, multipolygons, polygons
375
392
  * that are wound clockwise, or that cross the antimeridian. </p>
@@ -385,8 +402,13 @@ export interface GeofenceGeometry {
385
402
  * list their vertices in counter-clockwise order around the ring's center, where the left
386
403
  * side is the polygon's exterior. Inner rings must list their vertices in clockwise order,
387
404
  * where the left side is the polygon's interior.</p>
405
+ * <p>A geofence polygon can consist of between 4 and 1,000 vertices.</p>
388
406
  */
389
407
  Polygon?: number[][][];
408
+ /**
409
+ * <p>A circle on the earth, as defined by a center point and a radius.</p>
410
+ */
411
+ Circle?: Circle;
390
412
  }
391
413
  /**
392
414
  * <p>Contains geofence geometry details. </p>
@@ -397,9 +419,11 @@ export interface BatchPutGeofenceRequestEntry {
397
419
  */
398
420
  GeofenceId: string | undefined;
399
421
  /**
400
- * <p>Contains the polygon details to specify the position of the geofence.</p>
422
+ * <p>Contains the details of the position of the geofence. Can be either a
423
+ * polygon or a circle. Including both will return a validation error.</p>
401
424
  * <note>
402
- * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">geofence polygon</a> can have a maximum of 1,000 vertices.</p>
425
+ * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">
426
+ * geofence polygon</a> can have a maximum of 1,000 vertices.</p>
403
427
  * </note>
404
428
  */
405
429
  Geometry: GeofenceGeometry | undefined;
@@ -534,6 +558,11 @@ export interface TruckDimensions {
534
558
  * <p>For example, <code>15.5</code>.</p>
535
559
  * </li>
536
560
  * </ul>
561
+ * <note>
562
+ * <p>
563
+ * For routes calculated with a HERE resource, this value must be between 0 and 300 meters.
564
+ * </p>
565
+ * </note>
537
566
  */
538
567
  Length?: number;
539
568
  /**
@@ -543,6 +572,11 @@ export interface TruckDimensions {
543
572
  * <p>For example, <code>4.5</code>.</p>
544
573
  * </li>
545
574
  * </ul>
575
+ * <note>
576
+ * <p>
577
+ * For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
578
+ * </p>
579
+ * </note>
546
580
  */
547
581
  Height?: number;
548
582
  /**
@@ -552,6 +586,11 @@ export interface TruckDimensions {
552
586
  * <p>For example, <code>4.5</code>.</p>
553
587
  * </li>
554
588
  * </ul>
589
+ * <note>
590
+ * <p>
591
+ * For routes calculated with a HERE resource, this value must be between 0 and 50 meters.
592
+ * </p>
593
+ * </note>
555
594
  */
556
595
  Width?: number;
557
596
  /**
@@ -687,7 +726,8 @@ export interface CalculateRouteRequest {
687
726
  WaypointPositions?: number[][];
688
727
  /**
689
728
  * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
690
- * of travel and road compatibility.</p>
729
+ * of travel and road compatibility. You can choose <code>Car</code>, <code>Truck</code>,
730
+ * or <code>Walking</code> as options for the <code>TravelMode</code>.</p>
691
731
  * <p>The <code>TravelMode</code> you specify also determines how you specify route
692
732
  * preferences: </p>
693
733
  * <ul>
@@ -1414,7 +1454,7 @@ export interface MapConfiguration {
1414
1454
  * <ul>
1415
1455
  * <li>
1416
1456
  * <p>
1417
- * <code>VectorHereBerlin</code> – The HERE Berlin map style is a high contrast
1457
+ * <code>VectorHereContrast</code> – The HERE Contrast (Berlin) map style is a high contrast
1418
1458
  * detailed base map of the world that blends 3D and 2D rendering.</p>
1419
1459
  * </li>
1420
1460
  * <li>
@@ -1431,6 +1471,11 @@ export interface MapConfiguration {
1431
1471
  * within transport and logistics.</p>
1432
1472
  * </li>
1433
1473
  * </ul>
1474
+ * <note>
1475
+ * <p>The <code>VectorHereContrast</code> style has been renamed from <code>VectorHereBerlin</code>.
1476
+ * <code>VectorHereBerlin</code> has been deprecated, but will continue to work in
1477
+ * applications that use it.</p>
1478
+ * </note>
1434
1479
  */
1435
1480
  Style: string | undefined;
1436
1481
  }
@@ -2408,7 +2453,7 @@ export interface GetGeofenceResponse {
2408
2453
  */
2409
2454
  GeofenceId: string | undefined;
2410
2455
  /**
2411
- * <p>Contains the geofence geometry details describing a polygon.</p>
2456
+ * <p>Contains the geofence geometry details describing a polygon or a circle.</p>
2412
2457
  */
2413
2458
  Geometry: GeofenceGeometry | undefined;
2414
2459
  /**
@@ -2544,7 +2589,7 @@ export interface ListGeofenceResponseEntry {
2544
2589
  */
2545
2590
  GeofenceId: string | undefined;
2546
2591
  /**
2547
- * <p>Contains the geofence geometry details describing a polygon.</p>
2592
+ * <p>Contains the geofence geometry details describing a polygon or a circle.</p>
2548
2593
  */
2549
2594
  Geometry: GeofenceGeometry | undefined;
2550
2595
  /**
@@ -2610,9 +2655,11 @@ export interface PutGeofenceRequest {
2610
2655
  */
2611
2656
  GeofenceId: string | undefined;
2612
2657
  /**
2613
- * <p>Contains the polygon details to specify the position of the geofence.</p>
2658
+ * <p>Contains the details to specify the position of the geofence. Can be either a
2659
+ * polygon or a circle. Including both will return a validation error.</p>
2614
2660
  * <note>
2615
- * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">geofence polygon</a> can have a maximum of 1,000 vertices.</p>
2661
+ * <p>Each <a href="https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html">
2662
+ * geofence polygon</a> can have a maximum of 1,000 vertices.</p>
2616
2663
  * </note>
2617
2664
  */
2618
2665
  Geometry: GeofenceGeometry | undefined;
@@ -2821,7 +2868,7 @@ export interface GetMapGlyphsRequest {
2821
2868
  * <p>Valid font stacks for <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a> styles: </p>
2822
2869
  * <ul>
2823
2870
  * <li>
2824
- * <p>VectorHereBerlin – <code>Fira
2871
+ * <p>VectorHereContrast – <code>Fira
2825
2872
  * GO Regular</code> | <code>Fira GO Bold</code>
2826
2873
  * </p>
2827
2874
  * </li>
@@ -4134,6 +4181,10 @@ export declare const BatchGetDevicePositionErrorFilterSensitiveLog: (obj: BatchG
4134
4181
  * @internal
4135
4182
  */
4136
4183
  export declare const BatchGetDevicePositionResponseFilterSensitiveLog: (obj: BatchGetDevicePositionResponse) => any;
4184
+ /**
4185
+ * @internal
4186
+ */
4187
+ export declare const CircleFilterSensitiveLog: (obj: Circle) => any;
4137
4188
  /**
4138
4189
  * @internal
4139
4190
  */
@@ -193,9 +193,18 @@ export interface BatchGetDevicePositionResponse {
193
193
  DevicePositions: DevicePosition[] | undefined;
194
194
  }
195
195
 
196
+ export interface Circle {
197
+
198
+ Center: number[] | undefined;
199
+
200
+ Radius: number | undefined;
201
+ }
202
+
196
203
  export interface GeofenceGeometry {
197
204
 
198
205
  Polygon?: number[][][];
206
+
207
+ Circle?: Circle;
199
208
  }
200
209
 
201
210
  export interface BatchPutGeofenceRequestEntry {
@@ -1353,6 +1362,8 @@ export declare const BatchGetDevicePositionErrorFilterSensitiveLog: (obj: BatchG
1353
1362
 
1354
1363
  export declare const BatchGetDevicePositionResponseFilterSensitiveLog: (obj: BatchGetDevicePositionResponse) => any;
1355
1364
 
1365
+ export declare const CircleFilterSensitiveLog: (obj: Circle) => any;
1366
+
1356
1367
  export declare const GeofenceGeometryFilterSensitiveLog: (obj: GeofenceGeometry) => any;
1357
1368
 
1358
1369
  export declare const BatchPutGeofenceRequestEntryFilterSensitiveLog: (obj: BatchPutGeofenceRequestEntry) => any;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-location",
3
3
  "description": "AWS SDK for JavaScript Location Client for Node.js, Browser and React Native",
4
- "version": "3.141.0",
4
+ "version": "3.146.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.141.0",
21
+ "@aws-sdk/client-sts": "3.145.0",
22
22
  "@aws-sdk/config-resolver": "3.130.0",
23
- "@aws-sdk/credential-provider-node": "3.141.0",
23
+ "@aws-sdk/credential-provider-node": "3.145.0",
24
24
  "@aws-sdk/fetch-http-handler": "3.131.0",
25
25
  "@aws-sdk/hash-node": "3.127.0",
26
26
  "@aws-sdk/invalid-dependency": "3.127.0",
@@ -36,15 +36,15 @@
36
36
  "@aws-sdk/node-config-provider": "3.127.0",
37
37
  "@aws-sdk/node-http-handler": "3.127.0",
38
38
  "@aws-sdk/protocol-http": "3.127.0",
39
- "@aws-sdk/smithy-client": "3.137.0",
39
+ "@aws-sdk/smithy-client": "3.142.0",
40
40
  "@aws-sdk/types": "3.127.0",
41
41
  "@aws-sdk/url-parser": "3.127.0",
42
42
  "@aws-sdk/util-base64-browser": "3.109.0",
43
43
  "@aws-sdk/util-base64-node": "3.55.0",
44
44
  "@aws-sdk/util-body-length-browser": "3.55.0",
45
45
  "@aws-sdk/util-body-length-node": "3.55.0",
46
- "@aws-sdk/util-defaults-mode-browser": "3.137.0",
47
- "@aws-sdk/util-defaults-mode-node": "3.137.0",
46
+ "@aws-sdk/util-defaults-mode-browser": "3.142.0",
47
+ "@aws-sdk/util-defaults-mode-node": "3.142.0",
48
48
  "@aws-sdk/util-user-agent-browser": "3.127.0",
49
49
  "@aws-sdk/util-user-agent-node": "3.127.0",
50
50
  "@aws-sdk/util-utf8-browser": "3.109.0",
@@ -61,6 +61,11 @@
61
61
  "typedoc": "0.19.2",
62
62
  "typescript": "~4.6.2"
63
63
  },
64
+ "overrides": {
65
+ "typedoc": {
66
+ "typescript": "~4.6.2"
67
+ }
68
+ },
64
69
  "engines": {
65
70
  "node": ">=12.0.0"
66
71
  },