@aws-sdk/client-location 3.47.2 → 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.
@@ -799,7 +799,7 @@ export interface CalculateRouteRequest {
799
799
  * </li>
800
800
  * </ul>
801
801
  * <note>
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/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
803
803
  * position to the nearest road</a>. If Esri is the provider for your route calculator,
804
804
  * specifying a route that is longer than 400 km returns a <code>400 RoutesValidationException</code> error.</p>
805
805
  * </note>
@@ -817,7 +817,7 @@ export interface CalculateRouteRequest {
817
817
  * </li>
818
818
  * </ul>
819
819
  * <note>
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/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>
821
821
  * </note>
822
822
  * <p>Valid Values: <code>[-180 to 180,-90 to 90]</code>
823
823
  * </p>
@@ -835,7 +835,7 @@ export interface CalculateRouteRequest {
835
835
  * </li>
836
836
  * </ul>
837
837
  * <note>
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/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>
839
839
  * <p>Specifying more than 23 waypoints returns a <code>400 ValidationException</code>
840
840
  * error.</p>
841
841
  * <p>If Esri is the provider for your route calculator, specifying a
@@ -848,7 +848,8 @@ export interface CalculateRouteRequest {
848
848
  /**
849
849
  * <p>Specifies the mode of transport when calculating a route. Used in estimating the speed
850
850
  * of travel and road compatibility.</p>
851
- * <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>
852
853
  * <ul>
853
854
  * <li>
854
855
  * <p>If traveling by <code>Car</code> use the <code>CarModeOptions</code>
@@ -997,7 +998,7 @@ export declare namespace Step {
997
998
  * number of legs returned corresponds to one fewer than the total number of positions in
998
999
  * the request. </p>
999
1000
  * <p>For example, a route with a departure position and destination position returns one
1000
- * 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>
1001
1002
  * <ul>
1002
1003
  * <li>
1003
1004
  * <p>The <code>StartPosition</code> is the departure position.</p>
@@ -1024,7 +1025,7 @@ export interface Leg {
1024
1025
  * <p>The starting position of the leg. Follows the format
1025
1026
  * <code>[longitude,latitude]</code>.</p>
1026
1027
  * <note>
1027
- * <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>
1028
1029
  * </note>
1029
1030
  */
1030
1031
  StartPosition: number[] | undefined;
@@ -1032,7 +1033,7 @@ export interface Leg {
1032
1033
  * <p>The terminating position of the leg. Follows the format
1033
1034
  * <code>[longitude,latitude]</code>.</p>
1034
1035
  * <note>
1035
- * <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>
1036
1037
  * </note>
1037
1038
  */
1038
1039
  EndPosition: number[] | undefined;
@@ -1158,7 +1159,7 @@ export interface CalculateRouteResponse {
1158
1159
  * number of legs returned corresponds to one fewer than the total number of positions in
1159
1160
  * the request. </p>
1160
1161
  * <p>For example, a route with a departure position and destination position returns one
1161
- * 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>
1162
1163
  * <ul>
1163
1164
  * <li>
1164
1165
  * <p>The <code>StartPosition</code> is the departure position.</p>
@@ -1194,6 +1195,296 @@ export declare namespace CalculateRouteResponse {
1194
1195
  */
1195
1196
  const filterSensitiveLog: (obj: CalculateRouteResponse) => any;
1196
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
+ }
1197
1488
  export declare type PricingPlan = "MobileAssetManagement" | "MobileAssetTracking" | "RequestBasedUsage";
1198
1489
  export interface CreateGeofenceCollectionRequest {
1199
1490
  /**
@@ -1214,30 +1505,16 @@ export interface CreateGeofenceCollectionRequest {
1214
1505
  */
1215
1506
  CollectionName: string | undefined;
1216
1507
  /**
1217
- * <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
1218
1511
  * <code>RequestBasedUsage</code>.</p>
1219
- * <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
1220
- * page</a>.</p>
1221
1512
  */
1222
1513
  PricingPlan?: PricingPlan | string;
1223
1514
  /**
1224
- * <p>Specifies the data provider for the geofence collection.</p>
1225
- * <ul>
1226
- * <li>
1227
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1228
- * </code>| <code>MobileAssetManagement</code>
1229
- * </p>
1230
- * </li>
1231
- * </ul>
1232
- * <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
1233
- * Service product page.</p>
1234
- * <note>
1235
- * <p>Amazon Location Service only uses <code>PricingPlanDataSource</code> to calculate billing for
1236
- * your geofence collection. Your data won't be shared with the data provider, and will
1237
- * remain in your AWS account or Region unless you move it.</p>
1238
- * </note>
1239
- * <p>Valid Values: <code>Esri </code>| <code>Here</code>
1240
- * </p>
1515
+ * @deprecated
1516
+ *
1517
+ * <p>This parameter is no longer used.</p>
1241
1518
  */
1242
1519
  PricingPlanDataSource?: string;
1243
1520
  /**
@@ -1409,9 +1686,10 @@ export interface CreateMapRequest {
1409
1686
  */
1410
1687
  Configuration: MapConfiguration | undefined;
1411
1688
  /**
1412
- * <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
1413
1692
  * <code>RequestBasedUsage</code>.</p>
1414
- * <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>
1415
1693
  */
1416
1694
  PricingPlan?: PricingPlan | string;
1417
1695
  /**
@@ -1579,9 +1857,10 @@ export interface CreatePlaceIndexRequest {
1579
1857
  */
1580
1858
  DataSource: string | undefined;
1581
1859
  /**
1582
- * <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
1583
1863
  * <code>RequestBasedUsage</code>.</p>
1584
- * <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>
1585
1864
  */
1586
1865
  PricingPlan?: PricingPlan | string;
1587
1866
  /**
@@ -1701,9 +1980,10 @@ export interface CreateRouteCalculatorRequest {
1701
1980
  */
1702
1981
  DataSource: string | undefined;
1703
1982
  /**
1704
- * <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
1705
1986
  * <code>RequestBasedUsage</code>.</p>
1706
- * <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>
1707
1987
  */
1708
1988
  PricingPlan?: PricingPlan | string;
1709
1989
  /**
@@ -1813,9 +2093,10 @@ export interface CreateTrackerRequest {
1813
2093
  */
1814
2094
  TrackerName: string | undefined;
1815
2095
  /**
1816
- * <p>Optionally specifies the pricing plan for the tracker resource. Defaults to
1817
- * <code>RequestBasedUsage</code>.</p>
1818
- * <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>
1819
2100
  */
1820
2101
  PricingPlan?: PricingPlan | string;
1821
2102
  /**
@@ -1823,21 +2104,9 @@ export interface CreateTrackerRequest {
1823
2104
  */
1824
2105
  KmsKeyId?: string;
1825
2106
  /**
1826
- * <p>Specifies the data provider for the tracker resource.</p>
1827
- * <ul>
1828
- * <li>
1829
- * <p>Required value for the following pricing plans: <code>MobileAssetTracking
1830
- * </code>| <code>MobileAssetManagement</code>
1831
- * </p>
1832
- * </li>
1833
- * </ul>
1834
- * <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
1835
- * Service product page.</p>
1836
- * <note>
1837
- * <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>
1838
- * </note>
1839
- * <p>Valid values: <code>Esri</code> | <code>Here</code>
1840
- * </p>
2107
+ * @deprecated
2108
+ *
2109
+ * <p>This parameter is no longer used.</p>
1841
2110
  */
1842
2111
  PricingPlanDataSource?: string;
1843
2112
  /**
@@ -2079,13 +2348,15 @@ export interface DescribeGeofenceCollectionResponse {
2079
2348
  */
2080
2349
  Description: string | undefined;
2081
2350
  /**
2082
- * <p>The pricing plan selected for the specified geofence collection.</p>
2083
- * <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
2084
- * page</a>.</p>
2351
+ * @deprecated
2352
+ *
2353
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2085
2354
  */
2086
- PricingPlan: PricingPlan | string | undefined;
2355
+ PricingPlan?: PricingPlan | string;
2087
2356
  /**
2088
- * <p>The specified data provider for the geofence collection.</p>
2357
+ * @deprecated
2358
+ *
2359
+ * <p>No longer used. Always returns an empty string.</p>
2089
2360
  */
2090
2361
  PricingPlanDataSource?: string;
2091
2362
  /**
@@ -2147,11 +2418,11 @@ export interface DescribeMapResponse {
2147
2418
  */
2148
2419
  MapArn: string | undefined;
2149
2420
  /**
2150
- * <p>The pricing plan selected for the specified map resource.</p>
2421
+ * @deprecated
2151
2422
  *
2152
- * <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>
2153
2424
  */
2154
- PricingPlan: PricingPlan | string | undefined;
2425
+ PricingPlan?: PricingPlan | string;
2155
2426
  /**
2156
2427
  * <p>Specifies the data provider for the associated map tiles.</p>
2157
2428
  */
@@ -2217,10 +2488,11 @@ export interface DescribePlaceIndexResponse {
2217
2488
  */
2218
2489
  IndexArn: string | undefined;
2219
2490
  /**
2220
- * <p>The pricing plan selected for the specified place index resource.</p>
2221
- * <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>
2222
2494
  */
2223
- PricingPlan: PricingPlan | string | undefined;
2495
+ PricingPlan?: PricingPlan | string;
2224
2496
  /**
2225
2497
  * <p>The optional description for the place index resource.</p>
2226
2498
  */
@@ -2299,10 +2571,11 @@ export interface DescribeRouteCalculatorResponse {
2299
2571
  */
2300
2572
  CalculatorArn: string | undefined;
2301
2573
  /**
2302
- * <p>The pricing plan selected for the specified route calculator resource.</p>
2303
- * <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>
2304
2577
  */
2305
- PricingPlan: PricingPlan | string | undefined;
2578
+ PricingPlan?: PricingPlan | string;
2306
2579
  /**
2307
2580
  * <p>The optional description of the route calculator resource.</p>
2308
2581
  */
@@ -2394,12 +2667,15 @@ export interface DescribeTrackerResponse {
2394
2667
  */
2395
2668
  Description: string | undefined;
2396
2669
  /**
2397
- * <p>The pricing plan selected for the specified tracker resource.</p>
2398
- * <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>
2399
2673
  */
2400
- PricingPlan: PricingPlan | string | undefined;
2674
+ PricingPlan?: PricingPlan | string;
2401
2675
  /**
2402
- * <p>The specified data provider for the tracker resource.</p>
2676
+ * @deprecated
2677
+ *
2678
+ * <p>No longer used. Always returns an empty string.</p>
2403
2679
  */
2404
2680
  PricingPlanDataSource?: string;
2405
2681
  /**
@@ -2697,13 +2973,15 @@ export interface ListGeofenceCollectionsResponseEntry {
2697
2973
  */
2698
2974
  Description: string | undefined;
2699
2975
  /**
2700
- * <p>The pricing plan for the specified geofence collection.</p>
2701
- * <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
2702
- * page</a>.</p>
2976
+ * @deprecated
2977
+ *
2978
+ * <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
2703
2979
  */
2704
- PricingPlan: PricingPlan | string | undefined;
2980
+ PricingPlan?: PricingPlan | string;
2705
2981
  /**
2706
- * <p>The specified data provider for the geofence collection.</p>
2982
+ * @deprecated
2983
+ *
2984
+ * <p>No longer used. Always returns an empty string.</p>
2707
2985
  */
2708
2986
  PricingPlanDataSource?: string;
2709
2987
  /**
@@ -2891,26 +3169,16 @@ export interface UpdateGeofenceCollectionRequest {
2891
3169
  */
2892
3170
  CollectionName: string | undefined;
2893
3171
  /**
2894
- * <p>Updates the pricing plan for the geofence collection.</p>
2895
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
2896
- * pricing</a>.</p>
3172
+ * @deprecated
3173
+ *
3174
+ * <p>No longer used. If included, the only allowed value is
3175
+ * <code>RequestBasedUsage</code>.</p>
2897
3176
  */
2898
3177
  PricingPlan?: PricingPlan | string;
2899
3178
  /**
2900
- * <p>Updates the data provider for the geofence collection. </p>
2901
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>|
2902
- * <code>MobileAssetManagement</code>
2903
- * </p>
2904
- * <p>For more information about <a href="https://aws.amazon.com/location/data-providers/">data providers</a> and
2905
- * <a href="https://aws.amazon.com/location/pricing/">pricing plans</a>, see the
2906
- * Amazon Location Service product page.</p>
2907
- * <note>
2908
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
2909
- * request.</p>
2910
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
2911
- * billing for your geofence collection. Your data won't be shared with the data
2912
- * provider, and will remain in your AWS account and Region unless you move it.</p>
2913
- * </note>
3179
+ * @deprecated
3180
+ *
3181
+ * <p>This parameter is no longer used.</p>
2914
3182
  */
2915
3183
  PricingPlanDataSource?: string;
2916
3184
  /**
@@ -3391,10 +3659,11 @@ export interface ListMapsResponseEntry {
3391
3659
  */
3392
3660
  DataSource: string | undefined;
3393
3661
  /**
3394
- * <p>The pricing plan for the specified map resource.</p>
3395
- * <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>
3396
3665
  */
3397
- PricingPlan: PricingPlan | string | undefined;
3666
+ PricingPlan?: PricingPlan | string;
3398
3667
  /**
3399
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>
3400
3669
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>.</p>
@@ -3479,10 +3748,11 @@ export interface ListPlaceIndexesResponseEntry {
3479
3748
  */
3480
3749
  DataSource: string | undefined;
3481
3750
  /**
3482
- * <p>The pricing plan for the specified place index resource.</p>
3483
- * <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>
3484
3754
  */
3485
- PricingPlan: PricingPlan | string | undefined;
3755
+ PricingPlan?: PricingPlan | string;
3486
3756
  /**
3487
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:
3488
3758
  * <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
@@ -3569,10 +3839,11 @@ export interface ListRouteCalculatorsResponseEntry {
3569
3839
  */
3570
3840
  DataSource: string | undefined;
3571
3841
  /**
3572
- * <p>The pricing plan for the specified route calculator resource.</p>
3573
- * <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>
3574
3845
  */
3575
- PricingPlan: PricingPlan | string | undefined;
3846
+ PricingPlan?: PricingPlan | string;
3576
3847
  /**
3577
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>
3578
3849
  * format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. </p>
@@ -3695,12 +3966,15 @@ export interface ListTrackersResponseEntry {
3695
3966
  */
3696
3967
  Description: string | undefined;
3697
3968
  /**
3698
- * <p>The pricing plan for the specified tracker resource.</p>
3699
- * <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>
3700
3972
  */
3701
- PricingPlan: PricingPlan | string | undefined;
3973
+ PricingPlan?: PricingPlan | string;
3702
3974
  /**
3703
- * <p>The specified data provider for the tracker resource.</p>
3975
+ * @deprecated
3976
+ *
3977
+ * <p>No longer used. Always returns an empty string.</p>
3704
3978
  */
3705
3979
  PricingPlanDataSource?: string;
3706
3980
  /**
@@ -3744,8 +4018,10 @@ export interface UpdateMapRequest {
3744
4018
  */
3745
4019
  MapName: string | undefined;
3746
4020
  /**
3747
- * <p>Updates the pricing plan for the map resource.</p>
3748
- * <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>
3749
4025
  */
3750
4026
  PricingPlan?: PricingPlan | string;
3751
4027
  /**
@@ -4392,8 +4668,10 @@ export interface UpdatePlaceIndexRequest {
4392
4668
  */
4393
4669
  IndexName: string | undefined;
4394
4670
  /**
4395
- * <p>Updates the pricing plan for the place index resource.</p>
4396
- * <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>
4397
4675
  */
4398
4676
  PricingPlan?: PricingPlan | string;
4399
4677
  /**
@@ -4446,9 +4724,10 @@ export interface UpdateRouteCalculatorRequest {
4446
4724
  */
4447
4725
  CalculatorName: string | undefined;
4448
4726
  /**
4449
- * <p>Updates the pricing plan for the route calculator resource.</p>
4450
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location
4451
- * Service pricing</a>.</p>
4727
+ * @deprecated
4728
+ *
4729
+ * <p>No longer used. If included, the only allowed value is
4730
+ * <code>RequestBasedUsage</code>.</p>
4452
4731
  */
4453
4732
  PricingPlan?: PricingPlan | string;
4454
4733
  /**
@@ -4497,24 +4776,16 @@ export interface UpdateTrackerRequest {
4497
4776
  */
4498
4777
  TrackerName: string | undefined;
4499
4778
  /**
4500
- * <p>Updates the pricing plan for the tracker resource.</p>
4501
- * <p>For more information about each pricing plan option restrictions, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service
4502
- * pricing</a>.</p>
4779
+ * @deprecated
4780
+ *
4781
+ * <p>No longer used. If included, the only allowed value is
4782
+ * <code>RequestBasedUsage</code>.</p>
4503
4783
  */
4504
4784
  PricingPlan?: PricingPlan | string;
4505
4785
  /**
4506
- * <p>Updates the data provider for the tracker resource. </p>
4507
- * <p>A required value for the following pricing plans: <code>MobileAssetTracking</code>| <code>MobileAssetManagement</code>
4508
- * </p>
4509
- * <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
4510
- * page</p>
4511
- * <note>
4512
- * <p>This can only be updated when updating the <code>PricingPlan</code> in the same
4513
- * request.</p>
4514
- * <p>Amazon Location Service uses <code>PricingPlanDataSource</code> to calculate
4515
- * billing for your tracker resource. Your data won't be shared with the data provider,
4516
- * and will remain in your AWS account and Region unless you move it.</p>
4517
- * </note>
4786
+ * @deprecated
4787
+ *
4788
+ * <p>This parameter is no longer used.</p>
4518
4789
  */
4519
4790
  PricingPlanDataSource?: string;
4520
4791
  /**