@aws-sdk/client-location 3.46.0 → 3.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/dist-cjs/Location.js +15 -0
  3. package/dist-cjs/commands/CalculateRouteMatrixCommand.js +36 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/models/models_0.js +37 -45
  6. package/dist-cjs/protocols/Aws_restJson1.js +217 -3
  7. package/dist-cjs/runtimeConfig.browser.js +7 -2
  8. package/dist-cjs/runtimeConfig.js +10 -2
  9. package/dist-es/Location.js +15 -0
  10. package/dist-es/commands/CalculateRouteMatrixCommand.js +39 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/models/models_0.js +20 -28
  13. package/dist-es/protocols/Aws_restJson1.js +226 -0
  14. package/dist-es/runtimeConfig.browser.js +12 -3
  15. package/dist-es/runtimeConfig.js +13 -4
  16. package/dist-types/Location.d.ts +74 -12
  17. package/dist-types/LocationClient.d.ts +8 -3
  18. package/dist-types/commands/CalculateRouteCommand.d.ts +10 -12
  19. package/dist-types/commands/CalculateRouteMatrixCommand.d.ts +74 -0
  20. package/dist-types/commands/CreateMapCommand.d.ts +6 -0
  21. package/dist-types/commands/CreatePlaceIndexCommand.d.ts +6 -0
  22. package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +6 -0
  23. package/dist-types/commands/index.d.ts +1 -0
  24. package/dist-types/models/models_0.d.ts +398 -169
  25. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  26. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  27. package/dist-types/runtimeConfig.d.ts +4 -3
  28. package/dist-types/runtimeConfig.native.d.ts +1 -0
  29. package/dist-types/ts3.4/Location.d.ts +5 -0
  30. package/dist-types/ts3.4/LocationClient.d.ts +6 -3
  31. package/dist-types/ts3.4/commands/CalculateRouteMatrixCommand.d.ts +17 -0
  32. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  33. package/dist-types/ts3.4/models/models_0.d.ts +89 -38
  34. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
  35. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
  36. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
  37. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  38. package/package.json +35 -35
@@ -8,12 +8,6 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare
8
8
  $fault: "client";
9
9
  Message: string | undefined;
10
10
  }
11
- export declare namespace AccessDeniedException {
12
- /**
13
- * @internal
14
- */
15
- const filterSensitiveLog: (obj: AccessDeniedException) => any;
16
- }
17
11
  export interface AssociateTrackerConsumerRequest {
18
12
  /**
19
13
  * <p>The name of the tracker resource to be associated with a geofence collection.</p>
@@ -54,12 +48,6 @@ export interface ConflictException extends __SmithyException, $MetadataBearer {
54
48
  $fault: "client";
55
49
  Message: string | undefined;
56
50
  }
57
- export declare namespace ConflictException {
58
- /**
59
- * @internal
60
- */
61
- const filterSensitiveLog: (obj: ConflictException) => any;
62
- }
63
51
  /**
64
52
  * <p>The request has failed to process because of an unknown server error, exception, or failure.</p>
65
53
  */
@@ -69,12 +57,6 @@ export interface InternalServerException extends __SmithyException, $MetadataBea
69
57
  $retryable: {};
70
58
  Message: string | undefined;
71
59
  }
72
- export declare namespace InternalServerException {
73
- /**
74
- * @internal
75
- */
76
- const filterSensitiveLog: (obj: InternalServerException) => any;
77
- }
78
60
  /**
79
61
  * <p>The resource that you've entered was not found in your AWS account.</p>
80
62
  */
@@ -83,12 +65,6 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
83
65
  $fault: "client";
84
66
  Message: string | undefined;
85
67
  }
86
- export declare namespace ResourceNotFoundException {
87
- /**
88
- * @internal
89
- */
90
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
91
- }
92
68
  /**
93
69
  * <p>The operation was denied because the request would exceed the maximum <a href="https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html">quota</a>
94
70
  * set for Amazon Location Service.</p>
@@ -101,12 +77,6 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad
101
77
  */
102
78
  Message: string | undefined;
103
79
  }
104
- export declare namespace ServiceQuotaExceededException {
105
- /**
106
- * @internal
107
- */
108
- const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
109
- }
110
80
  /**
111
81
  * <p>The request was denied because of request throttling.</p>
112
82
  */
@@ -116,12 +86,6 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer
116
86
  $retryable: {};
117
87
  Message: string | undefined;
118
88
  }
119
- export declare namespace ThrottlingException {
120
- /**
121
- * @internal
122
- */
123
- const filterSensitiveLog: (obj: ThrottlingException) => any;
124
- }
125
89
  /**
126
90
  * <p>The input failed to meet the constraints specified by the AWS service in a specified
127
91
  * field. </p>
@@ -159,12 +123,6 @@ export interface ValidationException extends __SmithyException, $MetadataBearer
159
123
  */
160
124
  FieldList: ValidationExceptionField[] | undefined;
161
125
  }
162
- export declare namespace ValidationException {
163
- /**
164
- * @internal
165
- */
166
- const filterSensitiveLog: (obj: ValidationException) => any;
167
- }
168
126
  export interface BatchDeleteDevicePositionHistoryRequest {
169
127
  /**
170
128
  * <p>The name of the tracker resource to delete the device position history from.</p>
@@ -841,7 +799,7 @@ export interface CalculateRouteRequest {
841
799
  * </li>
842
800
  * </ul>
843
801
  * <note>
844
- * <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/calculate-route.html#snap-to-nearby-road">moves the
802
+ * <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
845
803
  * position to the nearest road</a>. If Esri is the provider for your route calculator,
846
804
  * specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
847
805
  * </note>
@@ -859,7 +817,7 @@ export interface CalculateRouteRequest {
859
817
  * </li>
860
818
  * </ul>
861
819
  * <note>
862
- * <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/calculate-route.html#snap-to-nearby-road">moves the position to the nearest road</a>. </p>
820
+ * <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 to the nearest road</a>. </p>
863
821
  * </note>
864
822
  * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
865
823
  * </p>
@@ -877,7 +835,7 @@ export interface CalculateRouteRequest {
877
835
  * </li>
878
836
  * </ul>
879
837
  * <note>
880
- * <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/calculate-route.html#snap-to-nearby-road">moves the position to the nearest road</a>. </p>
838
+ * <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 to the nearest road</a>. </p>
881
839
  * <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
882
840
  * error.</p>
883
841
  * <p>If Esri is the provider for your route calculator, specifying a
@@ -890,7 +848,8 @@ export interface CalculateRouteRequest {
890
848
  /**
891
849
  * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
892
850
  * of travel and road compatibility.</p>
893
- * <p>The <code>TravelMode</code> you specify determines how you specify route preferences: </p>
851
+ * <p>The <code>TravelMode</code> you specify also determines how you specify route
852
+ * preferences: </p>
894
853
  * <ul>
895
854
  * <li>
896
855
  * <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
@@ -1039,7 +998,7 @@ export declare namespace Step {
1039
998
  * number of legs returned corresponds to one fewer than the total number of positions in
1040
999
  * the request. </p>
1041
1000
  * <p>For example, a route with a departure position and destination position returns one
1042
- * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>:</p>
1001
+ * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby road</a>:</p>
1043
1002
  * <ul>
1044
1003
  * <li>
1045
1004
  * <p>The <code>StartPosition</code> is the departure position.</p>
@@ -1066,7 +1025,7 @@ export interface Leg {
1066
1025
  * <p>The starting position of the leg. Follows the format
1067
1026
  * <code>[longitude,latitude]</code>.</p>
1068
1027
  * <note>
1069
- * <p>If the <code>StartPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>. </p>
1028
+ * <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 nearby road</a>. </p>
1070
1029
  * </note>
1071
1030
  */
1072
1031
  StartPosition: number[] | undefined;
@@ -1074,7 +1033,7 @@ export interface Leg {
1074
1033
  * <p>The terminating position of the leg. Follows the format
1075
1034
  * <code>[longitude,latitude]</code>.</p>
1076
1035
  * <note>
1077
- * <p>If the <code>EndPosition</code> isn't located on a road, it's <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>. </p>
1036
+ * <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 road</a>. </p>
1078
1037
  * </note>
1079
1038
  */
1080
1039
  EndPosition: number[] | undefined;
@@ -1200,7 +1159,7 @@ export interface CalculateRouteResponse {
1200
1159
  * number of legs returned corresponds to one fewer than the total number of positions in
1201
1160
  * the request. </p>
1202
1161
  * <p>For example, a route with a departure position and destination position returns one
1203
- * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road">snapped to a nearby road</a>:</p>
1162
+ * leg with the positions <a href="https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html">snapped to a nearby road</a>:</p>
1204
1163
  * <ul>
1205
1164
  * <li>
1206
1165
  * <p>The <code>StartPosition</code> is the departure position.</p>
@@ -1236,6 +1195,296 @@ export declare namespace CalculateRouteResponse {
1236
1195
  */
1237
1196
  const filterSensitiveLog: (obj: CalculateRouteResponse) => any;
1238
1197
  }
1198
+ export interface CalculateRouteMatrixRequest {
1199
+ /**
1200
+ * <p>The name of the route calculator resource that you want to use to calculate the route matrix. </p>
1201
+ */
1202
+ CalculatorName: string | undefined;
1203
+ /**
1204
+ * <p>The list of departure (origin) positions for the route matrix. An array of points,
1205
+ * 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:
1206
+ * <code>[longitude, latitude]</code>. For example, <code>[-123.115,
1207
+ * 49.285]</code>.</p>
1208
+ * <important>
1209
+ * <p>Depending on the data provider selected in the route calculator resource there may be additional
1210
+ * 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">
1211
+ * Position restrictions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
1212
+ * </important>
1213
+ * <note>
1214
+ * <p>For route calculators that use Esri as the data provider, if you specify a
1215
+ * 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
1216
+ * to the nearest road</a>. The snapped value is available in the result in
1217
+ * <code>SnappedDeparturePositions</code>.</p>
1218
+ * </note>
1219
+ * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
1220
+ * </p>
1221
+ */
1222
+ DeparturePositions: number[][] | undefined;
1223
+ /**
1224
+ * <p>The list of destination positions for the route matrix. An array of points, each of
1225
+ * which is itself a 2-value array defined in <a href="https://earth-info.nga.mil/GandG/wgs84/index.html">WGS 84</a> format:
1226
+ * <code>[longitude, latitude]</code>. For example, <code>[-122.339,
1227
+ * 47.615]</code>
1228
+ * </p>
1229
+ * <important>
1230
+ * <p>Depending on the data provider selected in the route calculator resource there may be additional
1231
+ * 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">
1232
+ * Position restrictions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
1233
+ * </important>
1234
+ * <note>
1235
+ * <p>For route calculators that use Esri as the data provider, if you specify a
1236
+ * 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
1237
+ * to the nearest road</a>. The snapped value is available in the result in
1238
+ * <code>SnappedDestinationPositions</code>.</p>
1239
+ * </note>
1240
+ * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
1241
+ * </p>
1242
+ */
1243
+ DestinationPositions: number[][] | undefined;
1244
+ /**
1245
+ * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
1246
+ * of travel and road compatibility.</p>
1247
+ * <p>The <code>TravelMode</code> you specify also determines how you specify route
1248
+ * preferences: </p>
1249
+ * <ul>
1250
+ * <li>
1251
+ * <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
1252
+ * parameter.</p>
1253
+ * </li>
1254
+ * <li>
1255
+ * <p>If traveling by <code>Truck</code> use the <code>TruckModeOptions</code>
1256
+ * parameter.</p>
1257
+ * </li>
1258
+ * </ul>
1259
+ * <p>Default Value: <code>Car</code>
1260
+ * </p>
1261
+ */
1262
+ TravelMode?: TravelMode | string;
1263
+ /**
1264
+ * <p>Specifies the desired time of departure. Uses the given time to calculate the route
1265
+ * matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>. If
1266
+ * neither is set, the best time of day to travel with the best traffic conditions is used
1267
+ * to calculate the route matrix.</p>
1268
+ * <note>
1269
+ * <p>Setting a departure time in the past returns a <code>400
1270
+ * ValidationException</code> error.</p>
1271
+ * </note>
1272
+ * <ul>
1273
+ * <li>
1274
+ * <p>In <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO
1275
+ * 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. For example,
1276
+ * <code>2020–07-2T12:15:20.000Z+01:00</code>
1277
+ * </p>
1278
+ * </li>
1279
+ * </ul>
1280
+ */
1281
+ DepartureTime?: Date;
1282
+ /**
1283
+ * <p>Sets the time of departure as the current time. Uses the current time to calculate the
1284
+ * route matrix. You can't set both <code>DepartureTime</code> and <code>DepartNow</code>.
1285
+ * If neither is set, the best time of day to travel with the best traffic conditions is
1286
+ * used to calculate the route matrix.</p>
1287
+ * <p>Default Value: <code>false</code>
1288
+ * </p>
1289
+ * <p>Valid Values: <code>false</code> | <code>true</code>
1290
+ * </p>
1291
+ */
1292
+ DepartNow?: boolean;
1293
+ /**
1294
+ * <p>Set the unit system to specify the distance.</p>
1295
+ * <p>Default Value: <code>Kilometers</code>
1296
+ * </p>
1297
+ */
1298
+ DistanceUnit?: DistanceUnit | string;
1299
+ /**
1300
+ * <p>Specifies route preferences when traveling by <code>Car</code>, such as avoiding
1301
+ * routes that use ferries or tolls.</p>
1302
+ * <p>Requirements: <code>TravelMode</code> must be specified as <code>Car</code>.</p>
1303
+ */
1304
+ CarModeOptions?: CalculateRouteCarModeOptions;
1305
+ /**
1306
+ * <p>Specifies route preferences when traveling by <code>Truck</code>, such as avoiding
1307
+ * routes that use ferries or tolls, and truck specifications to consider when choosing an
1308
+ * optimal road.</p>
1309
+ * <p>Requirements: <code>TravelMode</code> must be specified as <code>Truck</code>.</p>
1310
+ */
1311
+ TruckModeOptions?: CalculateRouteTruckModeOptions;
1312
+ }
1313
+ export declare namespace CalculateRouteMatrixRequest {
1314
+ /**
1315
+ * @internal
1316
+ */
1317
+ const filterSensitiveLog: (obj: CalculateRouteMatrixRequest) => any;
1318
+ }
1319
+ export declare type RouteMatrixErrorCode = "DeparturePositionNotFound" | "DestinationPositionNotFound" | "OtherValidationError" | "PositionsNotFound" | "RouteNotFound" | "RouteTooLong";
1320
+ /**
1321
+ * <p>An error corresponding to the calculation of a route between the
1322
+ * <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
1323
+ * <p>The error code can be one of the following:</p>
1324
+ * <ul>
1325
+ * <li>
1326
+ * <p>
1327
+ * <code>RouteNotFound</code> - Unable to find a
1328
+ * valid route with the given parameters.</p>
1329
+ * </li>
1330
+ * </ul>
1331
+ * <ul>
1332
+ * <li>
1333
+ * <p>
1334
+ * <code>RouteTooLong</code> - Route calculation went
1335
+ * beyond the maximum size of a route and was terminated before completion.</p>
1336
+ * </li>
1337
+ * </ul>
1338
+ * <ul>
1339
+ * <li>
1340
+ * <p>
1341
+ * <code>PositionsNotFound</code> - One or more of the
1342
+ * input positions were not found on the route network.</p>
1343
+ * </li>
1344
+ * </ul>
1345
+ * <ul>
1346
+ * <li>
1347
+ * <p>
1348
+ * <code>DestinationPositionNotFound</code> - The
1349
+ * destination position was not found on the route network.</p>
1350
+ * </li>
1351
+ * </ul>
1352
+ * <ul>
1353
+ * <li>
1354
+ * <p>
1355
+ * <code>DeparturePositionNotFound</code> - The
1356
+ * departure position was not found on the route network.</p>
1357
+ * </li>
1358
+ * </ul>
1359
+ * <ul>
1360
+ * <li>
1361
+ * <p>
1362
+ * <code>OtherValidationError</code> - The given inputs were not valid or a
1363
+ * route was not found. More information is given in the error
1364
+ * <code>Message</code>
1365
+ * </p>
1366
+ * </li>
1367
+ * </ul>
1368
+ */
1369
+ export interface RouteMatrixEntryError {
1370
+ /**
1371
+ * <p>The type of error which occurred for the route calculation.</p>
1372
+ */
1373
+ Code: RouteMatrixErrorCode | string | undefined;
1374
+ /**
1375
+ * <p>A message about the error that occurred for the route calculation.</p>
1376
+ */
1377
+ Message?: string;
1378
+ }
1379
+ export declare namespace RouteMatrixEntryError {
1380
+ /**
1381
+ * @internal
1382
+ */
1383
+ const filterSensitiveLog: (obj: RouteMatrixEntryError) => any;
1384
+ }
1385
+ /**
1386
+ * <p>The result for one <code>SnappedDeparturePosition</code>
1387
+ * <code>SnappedDestinationPosition</code> pair.</p>
1388
+ */
1389
+ export interface RouteMatrixEntry {
1390
+ /**
1391
+ * <p>The total distance of travel for the route.</p>
1392
+ */
1393
+ Distance?: number;
1394
+ /**
1395
+ * <p>The expected duration of travel for the route.</p>
1396
+ */
1397
+ DurationSeconds?: number;
1398
+ /**
1399
+ * <p>An error corresponding to the calculation of a route between the
1400
+ * <code>DeparturePosition</code> and <code>DestinationPosition</code>.</p>
1401
+ */
1402
+ Error?: RouteMatrixEntryError;
1403
+ }
1404
+ export declare namespace RouteMatrixEntry {
1405
+ /**
1406
+ * @internal
1407
+ */
1408
+ const filterSensitiveLog: (obj: RouteMatrixEntry) => any;
1409
+ }
1410
+ /**
1411
+ * <p>A summary of the calculated route matrix.</p>
1412
+ */
1413
+ export interface CalculateRouteMatrixSummary {
1414
+ /**
1415
+ * <p>The data provider of traffic and road network data used to calculate the routes.
1416
+ * Indicates one of the available providers:</p>
1417
+ * <ul>
1418
+ * <li>
1419
+ * <p>
1420
+ * <code>Esri</code>
1421
+ * </p>
1422
+ * </li>
1423
+ * <li>
1424
+ * <p>
1425
+ * <code>Here</code>
1426
+ * </p>
1427
+ * </li>
1428
+ * </ul>
1429
+ * <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>
1430
+ */
1431
+ DataSource: string | undefined;
1432
+ /**
1433
+ * <p>The count of cells in the route matrix. Equal to the number of <code>DeparturePositions</code>
1434
+ * multiplied by the number of <code>DestinationPositions</code>.</p>
1435
+ */
1436
+ RouteCount: number | undefined;
1437
+ /**
1438
+ * <p>The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.</p>
1439
+ */
1440
+ ErrorCount: number | undefined;
1441
+ /**
1442
+ * <p>The unit of measurement for route distances.</p>
1443
+ */
1444
+ DistanceUnit: DistanceUnit | string | undefined;
1445
+ }
1446
+ export declare namespace CalculateRouteMatrixSummary {
1447
+ /**
1448
+ * @internal
1449
+ */
1450
+ const filterSensitiveLog: (obj: CalculateRouteMatrixSummary) => any;
1451
+ }
1452
+ /**
1453
+ * <p>Returns the result of the route matrix calculation.</p>
1454
+ */
1455
+ export interface CalculateRouteMatrixResponse {
1456
+ /**
1457
+ * <p>The calculated route matrix containing the results for all pairs of
1458
+ * <code>DeparturePositions</code> to <code>DestinationPositions</code>.
1459
+ * Each row corresponds to one entry in <code>DeparturePositions</code>. Each
1460
+ * entry in the row corresponds to the route from that entry in
1461
+ * <code>DeparturePositions</code> to an entry in <code>DestinationPositions</code>.
1462
+ * </p>
1463
+ */
1464
+ RouteMatrix: RouteMatrixEntry[][] | undefined;
1465
+ /**
1466
+ * <p>For routes calculated using an Esri route calculator resource, departure positions
1467
+ * are snapped to the closest road. For Esri route calculator resources, this returns
1468
+ * the list of departure/origin positions used for calculation of the
1469
+ * <code>RouteMatrix</code>.</p>
1470
+ */
1471
+ SnappedDeparturePositions?: number[][];
1472
+ /**
1473
+ * <p>The list of destination positions for the route matrix used for calculation of the <code>RouteMatrix</code>.</p>
1474
+ */
1475
+ SnappedDestinationPositions?: number[][];
1476
+ /**
1477
+ * <p>Contains information about the route matrix, <code>DataSource</code>,
1478
+ * <code>DistanceUnit</code>, <code>RouteCount</code> and <code>ErrorCount</code>.</p>
1479
+ */
1480
+ Summary: CalculateRouteMatrixSummary | undefined;
1481
+ }
1482
+ export declare namespace CalculateRouteMatrixResponse {
1483
+ /**
1484
+ * @internal
1485
+ */
1486
+ const filterSensitiveLog: (obj: CalculateRouteMatrixResponse) => any;
1487
+ }
1239
1488
  export declare type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking" | "RequestBasedUsage";
1240
1489
  export interface CreateGeofenceCollectionRequest {
1241
1490
  /**
@@ -1256,30 +1505,16 @@ export interface CreateGeofenceCollectionRequest {
1256
1505
  */
1257
1506
  CollectionName: string | undefined;
1258
1507
  /**
1259
- * <p>Optionally specifies the pricing plan for the geofence collection. Defaults to
1508
+ * @deprecated
1509
+ *
1510
+ * <p>No longer used. If included, the only allowed value is
1260
1511
  * <code>RequestBasedUsage</code>.</p>
1261
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
1262
- * page</a>.</p>
1263
1512
  */
1264
1513
  PricingPlan?: PricingPlan | string;
1265
1514
  /**
1266
- * <p>Specifies the data provider for the geofence collection.</p>
1267
- * <ul>
1268
- * <li>
1269
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1270
- * </code>| <code>MobileAssetManagement</code>
1271
- * </p>
1272
- * </li>
1273
- * </ul>
1274
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">Data Providers</a>, and <a href="https://aws.amazon.com/location/pricing/">Pricing plans</a>, see the Amazon Location
1275
- * Service product page.</p>
1276
- * <note>
1277
- * <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for
1278
- * your geofence collection. Your data won't be shared with the data provider, and will
1279
- * remain in your AWS account or Region unless you move it.</p>
1280
- * </note>
1281
- * <p>Valid Values: <code>Esri </code>| <code>Here</code>
1282
- * </p>
1515
+ * @deprecated
1516
+ *
1517
+ * <p>This parameter is no longer used.</p>
1283
1518
  */
1284
1519
  PricingPlanDataSource?: string;
1285
1520
  /**
@@ -1451,9 +1686,10 @@ export interface CreateMapRequest {
1451
1686
  */
1452
1687
  Configuration: MapConfiguration | undefined;
1453
1688
  /**
1454
- * <p>Optionally specifies the pricing plan for the map resource. Defaults to
1689
+ * @deprecated
1690
+ *
1691
+ * <p>No longer used. If included, the only allowed value is
1455
1692
  * <code>RequestBasedUsage</code>.</p>
1456
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1457
1693
  */
1458
1694
  PricingPlan?: PricingPlan | string;
1459
1695
  /**
@@ -1621,9 +1857,10 @@ export interface CreatePlaceIndexRequest {
1621
1857
  */
1622
1858
  DataSource: string | undefined;
1623
1859
  /**
1624
- * <p>Optionally specifies the pricing plan for the place index resource. Defaults to
1860
+ * @deprecated
1861
+ *
1862
+ * <p>No longer used. If included, the only allowed value is
1625
1863
  * <code>RequestBasedUsage</code>.</p>
1626
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1627
1864
  */
1628
1865
  PricingPlan?: PricingPlan | string;
1629
1866
  /**
@@ -1743,9 +1980,10 @@ export interface CreateRouteCalculatorRequest {
1743
1980
  */
1744
1981
  DataSource: string | undefined;
1745
1982
  /**
1746
- * <p>Optionally specifies the pricing plan for the route calculator resource. Defaults to
1983
+ * @deprecated
1984
+ *
1985
+ * <p>No longer used. If included, the only allowed value is
1747
1986
  * <code>RequestBasedUsage</code>.</p>
1748
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
1749
1987
  */
1750
1988
  PricingPlan?: PricingPlan | string;
1751
1989
  /**
@@ -1855,9 +2093,10 @@ export interface CreateTrackerRequest {
1855
2093
  */
1856
2094
  TrackerName: string | undefined;
1857
2095
  /**
1858
- * <p>Optionally specifies the pricing plan for the tracker resource. Defaults to
1859
- * <code>RequestBasedUsage</code>.</p>
1860
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2096
+ * @deprecated
2097
+ *
2098
+ * <p>No longer used. If included, the only allowed value is
2099
+ * <code>RequestBasedUsage</code>.</p>
1861
2100
  */
1862
2101
  PricingPlan?: PricingPlan | string;
1863
2102
  /**
@@ -1865,21 +2104,9 @@ export interface CreateTrackerRequest {
1865
2104
  */
1866
2105
  KmsKeyId?: string;
1867
2106
  /**
1868
- * <p>Specifies the data provider for the tracker resource.</p>
1869
- * <ul>
1870
- * <li>
1871
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1872
- * </code>| <code>MobileAssetManagement</code>
1873
- * </p>
1874
- * </li>
1875
- * </ul>
1876
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">Data Providers</a>, and <a href="https://aws.amazon.com/location/pricing/">Pricing plans</a>, see the Amazon Location
1877
- * Service product page.</p>
1878
- * <note>
1879
- * <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.</p>
1880
- * </note>
1881
- * <p>Valid values: <code>Esri</code> | <code>Here</code>
1882
- * </p>
2107
+ * @deprecated
2108
+ *
2109
+ * <p>This parameter is no longer used.</p>
1883
2110
  */
1884
2111
  PricingPlanDataSource?: string;
1885
2112
  /**
@@ -2121,13 +2348,15 @@ export interface DescribeGeofenceCollectionResponse {
2121
2348
  */
2122
2349
  Description: string | undefined;
2123
2350
  /**
2124
- * <p>The pricing plan selected for the specified geofence collection.</p>
2125
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
2126
- * page</a>.</p>
2351
+ * @deprecated
2352
+ *
2353
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2127
2354
  */
2128
- PricingPlan: PricingPlan | string | undefined;
2355
+ PricingPlan?: PricingPlan | string;
2129
2356
  /**
2130
- * <p>The specified data provider for the geofence collection.</p>
2357
+ * @deprecated
2358
+ *
2359
+ * <p>No longer used. Always returns an empty string.</p>
2131
2360
  */
2132
2361
  PricingPlanDataSource?: string;
2133
2362
  /**
@@ -2189,11 +2418,11 @@ export interface DescribeMapResponse {
2189
2418
  */
2190
2419
  MapArn: string | undefined;
2191
2420
  /**
2192
- * <p>The pricing plan selected for the specified map resource.</p>
2421
+ * @deprecated
2193
2422
  *
2194
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2423
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2195
2424
  */
2196
- PricingPlan: PricingPlan | string | undefined;
2425
+ PricingPlan?: PricingPlan | string;
2197
2426
  /**
2198
2427
  * <p>Specifies the data provider for the associated map tiles.</p>
2199
2428
  */
@@ -2259,10 +2488,11 @@ export interface DescribePlaceIndexResponse {
2259
2488
  */
2260
2489
  IndexArn: string | undefined;
2261
2490
  /**
2262
- * <p>The pricing plan selected for the specified place index resource.</p>
2263
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2491
+ * @deprecated
2492
+ *
2493
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2264
2494
  */
2265
- PricingPlan: PricingPlan | string | undefined;
2495
+ PricingPlan?: PricingPlan | string;
2266
2496
  /**
2267
2497
  * <p>The optional description for the place index resource.</p>
2268
2498
  */
@@ -2341,10 +2571,11 @@ export interface DescribeRouteCalculatorResponse {
2341
2571
  */
2342
2572
  CalculatorArn: string | undefined;
2343
2573
  /**
2344
- * <p>The pricing plan selected for the specified route calculator resource.</p>
2345
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2574
+ * @deprecated
2575
+ *
2576
+ * <p>Always returns <code>RequestBasedUsage</code>.</p>
2346
2577
  */
2347
- PricingPlan: PricingPlan | string | undefined;
2578
+ PricingPlan?: PricingPlan | string;
2348
2579
  /**
2349
2580
  * <p>The optional description of the route calculator resource.</p>
2350
2581
  */
@@ -2436,12 +2667,15 @@ export interface DescribeTrackerResponse {
2436
2667
  */
2437
2668
  Description: string | undefined;
2438
2669
  /**
2439
- * <p>The pricing plan selected for the specified tracker resource.</p>
2440
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
2670
+ * @deprecated
2671
+ *
2672
+ * <p>Always returns <code>RequestBasedUsage</code>.</p>
2441
2673
  */
2442
- PricingPlan: PricingPlan | string | undefined;
2674
+ PricingPlan?: PricingPlan | string;
2443
2675
  /**
2444
- * <p>The specified data provider for the tracker resource.</p>
2676
+ * @deprecated
2677
+ *
2678
+ * <p>No longer used. Always returns an empty string.</p>
2445
2679
  */
2446
2680
  PricingPlanDataSource?: string;
2447
2681
  /**
@@ -2739,13 +2973,15 @@ export interface ListGeofenceCollectionsResponseEntry {
2739
2973
  */
2740
2974
  Description: string | undefined;
2741
2975
  /**
2742
- * <p>The pricing plan for the specified geofence collection.</p>
2743
- * <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
2744
- * page</a>.</p>
2976
+ * @deprecated
2977
+ *
2978
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2745
2979
  */
2746
- PricingPlan: PricingPlan | string | undefined;
2980
+ PricingPlan?: PricingPlan | string;
2747
2981
  /**
2748
- * <p>The specified data provider for the geofence collection.</p>
2982
+ * @deprecated
2983
+ *
2984
+ * <p>No longer used. Always returns an empty string.</p>
2749
2985
  */
2750
2986
  PricingPlanDataSource?: string;
2751
2987
  /**
@@ -2933,26 +3169,16 @@ export interface UpdateGeofenceCollectionRequest {
2933
3169
  */
2934
3170
  CollectionName: string | undefined;
2935
3171
  /**
2936
- * <p>Updates the pricing plan for the geofence collection.</p>
2937
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
2938
- * pricing</a>.</p>
3172
+ * @deprecated
3173
+ *
3174
+ * <p>No longer used. If included, the only allowed value is
3175
+ * <code>RequestBasedUsage</code>.</p>
2939
3176
  */
2940
3177
  PricingPlan?: PricingPlan | string;
2941
3178
  /**
2942
- * <p>Updates the data provider for the geofence collection. </p>
2943
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>|
2944
- * <code>MobileAssetManagement</code>
2945
- * </p>
2946
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">data providers</a> and
2947
- * <a href="https://aws.amazon.com/location/pricing/">pricing plans</a>, see the
2948
- * Amazon Location Service product page.</p>
2949
- * <note>
2950
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
2951
- * request.</p>
2952
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
2953
- * billing for your geofence collection. Your data won't be shared with the data
2954
- * provider, and will remain in your AWS account and Region unless you move it.</p>
2955
- * </note>
3179
+ * @deprecated
3180
+ *
3181
+ * <p>This parameter is no longer used.</p>
2956
3182
  */
2957
3183
  PricingPlanDataSource?: string;
2958
3184
  /**
@@ -3433,10 +3659,11 @@ export interface ListMapsResponseEntry {
3433
3659
  */
3434
3660
  DataSource: string | undefined;
3435
3661
  /**
3436
- * <p>The pricing plan for the specified map resource.</p>
3437
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3662
+ * @deprecated
3663
+ *
3664
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
3438
3665
  */
3439
- PricingPlan: PricingPlan | string | undefined;
3666
+ PricingPlan?: PricingPlan | string;
3440
3667
  /**
3441
3668
  * <p>The timestamp for when the map resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3442
3669
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
@@ -3521,10 +3748,11 @@ export interface ListPlaceIndexesResponseEntry {
3521
3748
  */
3522
3749
  DataSource: string | undefined;
3523
3750
  /**
3524
- * <p>The pricing plan for the specified place index resource.</p>
3525
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3751
+ * @deprecated
3752
+ *
3753
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
3526
3754
  */
3527
- PricingPlan: PricingPlan | string | undefined;
3755
+ PricingPlan?: PricingPlan | string;
3528
3756
  /**
3529
3757
  * <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> format:
3530
3758
  * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
@@ -3611,10 +3839,11 @@ export interface ListRouteCalculatorsResponseEntry {
3611
3839
  */
3612
3840
  DataSource: string | undefined;
3613
3841
  /**
3614
- * <p>The pricing plan for the specified route calculator resource.</p>
3615
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3842
+ * @deprecated
3843
+ *
3844
+ * <p>Always returns <code>RequestBasedUsage</code>.</p>
3616
3845
  */
3617
- PricingPlan: PricingPlan | string | undefined;
3846
+ PricingPlan?: PricingPlan | string;
3618
3847
  /**
3619
3848
  * <p>The timestamp when the route calculator resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a>
3620
3849
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
@@ -3737,12 +3966,15 @@ export interface ListTrackersResponseEntry {
3737
3966
  */
3738
3967
  Description: string | undefined;
3739
3968
  /**
3740
- * <p>The pricing plan for the specified tracker resource.</p>
3741
- * <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
3969
+ * @deprecated
3970
+ *
3971
+ * <p>Always returns <code>RequestBasedUsage</code>.</p>
3742
3972
  */
3743
- PricingPlan: PricingPlan | string | undefined;
3973
+ PricingPlan?: PricingPlan | string;
3744
3974
  /**
3745
- * <p>The specified data provider for the tracker resource.</p>
3975
+ * @deprecated
3976
+ *
3977
+ * <p>No longer used. Always returns an empty string.</p>
3746
3978
  */
3747
3979
  PricingPlanDataSource?: string;
3748
3980
  /**
@@ -3786,8 +4018,10 @@ export interface UpdateMapRequest {
3786
4018
  */
3787
4019
  MapName: string | undefined;
3788
4020
  /**
3789
- * <p>Updates the pricing plan for the map resource.</p>
3790
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
4021
+ * @deprecated
4022
+ *
4023
+ * <p>No longer used. If included, the only allowed value is
4024
+ * <code>RequestBasedUsage</code>.</p>
3791
4025
  */
3792
4026
  PricingPlan?: PricingPlan | string;
3793
4027
  /**
@@ -4434,8 +4668,10 @@ export interface UpdatePlaceIndexRequest {
4434
4668
  */
4435
4669
  IndexName: string | undefined;
4436
4670
  /**
4437
- * <p>Updates the pricing plan for the place index resource.</p>
4438
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
4671
+ * @deprecated
4672
+ *
4673
+ * <p>No longer used. If included, the only allowed value is
4674
+ * <code>RequestBasedUsage</code>.</p>
4439
4675
  */
4440
4676
  PricingPlan?: PricingPlan | string;
4441
4677
  /**
@@ -4488,9 +4724,10 @@ export interface UpdateRouteCalculatorRequest {
4488
4724
  */
4489
4725
  CalculatorName: string | undefined;
4490
4726
  /**
4491
- * <p>Updates the pricing plan for the route calculator resource.</p>
4492
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location
4493
- * Service pricing</a>.</p>
4727
+ * @deprecated
4728
+ *
4729
+ * <p>No longer used. If included, the only allowed value is
4730
+ * <code>RequestBasedUsage</code>.</p>
4494
4731
  */
4495
4732
  PricingPlan?: PricingPlan | string;
4496
4733
  /**
@@ -4539,24 +4776,16 @@ export interface UpdateTrackerRequest {
4539
4776
  */
4540
4777
  TrackerName: string | undefined;
4541
4778
  /**
4542
- * <p>Updates the pricing plan for the tracker resource.</p>
4543
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
4544
- * pricing</a>.</p>
4779
+ * @deprecated
4780
+ *
4781
+ * <p>No longer used. If included, the only allowed value is
4782
+ * <code>RequestBasedUsage</code>.</p>
4545
4783
  */
4546
4784
  PricingPlan?: PricingPlan | string;
4547
4785
  /**
4548
- * <p>Updates the data provider for the tracker resource. </p>
4549
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>| <code>MobileAssetManagement</code>
4550
- * </p>
4551
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">data providers</a> and <a href="https://aws.amazon.com/location/pricing/">pricing plans</a>, see the Amazon Location Service product
4552
- * page</p>
4553
- * <note>
4554
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
4555
- * request.</p>
4556
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
4557
- * billing for your tracker resource. Your data won't be shared with the data provider,
4558
- * and will remain in your AWS account and Region unless you move it.</p>
4559
- * </note>
4786
+ * @deprecated
4787
+ *
4788
+ * <p>This parameter is no longer used.</p>
4560
4789
  */
4561
4790
  PricingPlanDataSource?: string;
4562
4791
  /**