@aws-sdk/client-location 3.85.0 → 3.92.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 +27 -0
- package/dist-cjs/pagination/ListGeofencesPaginator.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1 -0
- package/dist-es/pagination/ListGeofencesPaginator.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -1
- package/dist-types/Location.d.ts +65 -54
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +4 -0
- package/dist-types/commands/CalculateRouteCommand.d.ts +7 -5
- package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +19 -17
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +9 -8
- package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/DeletePlaceIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +1 -1
- package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +2 -2
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +11 -9
- package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +413 -350
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +3 -3
|
@@ -815,11 +815,13 @@ export declare namespace CalculateRouteTruckModeOptions {
|
|
|
815
815
|
}
|
|
816
816
|
export interface CalculateRouteRequest {
|
|
817
817
|
/**
|
|
818
|
-
* <p>The name of the route calculator resource that you want to use to calculate the route.
|
|
818
|
+
* <p>The name of the route calculator resource that you want to use to calculate the route.
|
|
819
|
+
* </p>
|
|
819
820
|
*/
|
|
820
821
|
CalculatorName: string | undefined;
|
|
821
822
|
/**
|
|
822
|
-
* <p>The start position for the route. Defined in <a href="https://earth-info.nga.mil/
|
|
823
|
+
* <p>The start position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic
|
|
824
|
+
* System (WGS 84)</a> format:
|
|
823
825
|
* <code>[longitude, latitude]</code>.</p>
|
|
824
826
|
* <ul>
|
|
825
827
|
* <li>
|
|
@@ -828,16 +830,18 @@ export interface CalculateRouteRequest {
|
|
|
828
830
|
* </li>
|
|
829
831
|
* </ul>
|
|
830
832
|
* <note>
|
|
831
|
-
* <p>If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the
|
|
832
|
-
*
|
|
833
|
-
* specifying a route that is longer than 400 km returns a <code>400
|
|
833
|
+
* <p>If you specify a departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
834
|
+
* to the nearest road</a>. If Esri is the provider for your route calculator,
|
|
835
|
+
* specifying a route that is longer than 400 km returns a <code>400
|
|
836
|
+
* RoutesValidationException</code> error.</p>
|
|
834
837
|
* </note>
|
|
835
838
|
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
836
839
|
* </p>
|
|
837
840
|
*/
|
|
838
841
|
DeparturePosition: number[] | undefined;
|
|
839
842
|
/**
|
|
840
|
-
* <p>The finish position for the route. Defined in <a href="https://earth-info.nga.mil/
|
|
843
|
+
* <p>The finish position for the route. Defined in <a href="https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84">World Geodetic
|
|
844
|
+
* System (WGS 84)</a> format:
|
|
841
845
|
* <code>[longitude, latitude]</code>.</p>
|
|
842
846
|
* <ul>
|
|
843
847
|
* <li>
|
|
@@ -846,7 +850,8 @@ export interface CalculateRouteRequest {
|
|
|
846
850
|
* </li>
|
|
847
851
|
* </ul>
|
|
848
852
|
* <note>
|
|
849
|
-
* <p>If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
853
|
+
* <p>If you specify a destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
854
|
+
* to the nearest road</a>. </p>
|
|
850
855
|
* </note>
|
|
851
856
|
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
852
857
|
* </p>
|
|
@@ -864,11 +869,13 @@ export interface CalculateRouteRequest {
|
|
|
864
869
|
* </li>
|
|
865
870
|
* </ul>
|
|
866
871
|
* <note>
|
|
867
|
-
* <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
872
|
+
* <p>If you specify a waypoint position that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">moves the position
|
|
873
|
+
* to the nearest road</a>. </p>
|
|
868
874
|
* <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
|
|
869
875
|
* error.</p>
|
|
870
|
-
* <p>If Esri is the provider for your route calculator, specifying a
|
|
871
|
-
*
|
|
876
|
+
* <p>If Esri is the provider for your route calculator, specifying a route that is
|
|
877
|
+
* longer than 400 km returns a <code>400 RoutesValidationException</code>
|
|
878
|
+
* error.</p>
|
|
872
879
|
* </note>
|
|
873
880
|
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
874
881
|
* </p>
|
|
@@ -1027,7 +1034,8 @@ export declare namespace Step {
|
|
|
1027
1034
|
* number of legs returned corresponds to one fewer than the total number of positions in
|
|
1028
1035
|
* the request. </p>
|
|
1029
1036
|
* <p>For example, a route with a departure position and destination position returns one
|
|
1030
|
-
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
1037
|
+
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
1038
|
+
* road</a>:</p>
|
|
1031
1039
|
* <ul>
|
|
1032
1040
|
* <li>
|
|
1033
1041
|
* <p>The <code>StartPosition</code> is the departure position.</p>
|
|
@@ -1054,7 +1062,8 @@ export interface Leg {
|
|
|
1054
1062
|
* <p>The starting position of the leg. Follows the format
|
|
1055
1063
|
* <code>[longitude,latitude]</code>.</p>
|
|
1056
1064
|
* <note>
|
|
1057
|
-
* <p>If the <code>StartPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a
|
|
1065
|
+
* <p>If the <code>StartPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a
|
|
1066
|
+
* nearby road</a>. </p>
|
|
1058
1067
|
* </note>
|
|
1059
1068
|
*/
|
|
1060
1069
|
StartPosition: number[] | undefined;
|
|
@@ -1062,7 +1071,8 @@ export interface Leg {
|
|
|
1062
1071
|
* <p>The terminating position of the leg. Follows the format
|
|
1063
1072
|
* <code>[longitude,latitude]</code>.</p>
|
|
1064
1073
|
* <note>
|
|
1065
|
-
* <p>If the <code>EndPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html">snapped to a nearby
|
|
1074
|
+
* <p>If the <code>EndPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/nap-to-nearby-road.html">snapped to a nearby
|
|
1075
|
+
* road</a>. </p>
|
|
1066
1076
|
* </note>
|
|
1067
1077
|
*/
|
|
1068
1078
|
EndPosition: number[] | undefined;
|
|
@@ -1153,9 +1163,9 @@ export interface CalculateRouteSummary {
|
|
|
1153
1163
|
* <p>The total distance covered by the route. The sum of the distance travelled between
|
|
1154
1164
|
* every stop on the route.</p>
|
|
1155
1165
|
* <note>
|
|
1156
|
-
* <p>If Esri is the data source for the route calculator, the route distance can’t
|
|
1157
|
-
*
|
|
1158
|
-
*
|
|
1166
|
+
* <p>If Esri is the data source for the route calculator, the route distance can’t be
|
|
1167
|
+
* greater than 400 km. If the route exceeds 400 km, the response is a <code>400
|
|
1168
|
+
* RoutesValidationException</code> error.</p>
|
|
1159
1169
|
* </note>
|
|
1160
1170
|
*/
|
|
1161
1171
|
Distance: number | undefined;
|
|
@@ -1188,7 +1198,8 @@ export interface CalculateRouteResponse {
|
|
|
1188
1198
|
* number of legs returned corresponds to one fewer than the total number of positions in
|
|
1189
1199
|
* the request. </p>
|
|
1190
1200
|
* <p>For example, a route with a departure position and destination position returns one
|
|
1191
|
-
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
1201
|
+
* leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby
|
|
1202
|
+
* road</a>:</p>
|
|
1192
1203
|
* <ul>
|
|
1193
1204
|
* <li>
|
|
1194
1205
|
* <p>The <code>StartPosition</code> is the departure position.</p>
|
|
@@ -1226,24 +1237,25 @@ export declare namespace CalculateRouteResponse {
|
|
|
1226
1237
|
}
|
|
1227
1238
|
export interface CalculateRouteMatrixRequest {
|
|
1228
1239
|
/**
|
|
1229
|
-
* <p>The name of the route calculator resource that you want to use to calculate the route
|
|
1240
|
+
* <p>The name of the route calculator resource that you want to use to calculate the route
|
|
1241
|
+
* matrix. </p>
|
|
1230
1242
|
*/
|
|
1231
1243
|
CalculatorName: string | undefined;
|
|
1232
1244
|
/**
|
|
1233
1245
|
* <p>The list of departure (origin) positions for the route matrix. An array of points,
|
|
1234
1246
|
* each of which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
|
|
1235
|
-
*
|
|
1247
|
+
* <code>[longitude, latitude]</code>. For example, <code>[-123.115,
|
|
1236
1248
|
* 49.285]</code>.</p>
|
|
1237
1249
|
* <important>
|
|
1238
|
-
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1239
|
-
* restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits">
|
|
1240
|
-
*
|
|
1250
|
+
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1251
|
+
* be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the <i>Amazon Location Service Developer
|
|
1252
|
+
* Guide</i>.</p>
|
|
1241
1253
|
* </important>
|
|
1242
1254
|
* <note>
|
|
1243
1255
|
* <p>For route calculators that use Esri as the data provider, if you specify a
|
|
1244
|
-
* departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1245
|
-
*
|
|
1246
|
-
* <code>SnappedDeparturePositions</code>.</p>
|
|
1256
|
+
* departure that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1257
|
+
* position to the nearest road</a>. The snapped value is available in the
|
|
1258
|
+
* result in <code>SnappedDeparturePositions</code>.</p>
|
|
1247
1259
|
* </note>
|
|
1248
1260
|
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
1249
1261
|
* </p>
|
|
@@ -1252,19 +1264,19 @@ export interface CalculateRouteMatrixRequest {
|
|
|
1252
1264
|
/**
|
|
1253
1265
|
* <p>The list of destination positions for the route matrix. An array of points, each of
|
|
1254
1266
|
* which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
|
|
1255
|
-
*
|
|
1267
|
+
* <code>[longitude, latitude]</code>. For example, <code>[-122.339,
|
|
1256
1268
|
* 47.615]</code>
|
|
1257
1269
|
* </p>
|
|
1258
1270
|
* <important>
|
|
1259
|
-
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1260
|
-
* restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits">
|
|
1261
|
-
*
|
|
1271
|
+
* <p>Depending on the data provider selected in the route calculator resource there may
|
|
1272
|
+
* be additional restrictions on the inputs you can choose. See <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits"> Position restrictions</a> in the <i>Amazon Location Service Developer
|
|
1273
|
+
* Guide</i>.</p>
|
|
1262
1274
|
* </important>
|
|
1263
1275
|
* <note>
|
|
1264
1276
|
* <p>For route calculators that use Esri as the data provider, if you specify a
|
|
1265
|
-
* destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1266
|
-
*
|
|
1267
|
-
* <code>SnappedDestinationPositions</code>.</p>
|
|
1277
|
+
* destination that's not located on a road, Amazon Location <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html"> moves the
|
|
1278
|
+
* position to the nearest road</a>. The snapped value is available in the
|
|
1279
|
+
* result in <code>SnappedDestinationPositions</code>.</p>
|
|
1268
1280
|
* </note>
|
|
1269
1281
|
* <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
|
|
1270
1282
|
* </p>
|
|
@@ -1348,48 +1360,48 @@ export declare namespace CalculateRouteMatrixRequest {
|
|
|
1348
1360
|
export declare type RouteMatrixErrorCode = "DeparturePositionNotFound" | "DestinationPositionNotFound" | "OtherValidationError" | "PositionsNotFound" | "RouteNotFound" | "RouteTooLong";
|
|
1349
1361
|
/**
|
|
1350
1362
|
* <p>An error corresponding to the calculation of a route between the
|
|
1351
|
-
*
|
|
1363
|
+
* <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
|
|
1352
1364
|
* <p>The error code can be one of the following:</p>
|
|
1353
1365
|
* <ul>
|
|
1354
1366
|
* <li>
|
|
1355
1367
|
* <p>
|
|
1356
|
-
* <code>RouteNotFound</code> - Unable to find a
|
|
1357
|
-
*
|
|
1368
|
+
* <code>RouteNotFound</code> - Unable to find a valid route with the given
|
|
1369
|
+
* parameters.</p>
|
|
1358
1370
|
* </li>
|
|
1359
1371
|
* </ul>
|
|
1360
1372
|
* <ul>
|
|
1361
1373
|
* <li>
|
|
1362
1374
|
* <p>
|
|
1363
|
-
* <code>RouteTooLong</code> - Route calculation went
|
|
1364
|
-
*
|
|
1375
|
+
* <code>RouteTooLong</code> - Route calculation went beyond the maximum size of
|
|
1376
|
+
* a route and was terminated before completion.</p>
|
|
1365
1377
|
* </li>
|
|
1366
1378
|
* </ul>
|
|
1367
1379
|
* <ul>
|
|
1368
1380
|
* <li>
|
|
1369
1381
|
* <p>
|
|
1370
|
-
* <code>PositionsNotFound</code> - One or more of the
|
|
1371
|
-
*
|
|
1382
|
+
* <code>PositionsNotFound</code> - One or more of the input positions were not
|
|
1383
|
+
* found on the route network.</p>
|
|
1372
1384
|
* </li>
|
|
1373
1385
|
* </ul>
|
|
1374
1386
|
* <ul>
|
|
1375
1387
|
* <li>
|
|
1376
1388
|
* <p>
|
|
1377
|
-
* <code>DestinationPositionNotFound</code> - The
|
|
1378
|
-
*
|
|
1389
|
+
* <code>DestinationPositionNotFound</code> - The destination position was not
|
|
1390
|
+
* found on the route network.</p>
|
|
1379
1391
|
* </li>
|
|
1380
1392
|
* </ul>
|
|
1381
1393
|
* <ul>
|
|
1382
1394
|
* <li>
|
|
1383
1395
|
* <p>
|
|
1384
|
-
* <code>DeparturePositionNotFound</code> - The
|
|
1385
|
-
*
|
|
1396
|
+
* <code>DeparturePositionNotFound</code> - The departure position was not found
|
|
1397
|
+
* on the route network.</p>
|
|
1386
1398
|
* </li>
|
|
1387
1399
|
* </ul>
|
|
1388
1400
|
* <ul>
|
|
1389
1401
|
* <li>
|
|
1390
1402
|
* <p>
|
|
1391
|
-
* <code>OtherValidationError</code> - The given inputs were not valid or a
|
|
1392
|
-
*
|
|
1403
|
+
* <code>OtherValidationError</code> - The given inputs were not valid or a route
|
|
1404
|
+
* was not found. More information is given in the error
|
|
1393
1405
|
* <code>Message</code>
|
|
1394
1406
|
* </p>
|
|
1395
1407
|
* </li>
|
|
@@ -1426,7 +1438,7 @@ export interface RouteMatrixEntry {
|
|
|
1426
1438
|
DurationSeconds?: number;
|
|
1427
1439
|
/**
|
|
1428
1440
|
* <p>An error corresponding to the calculation of a route between the
|
|
1429
|
-
*
|
|
1441
|
+
* <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
|
|
1430
1442
|
*/
|
|
1431
1443
|
Error?: RouteMatrixEntryError;
|
|
1432
1444
|
}
|
|
@@ -1455,16 +1467,19 @@ export interface CalculateRouteMatrixSummary {
|
|
|
1455
1467
|
* </p>
|
|
1456
1468
|
* </li>
|
|
1457
1469
|
* </ul>
|
|
1458
|
-
* <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
|
|
1470
|
+
* <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
|
|
1471
|
+
* providers</a>.</p>
|
|
1459
1472
|
*/
|
|
1460
1473
|
DataSource: string | undefined;
|
|
1461
1474
|
/**
|
|
1462
|
-
* <p>The count of cells in the route matrix. Equal to the number of
|
|
1463
|
-
*
|
|
1475
|
+
* <p>The count of cells in the route matrix. Equal to the number of
|
|
1476
|
+
* <code>DeparturePositions</code> multiplied by the number of
|
|
1477
|
+
* <code>DestinationPositions</code>.</p>
|
|
1464
1478
|
*/
|
|
1465
1479
|
RouteCount: number | undefined;
|
|
1466
1480
|
/**
|
|
1467
|
-
* <p>The count of error results in the route matrix. If this number is 0, all routes were
|
|
1481
|
+
* <p>The count of error results in the route matrix. If this number is 0, all routes were
|
|
1482
|
+
* calculated successfully.</p>
|
|
1468
1483
|
*/
|
|
1469
1484
|
ErrorCount: number | undefined;
|
|
1470
1485
|
/**
|
|
@@ -1484,27 +1499,28 @@ export declare namespace CalculateRouteMatrixSummary {
|
|
|
1484
1499
|
export interface CalculateRouteMatrixResponse {
|
|
1485
1500
|
/**
|
|
1486
1501
|
* <p>The calculated route matrix containing the results for all pairs of
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
*
|
|
1490
|
-
*
|
|
1491
|
-
* </p>
|
|
1502
|
+
* <code>DeparturePositions</code> to <code>DestinationPositions</code>. Each row
|
|
1503
|
+
* corresponds to one entry in <code>DeparturePositions</code>. Each entry in the row
|
|
1504
|
+
* corresponds to the route from that entry in <code>DeparturePositions</code> to an entry
|
|
1505
|
+
* in <code>DestinationPositions</code>. </p>
|
|
1492
1506
|
*/
|
|
1493
1507
|
RouteMatrix: RouteMatrixEntry[][] | undefined;
|
|
1494
1508
|
/**
|
|
1495
|
-
* <p>For routes calculated using an Esri route calculator resource, departure positions
|
|
1496
|
-
*
|
|
1497
|
-
*
|
|
1509
|
+
* <p>For routes calculated using an Esri route calculator resource, departure positions are
|
|
1510
|
+
* snapped to the closest road. For Esri route calculator resources, this returns the list
|
|
1511
|
+
* of departure/origin positions used for calculation of the
|
|
1498
1512
|
* <code>RouteMatrix</code>.</p>
|
|
1499
1513
|
*/
|
|
1500
1514
|
SnappedDeparturePositions?: number[][];
|
|
1501
1515
|
/**
|
|
1502
|
-
* <p>The list of destination positions for the route matrix used for calculation of the
|
|
1516
|
+
* <p>The list of destination positions for the route matrix used for calculation of the
|
|
1517
|
+
* <code>RouteMatrix</code>.</p>
|
|
1503
1518
|
*/
|
|
1504
1519
|
SnappedDestinationPositions?: number[][];
|
|
1505
1520
|
/**
|
|
1506
1521
|
* <p>Contains information about the route matrix, <code>DataSource</code>,
|
|
1507
|
-
*
|
|
1522
|
+
* <code>DistanceUnit</code>, <code>RouteCount</code> and
|
|
1523
|
+
* <code>ErrorCount</code>.</p>
|
|
1508
1524
|
*/
|
|
1509
1525
|
Summary: CalculateRouteMatrixSummary | undefined;
|
|
1510
1526
|
}
|
|
@@ -1802,39 +1818,40 @@ export declare namespace CreateMapResponse {
|
|
|
1802
1818
|
export declare type IntendedUse = "SingleUse" | "Storage";
|
|
1803
1819
|
/**
|
|
1804
1820
|
* <p>Specifies the data storage option chosen for requesting Places.</p>
|
|
1805
|
-
*
|
|
1821
|
+
* <important>
|
|
1806
1822
|
* <p>When using Amazon Location Places:</p>
|
|
1807
1823
|
* <ul>
|
|
1808
1824
|
* <li>
|
|
1809
|
-
*
|
|
1810
|
-
*
|
|
1811
|
-
*
|
|
1812
|
-
*
|
|
1825
|
+
* <p>If using HERE Technologies as a data provider, you can't store results for
|
|
1826
|
+
* locations in Japan by setting <code>IntendedUse</code> to
|
|
1827
|
+
* <code>Storage</code>. parameter.</p>
|
|
1828
|
+
* </li>
|
|
1813
1829
|
* <li>
|
|
1814
|
-
*
|
|
1815
|
-
*
|
|
1816
|
-
*
|
|
1817
|
-
*
|
|
1830
|
+
* <p>Under the <code>MobileAssetTracking</code> or
|
|
1831
|
+
* <code>MobilAssetManagement</code> pricing plan, you can't store results
|
|
1832
|
+
* from your place index resources by setting <code>IntendedUse</code> to
|
|
1833
|
+
* <code>Storage</code>. This returns a validation exception error.</p>
|
|
1834
|
+
* </li>
|
|
1818
1835
|
* </ul>
|
|
1819
|
-
* <p>For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for
|
|
1820
|
-
*
|
|
1821
|
-
* </important>
|
|
1836
|
+
* <p>For more information, see the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a> for Amazon Location Service.</p>
|
|
1837
|
+
* </important>
|
|
1822
1838
|
*/
|
|
1823
1839
|
export interface DataSourceConfiguration {
|
|
1824
1840
|
/**
|
|
1825
1841
|
* <p>Specifies how the results of an operation will be stored by the caller. </p>
|
|
1826
|
-
*
|
|
1827
|
-
*
|
|
1842
|
+
* <p>Valid values include:</p>
|
|
1843
|
+
* <ul>
|
|
1828
1844
|
* <li>
|
|
1829
|
-
*
|
|
1845
|
+
* <p>
|
|
1830
1846
|
* <code>SingleUse</code> specifies that the results won't be stored. </p>
|
|
1831
1847
|
* </li>
|
|
1832
1848
|
* <li>
|
|
1833
|
-
*
|
|
1834
|
-
* <code>Storage</code> specifies that the result can be cached or stored in a
|
|
1849
|
+
* <p>
|
|
1850
|
+
* <code>Storage</code> specifies that the result can be cached or stored in a
|
|
1851
|
+
* database.</p>
|
|
1835
1852
|
* </li>
|
|
1836
1853
|
* </ul>
|
|
1837
|
-
*
|
|
1854
|
+
* <p>Default value: <code>SingleUse</code>
|
|
1838
1855
|
* </p>
|
|
1839
1856
|
*/
|
|
1840
1857
|
IntendedUse?: IntendedUse | string;
|
|
@@ -1848,55 +1865,54 @@ export declare namespace DataSourceConfiguration {
|
|
|
1848
1865
|
export interface CreatePlaceIndexRequest {
|
|
1849
1866
|
/**
|
|
1850
1867
|
* <p>The name of the place index resource. </p>
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1868
|
+
* <p>Requirements:</p>
|
|
1869
|
+
* <ul>
|
|
1853
1870
|
* <li>
|
|
1854
|
-
*
|
|
1855
|
-
*
|
|
1871
|
+
* <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods
|
|
1872
|
+
* (.), and underscores (_).</p>
|
|
1856
1873
|
* </li>
|
|
1857
1874
|
* <li>
|
|
1858
|
-
*
|
|
1875
|
+
* <p>Must be a unique place index resource name.</p>
|
|
1859
1876
|
* </li>
|
|
1860
1877
|
* <li>
|
|
1861
|
-
*
|
|
1878
|
+
* <p>No spaces allowed. For example, <code>ExamplePlaceIndex</code>.</p>
|
|
1862
1879
|
* </li>
|
|
1863
1880
|
* </ul>
|
|
1864
1881
|
*/
|
|
1865
1882
|
IndexName: string | undefined;
|
|
1866
1883
|
/**
|
|
1867
1884
|
* <p>Specifies the geospatial data provider for the new place index.</p>
|
|
1868
|
-
*
|
|
1869
|
-
* <p>This field is case-sensitive. Enter the valid values as shown. For example,
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1872
|
-
*
|
|
1873
|
-
*
|
|
1885
|
+
* <note>
|
|
1886
|
+
* <p>This field is case-sensitive. Enter the valid values as shown. For example,
|
|
1887
|
+
* entering <code>HERE</code> returns an error.</p>
|
|
1888
|
+
* </note>
|
|
1889
|
+
* <p>Valid values include:</p>
|
|
1890
|
+
* <ul>
|
|
1874
1891
|
* <li>
|
|
1875
|
-
*
|
|
1876
|
-
* <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your
|
|
1877
|
-
* region of interest, see <a href="https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm">Esri details on geocoding coverage</a>.</p>
|
|
1892
|
+
* <p>
|
|
1893
|
+
* <code>Esri</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/esri.html">Esri</a>'s coverage in your region of interest, see <a href="https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm">Esri details on geocoding coverage</a>.</p>
|
|
1878
1894
|
* </li>
|
|
1879
1895
|
* <li>
|
|
1880
|
-
*
|
|
1881
|
-
* <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
|
|
1882
|
-
*
|
|
1883
|
-
*
|
|
1884
|
-
*
|
|
1885
|
-
*
|
|
1886
|
-
*
|
|
1887
|
-
*
|
|
1888
|
-
*
|
|
1896
|
+
* <p>
|
|
1897
|
+
* <code>Here</code> – For additional information about <a href="https://docs.aws.amazon.com/location/latest/developerguide/HERE.html">HERE
|
|
1898
|
+
* Technologies</a>' 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>
|
|
1899
|
+
* <important>
|
|
1900
|
+
* <p>If you specify HERE Technologies (<code>Here</code>) as the data provider,
|
|
1901
|
+
* 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
|
|
1902
|
+
* the <a href="https://aws.amazon.com/service-terms/">AWS Service
|
|
1903
|
+
* Terms</a> for Amazon Location Service.</p>
|
|
1904
|
+
* </important>
|
|
1889
1905
|
* </li>
|
|
1890
1906
|
* </ul>
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
1907
|
+
* <p>For additional information , see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Data
|
|
1908
|
+
* providers</a> on the <i>Amazon Location Service Developer Guide</i>.</p>
|
|
1893
1909
|
*/
|
|
1894
1910
|
DataSource: string | undefined;
|
|
1895
1911
|
/**
|
|
1896
1912
|
* @deprecated
|
|
1897
1913
|
*
|
|
1898
1914
|
* <p>No longer used. If included, the only allowed value is
|
|
1899
|
-
*
|
|
1915
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1900
1916
|
*/
|
|
1901
1917
|
PricingPlan?: PricingPlan | string;
|
|
1902
1918
|
/**
|
|
@@ -1908,30 +1924,30 @@ export interface CreatePlaceIndexRequest {
|
|
|
1908
1924
|
*/
|
|
1909
1925
|
DataSourceConfiguration?: DataSourceConfiguration;
|
|
1910
1926
|
/**
|
|
1911
|
-
* <p>Applies one or more tags to the place index resource. A tag is a key-value pair that
|
|
1912
|
-
*
|
|
1913
|
-
*
|
|
1927
|
+
* <p>Applies one or more tags to the place index resource. A tag is a key-value pair that
|
|
1928
|
+
* helps you manage, identify, search, and filter your resources.</p>
|
|
1929
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
1914
1930
|
* </p>
|
|
1915
|
-
*
|
|
1916
|
-
*
|
|
1931
|
+
* <p>Restrictions:</p>
|
|
1932
|
+
* <ul>
|
|
1917
1933
|
* <li>
|
|
1918
|
-
*
|
|
1934
|
+
* <p>Maximum 50 tags per resource.</p>
|
|
1919
1935
|
* </li>
|
|
1920
1936
|
* <li>
|
|
1921
|
-
*
|
|
1937
|
+
* <p>Each tag key must be unique and must have exactly one associated value.</p>
|
|
1922
1938
|
* </li>
|
|
1923
1939
|
* <li>
|
|
1924
|
-
*
|
|
1940
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1925
1941
|
* </li>
|
|
1926
1942
|
* <li>
|
|
1927
|
-
*
|
|
1943
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1928
1944
|
* </li>
|
|
1929
1945
|
* <li>
|
|
1930
|
-
*
|
|
1931
|
-
*
|
|
1946
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters:
|
|
1947
|
+
* + - = . _ : / @</p>
|
|
1932
1948
|
* </li>
|
|
1933
1949
|
* <li>
|
|
1934
|
-
*
|
|
1950
|
+
* <p>Cannot use "aws:" as a prefix for a key.</p>
|
|
1935
1951
|
* </li>
|
|
1936
1952
|
* </ul>
|
|
1937
1953
|
*/
|
|
@@ -1951,20 +1967,20 @@ export interface CreatePlaceIndexResponse {
|
|
|
1951
1967
|
*/
|
|
1952
1968
|
IndexName: string | undefined;
|
|
1953
1969
|
/**
|
|
1954
|
-
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
1955
|
-
*
|
|
1956
|
-
*
|
|
1970
|
+
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
1971
|
+
* resource across AWS. </p>
|
|
1972
|
+
* <ul>
|
|
1957
1973
|
* <li>
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1974
|
+
* <p>Format example:
|
|
1975
|
+
* <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
|
|
1960
1976
|
* </p>
|
|
1961
1977
|
* </li>
|
|
1962
1978
|
* </ul>
|
|
1963
1979
|
*/
|
|
1964
1980
|
IndexArn: string | undefined;
|
|
1965
1981
|
/**
|
|
1966
|
-
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
1967
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
1982
|
+
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
1983
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
1968
1984
|
*/
|
|
1969
1985
|
CreateTime: Date | undefined;
|
|
1970
1986
|
}
|
|
@@ -1980,11 +1996,11 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1980
1996
|
* <p>Requirements:</p>
|
|
1981
1997
|
* <ul>
|
|
1982
1998
|
* <li>
|
|
1983
|
-
*
|
|
1984
|
-
* (_).</p>
|
|
1999
|
+
* <p>Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.),
|
|
2000
|
+
* and underscores (_).</p>
|
|
1985
2001
|
* </li>
|
|
1986
2002
|
* <li>
|
|
1987
|
-
*
|
|
2003
|
+
* <p>Must be a unique Route calculator resource name.</p>
|
|
1988
2004
|
* </li>
|
|
1989
2005
|
* <li>
|
|
1990
2006
|
* <p>No spaces allowed. For example, <code>ExampleRouteCalculator</code>.</p>
|
|
@@ -1996,8 +2012,8 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1996
2012
|
* <p>Specifies the data provider of traffic and road network data.</p>
|
|
1997
2013
|
* <note>
|
|
1998
2014
|
* <p>This field is case-sensitive. Enter the valid values as shown. For example,
|
|
1999
|
-
* entering <code>HERE</code> returns an error. Route calculators that use Esri as a
|
|
2000
|
-
*
|
|
2015
|
+
* entering <code>HERE</code> returns an error. Route calculators that use Esri as a
|
|
2016
|
+
* data source only calculate routes that are shorter than 400 km.</p>
|
|
2001
2017
|
* </note>
|
|
2002
2018
|
* <p>Valid values include:</p>
|
|
2003
2019
|
* <ul>
|
|
@@ -2512,12 +2528,12 @@ export interface DescribePlaceIndexResponse {
|
|
|
2512
2528
|
*/
|
|
2513
2529
|
IndexName: string | undefined;
|
|
2514
2530
|
/**
|
|
2515
|
-
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
2516
|
-
*
|
|
2517
|
-
*
|
|
2531
|
+
* <p>The Amazon Resource Name (ARN) for the place index resource. Used to specify a
|
|
2532
|
+
* resource across AWS. </p>
|
|
2533
|
+
* <ul>
|
|
2518
2534
|
* <li>
|
|
2519
|
-
*
|
|
2520
|
-
*
|
|
2535
|
+
* <p>Format example:
|
|
2536
|
+
* <code>arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex</code>
|
|
2521
2537
|
* </p>
|
|
2522
2538
|
* </li>
|
|
2523
2539
|
* </ul>
|
|
@@ -2534,30 +2550,30 @@ export interface DescribePlaceIndexResponse {
|
|
|
2534
2550
|
*/
|
|
2535
2551
|
Description: string | undefined;
|
|
2536
2552
|
/**
|
|
2537
|
-
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2538
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2553
|
+
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2554
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2539
2555
|
*/
|
|
2540
2556
|
CreateTime: Date | undefined;
|
|
2541
2557
|
/**
|
|
2542
|
-
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2543
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2558
|
+
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
2559
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
2544
2560
|
*/
|
|
2545
2561
|
UpdateTime: Date | undefined;
|
|
2546
2562
|
/**
|
|
2547
2563
|
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
2548
|
-
*
|
|
2564
|
+
* <ul>
|
|
2549
2565
|
* <li>
|
|
2550
|
-
*
|
|
2566
|
+
* <p>
|
|
2551
2567
|
* <code>Esri</code>
|
|
2552
2568
|
* </p>
|
|
2553
2569
|
* </li>
|
|
2554
2570
|
* <li>
|
|
2555
|
-
*
|
|
2571
|
+
* <p>
|
|
2556
2572
|
* <code>Here</code>
|
|
2557
2573
|
* </p>
|
|
2558
2574
|
* </li>
|
|
2559
2575
|
* </ul>
|
|
2560
|
-
*
|
|
2576
|
+
* <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>
|
|
2561
2577
|
*/
|
|
2562
2578
|
DataSource: string | undefined;
|
|
2563
2579
|
/**
|
|
@@ -3068,6 +3084,12 @@ export interface ListGeofencesRequest {
|
|
|
3068
3084
|
* </p>
|
|
3069
3085
|
*/
|
|
3070
3086
|
NextToken?: string;
|
|
3087
|
+
/**
|
|
3088
|
+
* <p>An optional limit for the number of geofences returned in a single call. </p>
|
|
3089
|
+
* <p>Default value: <code>100</code>
|
|
3090
|
+
* </p>
|
|
3091
|
+
*/
|
|
3092
|
+
MaxResults?: number;
|
|
3071
3093
|
}
|
|
3072
3094
|
export declare namespace ListGeofencesRequest {
|
|
3073
3095
|
/**
|
|
@@ -3749,14 +3771,14 @@ export declare namespace ListMapsResponse {
|
|
|
3749
3771
|
export interface ListPlaceIndexesRequest {
|
|
3750
3772
|
/**
|
|
3751
3773
|
* <p>An optional limit for the maximum number of results returned in a single call.</p>
|
|
3752
|
-
*
|
|
3774
|
+
* <p>Default value: <code>100</code>
|
|
3753
3775
|
* </p>
|
|
3754
3776
|
*/
|
|
3755
3777
|
MaxResults?: number;
|
|
3756
3778
|
/**
|
|
3757
3779
|
* <p>The pagination token specifying which page of results to return in the response. If no
|
|
3758
|
-
*
|
|
3759
|
-
*
|
|
3780
|
+
* token is provided, the default page is the first page.</p>
|
|
3781
|
+
* <p>Default value: <code>null</code>
|
|
3760
3782
|
* </p>
|
|
3761
3783
|
*/
|
|
3762
3784
|
NextToken?: string;
|
|
@@ -3781,19 +3803,19 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3781
3803
|
Description: string | undefined;
|
|
3782
3804
|
/**
|
|
3783
3805
|
* <p>The data provider of geospatial data. Values can be one of the following:</p>
|
|
3784
|
-
*
|
|
3806
|
+
* <ul>
|
|
3785
3807
|
* <li>
|
|
3786
|
-
*
|
|
3808
|
+
* <p>
|
|
3787
3809
|
* <code>Esri</code>
|
|
3788
3810
|
* </p>
|
|
3789
3811
|
* </li>
|
|
3790
3812
|
* <li>
|
|
3791
|
-
*
|
|
3813
|
+
* <p>
|
|
3792
3814
|
* <code>Here</code>
|
|
3793
3815
|
* </p>
|
|
3794
3816
|
* </li>
|
|
3795
3817
|
* </ul>
|
|
3796
|
-
*
|
|
3818
|
+
* <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>
|
|
3797
3819
|
*/
|
|
3798
3820
|
DataSource: string | undefined;
|
|
3799
3821
|
/**
|
|
@@ -3803,13 +3825,13 @@ export interface ListPlaceIndexesResponseEntry {
|
|
|
3803
3825
|
*/
|
|
3804
3826
|
PricingPlan?: PricingPlan | string;
|
|
3805
3827
|
/**
|
|
3806
|
-
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3807
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3828
|
+
* <p>The timestamp for when the place index resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3829
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3808
3830
|
*/
|
|
3809
3831
|
CreateTime: Date | undefined;
|
|
3810
3832
|
/**
|
|
3811
|
-
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3812
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3833
|
+
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
|
|
3834
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
3813
3835
|
*/
|
|
3814
3836
|
UpdateTime: Date | undefined;
|
|
3815
3837
|
}
|
|
@@ -3825,8 +3847,8 @@ export interface ListPlaceIndexesResponse {
|
|
|
3825
3847
|
*/
|
|
3826
3848
|
Entries: ListPlaceIndexesResponseEntry[] | undefined;
|
|
3827
3849
|
/**
|
|
3828
|
-
* <p>A pagination token indicating that there are additional pages available. You can use
|
|
3829
|
-
*
|
|
3850
|
+
* <p>A pagination token indicating that there are additional pages available. You can use
|
|
3851
|
+
* the token in a new request to fetch the next page of results.</p>
|
|
3830
3852
|
*/
|
|
3831
3853
|
NextToken?: string;
|
|
3832
3854
|
}
|
|
@@ -4119,26 +4141,34 @@ export interface SearchPlaceIndexForPositionRequest {
|
|
|
4119
4141
|
IndexName: string | undefined;
|
|
4120
4142
|
/**
|
|
4121
4143
|
* <p>Specifies the longitude and latitude of the position to query.</p>
|
|
4122
|
-
*
|
|
4123
|
-
*
|
|
4124
|
-
*
|
|
4125
|
-
*
|
|
4126
|
-
*
|
|
4127
|
-
* latitude <code>49.2847</code>.</p>
|
|
4144
|
+
* <p> This parameter must contain a pair of numbers. The first number represents the X
|
|
4145
|
+
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
4146
|
+
* latitude.</p>
|
|
4147
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents a position with longitude
|
|
4148
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4128
4149
|
*/
|
|
4129
4150
|
Position: number[] | undefined;
|
|
4130
4151
|
/**
|
|
4131
4152
|
* <p>An optional parameter. The maximum number of results returned per request.</p>
|
|
4132
|
-
*
|
|
4153
|
+
* <p>Default value: <code>50</code>
|
|
4133
4154
|
* </p>
|
|
4134
4155
|
*/
|
|
4135
4156
|
MaxResults?: number;
|
|
4136
4157
|
/**
|
|
4137
4158
|
* <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,
|
|
4138
|
-
*
|
|
4139
|
-
*
|
|
4140
|
-
*
|
|
4141
|
-
*
|
|
4159
|
+
* <code>en</code> for English.</p>
|
|
4160
|
+
* <p>This setting affects the languages used in the results, but not the results
|
|
4161
|
+
* themselves. If no language is specified, or not supported for a particular result, the
|
|
4162
|
+
* partner automatically chooses a language for the result.</p>
|
|
4163
|
+
* <p>For an example, we'll use the Greek language. You search for a location around Athens,
|
|
4164
|
+
* Greece, with the <code>language</code> parameter set to <code>en</code>. The
|
|
4165
|
+
* <code>city</code> in the results will most likely be returned as
|
|
4166
|
+
* <code>Athens</code>.</p>
|
|
4167
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
4168
|
+
* <code>city</code> in the results will more likely be returned as
|
|
4169
|
+
* <code>Αθήνα</code>.</p>
|
|
4170
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
4171
|
+
* that the provider does support.</p>
|
|
4142
4172
|
*/
|
|
4143
4173
|
Language?: string;
|
|
4144
4174
|
}
|
|
@@ -4154,14 +4184,14 @@ export declare namespace SearchPlaceIndexForPositionRequest {
|
|
|
4154
4184
|
export interface PlaceGeometry {
|
|
4155
4185
|
/**
|
|
4156
4186
|
* <p>A single point geometry specifies a location for a Place using <a href="https://gisgeography.com/wgs84-world-geodetic-system/">WGS 84</a>
|
|
4157
|
-
*
|
|
4158
|
-
*
|
|
4187
|
+
* coordinates:</p>
|
|
4188
|
+
* <ul>
|
|
4159
4189
|
* <li>
|
|
4160
|
-
*
|
|
4190
|
+
* <p>
|
|
4161
4191
|
* <i>x</i> — Specifies the x coordinate or longitude. </p>
|
|
4162
4192
|
* </li>
|
|
4163
4193
|
* <li>
|
|
4164
|
-
*
|
|
4194
|
+
* <p>
|
|
4165
4195
|
* <i>y</i> — Specifies the y coordinate or latitude. </p>
|
|
4166
4196
|
* </li>
|
|
4167
4197
|
* </ul>
|
|
@@ -4175,13 +4205,14 @@ export declare namespace PlaceGeometry {
|
|
|
4175
4205
|
const filterSensitiveLog: (obj: PlaceGeometry) => any;
|
|
4176
4206
|
}
|
|
4177
4207
|
/**
|
|
4178
|
-
* <p>Information about a time zone. Includes the name of the time zone and the offset
|
|
4179
|
-
*
|
|
4208
|
+
* <p>Information about a time zone. Includes the name of the time zone and the offset from
|
|
4209
|
+
* UTC in seconds.</p>
|
|
4180
4210
|
*/
|
|
4181
4211
|
export interface TimeZone {
|
|
4182
4212
|
/**
|
|
4183
4213
|
* <p>The name of the time zone, following the <a href="https://www.iana.org/time-zones">
|
|
4184
|
-
*
|
|
4214
|
+
* IANA time zone standard</a>. For example,
|
|
4215
|
+
* <code>America/Los_Angeles</code>.</p>
|
|
4185
4216
|
*/
|
|
4186
4217
|
Name: string | undefined;
|
|
4187
4218
|
/**
|
|
@@ -4197,12 +4228,14 @@ export declare namespace TimeZone {
|
|
|
4197
4228
|
}
|
|
4198
4229
|
/**
|
|
4199
4230
|
* <p>Contains details about addresses or points of interest that match the search
|
|
4200
|
-
*
|
|
4231
|
+
* criteria.</p>
|
|
4232
|
+
* <p>Not all details are included with all responses. Some details may only be returned
|
|
4233
|
+
* by specific data partners.</p>
|
|
4201
4234
|
*/
|
|
4202
4235
|
export interface Place {
|
|
4203
4236
|
/**
|
|
4204
|
-
* <p>The full name and address of the point of interest such as a city,
|
|
4205
|
-
*
|
|
4237
|
+
* <p>The full name and address of the point of interest such as a city, region, or country.
|
|
4238
|
+
* For example, <code>123 Any Street, Any Town, USA</code>.</p>
|
|
4206
4239
|
*/
|
|
4207
4240
|
Label?: string;
|
|
4208
4241
|
/**
|
|
@@ -4215,7 +4248,7 @@ export interface Place {
|
|
|
4215
4248
|
AddressNumber?: string;
|
|
4216
4249
|
/**
|
|
4217
4250
|
* <p>The name for a street or a road to identify a location. For example, <code>Main
|
|
4218
|
-
*
|
|
4251
|
+
* Street</code>.</p>
|
|
4219
4252
|
*/
|
|
4220
4253
|
Street?: string;
|
|
4221
4254
|
/**
|
|
@@ -4224,44 +4257,44 @@ export interface Place {
|
|
|
4224
4257
|
Neighborhood?: string;
|
|
4225
4258
|
/**
|
|
4226
4259
|
* <p>A name for a local area, such as a city or town name. For example,
|
|
4227
|
-
*
|
|
4260
|
+
* <code>Toronto</code>.</p>
|
|
4228
4261
|
*/
|
|
4229
4262
|
Municipality?: string;
|
|
4230
4263
|
/**
|
|
4231
|
-
* <p>A country, or an area that's part of a larger region.
|
|
4232
|
-
*
|
|
4264
|
+
* <p>A country, or an area that's part of a larger region. For example, <code>Metro
|
|
4265
|
+
* Vancouver</code>.</p>
|
|
4233
4266
|
*/
|
|
4234
4267
|
SubRegion?: string;
|
|
4235
4268
|
/**
|
|
4236
4269
|
* <p>A name for an area or geographical division, such as a province or state name. For
|
|
4237
|
-
*
|
|
4270
|
+
* example, <code>British Columbia</code>.</p>
|
|
4238
4271
|
*/
|
|
4239
4272
|
Region?: string;
|
|
4240
4273
|
/**
|
|
4241
4274
|
* <p>A country/region specified using <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
|
|
4242
|
-
*
|
|
4275
|
+
* country/region code. For example, <code>CAN</code>.</p>
|
|
4243
4276
|
*/
|
|
4244
4277
|
Country?: string;
|
|
4245
4278
|
/**
|
|
4246
4279
|
* <p>A group of numbers and letters in a country-specific format, which accompanies the
|
|
4247
|
-
*
|
|
4280
|
+
* address for the purpose of identifying a location. </p>
|
|
4248
4281
|
*/
|
|
4249
4282
|
PostalCode?: string;
|
|
4250
4283
|
/**
|
|
4251
4284
|
* <p>
|
|
4252
4285
|
* <code>True</code> if the result is interpolated from other known places.</p>
|
|
4253
|
-
*
|
|
4286
|
+
* <p>
|
|
4254
4287
|
* <code>False</code> if the Place is a known place.</p>
|
|
4255
|
-
*
|
|
4256
|
-
*
|
|
4257
|
-
*
|
|
4258
|
-
*
|
|
4259
|
-
*
|
|
4288
|
+
* <p>Not returned when the partner does not provide the information.</p>
|
|
4289
|
+
* <p>For example, returns <code>False</code> for an address location that is found in the
|
|
4290
|
+
* partner data, but returns <code>True</code> if an address does not exist in the partner
|
|
4291
|
+
* data and its location is calculated by interpolating between other known addresses.
|
|
4292
|
+
* </p>
|
|
4260
4293
|
*/
|
|
4261
4294
|
Interpolated?: boolean;
|
|
4262
4295
|
/**
|
|
4263
4296
|
* <p>The time zone in which the <code>Place</code> is located. Returned only when using
|
|
4264
|
-
*
|
|
4297
|
+
* Here as the selected partner.</p>
|
|
4265
4298
|
*/
|
|
4266
4299
|
TimeZone?: TimeZone;
|
|
4267
4300
|
}
|
|
@@ -4272,7 +4305,8 @@ export declare namespace Place {
|
|
|
4272
4305
|
const filterSensitiveLog: (obj: Place) => any;
|
|
4273
4306
|
}
|
|
4274
4307
|
/**
|
|
4275
|
-
* <p>Contains a search result from a position search query that is run on a place index
|
|
4308
|
+
* <p>Contains a search result from a position search query that is run on a place index
|
|
4309
|
+
* resource.</p>
|
|
4276
4310
|
*/
|
|
4277
4311
|
export interface SearchForPositionResult {
|
|
4278
4312
|
/**
|
|
@@ -4281,11 +4315,11 @@ export interface SearchForPositionResult {
|
|
|
4281
4315
|
Place: Place | undefined;
|
|
4282
4316
|
/**
|
|
4283
4317
|
* <p>The distance in meters of a great-circle arc between the query position and the
|
|
4284
|
-
*
|
|
4285
|
-
*
|
|
4286
|
-
* <p>A great-circle arc is the shortest path on a sphere, in this case the
|
|
4287
|
-
*
|
|
4288
|
-
*
|
|
4318
|
+
* result.</p>
|
|
4319
|
+
* <note>
|
|
4320
|
+
* <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This
|
|
4321
|
+
* returns the shortest distance between two locations.</p>
|
|
4322
|
+
* </note>
|
|
4289
4323
|
*/
|
|
4290
4324
|
Distance: number | undefined;
|
|
4291
4325
|
}
|
|
@@ -4296,7 +4330,8 @@ export declare namespace SearchForPositionResult {
|
|
|
4296
4330
|
const filterSensitiveLog: (obj: SearchForPositionResult) => any;
|
|
4297
4331
|
}
|
|
4298
4332
|
/**
|
|
4299
|
-
* <p>A summary of the request sent by using
|
|
4333
|
+
* <p>A summary of the request sent by using
|
|
4334
|
+
* <code>SearchPlaceIndexForPosition</code>.</p>
|
|
4300
4335
|
*/
|
|
4301
4336
|
export interface SearchPlaceIndexForPositionSummary {
|
|
4302
4337
|
/**
|
|
@@ -4305,28 +4340,28 @@ export interface SearchPlaceIndexForPositionSummary {
|
|
|
4305
4340
|
Position: number[] | undefined;
|
|
4306
4341
|
/**
|
|
4307
4342
|
* <p>Contains the optional result count limit that is specified in the request.</p>
|
|
4308
|
-
*
|
|
4343
|
+
* <p>Default value: <code>50</code>
|
|
4309
4344
|
* </p>
|
|
4310
4345
|
*/
|
|
4311
4346
|
MaxResults?: number;
|
|
4312
4347
|
/**
|
|
4313
|
-
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4314
|
-
*
|
|
4315
|
-
*
|
|
4348
|
+
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4349
|
+
* request. Values can be one of the following:</p>
|
|
4350
|
+
* <ul>
|
|
4316
4351
|
* <li>
|
|
4317
|
-
*
|
|
4352
|
+
* <p>Esri</p>
|
|
4318
4353
|
* </li>
|
|
4319
4354
|
* <li>
|
|
4320
|
-
*
|
|
4355
|
+
* <p>Here</p>
|
|
4321
4356
|
* </li>
|
|
4322
4357
|
* </ul>
|
|
4323
|
-
*
|
|
4358
|
+
* <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>
|
|
4324
4359
|
*/
|
|
4325
4360
|
DataSource: string | undefined;
|
|
4326
4361
|
/**
|
|
4327
4362
|
* <p>The preferred language used to return results. Matches the language in the request.
|
|
4328
|
-
*
|
|
4329
|
-
*
|
|
4363
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
|
|
4364
|
+
* language tag, for example, <code>en</code> for English.</p>
|
|
4330
4365
|
*/
|
|
4331
4366
|
Language?: string;
|
|
4332
4367
|
}
|
|
@@ -4339,13 +4374,13 @@ export declare namespace SearchPlaceIndexForPositionSummary {
|
|
|
4339
4374
|
export interface SearchPlaceIndexForPositionResponse {
|
|
4340
4375
|
/**
|
|
4341
4376
|
* <p>Contains a summary of the request. Echoes the input values for <code>Position</code>,
|
|
4342
|
-
*
|
|
4343
|
-
*
|
|
4377
|
+
* <code>Language</code>, <code>MaxResults</code>, and the <code>DataSource</code> of
|
|
4378
|
+
* the place index. </p>
|
|
4344
4379
|
*/
|
|
4345
4380
|
Summary: SearchPlaceIndexForPositionSummary | undefined;
|
|
4346
4381
|
/**
|
|
4347
4382
|
* <p>Returns a list of Places closest to the specified position. Each result contains
|
|
4348
|
-
*
|
|
4383
|
+
* additional information about the Places returned.</p>
|
|
4349
4384
|
*/
|
|
4350
4385
|
Results: SearchForPositionResult[] | undefined;
|
|
4351
4386
|
}
|
|
@@ -4362,65 +4397,74 @@ export interface SearchPlaceIndexForSuggestionsRequest {
|
|
|
4362
4397
|
IndexName: string | undefined;
|
|
4363
4398
|
/**
|
|
4364
4399
|
* <p>The free-form partial text to use to generate place suggestions. For example,
|
|
4365
|
-
*
|
|
4400
|
+
* <code>eiffel tow</code>.</p>
|
|
4366
4401
|
*/
|
|
4367
4402
|
Text: string | undefined;
|
|
4368
4403
|
/**
|
|
4369
|
-
* <p>An optional parameter that indicates a preference for place suggestions that are
|
|
4370
|
-
*
|
|
4371
|
-
*
|
|
4372
|
-
*
|
|
4373
|
-
*
|
|
4374
|
-
*
|
|
4375
|
-
*
|
|
4376
|
-
*
|
|
4404
|
+
* <p>An optional parameter that indicates a preference for place suggestions that are
|
|
4405
|
+
* closer to a specified position.</p>
|
|
4406
|
+
* <p> If provided, this parameter must contain a pair of numbers. The first number
|
|
4407
|
+
* represents the X coordinate, or longitude; the second number represents the Y
|
|
4408
|
+
* coordinate, or latitude.</p>
|
|
4409
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
4410
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4411
|
+
* <note>
|
|
4377
4412
|
* <p>
|
|
4378
|
-
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
4379
|
-
*
|
|
4380
|
-
*
|
|
4413
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
4414
|
+
* Specifying both options results in an error. </p>
|
|
4415
|
+
* </note>
|
|
4381
4416
|
*/
|
|
4382
4417
|
BiasPosition?: number[];
|
|
4383
4418
|
/**
|
|
4384
|
-
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
4385
|
-
*
|
|
4386
|
-
*
|
|
4387
|
-
*
|
|
4388
|
-
*
|
|
4389
|
-
*
|
|
4390
|
-
*
|
|
4391
|
-
*
|
|
4392
|
-
*
|
|
4393
|
-
*
|
|
4419
|
+
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
4420
|
+
* within a specified bounding box.</p>
|
|
4421
|
+
* <p> If provided, this parameter must contain a total of four consecutive numbers in two
|
|
4422
|
+
* pairs. The first pair of numbers represents the X and Y coordinates (longitude and
|
|
4423
|
+
* latitude, respectively) of the southwest corner of the bounding box; the second pair of
|
|
4424
|
+
* numbers represents the X and Y coordinates (longitude and latitude, respectively) of the
|
|
4425
|
+
* northeast corner of the bounding box.</p>
|
|
4426
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a
|
|
4427
|
+
* bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude
|
|
4428
|
+
* <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code>
|
|
4429
|
+
* and latitude <code>-36.9542</code>.</p>
|
|
4430
|
+
* <note>
|
|
4394
4431
|
* <p>
|
|
4395
|
-
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
4396
|
-
*
|
|
4397
|
-
*
|
|
4432
|
+
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
4433
|
+
* Specifying both options results in an error. </p>
|
|
4434
|
+
* </note>
|
|
4398
4435
|
*/
|
|
4399
4436
|
FilterBBox?: number[];
|
|
4400
4437
|
/**
|
|
4401
|
-
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
4402
|
-
*
|
|
4438
|
+
* <p>An optional parameter that limits the search results by returning only suggestions
|
|
4439
|
+
* within the provided list of countries.</p>
|
|
4440
|
+
* <ul>
|
|
4403
4441
|
* <li>
|
|
4404
|
-
*
|
|
4405
|
-
*
|
|
4406
|
-
*
|
|
4442
|
+
* <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO
|
|
4443
|
+
* 3166</a> 3-digit country code. For example, Australia uses three
|
|
4444
|
+
* upper-case characters: <code>AUS</code>.</p>
|
|
4407
4445
|
* </li>
|
|
4408
4446
|
* </ul>
|
|
4409
4447
|
*/
|
|
4410
4448
|
FilterCountries?: string[];
|
|
4411
4449
|
/**
|
|
4412
4450
|
* <p>An optional parameter. The maximum number of results returned per request. </p>
|
|
4413
|
-
*
|
|
4451
|
+
* <p>The default: <code>5</code>
|
|
4414
4452
|
* </p>
|
|
4415
4453
|
*/
|
|
4416
4454
|
MaxResults?: number;
|
|
4417
4455
|
/**
|
|
4418
4456
|
* <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,
|
|
4419
|
-
*
|
|
4420
|
-
*
|
|
4421
|
-
*
|
|
4422
|
-
*
|
|
4423
|
-
*
|
|
4457
|
+
* <code>en</code> for English.</p>
|
|
4458
|
+
* <p>This setting affects the languages used in the results. If no language is specified,
|
|
4459
|
+
* or not supported for a particular result, the partner automatically chooses a language
|
|
4460
|
+
* for the result.</p>
|
|
4461
|
+
* <p>For an example, we'll use the Greek language. You search for <code>Athens, Gr</code>
|
|
4462
|
+
* to get suggestions with the <code>language</code> parameter set to <code>en</code>. The
|
|
4463
|
+
* results found will most likely be returned as <code>Athens, Greece</code>.</p>
|
|
4464
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
4465
|
+
* result found will more likely be returned as <code>Αθήνα, Ελλάδα</code>.</p>
|
|
4466
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
4467
|
+
* that the provider does support.</p>
|
|
4424
4468
|
*/
|
|
4425
4469
|
Language?: string;
|
|
4426
4470
|
}
|
|
@@ -4431,7 +4475,8 @@ export declare namespace SearchPlaceIndexForSuggestionsRequest {
|
|
|
4431
4475
|
const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsRequest) => any;
|
|
4432
4476
|
}
|
|
4433
4477
|
/**
|
|
4434
|
-
* <p>Contains a place suggestion resulting from a place suggestion query that is run on a
|
|
4478
|
+
* <p>Contains a place suggestion resulting from a place suggestion query that is run on a
|
|
4479
|
+
* place index resource.</p>
|
|
4435
4480
|
*/
|
|
4436
4481
|
export interface SearchForSuggestionsResult {
|
|
4437
4482
|
/**
|
|
@@ -4446,7 +4491,8 @@ export declare namespace SearchForSuggestionsResult {
|
|
|
4446
4491
|
const filterSensitiveLog: (obj: SearchForSuggestionsResult) => any;
|
|
4447
4492
|
}
|
|
4448
4493
|
/**
|
|
4449
|
-
* <p>A summary of the request sent by using
|
|
4494
|
+
* <p>A summary of the request sent by using
|
|
4495
|
+
* <code>SearchPlaceIndexForSuggestions</code>.</p>
|
|
4450
4496
|
*/
|
|
4451
4497
|
export interface SearchPlaceIndexForSuggestionsSummary {
|
|
4452
4498
|
/**
|
|
@@ -4454,15 +4500,18 @@ export interface SearchPlaceIndexForSuggestionsSummary {
|
|
|
4454
4500
|
*/
|
|
4455
4501
|
Text: string | undefined;
|
|
4456
4502
|
/**
|
|
4457
|
-
* <p>Contains the coordinates for the optional bias position specified in the
|
|
4458
|
-
*
|
|
4459
|
-
*
|
|
4460
|
-
*
|
|
4461
|
-
*
|
|
4503
|
+
* <p>Contains the coordinates for the optional bias position specified in the
|
|
4504
|
+
* request.</p>
|
|
4505
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
4506
|
+
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
4507
|
+
* latitude.</p>
|
|
4508
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
4509
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4462
4510
|
*/
|
|
4463
4511
|
BiasPosition?: number[];
|
|
4464
4512
|
/**
|
|
4465
|
-
* <p>Contains the coordinates for the optional bounding box specified in the
|
|
4513
|
+
* <p>Contains the coordinates for the optional bounding box specified in the
|
|
4514
|
+
* request.</p>
|
|
4466
4515
|
*/
|
|
4467
4516
|
FilterBBox?: number[];
|
|
4468
4517
|
/**
|
|
@@ -4474,23 +4523,23 @@ export interface SearchPlaceIndexForSuggestionsSummary {
|
|
|
4474
4523
|
*/
|
|
4475
4524
|
MaxResults?: number;
|
|
4476
4525
|
/**
|
|
4477
|
-
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4478
|
-
*
|
|
4479
|
-
*
|
|
4526
|
+
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4527
|
+
* request. Values can be one of the following:</p>
|
|
4528
|
+
* <ul>
|
|
4480
4529
|
* <li>
|
|
4481
|
-
*
|
|
4530
|
+
* <p>Esri</p>
|
|
4482
4531
|
* </li>
|
|
4483
4532
|
* <li>
|
|
4484
|
-
*
|
|
4533
|
+
* <p>Here</p>
|
|
4485
4534
|
* </li>
|
|
4486
4535
|
* </ul>
|
|
4487
|
-
*
|
|
4536
|
+
* <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>
|
|
4488
4537
|
*/
|
|
4489
4538
|
DataSource: string | undefined;
|
|
4490
4539
|
/**
|
|
4491
4540
|
* <p>The preferred language used to return results. Matches the language in the request.
|
|
4492
|
-
*
|
|
4493
|
-
*
|
|
4541
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
|
|
4542
|
+
* language tag, for example, <code>en</code> for English.</p>
|
|
4494
4543
|
*/
|
|
4495
4544
|
Language?: string;
|
|
4496
4545
|
}
|
|
@@ -4502,10 +4551,10 @@ export declare namespace SearchPlaceIndexForSuggestionsSummary {
|
|
|
4502
4551
|
}
|
|
4503
4552
|
export interface SearchPlaceIndexForSuggestionsResponse {
|
|
4504
4553
|
/**
|
|
4505
|
-
* <p>Contains a summary of the request. Echoes the input values for
|
|
4506
|
-
*
|
|
4507
|
-
*
|
|
4508
|
-
*
|
|
4554
|
+
* <p>Contains a summary of the request. Echoes the input values for
|
|
4555
|
+
* <code>BiasPosition</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
|
|
4556
|
+
* <code>Language</code>, <code>MaxResults</code>, and <code>Text</code>. Also includes
|
|
4557
|
+
* the <code>DataSource</code> of the place index. </p>
|
|
4509
4558
|
*/
|
|
4510
4559
|
Summary: SearchPlaceIndexForSuggestionsSummary | undefined;
|
|
4511
4560
|
/**
|
|
@@ -4525,67 +4574,75 @@ export interface SearchPlaceIndexForTextRequest {
|
|
|
4525
4574
|
*/
|
|
4526
4575
|
IndexName: string | undefined;
|
|
4527
4576
|
/**
|
|
4528
|
-
* <p>The address, name,
|
|
4529
|
-
*
|
|
4530
|
-
* Street</code>.</p>
|
|
4577
|
+
* <p>The address, name, city, or region to be used in the search in free-form text format.
|
|
4578
|
+
* For example, <code>123 Any Street</code>.</p>
|
|
4531
4579
|
*/
|
|
4532
4580
|
Text: string | undefined;
|
|
4533
4581
|
/**
|
|
4534
|
-
* <p>An optional parameter that indicates a preference for places that are closer to a
|
|
4535
|
-
*
|
|
4536
|
-
*
|
|
4537
|
-
*
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4540
|
-
*
|
|
4541
|
-
*
|
|
4582
|
+
* <p>An optional parameter that indicates a preference for places that are closer to a
|
|
4583
|
+
* specified position.</p>
|
|
4584
|
+
* <p> If provided, this parameter must contain a pair of numbers. The first number
|
|
4585
|
+
* represents the X coordinate, or longitude; the second number represents the Y
|
|
4586
|
+
* coordinate, or latitude.</p>
|
|
4587
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
4588
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4589
|
+
* <note>
|
|
4542
4590
|
* <p>
|
|
4543
|
-
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
4544
|
-
*
|
|
4545
|
-
*
|
|
4546
|
-
* </note>
|
|
4591
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive.
|
|
4592
|
+
* Specifying both options results in an error. </p>
|
|
4593
|
+
* </note>
|
|
4547
4594
|
*/
|
|
4548
4595
|
BiasPosition?: number[];
|
|
4549
4596
|
/**
|
|
4550
|
-
* <p>An optional parameter that limits the search results by returning only places that are
|
|
4551
|
-
*
|
|
4552
|
-
*
|
|
4553
|
-
*
|
|
4554
|
-
*
|
|
4555
|
-
*
|
|
4556
|
-
*
|
|
4557
|
-
*
|
|
4558
|
-
*
|
|
4559
|
-
*
|
|
4597
|
+
* <p>An optional parameter that limits the search results by returning only places that are
|
|
4598
|
+
* within the provided bounding box.</p>
|
|
4599
|
+
* <p> If provided, this parameter must contain a total of four consecutive numbers in two
|
|
4600
|
+
* pairs. The first pair of numbers represents the X and Y coordinates (longitude and
|
|
4601
|
+
* latitude, respectively) of the southwest corner of the bounding box; the second pair of
|
|
4602
|
+
* numbers represents the X and Y coordinates (longitude and latitude, respectively) of the
|
|
4603
|
+
* northeast corner of the bounding box.</p>
|
|
4604
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a
|
|
4605
|
+
* bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude
|
|
4606
|
+
* <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code>
|
|
4607
|
+
* and latitude <code>-36.9542</code>.</p>
|
|
4608
|
+
* <note>
|
|
4560
4609
|
* <p>
|
|
4561
|
-
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
4562
|
-
*
|
|
4563
|
-
*
|
|
4610
|
+
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive.
|
|
4611
|
+
* Specifying both options results in an error. </p>
|
|
4612
|
+
* </note>
|
|
4564
4613
|
*/
|
|
4565
4614
|
FilterBBox?: number[];
|
|
4566
4615
|
/**
|
|
4567
|
-
* <p>An optional parameter that limits the search results by returning only places that are
|
|
4568
|
-
*
|
|
4616
|
+
* <p>An optional parameter that limits the search results by returning only places that are
|
|
4617
|
+
* in a specified list of countries.</p>
|
|
4618
|
+
* <ul>
|
|
4569
4619
|
* <li>
|
|
4570
|
-
*
|
|
4571
|
-
*
|
|
4572
|
-
*
|
|
4620
|
+
* <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a>
|
|
4621
|
+
* 3-digit country codes. For example, Australia uses three upper-case characters:
|
|
4622
|
+
* <code>AUS</code>.</p>
|
|
4573
4623
|
* </li>
|
|
4574
4624
|
* </ul>
|
|
4575
4625
|
*/
|
|
4576
4626
|
FilterCountries?: string[];
|
|
4577
4627
|
/**
|
|
4578
4628
|
* <p>An optional parameter. The maximum number of results returned per request. </p>
|
|
4579
|
-
*
|
|
4629
|
+
* <p>The default: <code>50</code>
|
|
4580
4630
|
* </p>
|
|
4581
4631
|
*/
|
|
4582
4632
|
MaxResults?: number;
|
|
4583
4633
|
/**
|
|
4584
4634
|
* <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,
|
|
4585
|
-
*
|
|
4586
|
-
*
|
|
4587
|
-
*
|
|
4588
|
-
*
|
|
4635
|
+
* <code>en</code> for English.</p>
|
|
4636
|
+
* <p>This setting affects the languages used in the results, but not the results
|
|
4637
|
+
* themselves. If no language is specified, or not supported for a particular result, the
|
|
4638
|
+
* partner automatically chooses a language for the result.</p>
|
|
4639
|
+
* <p>For an example, we'll use the Greek language. You search for <code>Athens,
|
|
4640
|
+
* Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The
|
|
4641
|
+
* result found will most likely be returned as <code>Athens</code>.</p>
|
|
4642
|
+
* <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the
|
|
4643
|
+
* result found will more likely be returned as <code>Αθήνα</code>.</p>
|
|
4644
|
+
* <p>If the data provider does not have a value for Greek, the result will be in a language
|
|
4645
|
+
* that the provider does support.</p>
|
|
4589
4646
|
*/
|
|
4590
4647
|
Language?: string;
|
|
4591
4648
|
}
|
|
@@ -4596,7 +4653,8 @@ export declare namespace SearchPlaceIndexForTextRequest {
|
|
|
4596
4653
|
const filterSensitiveLog: (obj: SearchPlaceIndexForTextRequest) => any;
|
|
4597
4654
|
}
|
|
4598
4655
|
/**
|
|
4599
|
-
* <p>Contains a search result from a text search query that is run on a place index
|
|
4656
|
+
* <p>Contains a search result from a text search query that is run on a place index
|
|
4657
|
+
* resource.</p>
|
|
4600
4658
|
*/
|
|
4601
4659
|
export interface SearchForTextResult {
|
|
4602
4660
|
/**
|
|
@@ -4604,20 +4662,20 @@ export interface SearchForTextResult {
|
|
|
4604
4662
|
*/
|
|
4605
4663
|
Place: Place | undefined;
|
|
4606
4664
|
/**
|
|
4607
|
-
* <p>The distance in meters of a great-circle arc between the bias position specified
|
|
4608
|
-
*
|
|
4609
|
-
*
|
|
4610
|
-
*
|
|
4611
|
-
* <p>A great-circle arc is the shortest path on a sphere, in this case the
|
|
4612
|
-
*
|
|
4613
|
-
*
|
|
4665
|
+
* <p>The distance in meters of a great-circle arc between the bias position specified and
|
|
4666
|
+
* the result. <code>Distance</code> will be returned only if a bias position was specified
|
|
4667
|
+
* in the query.</p>
|
|
4668
|
+
* <note>
|
|
4669
|
+
* <p>A great-circle arc is the shortest path on a sphere, in this case the Earth. This
|
|
4670
|
+
* returns the shortest distance between two locations.</p>
|
|
4671
|
+
* </note>
|
|
4614
4672
|
*/
|
|
4615
4673
|
Distance?: number;
|
|
4616
4674
|
/**
|
|
4617
4675
|
* <p>The relative confidence in the match for a result among the results returned. For
|
|
4618
|
-
*
|
|
4619
|
-
*
|
|
4620
|
-
*
|
|
4676
|
+
* example, if more fields for an address match (including house number, street, city,
|
|
4677
|
+
* country/region, and postal code), the relevance score is closer to 1.</p>
|
|
4678
|
+
* <p>Returned only when the partner selected is Esri.</p>
|
|
4621
4679
|
*/
|
|
4622
4680
|
Relevance?: number;
|
|
4623
4681
|
}
|
|
@@ -4636,15 +4694,18 @@ export interface SearchPlaceIndexForTextSummary {
|
|
|
4636
4694
|
*/
|
|
4637
4695
|
Text: string | undefined;
|
|
4638
4696
|
/**
|
|
4639
|
-
* <p>Contains the coordinates for the optional bias position specified in the
|
|
4640
|
-
*
|
|
4641
|
-
*
|
|
4642
|
-
*
|
|
4643
|
-
*
|
|
4697
|
+
* <p>Contains the coordinates for the optional bias position specified in the
|
|
4698
|
+
* request.</p>
|
|
4699
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
4700
|
+
* coordinate, or longitude; the second number represents the Y coordinate, or
|
|
4701
|
+
* latitude.</p>
|
|
4702
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude
|
|
4703
|
+
* <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4644
4704
|
*/
|
|
4645
4705
|
BiasPosition?: number[];
|
|
4646
4706
|
/**
|
|
4647
|
-
* <p>Contains the coordinates for the optional bounding box specified in the
|
|
4707
|
+
* <p>Contains the coordinates for the optional bounding box specified in the
|
|
4708
|
+
* request.</p>
|
|
4648
4709
|
*/
|
|
4649
4710
|
FilterBBox?: number[];
|
|
4650
4711
|
/**
|
|
@@ -4657,30 +4718,30 @@ export interface SearchPlaceIndexForTextSummary {
|
|
|
4657
4718
|
MaxResults?: number;
|
|
4658
4719
|
/**
|
|
4659
4720
|
* <p>The bounding box that fully contains all search results.</p>
|
|
4660
|
-
*
|
|
4661
|
-
* <p>If you specified the optional <code>FilterBBox</code> parameter in the request,
|
|
4662
|
-
*
|
|
4663
|
-
*
|
|
4721
|
+
* <note>
|
|
4722
|
+
* <p>If you specified the optional <code>FilterBBox</code> parameter in the request,
|
|
4723
|
+
* <code>ResultBBox</code> is contained within <code>FilterBBox</code>.</p>
|
|
4724
|
+
* </note>
|
|
4664
4725
|
*/
|
|
4665
4726
|
ResultBBox?: number[];
|
|
4666
4727
|
/**
|
|
4667
|
-
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4668
|
-
*
|
|
4669
|
-
*
|
|
4728
|
+
* <p>The geospatial data provider attached to the place index resource specified in the
|
|
4729
|
+
* request. Values can be one of the following:</p>
|
|
4730
|
+
* <ul>
|
|
4670
4731
|
* <li>
|
|
4671
|
-
*
|
|
4732
|
+
* <p>Esri</p>
|
|
4672
4733
|
* </li>
|
|
4673
4734
|
* <li>
|
|
4674
|
-
*
|
|
4735
|
+
* <p>Here</p>
|
|
4675
4736
|
* </li>
|
|
4676
4737
|
* </ul>
|
|
4677
|
-
*
|
|
4738
|
+
* <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>
|
|
4678
4739
|
*/
|
|
4679
4740
|
DataSource: string | undefined;
|
|
4680
4741
|
/**
|
|
4681
4742
|
* <p>The preferred language used to return results. Matches the language in the request.
|
|
4682
|
-
*
|
|
4683
|
-
*
|
|
4743
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a>
|
|
4744
|
+
* language tag, for example, <code>en</code> for English.</p>
|
|
4684
4745
|
*/
|
|
4685
4746
|
Language?: string;
|
|
4686
4747
|
}
|
|
@@ -4692,16 +4753,18 @@ export declare namespace SearchPlaceIndexForTextSummary {
|
|
|
4692
4753
|
}
|
|
4693
4754
|
export interface SearchPlaceIndexForTextResponse {
|
|
4694
4755
|
/**
|
|
4695
|
-
* <p>Contains a summary of the request. Echoes the input values for
|
|
4696
|
-
*
|
|
4697
|
-
*
|
|
4698
|
-
*
|
|
4699
|
-
*
|
|
4756
|
+
* <p>Contains a summary of the request. Echoes the input values for
|
|
4757
|
+
* <code>BiasPosition</code>, <code>FilterBBox</code>, <code>FilterCountries</code>,
|
|
4758
|
+
* <code>Language</code>, <code>MaxResults</code>, and <code>Text</code>. Also includes
|
|
4759
|
+
* the <code>DataSource</code> of the place index and the bounding box,
|
|
4760
|
+
* <code>ResultBBox</code>, which surrounds the search results. </p>
|
|
4700
4761
|
*/
|
|
4701
4762
|
Summary: SearchPlaceIndexForTextSummary | undefined;
|
|
4702
4763
|
/**
|
|
4703
|
-
* <p>A list of Places matching the input text. Each result contains additional
|
|
4704
|
-
*
|
|
4764
|
+
* <p>A list of Places matching the input text. Each result contains additional information
|
|
4765
|
+
* about the specific point of interest. </p>
|
|
4766
|
+
* <p>Not all response properties are included with all responses. Some properties may
|
|
4767
|
+
* only be returned by specific data partners.</p>
|
|
4705
4768
|
*/
|
|
4706
4769
|
Results: SearchForTextResult[] | undefined;
|
|
4707
4770
|
}
|
|
@@ -4720,7 +4783,7 @@ export interface UpdatePlaceIndexRequest {
|
|
|
4720
4783
|
* @deprecated
|
|
4721
4784
|
*
|
|
4722
4785
|
* <p>No longer used. If included, the only allowed value is
|
|
4723
|
-
*
|
|
4786
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
4724
4787
|
*/
|
|
4725
4788
|
PricingPlan?: PricingPlan | string;
|
|
4726
4789
|
/**
|
|
@@ -4745,19 +4808,19 @@ export interface UpdatePlaceIndexResponse {
|
|
|
4745
4808
|
IndexName: string | undefined;
|
|
4746
4809
|
/**
|
|
4747
4810
|
* <p>The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a
|
|
4748
|
-
*
|
|
4749
|
-
*
|
|
4811
|
+
* resource across AWS.</p>
|
|
4812
|
+
* <ul>
|
|
4750
4813
|
* <li>
|
|
4751
|
-
*
|
|
4752
|
-
*
|
|
4814
|
+
* <p>Format example: <code>arn:aws:geo:region:account-id:place-
|
|
4815
|
+
* index/ExamplePlaceIndex</code>
|
|
4753
4816
|
* </p>
|
|
4754
4817
|
* </li>
|
|
4755
4818
|
* </ul>
|
|
4756
4819
|
*/
|
|
4757
4820
|
IndexArn: string | undefined;
|
|
4758
4821
|
/**
|
|
4759
|
-
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
4760
|
-
* <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
4822
|
+
* <p>The timestamp for when the place index resource was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a>
|
|
4823
|
+
* format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
|
|
4761
4824
|
*/
|
|
4762
4825
|
UpdateTime: Date | undefined;
|
|
4763
4826
|
}
|
|
@@ -4796,12 +4859,12 @@ export interface UpdateRouteCalculatorResponse {
|
|
|
4796
4859
|
*/
|
|
4797
4860
|
CalculatorName: string | undefined;
|
|
4798
4861
|
/**
|
|
4799
|
-
* <p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to
|
|
4800
|
-
* across AWS.</p>
|
|
4862
|
+
* <p>The Amazon Resource Name (ARN) of the updated route calculator resource. Used to
|
|
4863
|
+
* specify a resource across AWS.</p>
|
|
4801
4864
|
* <ul>
|
|
4802
4865
|
* <li>
|
|
4803
|
-
*
|
|
4804
|
-
*
|
|
4866
|
+
* <p>Format example: <code>arn:aws:geo:region:account-id:route-
|
|
4867
|
+
* calculator/ExampleCalculator</code>
|
|
4805
4868
|
* </p>
|
|
4806
4869
|
* </li>
|
|
4807
4870
|
* </ul>
|