@aws-sdk/client-location 3.39.0 → 3.43.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 +41 -0
- package/dist-cjs/endpoints.js +74 -5
- package/dist-cjs/models/models_0.js +7 -1
- package/dist-cjs/protocols/Aws_restJson1.js +17 -0
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-es/endpoints.js +74 -5
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +19 -4
- package/dist-es/runtimeConfig.browser.js +3 -2
- package/dist-es/runtimeConfig.js +3 -3
- package/dist-types/Location.d.ts +8 -7
- package/dist-types/LocationClient.d.ts +8 -0
- package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +1 -1
- package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +1 -1
- package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +1 -1
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetDevicePositionCommand.d.ts +1 -1
- package/dist-types/commands/BatchPutGeofenceCommand.d.ts +1 -1
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +1 -1
- package/dist-types/commands/CalculateRouteCommand.d.ts +3 -4
- package/dist-types/commands/CreateGeofenceCollectionCommand.d.ts +1 -1
- package/dist-types/commands/CreateMapCommand.d.ts +1 -1
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +4 -3
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/CreateTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMapCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGeofenceCollectionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMapCommand.d.ts +1 -1
- package/dist-types/commands/DescribePlaceIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +1 -1
- package/dist-types/commands/GetDevicePositionCommand.d.ts +1 -1
- package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetGeofenceCommand.d.ts +1 -1
- package/dist-types/commands/GetMapGlyphsCommand.d.ts +1 -1
- package/dist-types/commands/GetMapSpritesCommand.d.ts +1 -1
- package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +1 -1
- package/dist-types/commands/GetMapTileCommand.d.ts +1 -1
- package/dist-types/commands/ListDevicePositionsCommand.d.ts +1 -1
- package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +1 -1
- package/dist-types/commands/ListGeofencesCommand.d.ts +1 -1
- package/dist-types/commands/ListMapsCommand.d.ts +1 -1
- package/dist-types/commands/ListPlaceIndexesCommand.d.ts +1 -1
- package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTrackerConsumersCommand.d.ts +1 -1
- package/dist-types/commands/ListTrackersCommand.d.ts +1 -1
- package/dist-types/commands/PutGeofenceCommand.d.ts +1 -1
- package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +1 -1
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +4 -3
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGeofenceCollectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMapCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePlaceIndexCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTrackerCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +228 -112
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/LocationClient.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +30 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +23 -23
|
@@ -788,7 +788,7 @@ export declare namespace CalculateRouteTruckModeOptions {
|
|
|
788
788
|
}
|
|
789
789
|
export interface CalculateRouteRequest {
|
|
790
790
|
/**
|
|
791
|
-
* <p>The name of the route calculator resource that you want to use to calculate
|
|
791
|
+
* <p>The name of the route calculator resource that you want to use to calculate the route. </p>
|
|
792
792
|
*/
|
|
793
793
|
CalculatorName: string | undefined;
|
|
794
794
|
/**
|
|
@@ -866,7 +866,7 @@ export interface CalculateRouteRequest {
|
|
|
866
866
|
*/
|
|
867
867
|
TravelMode?: TravelMode | string;
|
|
868
868
|
/**
|
|
869
|
-
* <p>Specifies the desired time of departure. Uses the given time to calculate
|
|
869
|
+
* <p>Specifies the desired time of departure. Uses the given time to calculate the route.
|
|
870
870
|
* Otherwise, the best time of day to travel with the best traffic conditions is used to
|
|
871
871
|
* calculate the route.</p>
|
|
872
872
|
* <note>
|
|
@@ -1138,7 +1138,7 @@ export interface CalculateRouteSummary {
|
|
|
1138
1138
|
*/
|
|
1139
1139
|
DurationSeconds: number | undefined;
|
|
1140
1140
|
/**
|
|
1141
|
-
* <p>The unit of measurement for
|
|
1141
|
+
* <p>The unit of measurement for route distances.</p>
|
|
1142
1142
|
*/
|
|
1143
1143
|
DistanceUnit: DistanceUnit | string | undefined;
|
|
1144
1144
|
}
|
|
@@ -1268,6 +1268,9 @@ export interface CreateGeofenceCollectionRequest {
|
|
|
1268
1268
|
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1269
1269
|
* + - = . _ : / @. </p>
|
|
1270
1270
|
* </li>
|
|
1271
|
+
* <li>
|
|
1272
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1273
|
+
* </li>
|
|
1271
1274
|
* </ul>
|
|
1272
1275
|
*/
|
|
1273
1276
|
Tags?: {
|
|
@@ -1438,6 +1441,9 @@ export interface CreateMapRequest {
|
|
|
1438
1441
|
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /
|
|
1439
1442
|
* @. </p>
|
|
1440
1443
|
* </li>
|
|
1444
|
+
* <li>
|
|
1445
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1446
|
+
* </li>
|
|
1441
1447
|
* </ul>
|
|
1442
1448
|
*/
|
|
1443
1449
|
Tags?: {
|
|
@@ -1514,7 +1520,7 @@ export interface DataSourceConfiguration {
|
|
|
1514
1520
|
* <code>Storage</code> specifies that the result can be cached or stored in a database.</p>
|
|
1515
1521
|
* </li>
|
|
1516
1522
|
* </ul>
|
|
1517
|
-
* <p>Default value:
|
|
1523
|
+
* <p>Default value: <code>SingleUse</code>
|
|
1518
1524
|
* </p>
|
|
1519
1525
|
*/
|
|
1520
1526
|
IntendedUse?: IntendedUse | string;
|
|
@@ -1544,7 +1550,7 @@ export interface CreatePlaceIndexRequest {
|
|
|
1544
1550
|
*/
|
|
1545
1551
|
IndexName: string | undefined;
|
|
1546
1552
|
/**
|
|
1547
|
-
* <p>Specifies the data provider
|
|
1553
|
+
* <p>Specifies the geospatial data provider for the new place index.</p>
|
|
1548
1554
|
* <note>
|
|
1549
1555
|
* <p>This field is case-sensitive. Enter the valid values as shown. For example, entering
|
|
1550
1556
|
* <code>HERE</code> returns an error.</p>
|
|
@@ -1561,7 +1567,8 @@ export interface CreatePlaceIndexRequest {
|
|
|
1561
1567
|
* <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE Technologies</a>'
|
|
1562
1568
|
* 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
1569
|
* <important>
|
|
1564
|
-
* <p>
|
|
1570
|
+
* <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
|
|
1571
|
+
* 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
1572
|
* <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>
|
|
1566
1573
|
* for Amazon Location Service.</p>
|
|
1567
1574
|
* </important>
|
|
@@ -1585,27 +1592,30 @@ export interface CreatePlaceIndexRequest {
|
|
|
1585
1592
|
*/
|
|
1586
1593
|
DataSourceConfiguration?: DataSourceConfiguration;
|
|
1587
1594
|
/**
|
|
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
|
|
1595
|
+
* <p>Applies one or more tags to the place index resource. A tag is a key-value pair that helps you
|
|
1596
|
+
* manage, identify, search, and filter your resources.</p>
|
|
1590
1597
|
* <p>Format: <code>"key" : "value"</code>
|
|
1591
1598
|
* </p>
|
|
1592
1599
|
* <p>Restrictions:</p>
|
|
1593
1600
|
* <ul>
|
|
1594
1601
|
* <li>
|
|
1595
|
-
* <p>Maximum 50 tags per resource
|
|
1602
|
+
* <p>Maximum 50 tags per resource.</p>
|
|
1596
1603
|
* </li>
|
|
1597
1604
|
* <li>
|
|
1598
|
-
* <p>Each
|
|
1605
|
+
* <p>Each tag key must be unique and must have exactly one associated value.</p>
|
|
1599
1606
|
* </li>
|
|
1600
1607
|
* <li>
|
|
1601
|
-
* <p>Maximum key length: 128 Unicode characters in UTF-8
|
|
1608
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1602
1609
|
* </li>
|
|
1603
1610
|
* <li>
|
|
1604
|
-
* <p>Maximum value length: 256 Unicode characters in UTF-8
|
|
1611
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1605
1612
|
* </li>
|
|
1606
1613
|
* <li>
|
|
1607
1614
|
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
|
|
1608
|
-
* = . _ : /
|
|
1615
|
+
* = . _ : / @</p>
|
|
1616
|
+
* </li>
|
|
1617
|
+
* <li>
|
|
1618
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1609
1619
|
* </li>
|
|
1610
1620
|
* </ul>
|
|
1611
1621
|
*/
|
|
@@ -1727,6 +1737,9 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1727
1737
|
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1728
1738
|
* + - = . _ : / @. </p>
|
|
1729
1739
|
* </li>
|
|
1740
|
+
* <li>
|
|
1741
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1742
|
+
* </li>
|
|
1730
1743
|
* </ul>
|
|
1731
1744
|
*/
|
|
1732
1745
|
Tags?: {
|
|
@@ -1779,7 +1792,7 @@ export declare namespace CreateRouteCalculatorResponse {
|
|
|
1779
1792
|
*/
|
|
1780
1793
|
const filterSensitiveLog: (obj: CreateRouteCalculatorResponse) => any;
|
|
1781
1794
|
}
|
|
1782
|
-
export declare type PositionFiltering = "DistanceBased" | "TimeBased";
|
|
1795
|
+
export declare type PositionFiltering = "AccuracyBased" | "DistanceBased" | "TimeBased";
|
|
1783
1796
|
export interface CreateTrackerRequest {
|
|
1784
1797
|
/**
|
|
1785
1798
|
* <p>The name for the tracker resource.</p>
|
|
@@ -1851,6 +1864,9 @@ export interface CreateTrackerRequest {
|
|
|
1851
1864
|
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1852
1865
|
* + - = . _ : / @. </p>
|
|
1853
1866
|
* </li>
|
|
1867
|
+
* <li>
|
|
1868
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1869
|
+
* </li>
|
|
1854
1870
|
* </ul>
|
|
1855
1871
|
*/
|
|
1856
1872
|
Tags?: {
|
|
@@ -1870,9 +1886,9 @@ export interface CreateTrackerRequest {
|
|
|
1870
1886
|
* <li>
|
|
1871
1887
|
* <p>
|
|
1872
1888
|
* <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
|
|
1873
|
-
* ignored. Location updates within this
|
|
1874
|
-
* This helps control costs by reducing the number of geofence evaluations and device positions to
|
|
1875
|
-
* Distance-based filtering can also reduce the
|
|
1889
|
+
* ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.
|
|
1890
|
+
* This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
|
|
1891
|
+
* Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
|
|
1876
1892
|
* </p>
|
|
1877
1893
|
* </li>
|
|
1878
1894
|
* </ul>
|
|
@@ -2206,7 +2222,7 @@ export interface DescribePlaceIndexResponse {
|
|
|
2206
2222
|
*/
|
|
2207
2223
|
UpdateTime: Date | undefined;
|
|
2208
2224
|
/**
|
|
2209
|
-
* <p>The data provider of geospatial data.
|
|
2225
|
+
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
2210
2226
|
* <ul>
|
|
2211
2227
|
* <li>
|
|
2212
2228
|
* <p>
|
|
@@ -2219,7 +2235,7 @@ export interface DescribePlaceIndexResponse {
|
|
|
2219
2235
|
* </p>
|
|
2220
2236
|
* </li>
|
|
2221
2237
|
* </ul>
|
|
2222
|
-
* <p>For
|
|
2238
|
+
* <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
2239
|
*/
|
|
2224
2240
|
DataSource: string | undefined;
|
|
2225
2241
|
/**
|
|
@@ -2485,11 +2501,30 @@ export interface TagResourceRequest {
|
|
|
2485
2501
|
*/
|
|
2486
2502
|
ResourceArn: string | undefined;
|
|
2487
2503
|
/**
|
|
2488
|
-
* <p>
|
|
2489
|
-
*
|
|
2504
|
+
* <p>Applies one or more tags to specific resource. A tag is a key-value pair that helps you
|
|
2505
|
+
* manage, identify, search, and filter your resources.</p>
|
|
2506
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
2507
|
+
* </p>
|
|
2508
|
+
* <p>Restrictions:</p>
|
|
2509
|
+
* <ul>
|
|
2490
2510
|
* <li>
|
|
2491
|
-
*
|
|
2492
|
-
*
|
|
2511
|
+
* <p>Maximum 50 tags per resource.</p>
|
|
2512
|
+
* </li>
|
|
2513
|
+
* <li>
|
|
2514
|
+
* <p>Each tag key must be unique and must have exactly one associated value.</p>
|
|
2515
|
+
* </li>
|
|
2516
|
+
* <li>
|
|
2517
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
2518
|
+
* </li>
|
|
2519
|
+
* <li>
|
|
2520
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2521
|
+
* </li>
|
|
2522
|
+
* <li>
|
|
2523
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + -
|
|
2524
|
+
* = . _ : / @</p>
|
|
2525
|
+
* </li>
|
|
2526
|
+
* <li>
|
|
2527
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
2493
2528
|
* </li>
|
|
2494
2529
|
* </ul>
|
|
2495
2530
|
*/
|
|
@@ -3393,7 +3428,7 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3393
3428
|
*/
|
|
3394
3429
|
Description: string | undefined;
|
|
3395
3430
|
/**
|
|
3396
|
-
* <p>The data provider of geospatial data.
|
|
3431
|
+
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
3397
3432
|
* <ul>
|
|
3398
3433
|
* <li>
|
|
3399
3434
|
* <p>
|
|
@@ -3406,7 +3441,7 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3406
3441
|
* </p>
|
|
3407
3442
|
* </li>
|
|
3408
3443
|
* </ul>
|
|
3409
|
-
* <p>For
|
|
3444
|
+
* <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
3445
|
*/
|
|
3411
3446
|
DataSource: string | undefined;
|
|
3412
3447
|
/**
|
|
@@ -3437,8 +3472,8 @@ export interface ListPlaceIndexesResponse {
|
|
|
3437
3472
|
*/
|
|
3438
3473
|
Entries: ListPlaceIndexesResponseEntry[] | undefined;
|
|
3439
3474
|
/**
|
|
3440
|
-
* <p>A pagination token indicating there are additional pages available. You can use the
|
|
3441
|
-
* token in a
|
|
3475
|
+
* <p>A pagination token indicating that there are additional pages available. You can use the
|
|
3476
|
+
* token in a new request to fetch the next page of results.</p>
|
|
3442
3477
|
*/
|
|
3443
3478
|
NextToken?: string;
|
|
3444
3479
|
}
|
|
@@ -3724,24 +3759,29 @@ export interface SearchPlaceIndexForPositionRequest {
|
|
|
3724
3759
|
*/
|
|
3725
3760
|
IndexName: string | undefined;
|
|
3726
3761
|
/**
|
|
3727
|
-
* <p>Specifies
|
|
3728
|
-
* <
|
|
3729
|
-
*
|
|
3730
|
-
*
|
|
3731
|
-
*
|
|
3732
|
-
*
|
|
3733
|
-
*
|
|
3734
|
-
* </li>
|
|
3735
|
-
* </ul>
|
|
3736
|
-
* <p>For example, <code>position=xLongitude&position=yLatitude</code> .</p>
|
|
3762
|
+
* <p>Specifies the longitude and latitude of the position to query.</p>
|
|
3763
|
+
* <p>
|
|
3764
|
+
* This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude;
|
|
3765
|
+
* the second number represents the Y coordinate, or latitude.</p>
|
|
3766
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents a position with
|
|
3767
|
+
* longitude <code>-123.1174</code> and
|
|
3768
|
+
* latitude <code>49.2847</code>.</p>
|
|
3737
3769
|
*/
|
|
3738
3770
|
Position: number[] | undefined;
|
|
3739
3771
|
/**
|
|
3740
|
-
* <p>An optional
|
|
3772
|
+
* <p>An optional parameter. The maximum number of results returned per request.</p>
|
|
3741
3773
|
* <p>Default value: <code>50</code>
|
|
3742
3774
|
* </p>
|
|
3743
3775
|
*/
|
|
3744
3776
|
MaxResults?: number;
|
|
3777
|
+
/**
|
|
3778
|
+
* <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,
|
|
3779
|
+
* <code>en</code> for English.</p>
|
|
3780
|
+
* <p>This setting affects the languages used in the results. It does not change which
|
|
3781
|
+
* results are returned. If the language is not specified, or not supported for a
|
|
3782
|
+
* particular result, the partner automatically chooses a language for the result.</p>
|
|
3783
|
+
*/
|
|
3784
|
+
Language?: string;
|
|
3745
3785
|
}
|
|
3746
3786
|
export declare namespace SearchPlaceIndexForPositionRequest {
|
|
3747
3787
|
/**
|
|
@@ -3775,6 +3815,27 @@ export declare namespace PlaceGeometry {
|
|
|
3775
3815
|
*/
|
|
3776
3816
|
const filterSensitiveLog: (obj: PlaceGeometry) => any;
|
|
3777
3817
|
}
|
|
3818
|
+
/**
|
|
3819
|
+
* <p>Information about a time zone. Includes the name of the time zone and the offset
|
|
3820
|
+
* from UTC in seconds.</p>
|
|
3821
|
+
*/
|
|
3822
|
+
export interface TimeZone {
|
|
3823
|
+
/**
|
|
3824
|
+
* <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
|
|
3825
|
+
* IANA time zone standard</a>. For example, <code>America/Los_Angeles</code>.</p>
|
|
3826
|
+
*/
|
|
3827
|
+
Name: string | undefined;
|
|
3828
|
+
/**
|
|
3829
|
+
* <p>The time zone's offset, in seconds, from UTC.</p>
|
|
3830
|
+
*/
|
|
3831
|
+
Offset?: number;
|
|
3832
|
+
}
|
|
3833
|
+
export declare namespace TimeZone {
|
|
3834
|
+
/**
|
|
3835
|
+
* @internal
|
|
3836
|
+
*/
|
|
3837
|
+
const filterSensitiveLog: (obj: TimeZone) => any;
|
|
3838
|
+
}
|
|
3778
3839
|
/**
|
|
3779
3840
|
* <p>Contains details about addresses or points of interest that match the search
|
|
3780
3841
|
* criteria.</p>
|
|
@@ -3808,7 +3869,7 @@ export interface Place {
|
|
|
3808
3869
|
*/
|
|
3809
3870
|
Municipality?: string;
|
|
3810
3871
|
/**
|
|
3811
|
-
* <p>A country, or an area that's part of a larger region
|
|
3872
|
+
* <p>A country, or an area that's part of a larger region. For example, <code>Metro
|
|
3812
3873
|
* Vancouver</code>.</p>
|
|
3813
3874
|
*/
|
|
3814
3875
|
SubRegion?: string;
|
|
@@ -3827,6 +3888,23 @@ export interface Place {
|
|
|
3827
3888
|
* address for the purpose of identifying a location. </p>
|
|
3828
3889
|
*/
|
|
3829
3890
|
PostalCode?: string;
|
|
3891
|
+
/**
|
|
3892
|
+
* <p>
|
|
3893
|
+
* <code>True</code> if the result is interpolated from other known places.</p>
|
|
3894
|
+
* <p>
|
|
3895
|
+
* <code>False</code> if the Place is a known place.</p>
|
|
3896
|
+
* <p>Not returned when the partner does not provide the information.</p>
|
|
3897
|
+
* <p>For example, returns <code>False</code> for an address location that is found in the
|
|
3898
|
+
* partner data, but returns <code>True</code> if an address does not exist in the partner
|
|
3899
|
+
* data and its location is calculated by interpolating between other known addresses.
|
|
3900
|
+
* </p>
|
|
3901
|
+
*/
|
|
3902
|
+
Interpolated?: boolean;
|
|
3903
|
+
/**
|
|
3904
|
+
* <p>The time zone in which the <code>Place</code> is located. Returned only when using
|
|
3905
|
+
* Here as the selected partner.</p>
|
|
3906
|
+
*/
|
|
3907
|
+
TimeZone?: TimeZone;
|
|
3830
3908
|
}
|
|
3831
3909
|
export declare namespace Place {
|
|
3832
3910
|
/**
|
|
@@ -3835,14 +3913,22 @@ export declare namespace Place {
|
|
|
3835
3913
|
const filterSensitiveLog: (obj: Place) => any;
|
|
3836
3914
|
}
|
|
3837
3915
|
/**
|
|
3838
|
-
* <p>
|
|
3839
|
-
* from a dataset configured in the place index resource.</p>
|
|
3916
|
+
* <p>Contains a search result from a position search query that is run on a place index resource.</p>
|
|
3840
3917
|
*/
|
|
3841
3918
|
export interface SearchForPositionResult {
|
|
3842
3919
|
/**
|
|
3843
|
-
* <p>
|
|
3920
|
+
* <p>Details about the search result, such as its address and position.</p>
|
|
3844
3921
|
*/
|
|
3845
3922
|
Place: Place | undefined;
|
|
3923
|
+
/**
|
|
3924
|
+
* <p>The distance in meters of a great-circle arc between the query position and the
|
|
3925
|
+
* result.</p>
|
|
3926
|
+
* <note>
|
|
3927
|
+
* <p>A great-circle arc is the shortest path on a sphere, in this case the
|
|
3928
|
+
* Earth. This returns the shortest distance between two locations.</p>
|
|
3929
|
+
* </note>
|
|
3930
|
+
*/
|
|
3931
|
+
Distance: number | undefined;
|
|
3846
3932
|
}
|
|
3847
3933
|
export declare namespace SearchForPositionResult {
|
|
3848
3934
|
/**
|
|
@@ -3851,32 +3937,39 @@ export declare namespace SearchForPositionResult {
|
|
|
3851
3937
|
const filterSensitiveLog: (obj: SearchForPositionResult) => any;
|
|
3852
3938
|
}
|
|
3853
3939
|
/**
|
|
3854
|
-
* <p>A summary of the
|
|
3940
|
+
* <p>A summary of the request sent by using <code>SearchPlaceIndexForPosition</code>.</p>
|
|
3855
3941
|
*/
|
|
3856
3942
|
export interface SearchPlaceIndexForPositionSummary {
|
|
3857
3943
|
/**
|
|
3858
|
-
* <p>The position
|
|
3944
|
+
* <p>The position specified in the request.</p>
|
|
3859
3945
|
*/
|
|
3860
3946
|
Position: number[] | undefined;
|
|
3861
3947
|
/**
|
|
3862
|
-
* <p>
|
|
3948
|
+
* <p>Contains the optional result count limit that is specified in the request.</p>
|
|
3863
3949
|
* <p>Default value: <code>50</code>
|
|
3864
3950
|
* </p>
|
|
3865
3951
|
*/
|
|
3866
3952
|
MaxResults?: number;
|
|
3867
3953
|
/**
|
|
3868
|
-
* <p>The data provider
|
|
3954
|
+
* <p>The geospatial data provider attached to the place index resource specified in the request.
|
|
3955
|
+
* Values can be one of the following:</p>
|
|
3869
3956
|
* <ul>
|
|
3870
3957
|
* <li>
|
|
3871
3958
|
* <p>Esri</p>
|
|
3872
3959
|
* </li>
|
|
3873
3960
|
* <li>
|
|
3874
|
-
* <p>
|
|
3961
|
+
* <p>Here</p>
|
|
3875
3962
|
* </li>
|
|
3876
3963
|
* </ul>
|
|
3877
|
-
* <p>For
|
|
3964
|
+
* <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
3965
|
*/
|
|
3879
3966
|
DataSource: string | undefined;
|
|
3967
|
+
/**
|
|
3968
|
+
* <p>The preferred language used to return results. Matches the language in the request.
|
|
3969
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
3970
|
+
* <code>en</code> for English.</p>
|
|
3971
|
+
*/
|
|
3972
|
+
Language?: string;
|
|
3880
3973
|
}
|
|
3881
3974
|
export declare namespace SearchPlaceIndexForPositionSummary {
|
|
3882
3975
|
/**
|
|
@@ -3886,7 +3979,9 @@ export declare namespace SearchPlaceIndexForPositionSummary {
|
|
|
3886
3979
|
}
|
|
3887
3980
|
export interface SearchPlaceIndexForPositionResponse {
|
|
3888
3981
|
/**
|
|
3889
|
-
* <p>Contains a summary of the request
|
|
3982
|
+
* <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
|
|
3983
|
+
* <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of the place index.
|
|
3984
|
+
* </p>
|
|
3890
3985
|
*/
|
|
3891
3986
|
Summary: SearchPlaceIndexForPositionSummary | undefined;
|
|
3892
3987
|
/**
|
|
@@ -3908,61 +4003,49 @@ export interface SearchPlaceIndexForTextRequest {
|
|
|
3908
4003
|
IndexName: string | undefined;
|
|
3909
4004
|
/**
|
|
3910
4005
|
* <p>The address, name,
|
|
3911
|
-
* city, or region to be used in the search
|
|
4006
|
+
* city, or region to be used in the search in free-form text format. For example, <code>123 Any
|
|
3912
4007
|
* Street</code>.</p>
|
|
3913
4008
|
*/
|
|
3914
4009
|
Text: string | undefined;
|
|
3915
4010
|
/**
|
|
3916
|
-
* <p>
|
|
3917
|
-
*
|
|
3918
|
-
*
|
|
3919
|
-
*
|
|
3920
|
-
*
|
|
3921
|
-
*
|
|
3922
|
-
*
|
|
3923
|
-
*
|
|
3924
|
-
*
|
|
3925
|
-
*
|
|
3926
|
-
*
|
|
4011
|
+
* <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
|
|
4012
|
+
* <p>
|
|
4013
|
+
* If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the
|
|
4014
|
+
* second number represents the Y coordinate, or latitude.</p>
|
|
4015
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
|
|
4016
|
+
* longitude <code>-123.1174</code> and
|
|
4017
|
+
* latitude <code>49.2847</code>.</p>
|
|
4018
|
+
* <note>
|
|
4019
|
+
* <p>
|
|
4020
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options
|
|
4021
|
+
* results in an error.
|
|
4022
|
+
* </p>
|
|
4023
|
+
* </note>
|
|
3927
4024
|
*/
|
|
3928
4025
|
BiasPosition?: number[];
|
|
3929
4026
|
/**
|
|
3930
|
-
* <p>
|
|
3931
|
-
*
|
|
3932
|
-
*
|
|
3933
|
-
*
|
|
3934
|
-
*
|
|
3935
|
-
*
|
|
3936
|
-
*
|
|
3937
|
-
*
|
|
3938
|
-
*
|
|
3939
|
-
*
|
|
3940
|
-
*
|
|
3941
|
-
*
|
|
3942
|
-
* </ul>
|
|
3943
|
-
* <p>For example, <code>bbox=xLongitudeSW&bbox=yLatitudeSW</code>.</p>
|
|
3944
|
-
* <p>The next <code>bbox</code> parameters describe the upper northeast corner:</p>
|
|
3945
|
-
* <ul>
|
|
3946
|
-
* <li>
|
|
3947
|
-
* <p>The third <code>bbox</code> position is the X coordinate, or longitude of the
|
|
3948
|
-
* upper northeast corner.</p>
|
|
3949
|
-
* </li>
|
|
3950
|
-
* <li>
|
|
3951
|
-
* <p>The fourth <code>bbox</code> position is the Y coordinate, or longitude of the
|
|
3952
|
-
* upper northeast corner.</p>
|
|
3953
|
-
* </li>
|
|
3954
|
-
* </ul>
|
|
3955
|
-
* <p>For example, <code>bbox=xLongitudeNE&bbox=yLatitudeNE</code>
|
|
4027
|
+
* <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
|
|
4028
|
+
* <p>
|
|
4029
|
+
* If provided, this parameter must contain a total of four consecutive numbers in two pairs.
|
|
4030
|
+
* The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
|
|
4031
|
+
* of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
|
|
4032
|
+
* of the northeast corner of the bounding box.</p>
|
|
4033
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents
|
|
4034
|
+
* a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>,
|
|
4035
|
+
* and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>
|
|
4036
|
+
* <note>
|
|
4037
|
+
* <p>
|
|
4038
|
+
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.
|
|
3956
4039
|
* </p>
|
|
4040
|
+
* </note>
|
|
3957
4041
|
*/
|
|
3958
4042
|
FilterBBox?: number[];
|
|
3959
4043
|
/**
|
|
3960
|
-
* <p>
|
|
3961
|
-
* parameter.</p>
|
|
4044
|
+
* <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
|
|
3962
4045
|
* <ul>
|
|
3963
4046
|
* <li>
|
|
3964
|
-
* <p>
|
|
3965
|
-
* country
|
|
4047
|
+
* <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
|
|
4048
|
+
* country codes. For example, Australia uses three upper-case characters:
|
|
3966
4049
|
* <code>AUS</code>.</p>
|
|
3967
4050
|
* </li>
|
|
3968
4051
|
* </ul>
|
|
@@ -3974,6 +4057,14 @@ export interface SearchPlaceIndexForTextRequest {
|
|
|
3974
4057
|
* </p>
|
|
3975
4058
|
*/
|
|
3976
4059
|
MaxResults?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* <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,
|
|
4062
|
+
* <code>en</code> for English.</p>
|
|
4063
|
+
* <p>This setting affects the languages used in the results. It does not change which
|
|
4064
|
+
* results are returned. If the language is not specified, or not supported for a
|
|
4065
|
+
* particular result, the partner automatically chooses a language for the result.</p>
|
|
4066
|
+
*/
|
|
4067
|
+
Language?: string;
|
|
3977
4068
|
}
|
|
3978
4069
|
export declare namespace SearchPlaceIndexForTextRequest {
|
|
3979
4070
|
/**
|
|
@@ -3982,14 +4073,30 @@ export declare namespace SearchPlaceIndexForTextRequest {
|
|
|
3982
4073
|
const filterSensitiveLog: (obj: SearchPlaceIndexForTextRequest) => any;
|
|
3983
4074
|
}
|
|
3984
4075
|
/**
|
|
3985
|
-
* <p>Contains
|
|
3986
|
-
* <code>SearchPlaceIndexForText</code>.</p>
|
|
4076
|
+
* <p>Contains a search result from a text search query that is run on a place index resource.</p>
|
|
3987
4077
|
*/
|
|
3988
4078
|
export interface SearchForTextResult {
|
|
3989
4079
|
/**
|
|
3990
|
-
* <p>
|
|
4080
|
+
* <p>Details about the search result, such as its address and position.</p>
|
|
3991
4081
|
*/
|
|
3992
4082
|
Place: Place | undefined;
|
|
4083
|
+
/**
|
|
4084
|
+
* <p>The distance in meters of a great-circle arc between the bias position specified
|
|
4085
|
+
* and the result. <code>Distance</code> will be returned only if a bias position was
|
|
4086
|
+
* specified in the query.</p>
|
|
4087
|
+
* <note>
|
|
4088
|
+
* <p>A great-circle arc is the shortest path on a sphere, in this case the
|
|
4089
|
+
* Earth. This returns the shortest distance between two locations.</p>
|
|
4090
|
+
* </note>
|
|
4091
|
+
*/
|
|
4092
|
+
Distance?: number;
|
|
4093
|
+
/**
|
|
4094
|
+
* <p>The relative confidence in the match for a result among the results returned. For
|
|
4095
|
+
* example, if more fields for an address match (including house number, street, city,
|
|
4096
|
+
* country/region, and postal code), the relevance score is closer to 1.</p>
|
|
4097
|
+
* <p>Returned only when the partner selected is Esri.</p>
|
|
4098
|
+
*/
|
|
4099
|
+
Relevance?: number;
|
|
3993
4100
|
}
|
|
3994
4101
|
export declare namespace SearchForTextResult {
|
|
3995
4102
|
/**
|
|
@@ -3998,50 +4105,57 @@ export declare namespace SearchForTextResult {
|
|
|
3998
4105
|
const filterSensitiveLog: (obj: SearchForTextResult) => any;
|
|
3999
4106
|
}
|
|
4000
4107
|
/**
|
|
4001
|
-
* <p>A summary of the
|
|
4108
|
+
* <p>A summary of the request sent by using <code>SearchPlaceIndexForText</code>.</p>
|
|
4002
4109
|
*/
|
|
4003
4110
|
export interface SearchPlaceIndexForTextSummary {
|
|
4004
4111
|
/**
|
|
4005
|
-
* <p>The
|
|
4006
|
-
* format. For example, <code>Vancouver</code>.</p>
|
|
4112
|
+
* <p>The search text specified in the request.</p>
|
|
4007
4113
|
*/
|
|
4008
4114
|
Text: string | undefined;
|
|
4009
4115
|
/**
|
|
4010
|
-
* <p>Contains the coordinates for the bias position
|
|
4116
|
+
* <p>Contains the coordinates for the optional bias position specified in the request.</p>
|
|
4011
4117
|
*/
|
|
4012
4118
|
BiasPosition?: number[];
|
|
4013
4119
|
/**
|
|
4014
|
-
* <p>Contains the coordinates for the optional bounding box
|
|
4015
|
-
* geocoding request.</p>
|
|
4120
|
+
* <p>Contains the coordinates for the optional bounding box specified in the request.</p>
|
|
4016
4121
|
*/
|
|
4017
4122
|
FilterBBox?: number[];
|
|
4018
4123
|
/**
|
|
4019
|
-
* <p>Contains the country filter
|
|
4124
|
+
* <p>Contains the optional country filter specified in the request.</p>
|
|
4020
4125
|
*/
|
|
4021
4126
|
FilterCountries?: string[];
|
|
4022
4127
|
/**
|
|
4023
|
-
* <p>Contains the
|
|
4128
|
+
* <p>Contains the optional result count limit specified in the request.</p>
|
|
4024
4129
|
*/
|
|
4025
4130
|
MaxResults?: number;
|
|
4026
4131
|
/**
|
|
4027
|
-
* <p>
|
|
4028
|
-
*
|
|
4029
|
-
* <code>FilterBBox</code
|
|
4132
|
+
* <p>The bounding box that fully contains all search results.</p>
|
|
4133
|
+
* <note>
|
|
4134
|
+
* <p>If you specified the optional <code>FilterBBox</code> parameter in the request, <code>ResultBBox</code>
|
|
4135
|
+
* is contained within <code>FilterBBox</code>.</p>
|
|
4136
|
+
* </note>
|
|
4030
4137
|
*/
|
|
4031
4138
|
ResultBBox?: number[];
|
|
4032
4139
|
/**
|
|
4033
|
-
* <p>The data provider
|
|
4140
|
+
* <p>The geospatial data provider attached to the place index resource specified in the request.
|
|
4141
|
+
* Values can be one of the following:</p>
|
|
4034
4142
|
* <ul>
|
|
4035
4143
|
* <li>
|
|
4036
4144
|
* <p>Esri</p>
|
|
4037
4145
|
* </li>
|
|
4038
4146
|
* <li>
|
|
4039
|
-
* <p>
|
|
4147
|
+
* <p>Here</p>
|
|
4040
4148
|
* </li>
|
|
4041
4149
|
* </ul>
|
|
4042
|
-
* <p>For
|
|
4150
|
+
* <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
4151
|
*/
|
|
4044
4152
|
DataSource: string | undefined;
|
|
4153
|
+
/**
|
|
4154
|
+
* <p>The preferred language used to return results. Matches the language in the request.
|
|
4155
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
4156
|
+
* <code>en</code> for English.</p>
|
|
4157
|
+
*/
|
|
4158
|
+
Language?: string;
|
|
4045
4159
|
}
|
|
4046
4160
|
export declare namespace SearchPlaceIndexForTextSummary {
|
|
4047
4161
|
/**
|
|
@@ -4051,13 +4165,15 @@ export declare namespace SearchPlaceIndexForTextSummary {
|
|
|
4051
4165
|
}
|
|
4052
4166
|
export interface SearchPlaceIndexForTextResponse {
|
|
4053
4167
|
/**
|
|
4054
|
-
* <p>Contains a summary of the request.
|
|
4055
|
-
* <code>
|
|
4056
|
-
*
|
|
4168
|
+
* <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,
|
|
4169
|
+
* <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,
|
|
4170
|
+
* and <code>Text</code>. Also includes the <code>DataSource</code> of the place index and
|
|
4171
|
+
* the bounding box, <code>ResultBBox</code>, which surrounds the search results.
|
|
4172
|
+
* </p>
|
|
4057
4173
|
*/
|
|
4058
4174
|
Summary: SearchPlaceIndexForTextSummary | undefined;
|
|
4059
4175
|
/**
|
|
4060
|
-
* <p>A list of Places
|
|
4176
|
+
* <p>A list of Places matching the input text. Each result contains additional
|
|
4061
4177
|
* information about the specific point of interest. </p>
|
|
4062
4178
|
*/
|
|
4063
4179
|
Results: SearchForTextResult[] | undefined;
|