@aws-sdk/client-location 3.41.0 → 3.46.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.
Files changed (33) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/Location.js +15 -0
  3. package/dist-cjs/commands/SearchPlaceIndexForSuggestionsCommand.js +36 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoints.js +1 -0
  6. package/dist-cjs/models/models_0.js +50 -3
  7. package/dist-cjs/protocols/Aws_restJson1.js +244 -2
  8. package/dist-cjs/runtimeConfig.js +0 -2
  9. package/dist-es/Location.js +15 -0
  10. package/dist-es/commands/SearchPlaceIndexForSuggestionsCommand.js +39 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoints.js +1 -0
  13. package/dist-es/models/models_0.js +28 -4
  14. package/dist-es/protocols/Aws_restJson1.js +253 -6
  15. package/dist-es/runtimeConfig.js +0 -2
  16. package/dist-types/Location.d.ts +40 -10
  17. package/dist-types/LocationClient.d.ts +3 -2
  18. package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +4 -0
  19. package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +11 -3
  20. package/dist-types/commands/CalculateRouteCommand.d.ts +2 -3
  21. package/dist-types/commands/CreatePlaceIndexCommand.d.ts +4 -2
  22. package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +44 -0
  23. package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +3 -2
  24. package/dist-types/commands/index.d.ts +1 -0
  25. package/dist-types/models/models_0.d.ts +488 -117
  26. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  27. package/dist-types/ts3.4/Location.d.ts +5 -0
  28. package/dist-types/ts3.4/LocationClient.d.ts +3 -2
  29. package/dist-types/ts3.4/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +17 -0
  30. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  31. package/dist-types/ts3.4/models/models_0.d.ts +128 -6
  32. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
  33. package/package.json +36 -43
@@ -287,6 +287,22 @@ export declare namespace BatchDeleteGeofenceResponse {
287
287
  */
288
288
  const filterSensitiveLog: (obj: BatchDeleteGeofenceResponse) => any;
289
289
  }
290
+ /**
291
+ * <p>Defines the level of certainty of the position.</p>
292
+ */
293
+ export interface PositionalAccuracy {
294
+ /**
295
+ * <p>Estimated maximum distance, in meters, between the measured position and the true
296
+ * position of a device, along the Earth's surface.</p>
297
+ */
298
+ Horizontal: number | undefined;
299
+ }
300
+ export declare namespace PositionalAccuracy {
301
+ /**
302
+ * @internal
303
+ */
304
+ const filterSensitiveLog: (obj: PositionalAccuracy) => any;
305
+ }
290
306
  /**
291
307
  * <p>Contains the position update details for a device.</p>
292
308
  */
@@ -306,6 +322,20 @@ export interface DevicePositionUpdate {
306
322
  * <code>[X or longitude, Y or latitude]</code>.</p>
307
323
  */
308
324
  Position: number[] | undefined;
325
+ /**
326
+ * <p>The accuracy of the device position.</p>
327
+ */
328
+ Accuracy?: PositionalAccuracy;
329
+ /**
330
+ * <p>Associates one of more properties with the position update. A property is a key-value
331
+ * pair stored with the position update and added to any geofence event the update may
332
+ * trigger.</p>
333
+ * <p>Format: <code>"key" : "value"</code>
334
+ * </p>
335
+ */
336
+ PositionProperties?: {
337
+ [key: string]: string;
338
+ };
309
339
  }
310
340
  export declare namespace DevicePositionUpdate {
311
341
  /**
@@ -415,6 +445,16 @@ export interface DevicePosition {
415
445
  * <p>The last known device position.</p>
416
446
  */
417
447
  Position: number[] | undefined;
448
+ /**
449
+ * <p>The accuracy of the device position.</p>
450
+ */
451
+ Accuracy?: PositionalAccuracy;
452
+ /**
453
+ * <p>The properties associated with the position.</p>
454
+ */
455
+ PositionProperties?: {
456
+ [key: string]: string;
457
+ };
418
458
  }
419
459
  export declare namespace DevicePosition {
420
460
  /**
@@ -788,7 +828,7 @@ export declare namespace CalculateRouteTruckModeOptions {
788
828
  }
789
829
  export interface CalculateRouteRequest {
790
830
  /**
791
- * <p>The name of the route calculator resource that you want to use to calculate a route. </p>
831
+ * <p>The name of the route calculator resource that you want to use to calculate the route. </p>
792
832
  */
793
833
  CalculatorName: string | undefined;
794
834
  /**
@@ -866,7 +906,7 @@ export interface CalculateRouteRequest {
866
906
  */
867
907
  TravelMode?: TravelMode | string;
868
908
  /**
869
- * <p>Specifies the desired time of departure. Uses the given time to calculate a route.
909
+ * <p>Specifies the desired time of departure. Uses the given time to calculate the route.
870
910
  * Otherwise, the best time of day to travel with the best traffic conditions is used to
871
911
  * calculate the route.</p>
872
912
  * <note>
@@ -1138,7 +1178,7 @@ export interface CalculateRouteSummary {
1138
1178
  */
1139
1179
  DurationSeconds: number | undefined;
1140
1180
  /**
1141
- * <p>The unit of measurement for the distance.</p>
1181
+ * <p>The unit of measurement for route distances.</p>
1142
1182
  */
1143
1183
  DistanceUnit: DistanceUnit | string | undefined;
1144
1184
  }
@@ -1216,11 +1256,12 @@ export interface CreateGeofenceCollectionRequest {
1216
1256
  */
1217
1257
  CollectionName: string | undefined;
1218
1258
  /**
1219
- * <p>Specifies the pricing plan for the geofence collection.</p>
1259
+ * <p>Optionally specifies the pricing plan for the geofence collection. Defaults to
1260
+ * <code>RequestBasedUsage</code>.</p>
1220
1261
  * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
1221
1262
  * page</a>.</p>
1222
1263
  */
1223
- PricingPlan: PricingPlan | string | undefined;
1264
+ PricingPlan?: PricingPlan | string;
1224
1265
  /**
1225
1266
  * <p>Specifies the data provider for the geofence collection.</p>
1226
1267
  * <ul>
@@ -1268,6 +1309,9 @@ export interface CreateGeofenceCollectionRequest {
1268
1309
  * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1269
1310
  * + - = . _ : / @. </p>
1270
1311
  * </li>
1312
+ * <li>
1313
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
1314
+ * </li>
1271
1315
  * </ul>
1272
1316
  */
1273
1317
  Tags?: {
@@ -1407,10 +1451,11 @@ export interface CreateMapRequest {
1407
1451
  */
1408
1452
  Configuration: MapConfiguration | undefined;
1409
1453
  /**
1410
- * <p>Specifies the pricing plan for your map resource.</p>
1454
+ * <p>Optionally specifies the pricing plan for the map resource. Defaults to
1455
+ * <code>RequestBasedUsage</code>.</p>
1411
1456
  * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1412
1457
  */
1413
- PricingPlan: PricingPlan | string | undefined;
1458
+ PricingPlan?: PricingPlan | string;
1414
1459
  /**
1415
1460
  * <p>An optional description for the map resource.</p>
1416
1461
  */
@@ -1438,6 +1483,9 @@ export interface CreateMapRequest {
1438
1483
  * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /
1439
1484
  * @. </p>
1440
1485
  * </li>
1486
+ * <li>
1487
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
1488
+ * </li>
1441
1489
  * </ul>
1442
1490
  */
1443
1491
  Tags?: {
@@ -1514,7 +1562,7 @@ export interface DataSourceConfiguration {
1514
1562
  * <code>Storage</code> specifies that the result can be cached or stored in a database.</p>
1515
1563
  * </li>
1516
1564
  * </ul>
1517
- * <p>Default value: <code>SingleUse</code>
1565
+ * <p>Default value: <code>SingleUse</code>
1518
1566
  * </p>
1519
1567
  */
1520
1568
  IntendedUse?: IntendedUse | string;
@@ -1544,7 +1592,7 @@ export interface CreatePlaceIndexRequest {
1544
1592
  */
1545
1593
  IndexName: string | undefined;
1546
1594
  /**
1547
- * <p>Specifies the data provider of geospatial data.</p>
1595
+ * <p>Specifies the geospatial data provider for the new place index.</p>
1548
1596
  * <note>
1549
1597
  * <p>This field is case-sensitive. Enter the valid values as shown. For example, entering
1550
1598
  * <code>HERE</code> returns an error.</p>
@@ -1561,7 +1609,8 @@ export interface CreatePlaceIndexRequest {
1561
1609
  * <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'
1562
1610
  * coverage in your region of interest, see <a href="https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html">HERE details on goecoding coverage</a>.</p>
1563
1611
  * <important>
1564
- * <p>Place index resources using HERE Technologies as a data provider can't <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
1612
+ * <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
1613
+ * you may not <a href="https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html">store results</a> for locations in Japan. For more information, see the
1565
1614
  * <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>
1566
1615
  * for Amazon Location Service.</p>
1567
1616
  * </important>
@@ -1572,10 +1621,11 @@ export interface CreatePlaceIndexRequest {
1572
1621
  */
1573
1622
  DataSource: string | undefined;
1574
1623
  /**
1575
- * <p>Specifies the pricing plan for your place index resource.</p>
1624
+ * <p>Optionally specifies the pricing plan for the place index resource. Defaults to
1625
+ * <code>RequestBasedUsage</code>.</p>
1576
1626
  * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1577
1627
  */
1578
- PricingPlan: PricingPlan | string | undefined;
1628
+ PricingPlan?: PricingPlan | string;
1579
1629
  /**
1580
1630
  * <p>The optional description for the place index resource.</p>
1581
1631
  */
@@ -1585,27 +1635,30 @@ export interface CreatePlaceIndexRequest {
1585
1635
  */
1586
1636
  DataSourceConfiguration?: DataSourceConfiguration;
1587
1637
  /**
1588
- * <p>Applies one or more tags to the place index resource. A tag is a key-value pair helps
1589
- * manage, identify, search, and filter your resources by labelling them.</p>
1638
+ * <p>Applies one or more tags to the place index resource. A tag is a key-value pair that helps you
1639
+ * manage, identify, search, and filter your resources.</p>
1590
1640
  * <p>Format: <code>"key" : "value"</code>
1591
1641
  * </p>
1592
1642
  * <p>Restrictions:</p>
1593
1643
  * <ul>
1594
1644
  * <li>
1595
- * <p>Maximum 50 tags per resource</p>
1645
+ * <p>Maximum 50 tags per resource.</p>
1596
1646
  * </li>
1597
1647
  * <li>
1598
- * <p>Each resource tag must be unique with a maximum of one value.</p>
1648
+ * <p>Each tag key must be unique and must have exactly one associated value.</p>
1599
1649
  * </li>
1600
1650
  * <li>
1601
- * <p>Maximum key length: 128 Unicode characters in UTF-8</p>
1651
+ * <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
1602
1652
  * </li>
1603
1653
  * <li>
1604
- * <p>Maximum value length: 256 Unicode characters in UTF-8</p>
1654
+ * <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
1605
1655
  * </li>
1606
1656
  * <li>
1607
1657
  * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
1608
- * = . _ : / @. </p>
1658
+ * = . _ : / @</p>
1659
+ * </li>
1660
+ * <li>
1661
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
1609
1662
  * </li>
1610
1663
  * </ul>
1611
1664
  */
@@ -1690,10 +1743,11 @@ export interface CreateRouteCalculatorRequest {
1690
1743
  */
1691
1744
  DataSource: string | undefined;
1692
1745
  /**
1693
- * <p>Specifies the pricing plan for your route calculator resource.</p>
1746
+ * <p>Optionally specifies the pricing plan for the route calculator resource. Defaults to
1747
+ * <code>RequestBasedUsage</code>.</p>
1694
1748
  * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1695
1749
  */
1696
- PricingPlan: PricingPlan | string | undefined;
1750
+ PricingPlan?: PricingPlan | string;
1697
1751
  /**
1698
1752
  * <p>The optional description for the route calculator resource.</p>
1699
1753
  */
@@ -1727,6 +1781,9 @@ export interface CreateRouteCalculatorRequest {
1727
1781
  * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1728
1782
  * + - = . _ : / @. </p>
1729
1783
  * </li>
1784
+ * <li>
1785
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
1786
+ * </li>
1730
1787
  * </ul>
1731
1788
  */
1732
1789
  Tags?: {
@@ -1779,7 +1836,7 @@ export declare namespace CreateRouteCalculatorResponse {
1779
1836
  */
1780
1837
  const filterSensitiveLog: (obj: CreateRouteCalculatorResponse) => any;
1781
1838
  }
1782
- export declare type PositionFiltering = "DistanceBased" | "TimeBased";
1839
+ export declare type PositionFiltering = "AccuracyBased" | "DistanceBased" | "TimeBased";
1783
1840
  export interface CreateTrackerRequest {
1784
1841
  /**
1785
1842
  * <p>The name for the tracker resource.</p>
@@ -1798,10 +1855,11 @@ export interface CreateTrackerRequest {
1798
1855
  */
1799
1856
  TrackerName: string | undefined;
1800
1857
  /**
1801
- * <p>Specifies the pricing plan for the tracker resource.</p>
1858
+ * <p>Optionally specifies the pricing plan for the tracker resource. Defaults to
1859
+ * <code>RequestBasedUsage</code>.</p>
1802
1860
  * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1803
1861
  */
1804
- PricingPlan: PricingPlan | string | undefined;
1862
+ PricingPlan?: PricingPlan | string;
1805
1863
  /**
1806
1864
  * <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
1807
1865
  */
@@ -1851,6 +1909,9 @@ export interface CreateTrackerRequest {
1851
1909
  * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
1852
1910
  * + - = . _ : / @. </p>
1853
1911
  * </li>
1912
+ * <li>
1913
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
1914
+ * </li>
1854
1915
  * </ul>
1855
1916
  */
1856
1917
  Tags?: {
@@ -1870,9 +1931,20 @@ export interface CreateTrackerRequest {
1870
1931
  * <li>
1871
1932
  * <p>
1872
1933
  * <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
1873
- * ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
1874
- * This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
1875
- * Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
1934
+ * ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.
1935
+ * This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
1936
+ * Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
1937
+ * </p>
1938
+ * </li>
1939
+ * <li>
1940
+ * <p>
1941
+ * <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
1942
+ * location updates are ignored. For example, if two consecutive updates from a device
1943
+ * have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
1944
+ * has moved less than 15 m. Ignored location updates are neither evaluated against
1945
+ * linked geofence collections, nor stored. This can reduce the effects of GPS noise
1946
+ * when displaying device trajectories on a map, and can help control your costs by reducing the
1947
+ * number of geofence evaluations.
1876
1948
  * </p>
1877
1949
  * </li>
1878
1950
  * </ul>
@@ -2206,7 +2278,7 @@ export interface DescribePlaceIndexResponse {
2206
2278
  */
2207
2279
  UpdateTime: Date | undefined;
2208
2280
  /**
2209
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
2281
+ * <p>The data provider of geospatial data. Values can be one of the following:</p>
2210
2282
  * <ul>
2211
2283
  * <li>
2212
2284
  * <p>
@@ -2219,7 +2291,7 @@ export interface DescribePlaceIndexResponse {
2219
2291
  * </p>
2220
2292
  * </li>
2221
2293
  * </ul>
2222
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
2294
+ * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
2223
2295
  */
2224
2296
  DataSource: string | undefined;
2225
2297
  /**
@@ -2485,11 +2557,30 @@ export interface TagResourceRequest {
2485
2557
  */
2486
2558
  ResourceArn: string | undefined;
2487
2559
  /**
2488
- * <p>Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: <code>"TagKey" : "TagValue"</code>.</p>
2489
- * <ul>
2560
+ * <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps you
2561
+ * manage, identify, search, and filter your resources.</p>
2562
+ * <p>Format: <code>"key" : "value"</code>
2563
+ * </p>
2564
+ * <p>Restrictions:</p>
2565
+ * <ul>
2490
2566
  * <li>
2491
- * <p>Format example: <code>{"tag1" : "value1", "tag2" : "value2"} </code>
2492
- * </p>
2567
+ * <p>Maximum 50 tags per resource.</p>
2568
+ * </li>
2569
+ * <li>
2570
+ * <p>Each tag key must be unique and must have exactly one associated value.</p>
2571
+ * </li>
2572
+ * <li>
2573
+ * <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
2574
+ * </li>
2575
+ * <li>
2576
+ * <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
2577
+ * </li>
2578
+ * <li>
2579
+ * <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
2580
+ * = . _ : / @</p>
2581
+ * </li>
2582
+ * <li>
2583
+ * <p>Cannot use "aws:" as a prefix for a key.</p>
2493
2584
  * </li>
2494
2585
  * </ul>
2495
2586
  */
@@ -2940,6 +3031,16 @@ export interface GetDevicePositionResponse {
2940
3031
  * <p>The last known device position.</p>
2941
3032
  */
2942
3033
  Position: number[] | undefined;
3034
+ /**
3035
+ * <p>The accuracy of the device position.</p>
3036
+ */
3037
+ Accuracy?: PositionalAccuracy;
3038
+ /**
3039
+ * <p>The properties associated with the position.</p>
3040
+ */
3041
+ PositionProperties?: {
3042
+ [key: string]: string;
3043
+ };
2943
3044
  }
2944
3045
  export declare namespace GetDevicePositionResponse {
2945
3046
  /**
@@ -3259,6 +3360,16 @@ export interface ListDevicePositionsResponseEntry {
3259
3360
  * <p>The last known device position. Empty if no positions currently stored.</p>
3260
3361
  */
3261
3362
  Position: number[] | undefined;
3363
+ /**
3364
+ * <p>The accuracy of the device position.</p>
3365
+ */
3366
+ Accuracy?: PositionalAccuracy;
3367
+ /**
3368
+ * <p>The properties associated with the position.</p>
3369
+ */
3370
+ PositionProperties?: {
3371
+ [key: string]: string;
3372
+ };
3262
3373
  }
3263
3374
  export declare namespace ListDevicePositionsResponseEntry {
3264
3375
  /**
@@ -3393,7 +3504,7 @@ export interface ListPlaceIndexesResponseEntry {
3393
3504
  */
3394
3505
  Description: string | undefined;
3395
3506
  /**
3396
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
3507
+ * <p>The data provider of geospatial data. Values can be one of the following:</p>
3397
3508
  * <ul>
3398
3509
  * <li>
3399
3510
  * <p>
@@ -3406,7 +3517,7 @@ export interface ListPlaceIndexesResponseEntry {
3406
3517
  * </p>
3407
3518
  * </li>
3408
3519
  * </ul>
3409
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3520
+ * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3410
3521
  */
3411
3522
  DataSource: string | undefined;
3412
3523
  /**
@@ -3437,8 +3548,8 @@ export interface ListPlaceIndexesResponse {
3437
3548
  */
3438
3549
  Entries: ListPlaceIndexesResponseEntry[] | undefined;
3439
3550
  /**
3440
- * <p>A pagination token indicating there are additional pages available. You can use the
3441
- * token in a following request to fetch the next set of results.</p>
3551
+ * <p>A pagination token indicating that there are additional pages available. You can use the
3552
+ * token in a new request to fetch the next page of results.</p>
3442
3553
  */
3443
3554
  NextToken?: string;
3444
3555
  }
@@ -3724,24 +3835,29 @@ export interface SearchPlaceIndexForPositionRequest {
3724
3835
  */
3725
3836
  IndexName: string | undefined;
3726
3837
  /**
3727
- * <p>Specifies a coordinate for the query defined by a longitude, and latitude.</p>
3728
- * <ul>
3729
- * <li>
3730
- * <p>The first position is the X coordinate, or longitude.</p>
3731
- * </li>
3732
- * <li>
3733
- * <p>The second position is the Y coordinate, or latitude. </p>
3734
- * </li>
3735
- * </ul>
3736
- * <p>For example, <code>position=xLongitude&amp;position=yLatitude</code> .</p>
3838
+ * <p>Specifies the longitude and latitude of the position to query.</p>
3839
+ * <p>
3840
+ * This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude;
3841
+ * the second number represents the Y coordinate, or latitude.</p>
3842
+ * <p>For example, <code>[-123.1174, 49.2847]</code> represents a position with
3843
+ * longitude <code>-123.1174</code> and
3844
+ * latitude <code>49.2847</code>.</p>
3737
3845
  */
3738
3846
  Position: number[] | undefined;
3739
3847
  /**
3740
- * <p>An optional paramer. The maximum number of results returned per request. </p>
3848
+ * <p>An optional parameter. The maximum number of results returned per request.</p>
3741
3849
  * <p>Default value: <code>50</code>
3742
3850
  * </p>
3743
3851
  */
3744
3852
  MaxResults?: number;
3853
+ /**
3854
+ * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
3855
+ * <code>en</code> for English.</p>
3856
+ * <p>This setting affects the languages used in the results. It does not change which
3857
+ * results are returned. If the language is not specified, or not supported for a
3858
+ * particular result, the partner automatically chooses a language for the result.</p>
3859
+ */
3860
+ Language?: string;
3745
3861
  }
3746
3862
  export declare namespace SearchPlaceIndexForPositionRequest {
3747
3863
  /**
@@ -3775,6 +3891,27 @@ export declare namespace PlaceGeometry {
3775
3891
  */
3776
3892
  const filterSensitiveLog: (obj: PlaceGeometry) => any;
3777
3893
  }
3894
+ /**
3895
+ * <p>Information about a time zone. Includes the name of the time zone and the offset
3896
+ * from UTC in seconds.</p>
3897
+ */
3898
+ export interface TimeZone {
3899
+ /**
3900
+ * <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
3901
+ * IANA time zone standard</a>. For example, <code>America/Los_Angeles</code>.</p>
3902
+ */
3903
+ Name: string | undefined;
3904
+ /**
3905
+ * <p>The time zone's offset, in seconds, from UTC.</p>
3906
+ */
3907
+ Offset?: number;
3908
+ }
3909
+ export declare namespace TimeZone {
3910
+ /**
3911
+ * @internal
3912
+ */
3913
+ const filterSensitiveLog: (obj: TimeZone) => any;
3914
+ }
3778
3915
  /**
3779
3916
  * <p>Contains details about addresses or points of interest that match the search
3780
3917
  * criteria.</p>
@@ -3808,7 +3945,7 @@ export interface Place {
3808
3945
  */
3809
3946
  Municipality?: string;
3810
3947
  /**
3811
- * <p>A country, or an area that's part of a larger region . For example, <code>Metro
3948
+ * <p>A country, or an area that's part of a larger region. For example, <code>Metro
3812
3949
  * Vancouver</code>.</p>
3813
3950
  */
3814
3951
  SubRegion?: string;
@@ -3827,6 +3964,23 @@ export interface Place {
3827
3964
  * address for the purpose of identifying a location. </p>
3828
3965
  */
3829
3966
  PostalCode?: string;
3967
+ /**
3968
+ * <p>
3969
+ * <code>True</code> if the result is interpolated from other known places.</p>
3970
+ * <p>
3971
+ * <code>False</code> if the Place is a known place.</p>
3972
+ * <p>Not returned when the partner does not provide the information.</p>
3973
+ * <p>For example, returns <code>False</code> for an address location that is found in the
3974
+ * partner data, but returns <code>True</code> if an address does not exist in the partner
3975
+ * data and its location is calculated by interpolating between other known addresses.
3976
+ * </p>
3977
+ */
3978
+ Interpolated?: boolean;
3979
+ /**
3980
+ * <p>The time zone in which the <code>Place</code> is located. Returned only when using
3981
+ * Here as the selected partner.</p>
3982
+ */
3983
+ TimeZone?: TimeZone;
3830
3984
  }
3831
3985
  export declare namespace Place {
3832
3986
  /**
@@ -3835,14 +3989,22 @@ export declare namespace Place {
3835
3989
  const filterSensitiveLog: (obj: Place) => any;
3836
3990
  }
3837
3991
  /**
3838
- * <p>Specifies a single point of interest, or Place as a result of a search query obtained
3839
- * from a dataset configured in the place index resource.</p>
3992
+ * <p>Contains a search result from a position search query that is run on a place index resource.</p>
3840
3993
  */
3841
3994
  export interface SearchForPositionResult {
3842
3995
  /**
3843
- * <p>Contains details about the relevant point of interest.</p>
3996
+ * <p>Details about the search result, such as its address and position.</p>
3844
3997
  */
3845
3998
  Place: Place | undefined;
3999
+ /**
4000
+ * <p>The distance in meters of a great-circle arc between the query position and the
4001
+ * result.</p>
4002
+ * <note>
4003
+ * <p>A great-circle arc is the shortest path on a sphere, in this case the
4004
+ * Earth. This returns the shortest distance between two locations.</p>
4005
+ * </note>
4006
+ */
4007
+ Distance: number | undefined;
3846
4008
  }
3847
4009
  export declare namespace SearchForPositionResult {
3848
4010
  /**
@@ -3851,32 +4013,39 @@ export declare namespace SearchForPositionResult {
3851
4013
  const filterSensitiveLog: (obj: SearchForPositionResult) => any;
3852
4014
  }
3853
4015
  /**
3854
- * <p>A summary of the reverse geocoding request sent using <code>SearchPlaceIndexForPosition</code>.</p>
4016
+ * <p>A summary of the request sent by using <code>SearchPlaceIndexForPosition</code>.</p>
3855
4017
  */
3856
4018
  export interface SearchPlaceIndexForPositionSummary {
3857
4019
  /**
3858
- * <p>The position given in the reverse geocoding request.</p>
4020
+ * <p>The position specified in the request.</p>
3859
4021
  */
3860
4022
  Position: number[] | undefined;
3861
4023
  /**
3862
- * <p>An optional parameter. The maximum number of results returned per request. </p>
4024
+ * <p>Contains the optional result count limit that is specified in the request.</p>
3863
4025
  * <p>Default value: <code>50</code>
3864
4026
  * </p>
3865
4027
  */
3866
4028
  MaxResults?: number;
3867
4029
  /**
3868
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
4030
+ * <p>The geospatial data provider attached to the place index resource specified in the request.
4031
+ * Values can be one of the following:</p>
3869
4032
  * <ul>
3870
4033
  * <li>
3871
4034
  * <p>Esri</p>
3872
4035
  * </li>
3873
4036
  * <li>
3874
- * <p>HERE</p>
4037
+ * <p>Here</p>
3875
4038
  * </li>
3876
4039
  * </ul>
3877
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
4040
+ * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
3878
4041
  */
3879
4042
  DataSource: string | undefined;
4043
+ /**
4044
+ * <p>The preferred language used to return results. Matches the language in the request.
4045
+ * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4046
+ * <code>en</code> for English.</p>
4047
+ */
4048
+ Language?: string;
3880
4049
  }
3881
4050
  export declare namespace SearchPlaceIndexForPositionSummary {
3882
4051
  /**
@@ -3886,7 +4055,9 @@ export declare namespace SearchPlaceIndexForPositionSummary {
3886
4055
  }
3887
4056
  export interface SearchPlaceIndexForPositionResponse {
3888
4057
  /**
3889
- * <p>Contains a summary of the request.</p>
4058
+ * <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
4059
+ * <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of the place index.
4060
+ * </p>
3890
4061
  */
3891
4062
  Summary: SearchPlaceIndexForPositionSummary | undefined;
3892
4063
  /**
@@ -3901,68 +4072,220 @@ export declare namespace SearchPlaceIndexForPositionResponse {
3901
4072
  */
3902
4073
  const filterSensitiveLog: (obj: SearchPlaceIndexForPositionResponse) => any;
3903
4074
  }
3904
- export interface SearchPlaceIndexForTextRequest {
4075
+ export interface SearchPlaceIndexForSuggestionsRequest {
3905
4076
  /**
3906
4077
  * <p>The name of the place index resource you want to use for the search.</p>
3907
4078
  */
3908
4079
  IndexName: string | undefined;
3909
4080
  /**
3910
- * <p>The address, name,
3911
- * city, or region to be used in the search. In free-form text format. For example, <code>123 Any
3912
- * Street</code>.</p>
4081
+ * <p>The free-form partial text to use to generate place suggestions. For example,
4082
+ * <code>eiffel tow</code>.</p>
3913
4083
  */
3914
4084
  Text: string | undefined;
3915
4085
  /**
3916
- * <p>Searches for results closest to the given position. An optional parameter defined by
3917
- * longitude, and latitude.</p>
3918
- * <ul>
3919
- * <li>
3920
- * <p>The first <code>bias</code> position is the X coordinate, or longitude.</p>
3921
- * </li>
3922
- * <li>
3923
- * <p>The second <code>bias</code> position is the Y coordinate, or latitude. </p>
3924
- * </li>
3925
- * </ul>
3926
- * <p>For example, <code>bias=xLongitude&amp;bias=yLatitude</code>.</p>
4086
+ * <p>An optional parameter that indicates a preference for place suggestions that are closer to a specified position.</p>
4087
+ * <p>
4088
+ * If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude;
4089
+ * the second number represents the Y coordinate, or latitude.</p>
4090
+ * <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
4091
+ * longitude <code>-123.1174</code> and
4092
+ * latitude <code>49.2847</code>.</p>
4093
+ * <note>
4094
+ * <p>
4095
+ * <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.
4096
+ * </p>
4097
+ * </note>
3927
4098
  */
3928
4099
  BiasPosition?: number[];
3929
4100
  /**
3930
- * <p>Filters the results by returning only Places within the provided bounding box. An
3931
- * optional parameter.</p>
3932
- * <p>The first 2 <code>bbox</code> parameters describe the lower southwest corner:</p>
4101
+ * <p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p>
4102
+ * <p>
4103
+ * If provided, this parameter must contain a total of four consecutive numbers in two pairs.
4104
+ * The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
4105
+ * of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
4106
+ * of the northeast corner of the bounding box.</p>
4107
+ * <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents
4108
+ * a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>,
4109
+ * and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>
4110
+ * <note>
4111
+ * <p>
4112
+ * <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.
4113
+ * </p>
4114
+ * </note>
4115
+ */
4116
+ FilterBBox?: number[];
4117
+ /**
4118
+ * <p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p>
3933
4119
  * <ul>
3934
4120
  * <li>
3935
- * <p>The first <code>bbox</code> position is the X coordinate or longitude of the lower
3936
- * southwest corner.</p>
3937
- * </li>
3938
- * <li>
3939
- * <p>The second <code>bbox</code> position is the Y coordinate or latitude of the lower
3940
- * southwest corner.</p>
4121
+ * <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
4122
+ * country code. For example, Australia uses three upper-case characters:
4123
+ * <code>AUS</code>.</p>
3941
4124
  * </li>
3942
4125
  * </ul>
3943
- * <p>For example, <code>bbox=xLongitudeSW&amp;bbox=yLatitudeSW</code>.</p>
3944
- * <p>The next <code>bbox</code> parameters describe the upper northeast corner:</p>
4126
+ */
4127
+ FilterCountries?: string[];
4128
+ /**
4129
+ * <p>An optional parameter. The maximum number of results returned per request. </p>
4130
+ * <p>The default: <code>5</code>
4131
+ * </p>
4132
+ */
4133
+ MaxResults?: number;
4134
+ /**
4135
+ * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4136
+ * <code>en</code> for English.</p>
4137
+ * <p>This setting affects the languages used in the results. It does not change which
4138
+ * results are returned. If the language is not specified, or not supported for a
4139
+ * particular result, the partner automatically chooses a language for the result.</p>
4140
+ * <p>Used only when the partner selected is Here.</p>
4141
+ */
4142
+ Language?: string;
4143
+ }
4144
+ export declare namespace SearchPlaceIndexForSuggestionsRequest {
4145
+ /**
4146
+ * @internal
4147
+ */
4148
+ const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsRequest) => any;
4149
+ }
4150
+ /**
4151
+ * <p>Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.</p>
4152
+ */
4153
+ export interface SearchForSuggestionsResult {
4154
+ /**
4155
+ * <p>The text of the place suggestion, typically formatted as an address string.</p>
4156
+ */
4157
+ Text: string | undefined;
4158
+ }
4159
+ export declare namespace SearchForSuggestionsResult {
4160
+ /**
4161
+ * @internal
4162
+ */
4163
+ const filterSensitiveLog: (obj: SearchForSuggestionsResult) => any;
4164
+ }
4165
+ /**
4166
+ * <p>A summary of the request sent by using <code>SearchPlaceIndexForSuggestions</code>.</p>
4167
+ */
4168
+ export interface SearchPlaceIndexForSuggestionsSummary {
4169
+ /**
4170
+ * <p>The free-form partial text input specified in the request.</p>
4171
+ */
4172
+ Text: string | undefined;
4173
+ /**
4174
+ * <p>Contains the coordinates for the optional bias position specified in the request.</p>
4175
+ * <p>This parameter contains a pair of numbers. The first number represents the X
4176
+ * coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
4177
+ * <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
4178
+ * longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
4179
+ */
4180
+ BiasPosition?: number[];
4181
+ /**
4182
+ * <p>Contains the coordinates for the optional bounding box specified in the request.</p>
4183
+ */
4184
+ FilterBBox?: number[];
4185
+ /**
4186
+ * <p>Contains the optional country filter specified in the request.</p>
4187
+ */
4188
+ FilterCountries?: string[];
4189
+ /**
4190
+ * <p>Contains the optional result count limit specified in the request.</p>
4191
+ */
4192
+ MaxResults?: number;
4193
+ /**
4194
+ * <p>The geospatial data provider attached to the place index resource specified in the request.
4195
+ * Values can be one of the following:</p>
3945
4196
  * <ul>
3946
4197
  * <li>
3947
- * <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
3948
- * upper northeast corner.</p>
4198
+ * <p>Esri</p>
3949
4199
  * </li>
3950
4200
  * <li>
3951
- * <p>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the
3952
- * upper northeast corner.</p>
4201
+ * <p>Here</p>
3953
4202
  * </li>
3954
4203
  * </ul>
3955
- * <p>For example, <code>bbox=xLongitudeNE&amp;bbox=yLatitudeNE</code>
4204
+ * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
4205
+ */
4206
+ DataSource: string | undefined;
4207
+ /**
4208
+ * <p>The preferred language used to return results. Matches the language in the request.
4209
+ * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4210
+ * <code>en</code> for English.</p>
4211
+ */
4212
+ Language?: string;
4213
+ }
4214
+ export declare namespace SearchPlaceIndexForSuggestionsSummary {
4215
+ /**
4216
+ * @internal
4217
+ */
4218
+ const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsSummary) => any;
4219
+ }
4220
+ export interface SearchPlaceIndexForSuggestionsResponse {
4221
+ /**
4222
+ * <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,
4223
+ * <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,
4224
+ * and <code>Text</code>. Also includes the <code>DataSource</code> of the place index.
4225
+ * </p>
4226
+ */
4227
+ Summary: SearchPlaceIndexForSuggestionsSummary | undefined;
4228
+ /**
4229
+ * <p>A list of place suggestions that best match the search text.</p>
4230
+ */
4231
+ Results: SearchForSuggestionsResult[] | undefined;
4232
+ }
4233
+ export declare namespace SearchPlaceIndexForSuggestionsResponse {
4234
+ /**
4235
+ * @internal
4236
+ */
4237
+ const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsResponse) => any;
4238
+ }
4239
+ export interface SearchPlaceIndexForTextRequest {
4240
+ /**
4241
+ * <p>The name of the place index resource you want to use for the search.</p>
4242
+ */
4243
+ IndexName: string | undefined;
4244
+ /**
4245
+ * <p>The address, name,
4246
+ * city, or region to be used in the search in free-form text format. For example, <code>123 Any
4247
+ * Street</code>.</p>
4248
+ */
4249
+ Text: string | undefined;
4250
+ /**
4251
+ * <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
4252
+ * <p>
4253
+ * If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the
4254
+ * second number represents the Y coordinate, or latitude.</p>
4255
+ * <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
4256
+ * longitude <code>-123.1174</code> and
4257
+ * latitude <code>49.2847</code>.</p>
4258
+ * <note>
4259
+ * <p>
4260
+ * <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options
4261
+ * results in an error.
3956
4262
  * </p>
4263
+ * </note>
4264
+ */
4265
+ BiasPosition?: number[];
4266
+ /**
4267
+ * <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
4268
+ * <p>
4269
+ * If provided, this parameter must contain a total of four consecutive numbers in two pairs.
4270
+ * The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
4271
+ * of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
4272
+ * of the northeast corner of the bounding box.</p>
4273
+ * <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents
4274
+ * a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>,
4275
+ * and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>
4276
+ * <note>
4277
+ * <p>
4278
+ * <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.
4279
+ * </p>
4280
+ * </note>
3957
4281
  */
3958
4282
  FilterBBox?: number[];
3959
4283
  /**
3960
- * <p>Limits the search to the given a list of countries/regions. An optional
3961
- * parameter.</p>
4284
+ * <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
3962
4285
  * <ul>
3963
4286
  * <li>
3964
- * <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
3965
- * country code. For example, Australia uses three upper-case characters:
4287
+ * <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
4288
+ * country codes. For example, Australia uses three upper-case characters:
3966
4289
  * <code>AUS</code>.</p>
3967
4290
  * </li>
3968
4291
  * </ul>
@@ -3974,6 +4297,14 @@ export interface SearchPlaceIndexForTextRequest {
3974
4297
  * </p>
3975
4298
  */
3976
4299
  MaxResults?: number;
4300
+ /**
4301
+ * <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4302
+ * <code>en</code> for English.</p>
4303
+ * <p>This setting affects the languages used in the results. It does not change which
4304
+ * results are returned. If the language is not specified, or not supported for a
4305
+ * particular result, the partner automatically chooses a language for the result.</p>
4306
+ */
4307
+ Language?: string;
3977
4308
  }
3978
4309
  export declare namespace SearchPlaceIndexForTextRequest {
3979
4310
  /**
@@ -3982,14 +4313,30 @@ export declare namespace SearchPlaceIndexForTextRequest {
3982
4313
  const filterSensitiveLog: (obj: SearchPlaceIndexForTextRequest) => any;
3983
4314
  }
3984
4315
  /**
3985
- * <p>Contains relevant Places returned by calling
3986
- * <code>SearchPlaceIndexForText</code>.</p>
4316
+ * <p>Contains a search result from a text search query that is run on a place index resource.</p>
3987
4317
  */
3988
4318
  export interface SearchForTextResult {
3989
4319
  /**
3990
- * <p>Contains details about the relevant point of interest.</p>
4320
+ * <p>Details about the search result, such as its address and position.</p>
3991
4321
  */
3992
4322
  Place: Place | undefined;
4323
+ /**
4324
+ * <p>The distance in meters of a great-circle arc between the bias position specified
4325
+ * and the result. <code>Distance</code> will be returned only if a bias position was
4326
+ * specified in the query.</p>
4327
+ * <note>
4328
+ * <p>A great-circle arc is the shortest path on a sphere, in this case the
4329
+ * Earth. This returns the shortest distance between two locations.</p>
4330
+ * </note>
4331
+ */
4332
+ Distance?: number;
4333
+ /**
4334
+ * <p>The relative confidence in the match for a result among the results returned. For
4335
+ * example, if more fields for an address match (including house number, street, city,
4336
+ * country/region, and postal code), the relevance score is closer to 1.</p>
4337
+ * <p>Returned only when the partner selected is Esri.</p>
4338
+ */
4339
+ Relevance?: number;
3993
4340
  }
3994
4341
  export declare namespace SearchForTextResult {
3995
4342
  /**
@@ -3998,50 +4345,61 @@ export declare namespace SearchForTextResult {
3998
4345
  const filterSensitiveLog: (obj: SearchForTextResult) => any;
3999
4346
  }
4000
4347
  /**
4001
- * <p>A summary of the geocoding request sent using <code>SearchPlaceIndexForText</code>.</p>
4348
+ * <p>A summary of the request sent by using <code>SearchPlaceIndexForText</code>.</p>
4002
4349
  */
4003
4350
  export interface SearchPlaceIndexForTextSummary {
4004
4351
  /**
4005
- * <p>The address, name, city or region to be used in the geocoding request. In free-form text
4006
- * format. For example, <code>Vancouver</code>.</p>
4352
+ * <p>The search text specified in the request.</p>
4007
4353
  */
4008
4354
  Text: string | undefined;
4009
4355
  /**
4010
- * <p>Contains the coordinates for the bias position entered in the geocoding request.</p>
4356
+ * <p>Contains the coordinates for the optional bias position specified in the request.</p>
4357
+ * <p>This parameter contains a pair of numbers. The first number represents the X
4358
+ * coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
4359
+ * <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
4360
+ * longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
4011
4361
  */
4012
4362
  BiasPosition?: number[];
4013
4363
  /**
4014
- * <p>Contains the coordinates for the optional bounding box coordinated entered in the
4015
- * geocoding request.</p>
4364
+ * <p>Contains the coordinates for the optional bounding box specified in the request.</p>
4016
4365
  */
4017
4366
  FilterBBox?: number[];
4018
4367
  /**
4019
- * <p>Contains the country filter entered in the geocoding request.</p>
4368
+ * <p>Contains the optional country filter specified in the request.</p>
4020
4369
  */
4021
4370
  FilterCountries?: string[];
4022
4371
  /**
4023
- * <p>Contains the maximum number of results indicated for the request.</p>
4372
+ * <p>Contains the optional result count limit specified in the request.</p>
4024
4373
  */
4025
4374
  MaxResults?: number;
4026
4375
  /**
4027
- * <p>A bounding box that contains the search results within the specified area indicated by
4028
- * <code>FilterBBox</code>. A subset of bounding box specified using
4029
- * <code>FilterBBox</code>.</p>
4376
+ * <p>The bounding box that fully contains all search results.</p>
4377
+ * <note>
4378
+ * <p>If you specified the optional <code>FilterBBox</code> parameter in the request, <code>ResultBBox</code>
4379
+ * is contained within <code>FilterBBox</code>.</p>
4380
+ * </note>
4030
4381
  */
4031
4382
  ResultBBox?: number[];
4032
4383
  /**
4033
- * <p>The data provider of geospatial data. Indicates one of the available providers:</p>
4384
+ * <p>The geospatial data provider attached to the place index resource specified in the request.
4385
+ * Values can be one of the following:</p>
4034
4386
  * <ul>
4035
4387
  * <li>
4036
4388
  * <p>Esri</p>
4037
4389
  * </li>
4038
4390
  * <li>
4039
- * <p>HERE</p>
4391
+ * <p>Here</p>
4040
4392
  * </li>
4041
4393
  * </ul>
4042
- * <p>For additional details on data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
4394
+ * <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
4043
4395
  */
4044
4396
  DataSource: string | undefined;
4397
+ /**
4398
+ * <p>The preferred language used to return results. Matches the language in the request.
4399
+ * The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
4400
+ * <code>en</code> for English.</p>
4401
+ */
4402
+ Language?: string;
4045
4403
  }
4046
4404
  export declare namespace SearchPlaceIndexForTextSummary {
4047
4405
  /**
@@ -4051,13 +4409,15 @@ export declare namespace SearchPlaceIndexForTextSummary {
4051
4409
  }
4052
4410
  export interface SearchPlaceIndexForTextResponse {
4053
4411
  /**
4054
- * <p>Contains a summary of the request. Contains the <code>BiasPosition</code>,
4055
- * <code>DataSource</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
4056
- * <code>MaxResults</code>, <code>ResultBBox</code>, and <code>Text</code>.</p>
4412
+ * <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,
4413
+ * <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,
4414
+ * and <code>Text</code>. Also includes the <code>DataSource</code> of the place index and
4415
+ * the bounding box, <code>ResultBBox</code>, which surrounds the search results.
4416
+ * </p>
4057
4417
  */
4058
4418
  Summary: SearchPlaceIndexForTextSummary | undefined;
4059
4419
  /**
4060
- * <p>A list of Places closest to the specified position. Each result contains additional
4420
+ * <p>A list of Places matching the input text. Each result contains additional
4061
4421
  * information about the specific point of interest. </p>
4062
4422
  */
4063
4423
  Results: SearchForTextResult[] | undefined;
@@ -4218,8 +4578,19 @@ export interface UpdateTrackerRequest {
4218
4578
  * <p>
4219
4579
  * <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
4220
4580
  * ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
4221
- * This helps control costs by reducing the number of geofence evaluations and device positions to retrieve.
4222
- * Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
4581
+ * This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
4582
+ * Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
4583
+ * </p>
4584
+ * </li>
4585
+ * <li>
4586
+ * <p>
4587
+ * <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
4588
+ * location updates are ignored. For example, if two consecutive updates from a device
4589
+ * have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
4590
+ * has moved less than 15 m. Ignored location updates are neither evaluated against
4591
+ * linked geofence collections, nor stored. This helps educe the effects of GPS noise
4592
+ * when displaying device trajectories on a map, and can help control costs by reducing the
4593
+ * number of geofence evaluations.
4223
4594
  * </p>
4224
4595
  * </li>
4225
4596
  * </ul>