aws-sdk-locationservice 1.11.0 → 1.15.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.
@@ -219,8 +219,14 @@ module Aws::LocationService
219
219
  # collection_name: "ResourceName", # required
220
220
  # device_position_updates: [ # required
221
221
  # {
222
+ # accuracy: {
223
+ # horizontal: 1.0, # required
224
+ # },
222
225
  # device_id: "Id", # required
223
226
  # position: [1.0], # required
227
+ # position_properties: {
228
+ # "PropertyMapKeyString" => "PropertyMapValueString",
229
+ # },
224
230
  # sample_time: Time.now, # required
225
231
  # },
226
232
  # ],
@@ -536,8 +542,14 @@ module Aws::LocationService
536
542
  # tracker_name: "ResourceName", # required
537
543
  # updates: [ # required
538
544
  # {
545
+ # accuracy: {
546
+ # horizontal: 1.0, # required
547
+ # },
539
548
  # device_id: "Id", # required
540
549
  # position: [1.0], # required
550
+ # position_properties: {
551
+ # "PropertyMapKeyString" => "PropertyMapValueString",
552
+ # },
541
553
  # sample_time: Time.now, # required
542
554
  # },
543
555
  # ],
@@ -646,7 +658,7 @@ module Aws::LocationService
646
658
  #
647
659
  # @!attribute [rw] calculator_name
648
660
  # The name of the route calculator resource that you want to use to
649
- # calculate a route.
661
+ # calculate the route.
650
662
  # @return [String]
651
663
  #
652
664
  # @!attribute [rw] car_mode_options
@@ -691,7 +703,7 @@ module Aws::LocationService
691
703
  #
692
704
  # @!attribute [rw] departure_time
693
705
  # Specifies the desired time of departure. Uses the given time to
694
- # calculate a route. Otherwise, the best time of day to travel with
706
+ # calculate the route. Otherwise, the best time of day to travel with
695
707
  # the best traffic conditions is used to calculate the route.
696
708
  #
697
709
  # <note markdown="1"> Setting a departure time in the past returns a `400
@@ -892,7 +904,7 @@ module Aws::LocationService
892
904
  # @return [Float]
893
905
  #
894
906
  # @!attribute [rw] distance_unit
895
- # The unit of measurement for the distance.
907
+ # The unit of measurement for route distances.
896
908
  # @return [String]
897
909
  #
898
910
  # @!attribute [rw] duration_seconds
@@ -1014,7 +1026,7 @@ module Aws::LocationService
1014
1026
  # collection_name: "ResourceName", # required
1015
1027
  # description: "ResourceDescription",
1016
1028
  # kms_key_id: "KmsKeyId",
1017
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1029
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1018
1030
  # pricing_plan_data_source: "String",
1019
1031
  # tags: {
1020
1032
  # "TagKey" => "TagValue",
@@ -1048,7 +1060,8 @@ module Aws::LocationService
1048
1060
  # @return [String]
1049
1061
  #
1050
1062
  # @!attribute [rw] pricing_plan
1051
- # Specifies the pricing plan for the geofence collection.
1063
+ # Optionally specifies the pricing plan for the geofence collection.
1064
+ # Defaults to `RequestBasedUsage`.
1052
1065
  #
1053
1066
  # For additional details and restrictions on each pricing plan option,
1054
1067
  # see the [Amazon Location Service pricing page][1].
@@ -1103,6 +1116,8 @@ module Aws::LocationService
1103
1116
  #
1104
1117
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1105
1118
  # characters: + - = . \_ : / @.
1119
+ #
1120
+ # * Cannot use "aws:" as a prefix for a key.
1106
1121
  # @return [Hash<String,String>]
1107
1122
  #
1108
1123
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
@@ -1160,7 +1175,7 @@ module Aws::LocationService
1160
1175
  # },
1161
1176
  # description: "ResourceDescription",
1162
1177
  # map_name: "ResourceName", # required
1163
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1178
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1164
1179
  # tags: {
1165
1180
  # "TagKey" => "TagValue",
1166
1181
  # },
@@ -1188,7 +1203,8 @@ module Aws::LocationService
1188
1203
  # @return [String]
1189
1204
  #
1190
1205
  # @!attribute [rw] pricing_plan
1191
- # Specifies the pricing plan for your map resource.
1206
+ # Optionally specifies the pricing plan for the map resource. Defaults
1207
+ # to `RequestBasedUsage`.
1192
1208
  #
1193
1209
  # For additional details and restrictions on each pricing plan option,
1194
1210
  # see [Amazon Location Service pricing][1].
@@ -1217,6 +1233,8 @@ module Aws::LocationService
1217
1233
  #
1218
1234
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1219
1235
  # characters: + - = . \_ : / @.
1236
+ #
1237
+ # * Cannot use "aws:" as a prefix for a key.
1220
1238
  # @return [Hash<String,String>]
1221
1239
  #
1222
1240
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
@@ -1273,14 +1291,14 @@ module Aws::LocationService
1273
1291
  # },
1274
1292
  # description: "ResourceDescription",
1275
1293
  # index_name: "ResourceName", # required
1276
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1294
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1277
1295
  # tags: {
1278
1296
  # "TagKey" => "TagValue",
1279
1297
  # },
1280
1298
  # }
1281
1299
  #
1282
1300
  # @!attribute [rw] data_source
1283
- # Specifies the data provider of geospatial data.
1301
+ # Specifies the geospatial data provider for the new place index.
1284
1302
  #
1285
1303
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1286
1304
  # example, entering `HERE` returns an error.
@@ -1297,8 +1315,8 @@ module Aws::LocationService
1297
1315
  # coverage in your region of interest, see [HERE details on
1298
1316
  # goecoding coverage][4].
1299
1317
  #
1300
- # Place index resources using HERE Technologies as a data provider
1301
- # can't [store results][5] for locations in Japan. For more
1318
+ # If you specify HERE Technologies (`Here`) as the data provider,
1319
+ # you may not [store results][5] for locations in Japan. For more
1302
1320
  # information, see the [AWS Service Terms][6] for Amazon Location
1303
1321
  # Service.
1304
1322
  #
@@ -1338,7 +1356,8 @@ module Aws::LocationService
1338
1356
  # @return [String]
1339
1357
  #
1340
1358
  # @!attribute [rw] pricing_plan
1341
- # Specifies the pricing plan for your place index resource.
1359
+ # Optionally specifies the pricing plan for the place index resource.
1360
+ # Defaults to `RequestBasedUsage`.
1342
1361
  #
1343
1362
  # For additional details and restrictions on each pricing plan option,
1344
1363
  # see [Amazon Location Service pricing][1].
@@ -1350,23 +1369,26 @@ module Aws::LocationService
1350
1369
  #
1351
1370
  # @!attribute [rw] tags
1352
1371
  # Applies one or more tags to the place index resource. A tag is a
1353
- # key-value pair helps manage, identify, search, and filter your
1354
- # resources by labelling them.
1372
+ # key-value pair that helps you manage, identify, search, and filter
1373
+ # your resources.
1355
1374
  #
1356
1375
  # Format: `"key" : "value"`
1357
1376
  #
1358
1377
  # Restrictions:
1359
1378
  #
1360
- # * Maximum 50 tags per resource
1379
+ # * Maximum 50 tags per resource.
1361
1380
  #
1362
- # * Each resource tag must be unique with a maximum of one value.
1381
+ # * Each tag key must be unique and must have exactly one associated
1382
+ # value.
1363
1383
  #
1364
- # * Maximum key length: 128 Unicode characters in UTF-8
1384
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1365
1385
  #
1366
- # * Maximum value length: 256 Unicode characters in UTF-8
1386
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1367
1387
  #
1368
1388
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1369
- # characters: + - = . \_ : / @.
1389
+ # characters: + - = . \_ : / @
1390
+ #
1391
+ # * Cannot use "aws:" as a prefix for a key.
1370
1392
  # @return [Hash<String,String>]
1371
1393
  #
1372
1394
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
@@ -1422,7 +1444,7 @@ module Aws::LocationService
1422
1444
  # calculator_name: "ResourceName", # required
1423
1445
  # data_source: "String", # required
1424
1446
  # description: "ResourceDescription",
1425
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1447
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1426
1448
  # tags: {
1427
1449
  # "TagKey" => "TagValue",
1428
1450
  # },
@@ -1479,7 +1501,8 @@ module Aws::LocationService
1479
1501
  # @return [String]
1480
1502
  #
1481
1503
  # @!attribute [rw] pricing_plan
1482
- # Specifies the pricing plan for your route calculator resource.
1504
+ # Optionally specifies the pricing plan for the route calculator
1505
+ # resource. Defaults to `RequestBasedUsage`.
1483
1506
  #
1484
1507
  # For additional details and restrictions on each pricing plan option,
1485
1508
  # see [Amazon Location Service pricing][1].
@@ -1512,6 +1535,8 @@ module Aws::LocationService
1512
1535
  #
1513
1536
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1514
1537
  # characters: + - = . \_ : / @.
1538
+ #
1539
+ # * Cannot use "aws:" as a prefix for a key.
1515
1540
  # @return [Hash<String,String>]
1516
1541
  #
1517
1542
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorRequest AWS API Documentation
@@ -1573,8 +1598,8 @@ module Aws::LocationService
1573
1598
  # {
1574
1599
  # description: "ResourceDescription",
1575
1600
  # kms_key_id: "KmsKeyId",
1576
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
1577
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1601
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1602
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1578
1603
  # pricing_plan_data_source: "String",
1579
1604
  # tags: {
1580
1605
  # "TagKey" => "TagValue",
@@ -1607,18 +1632,29 @@ module Aws::LocationService
1607
1632
  #
1608
1633
  # * `DistanceBased` - If the device has moved less than 30 m (98.4
1609
1634
  # ft), location updates are ignored. Location updates within this
1610
- # distance are neither evaluated against linked geofence
1611
- # collections, nor stored. This helps control costs by reducing the
1612
- # number of geofence evaluations and device positions to retrieve.
1613
- # Distance-based filtering can also reduce the jitter effect when
1614
- # displaying device trajectory on a map.
1635
+ # area are neither evaluated against linked geofence collections,
1636
+ # nor stored. This helps control costs by reducing the number of
1637
+ # geofence evaluations and historical device positions to paginate
1638
+ # through. Distance-based filtering can also reduce the effects of
1639
+ # GPS noise when displaying device trajectories on a map.
1640
+ #
1641
+ # * `AccuracyBased` - If the device has moved less than the measured
1642
+ # accuracy, location updates are ignored. For example, if two
1643
+ # consecutive updates from a device have a horizontal accuracy of 5
1644
+ # m and 10 m, the second update is ignored if the device has moved
1645
+ # less than 15 m. Ignored location updates are neither evaluated
1646
+ # against linked geofence collections, nor stored. This can reduce
1647
+ # the effects of GPS noise when displaying device trajectories on a
1648
+ # map, and can help control your costs by reducing the number of
1649
+ # geofence evaluations.
1615
1650
  #
1616
1651
  # This field is optional. If not specified, the default value is
1617
1652
  # `TimeBased`.
1618
1653
  # @return [String]
1619
1654
  #
1620
1655
  # @!attribute [rw] pricing_plan
1621
- # Specifies the pricing plan for the tracker resource.
1656
+ # Optionally specifies the pricing plan for the tracker resource.
1657
+ # Defaults to `RequestBasedUsage`.
1622
1658
  #
1623
1659
  # For additional details and restrictions on each pricing plan option,
1624
1660
  # see [Amazon Location Service pricing][1].
@@ -1673,6 +1709,8 @@ module Aws::LocationService
1673
1709
  #
1674
1710
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1675
1711
  # characters: + - = . \_ : / @.
1712
+ #
1713
+ # * Cannot use "aws:" as a prefix for a key.
1676
1714
  # @return [Hash<String,String>]
1677
1715
  #
1678
1716
  # @!attribute [rw] tracker_name
@@ -2115,14 +2153,14 @@ module Aws::LocationService
2115
2153
  # @return [Time]
2116
2154
  #
2117
2155
  # @!attribute [rw] data_source
2118
- # The data provider of geospatial data. Indicates one of the available
2119
- # providers:
2156
+ # The data provider of geospatial data. Values can be one of the
2157
+ # following:
2120
2158
  #
2121
2159
  # * `Esri`
2122
2160
  #
2123
2161
  # * `Here`
2124
2162
  #
2125
- # For additional details on data providers, see [Amazon Location
2163
+ # For more information about data providers, see [Amazon Location
2126
2164
  # Service data providers][1].
2127
2165
  #
2128
2166
  #
@@ -2408,6 +2446,10 @@ module Aws::LocationService
2408
2446
 
2409
2447
  # Contains the device position details.
2410
2448
  #
2449
+ # @!attribute [rw] accuracy
2450
+ # The accuracy of the device position.
2451
+ # @return [Types::PositionalAccuracy]
2452
+ #
2411
2453
  # @!attribute [rw] device_id
2412
2454
  # The device whose position you retrieved.
2413
2455
  # @return [String]
@@ -2416,6 +2458,10 @@ module Aws::LocationService
2416
2458
  # The last known device position.
2417
2459
  # @return [Array<Float>]
2418
2460
  #
2461
+ # @!attribute [rw] position_properties
2462
+ # The properties associated with the position.
2463
+ # @return [Hash<String,String>]
2464
+ #
2419
2465
  # @!attribute [rw] received_time
2420
2466
  # The timestamp for when the tracker resource received the device
2421
2467
  # position in [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2437,11 +2483,13 @@ module Aws::LocationService
2437
2483
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
2438
2484
  #
2439
2485
  class DevicePosition < Struct.new(
2486
+ :accuracy,
2440
2487
  :device_id,
2441
2488
  :position,
2489
+ :position_properties,
2442
2490
  :received_time,
2443
2491
  :sample_time)
2444
- SENSITIVE = [:position]
2492
+ SENSITIVE = [:position, :position_properties]
2445
2493
  include Aws::Structure
2446
2494
  end
2447
2495
 
@@ -2451,11 +2499,21 @@ module Aws::LocationService
2451
2499
  # data as a hash:
2452
2500
  #
2453
2501
  # {
2502
+ # accuracy: {
2503
+ # horizontal: 1.0, # required
2504
+ # },
2454
2505
  # device_id: "Id", # required
2455
2506
  # position: [1.0], # required
2507
+ # position_properties: {
2508
+ # "PropertyMapKeyString" => "PropertyMapValueString",
2509
+ # },
2456
2510
  # sample_time: Time.now, # required
2457
2511
  # }
2458
2512
  #
2513
+ # @!attribute [rw] accuracy
2514
+ # The accuracy of the device position.
2515
+ # @return [Types::PositionalAccuracy]
2516
+ #
2459
2517
  # @!attribute [rw] device_id
2460
2518
  # The device associated to the position update.
2461
2519
  # @return [String]
@@ -2469,6 +2527,14 @@ module Aws::LocationService
2469
2527
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
2470
2528
  # @return [Array<Float>]
2471
2529
  #
2530
+ # @!attribute [rw] position_properties
2531
+ # Associates one of more properties with the position update. A
2532
+ # property is a key-value pair stored with the position update and
2533
+ # added to any geofence event the update may trigger.
2534
+ #
2535
+ # Format: `"key" : "value"`
2536
+ # @return [Hash<String,String>]
2537
+ #
2472
2538
  # @!attribute [rw] sample_time
2473
2539
  # The timestamp at which the device's position was determined. Uses
2474
2540
  # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
@@ -2481,10 +2547,12 @@ module Aws::LocationService
2481
2547
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
2482
2548
  #
2483
2549
  class DevicePositionUpdate < Struct.new(
2550
+ :accuracy,
2484
2551
  :device_id,
2485
2552
  :position,
2553
+ :position_properties,
2486
2554
  :sample_time)
2487
- SENSITIVE = [:position]
2555
+ SENSITIVE = [:position, :position_properties]
2488
2556
  include Aws::Structure
2489
2557
  end
2490
2558
 
@@ -2685,6 +2753,10 @@ module Aws::LocationService
2685
2753
  include Aws::Structure
2686
2754
  end
2687
2755
 
2756
+ # @!attribute [rw] accuracy
2757
+ # The accuracy of the device position.
2758
+ # @return [Types::PositionalAccuracy]
2759
+ #
2688
2760
  # @!attribute [rw] device_id
2689
2761
  # The device whose position you retrieved.
2690
2762
  # @return [String]
@@ -2693,6 +2765,10 @@ module Aws::LocationService
2693
2765
  # The last known device position.
2694
2766
  # @return [Array<Float>]
2695
2767
  #
2768
+ # @!attribute [rw] position_properties
2769
+ # The properties associated with the position.
2770
+ # @return [Hash<String,String>]
2771
+ #
2696
2772
  # @!attribute [rw] received_time
2697
2773
  # The timestamp for when the tracker resource received the device
2698
2774
  # position in [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2714,11 +2790,13 @@ module Aws::LocationService
2714
2790
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
2715
2791
  #
2716
2792
  class GetDevicePositionResponse < Struct.new(
2793
+ :accuracy,
2717
2794
  :device_id,
2718
2795
  :position,
2796
+ :position_properties,
2719
2797
  :received_time,
2720
2798
  :sample_time)
2721
- SENSITIVE = [:position]
2799
+ SENSITIVE = [:position, :position_properties]
2722
2800
  include Aws::Structure
2723
2801
  end
2724
2802
 
@@ -3221,6 +3299,10 @@ module Aws::LocationService
3221
3299
 
3222
3300
  # Contains the tracker resource details.
3223
3301
  #
3302
+ # @!attribute [rw] accuracy
3303
+ # The accuracy of the device position.
3304
+ # @return [Types::PositionalAccuracy]
3305
+ #
3224
3306
  # @!attribute [rw] device_id
3225
3307
  # The ID of the device for this position.
3226
3308
  # @return [String]
@@ -3230,6 +3312,10 @@ module Aws::LocationService
3230
3312
  # stored.
3231
3313
  # @return [Array<Float>]
3232
3314
  #
3315
+ # @!attribute [rw] position_properties
3316
+ # The properties associated with the position.
3317
+ # @return [Hash<String,String>]
3318
+ #
3233
3319
  # @!attribute [rw] sample_time
3234
3320
  # The timestamp at which the device position was determined. Uses [
3235
3321
  # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -3242,10 +3328,12 @@ module Aws::LocationService
3242
3328
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
3243
3329
  #
3244
3330
  class ListDevicePositionsResponseEntry < Struct.new(
3331
+ :accuracy,
3245
3332
  :device_id,
3246
3333
  :position,
3334
+ :position_properties,
3247
3335
  :sample_time)
3248
- SENSITIVE = [:position]
3336
+ SENSITIVE = [:position, :position_properties]
3249
3337
  include Aws::Structure
3250
3338
  end
3251
3339
 
@@ -3603,9 +3691,9 @@ module Aws::LocationService
3603
3691
  # @return [Array<Types::ListPlaceIndexesResponseEntry>]
3604
3692
  #
3605
3693
  # @!attribute [rw] next_token
3606
- # A pagination token indicating there are additional pages available.
3607
- # You can use the token in a following request to fetch the next set
3608
- # of results.
3694
+ # A pagination token indicating that there are additional pages
3695
+ # available. You can use the token in a new request to fetch the next
3696
+ # page of results.
3609
3697
  # @return [String]
3610
3698
  #
3611
3699
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponse AWS API Documentation
@@ -3629,14 +3717,14 @@ module Aws::LocationService
3629
3717
  # @return [Time]
3630
3718
  #
3631
3719
  # @!attribute [rw] data_source
3632
- # The data provider of geospatial data. Indicates one of the available
3633
- # providers:
3720
+ # The data provider of geospatial data. Values can be one of the
3721
+ # following:
3634
3722
  #
3635
3723
  # * `Esri`
3636
3724
  #
3637
3725
  # * `Here`
3638
3726
  #
3639
- # For additional details on data providers, see [Amazon Location
3727
+ # For more information about data providers, see [Amazon Location
3640
3728
  # Service data providers][1].
3641
3729
  #
3642
3730
  #
@@ -4110,6 +4198,19 @@ module Aws::LocationService
4110
4198
  # Places uses a point geometry to specify a location or a Place.
4111
4199
  # @return [Types::PlaceGeometry]
4112
4200
  #
4201
+ # @!attribute [rw] interpolated
4202
+ # `True` if the result is interpolated from other known places.
4203
+ #
4204
+ # `False` if the Place is a known place.
4205
+ #
4206
+ # Not returned when the partner does not provide the information.
4207
+ #
4208
+ # For example, returns `False` for an address location that is found
4209
+ # in the partner data, but returns `True` if an address does not exist
4210
+ # in the partner data and its location is calculated by interpolating
4211
+ # between other known addresses.
4212
+ # @return [Boolean]
4213
+ #
4113
4214
  # @!attribute [rw] label
4114
4215
  # The full name and address of the point of interest such as a city,
4115
4216
  # region, or country. For example, `123 Any Street, Any Town, USA`.
@@ -4140,23 +4241,30 @@ module Aws::LocationService
4140
4241
  # @return [String]
4141
4242
  #
4142
4243
  # @!attribute [rw] sub_region
4143
- # A country, or an area that's part of a larger region . For example,
4244
+ # A country, or an area that's part of a larger region. For example,
4144
4245
  # `Metro Vancouver`.
4145
4246
  # @return [String]
4146
4247
  #
4248
+ # @!attribute [rw] time_zone
4249
+ # The time zone in which the `Place` is located. Returned only when
4250
+ # using Here as the selected partner.
4251
+ # @return [Types::TimeZone]
4252
+ #
4147
4253
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
4148
4254
  #
4149
4255
  class Place < Struct.new(
4150
4256
  :address_number,
4151
4257
  :country,
4152
4258
  :geometry,
4259
+ :interpolated,
4153
4260
  :label,
4154
4261
  :municipality,
4155
4262
  :neighborhood,
4156
4263
  :postal_code,
4157
4264
  :region,
4158
4265
  :street,
4159
- :sub_region)
4266
+ :sub_region,
4267
+ :time_zone)
4160
4268
  SENSITIVE = []
4161
4269
  include Aws::Structure
4162
4270
  end
@@ -4184,6 +4292,28 @@ module Aws::LocationService
4184
4292
  include Aws::Structure
4185
4293
  end
4186
4294
 
4295
+ # Defines the level of certainty of the position.
4296
+ #
4297
+ # @note When making an API call, you may pass PositionalAccuracy
4298
+ # data as a hash:
4299
+ #
4300
+ # {
4301
+ # horizontal: 1.0, # required
4302
+ # }
4303
+ #
4304
+ # @!attribute [rw] horizontal
4305
+ # Estimated maximum distance, in meters, between the measured position
4306
+ # and the true position of a device, along the Earth's surface.
4307
+ # @return [Float]
4308
+ #
4309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PositionalAccuracy AWS API Documentation
4310
+ #
4311
+ class PositionalAccuracy < Struct.new(
4312
+ :horizontal)
4313
+ SENSITIVE = []
4314
+ include Aws::Structure
4315
+ end
4316
+
4187
4317
  # @note When making an API call, you may pass PutGeofenceRequest
4188
4318
  # data as a hash:
4189
4319
  #
@@ -4275,32 +4405,81 @@ module Aws::LocationService
4275
4405
  include Aws::Structure
4276
4406
  end
4277
4407
 
4278
- # Specifies a single point of interest, or Place as a result of a search
4279
- # query obtained from a dataset configured in the place index resource.
4408
+ # Contains a search result from a position search query that is run on a
4409
+ # place index resource.
4410
+ #
4411
+ # @!attribute [rw] distance
4412
+ # The distance in meters of a great-circle arc between the query
4413
+ # position and the result.
4414
+ #
4415
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4416
+ # the Earth. This returns the shortest distance between two locations.
4417
+ #
4418
+ # </note>
4419
+ # @return [Float]
4280
4420
  #
4281
4421
  # @!attribute [rw] place
4282
- # Contains details about the relevant point of interest.
4422
+ # Details about the search result, such as its address and position.
4283
4423
  # @return [Types::Place]
4284
4424
  #
4285
4425
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
4286
4426
  #
4287
4427
  class SearchForPositionResult < Struct.new(
4428
+ :distance,
4288
4429
  :place)
4289
4430
  SENSITIVE = []
4290
4431
  include Aws::Structure
4291
4432
  end
4292
4433
 
4293
- # Contains relevant Places returned by calling
4294
- # `SearchPlaceIndexForText`.
4434
+ # Contains a place suggestion resulting from a place suggestion query
4435
+ # that is run on a place index resource.
4436
+ #
4437
+ # @!attribute [rw] text
4438
+ # The text of the place suggestion, typically formatted as an address
4439
+ # string.
4440
+ # @return [String]
4441
+ #
4442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
4443
+ #
4444
+ class SearchForSuggestionsResult < Struct.new(
4445
+ :text)
4446
+ SENSITIVE = []
4447
+ include Aws::Structure
4448
+ end
4449
+
4450
+ # Contains a search result from a text search query that is run on a
4451
+ # place index resource.
4452
+ #
4453
+ # @!attribute [rw] distance
4454
+ # The distance in meters of a great-circle arc between the bias
4455
+ # position specified and the result. `Distance` will be returned only
4456
+ # if a bias position was specified in the query.
4457
+ #
4458
+ # <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
4459
+ # the Earth. This returns the shortest distance between two locations.
4460
+ #
4461
+ # </note>
4462
+ # @return [Float]
4295
4463
  #
4296
4464
  # @!attribute [rw] place
4297
- # Contains details about the relevant point of interest.
4465
+ # Details about the search result, such as its address and position.
4298
4466
  # @return [Types::Place]
4299
4467
  #
4468
+ # @!attribute [rw] relevance
4469
+ # The relative confidence in the match for a result among the results
4470
+ # returned. For example, if more fields for an address match
4471
+ # (including house number, street, city, country/region, and postal
4472
+ # code), the relevance score is closer to 1.
4473
+ #
4474
+ # Returned only when the partner selected is Esri.
4475
+ # @return [Float]
4476
+ #
4300
4477
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult AWS API Documentation
4301
4478
  #
4302
4479
  class SearchForTextResult < Struct.new(
4303
- :place)
4480
+ :distance,
4481
+ :place,
4482
+ :relevance)
4304
4483
  SENSITIVE = []
4305
4484
  include Aws::Structure
4306
4485
  end
@@ -4310,6 +4489,7 @@ module Aws::LocationService
4310
4489
  #
4311
4490
  # {
4312
4491
  # index_name: "ResourceName", # required
4492
+ # language: "LanguageTag",
4313
4493
  # max_results: 1,
4314
4494
  # position: [1.0], # required
4315
4495
  # }
@@ -4318,28 +4498,43 @@ module Aws::LocationService
4318
4498
  # The name of the place index resource you want to use for the search.
4319
4499
  # @return [String]
4320
4500
  #
4501
+ # @!attribute [rw] language
4502
+ # The preferred language used to return results. The value must be a
4503
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4504
+ #
4505
+ # This setting affects the languages used in the results. It does not
4506
+ # change which results are returned. If the language is not specified,
4507
+ # or not supported for a particular result, the partner automatically
4508
+ # chooses a language for the result.
4509
+ #
4510
+ #
4511
+ #
4512
+ # [1]: https://tools.ietf.org/search/bcp47
4513
+ # @return [String]
4514
+ #
4321
4515
  # @!attribute [rw] max_results
4322
- # An optional paramer. The maximum number of results returned per
4516
+ # An optional parameter. The maximum number of results returned per
4323
4517
  # request.
4324
4518
  #
4325
4519
  # Default value: `50`
4326
4520
  # @return [Integer]
4327
4521
  #
4328
4522
  # @!attribute [rw] position
4329
- # Specifies a coordinate for the query defined by a longitude, and
4330
- # latitude.
4523
+ # Specifies the longitude and latitude of the position to query.
4331
4524
  #
4332
- # * The first position is the X coordinate, or longitude.
4525
+ # This parameter must contain a pair of numbers. The first number
4526
+ # represents the X coordinate, or longitude; the second number
4527
+ # represents the Y coordinate, or latitude.
4333
4528
  #
4334
- # * The second position is the Y coordinate, or latitude.
4335
- #
4336
- # For example, `position=xLongitude&position=yLatitude` .
4529
+ # For example, `[-123.1174, 49.2847]` represents a position with
4530
+ # longitude `-123.1174` and latitude `49.2847`.
4337
4531
  # @return [Array<Float>]
4338
4532
  #
4339
4533
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionRequest AWS API Documentation
4340
4534
  #
4341
4535
  class SearchPlaceIndexForPositionRequest < Struct.new(
4342
4536
  :index_name,
4537
+ :language,
4343
4538
  :max_results,
4344
4539
  :position)
4345
4540
  SENSITIVE = [:position]
@@ -4352,7 +4547,9 @@ module Aws::LocationService
4352
4547
  # @return [Array<Types::SearchForPositionResult>]
4353
4548
  #
4354
4549
  # @!attribute [rw] summary
4355
- # Contains a summary of the request.
4550
+ # Contains a summary of the request. Echoes the input values for
4551
+ # `Position`, `Language`, `MaxResults`, and the `DataSource` of the
4552
+ # place index.
4356
4553
  # @return [Types::SearchPlaceIndexForPositionSummary]
4357
4554
  #
4358
4555
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionResponse AWS API Documentation
@@ -4364,18 +4561,17 @@ module Aws::LocationService
4364
4561
  include Aws::Structure
4365
4562
  end
4366
4563
 
4367
- # A summary of the reverse geocoding request sent using
4368
- # `SearchPlaceIndexForPosition`.
4564
+ # A summary of the request sent by using `SearchPlaceIndexForPosition`.
4369
4565
  #
4370
4566
  # @!attribute [rw] data_source
4371
- # The data provider of geospatial data. Indicates one of the available
4372
- # providers:
4567
+ # The geospatial data provider attached to the place index resource
4568
+ # specified in the request. Values can be one of the following:
4373
4569
  #
4374
4570
  # * Esri
4375
4571
  #
4376
- # * HERE
4572
+ # * Here
4377
4573
  #
4378
- # For additional details on data providers, see [Amazon Location
4574
+ # For more information about data providers, see [Amazon Location
4379
4575
  # Service data providers][1].
4380
4576
  #
4381
4577
  #
@@ -4383,28 +4579,39 @@ module Aws::LocationService
4383
4579
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4384
4580
  # @return [String]
4385
4581
  #
4582
+ # @!attribute [rw] language
4583
+ # The preferred language used to return results. Matches the language
4584
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4585
+ # example, `en` for English.
4586
+ #
4587
+ #
4588
+ #
4589
+ # [1]: https://tools.ietf.org/search/bcp47
4590
+ # @return [String]
4591
+ #
4386
4592
  # @!attribute [rw] max_results
4387
- # An optional parameter. The maximum number of results returned per
4593
+ # Contains the optional result count limit that is specified in the
4388
4594
  # request.
4389
4595
  #
4390
4596
  # Default value: `50`
4391
4597
  # @return [Integer]
4392
4598
  #
4393
4599
  # @!attribute [rw] position
4394
- # The position given in the reverse geocoding request.
4600
+ # The position specified in the request.
4395
4601
  # @return [Array<Float>]
4396
4602
  #
4397
4603
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionSummary AWS API Documentation
4398
4604
  #
4399
4605
  class SearchPlaceIndexForPositionSummary < Struct.new(
4400
4606
  :data_source,
4607
+ :language,
4401
4608
  :max_results,
4402
4609
  :position)
4403
4610
  SENSITIVE = [:position]
4404
4611
  include Aws::Structure
4405
4612
  end
4406
4613
 
4407
- # @note When making an API call, you may pass SearchPlaceIndexForTextRequest
4614
+ # @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
4408
4615
  # data as a hash:
4409
4616
  #
4410
4617
  # {
@@ -4412,52 +4619,260 @@ module Aws::LocationService
4412
4619
  # filter_b_box: [1.0],
4413
4620
  # filter_countries: ["CountryCode"],
4414
4621
  # index_name: "ResourceName", # required
4622
+ # language: "LanguageTag",
4415
4623
  # max_results: 1,
4416
- # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
4624
+ # text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
4417
4625
  # }
4418
4626
  #
4419
4627
  # @!attribute [rw] bias_position
4420
- # Searches for results closest to the given position. An optional
4421
- # parameter defined by longitude, and latitude.
4628
+ # An optional parameter that indicates a preference for place
4629
+ # suggestions that are closer to a specified position.
4630
+ #
4631
+ # If provided, this parameter must contain a pair of numbers. The
4632
+ # first number represents the X coordinate, or longitude; the second
4633
+ # number represents the Y coordinate, or latitude.
4422
4634
  #
4423
- # * The first `bias` position is the X coordinate, or longitude.
4635
+ # For example, `[-123.1174, 49.2847]` represents the position with
4636
+ # longitude `-123.1174` and latitude `49.2847`.
4424
4637
  #
4425
- # * The second `bias` position is the Y coordinate, or latitude.
4638
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4639
+ # both options results in an error.
4426
4640
  #
4427
- # For example, `bias=xLongitude&bias=yLatitude`.
4641
+ # </note>
4428
4642
  # @return [Array<Float>]
4429
4643
  #
4430
4644
  # @!attribute [rw] filter_b_box
4431
- # Filters the results by returning only Places within the provided
4432
- # bounding box. An optional parameter.
4645
+ # An optional parameter that limits the search results by returning
4646
+ # only suggestions within a specified bounding box.
4433
4647
  #
4434
- # The first 2 `bbox` parameters describe the lower southwest corner:
4648
+ # If provided, this parameter must contain a total of four consecutive
4649
+ # numbers in two pairs. The first pair of numbers represents the X and
4650
+ # Y coordinates (longitude and latitude, respectively) of the
4651
+ # southwest corner of the bounding box; the second pair of numbers
4652
+ # represents the X and Y coordinates (longitude and latitude,
4653
+ # respectively) of the northeast corner of the bounding box.
4435
4654
  #
4436
- # * The first `bbox` position is the X coordinate or longitude of the
4437
- # lower southwest corner.
4655
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4656
+ # bounding box where the southwest corner has longitude `-12.7935` and
4657
+ # latitude `-37.4835`, and the northeast corner has longitude
4658
+ # `-12.0684` and latitude `-36.9542`.
4438
4659
  #
4439
- # * The second `bbox` position is the Y coordinate or latitude of the
4440
- # lower southwest corner.
4660
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4661
+ # both options results in an error.
4662
+ #
4663
+ # </note>
4664
+ # @return [Array<Float>]
4441
4665
  #
4442
- # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`.
4666
+ # @!attribute [rw] filter_countries
4667
+ # An optional parameter that limits the search results by returning
4668
+ # only suggestions within the provided list of countries.
4443
4669
  #
4444
- # The next `bbox` parameters describe the upper northeast corner:
4670
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4671
+ # uses three upper-case characters: `AUS`.
4672
+ #
4673
+ # ^
4445
4674
  #
4446
- # * The third `bbox` position is the X coordinate, or longitude of the
4447
- # upper northeast corner.
4448
4675
  #
4449
- # * The fourth `bbox` position is the Y coordinate, or longitude of
4450
- # the upper northeast corner.
4451
4676
  #
4452
- # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE`
4677
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
4678
+ # @return [Array<String>]
4679
+ #
4680
+ # @!attribute [rw] index_name
4681
+ # The name of the place index resource you want to use for the search.
4682
+ # @return [String]
4683
+ #
4684
+ # @!attribute [rw] language
4685
+ # The preferred language used to return results. The value must be a
4686
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4687
+ #
4688
+ # This setting affects the languages used in the results. It does not
4689
+ # change which results are returned. If the language is not specified,
4690
+ # or not supported for a particular result, the partner automatically
4691
+ # chooses a language for the result.
4692
+ #
4693
+ # Used only when the partner selected is Here.
4694
+ #
4695
+ #
4696
+ #
4697
+ # [1]: https://tools.ietf.org/search/bcp47
4698
+ # @return [String]
4699
+ #
4700
+ # @!attribute [rw] max_results
4701
+ # An optional parameter. The maximum number of results returned per
4702
+ # request.
4703
+ #
4704
+ # The default: `5`
4705
+ # @return [Integer]
4706
+ #
4707
+ # @!attribute [rw] text
4708
+ # The free-form partial text to use to generate place suggestions. For
4709
+ # example, `eiffel tow`.
4710
+ # @return [String]
4711
+ #
4712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsRequest AWS API Documentation
4713
+ #
4714
+ class SearchPlaceIndexForSuggestionsRequest < Struct.new(
4715
+ :bias_position,
4716
+ :filter_b_box,
4717
+ :filter_countries,
4718
+ :index_name,
4719
+ :language,
4720
+ :max_results,
4721
+ :text)
4722
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
4723
+ include Aws::Structure
4724
+ end
4725
+
4726
+ # @!attribute [rw] results
4727
+ # A list of place suggestions that best match the search text.
4728
+ # @return [Array<Types::SearchForSuggestionsResult>]
4729
+ #
4730
+ # @!attribute [rw] summary
4731
+ # Contains a summary of the request. Echoes the input values for
4732
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4733
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4734
+ # place index.
4735
+ # @return [Types::SearchPlaceIndexForSuggestionsSummary]
4736
+ #
4737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsResponse AWS API Documentation
4738
+ #
4739
+ class SearchPlaceIndexForSuggestionsResponse < Struct.new(
4740
+ :results,
4741
+ :summary)
4742
+ SENSITIVE = []
4743
+ include Aws::Structure
4744
+ end
4745
+
4746
+ # A summary of the request sent by using
4747
+ # `SearchPlaceIndexForSuggestions`.
4748
+ #
4749
+ # @!attribute [rw] bias_position
4750
+ # Contains the coordinates for the optional bias position specified in
4751
+ # the request.
4752
+ #
4753
+ # This parameter contains a pair of numbers. The first number
4754
+ # represents the X coordinate, or longitude; the second number
4755
+ # represents the Y coordinate, or latitude.
4756
+ #
4757
+ # For example, `[-123.1174, 49.2847]` represents the position with
4758
+ # longitude `-123.1174` and latitude `49.2847`.
4759
+ # @return [Array<Float>]
4760
+ #
4761
+ # @!attribute [rw] data_source
4762
+ # The geospatial data provider attached to the place index resource
4763
+ # specified in the request. Values can be one of the following:
4764
+ #
4765
+ # * Esri
4766
+ #
4767
+ # * Here
4768
+ #
4769
+ # For more information about data providers, see [Amazon Location
4770
+ # Service data providers][1].
4771
+ #
4772
+ #
4773
+ #
4774
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4775
+ # @return [String]
4776
+ #
4777
+ # @!attribute [rw] filter_b_box
4778
+ # Contains the coordinates for the optional bounding box specified in
4779
+ # the request.
4453
4780
  # @return [Array<Float>]
4454
4781
  #
4455
4782
  # @!attribute [rw] filter_countries
4456
- # Limits the search to the given a list of countries/regions. An
4457
- # optional parameter.
4783
+ # Contains the optional country filter specified in the request.
4784
+ # @return [Array<String>]
4458
4785
  #
4459
- # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4460
- # uses three upper-case characters: `AUS`.
4786
+ # @!attribute [rw] language
4787
+ # The preferred language used to return results. Matches the language
4788
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4789
+ # example, `en` for English.
4790
+ #
4791
+ #
4792
+ #
4793
+ # [1]: https://tools.ietf.org/search/bcp47
4794
+ # @return [String]
4795
+ #
4796
+ # @!attribute [rw] max_results
4797
+ # Contains the optional result count limit specified in the request.
4798
+ # @return [Integer]
4799
+ #
4800
+ # @!attribute [rw] text
4801
+ # The free-form partial text input specified in the request.
4802
+ # @return [String]
4803
+ #
4804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsSummary AWS API Documentation
4805
+ #
4806
+ class SearchPlaceIndexForSuggestionsSummary < Struct.new(
4807
+ :bias_position,
4808
+ :data_source,
4809
+ :filter_b_box,
4810
+ :filter_countries,
4811
+ :language,
4812
+ :max_results,
4813
+ :text)
4814
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
4815
+ include Aws::Structure
4816
+ end
4817
+
4818
+ # @note When making an API call, you may pass SearchPlaceIndexForTextRequest
4819
+ # data as a hash:
4820
+ #
4821
+ # {
4822
+ # bias_position: [1.0],
4823
+ # filter_b_box: [1.0],
4824
+ # filter_countries: ["CountryCode"],
4825
+ # index_name: "ResourceName", # required
4826
+ # language: "LanguageTag",
4827
+ # max_results: 1,
4828
+ # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
4829
+ # }
4830
+ #
4831
+ # @!attribute [rw] bias_position
4832
+ # An optional parameter that indicates a preference for places that
4833
+ # are closer to a specified position.
4834
+ #
4835
+ # If provided, this parameter must contain a pair of numbers. The
4836
+ # first number represents the X coordinate, or longitude; the second
4837
+ # number represents the Y coordinate, or latitude.
4838
+ #
4839
+ # For example, `[-123.1174, 49.2847]` represents the position with
4840
+ # longitude `-123.1174` and latitude `49.2847`.
4841
+ #
4842
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4843
+ # both options results in an error.
4844
+ #
4845
+ # </note>
4846
+ # @return [Array<Float>]
4847
+ #
4848
+ # @!attribute [rw] filter_b_box
4849
+ # An optional parameter that limits the search results by returning
4850
+ # only places that are within the provided bounding box.
4851
+ #
4852
+ # If provided, this parameter must contain a total of four consecutive
4853
+ # numbers in two pairs. The first pair of numbers represents the X and
4854
+ # Y coordinates (longitude and latitude, respectively) of the
4855
+ # southwest corner of the bounding box; the second pair of numbers
4856
+ # represents the X and Y coordinates (longitude and latitude,
4857
+ # respectively) of the northeast corner of the bounding box.
4858
+ #
4859
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4860
+ # bounding box where the southwest corner has longitude `-12.7935` and
4861
+ # latitude `-37.4835`, and the northeast corner has longitude
4862
+ # `-12.0684` and latitude `-36.9542`.
4863
+ #
4864
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4865
+ # both options results in an error.
4866
+ #
4867
+ # </note>
4868
+ # @return [Array<Float>]
4869
+ #
4870
+ # @!attribute [rw] filter_countries
4871
+ # An optional parameter that limits the search results by returning
4872
+ # only places that are in a specified list of countries.
4873
+ #
4874
+ # * Valid values include [ISO 3166][1] 3-digit country codes. For
4875
+ # example, Australia uses three upper-case characters: `AUS`.
4461
4876
  #
4462
4877
  # ^
4463
4878
  #
@@ -4470,6 +4885,20 @@ module Aws::LocationService
4470
4885
  # The name of the place index resource you want to use for the search.
4471
4886
  # @return [String]
4472
4887
  #
4888
+ # @!attribute [rw] language
4889
+ # The preferred language used to return results. The value must be a
4890
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4891
+ #
4892
+ # This setting affects the languages used in the results. It does not
4893
+ # change which results are returned. If the language is not specified,
4894
+ # or not supported for a particular result, the partner automatically
4895
+ # chooses a language for the result.
4896
+ #
4897
+ #
4898
+ #
4899
+ # [1]: https://tools.ietf.org/search/bcp47
4900
+ # @return [String]
4901
+ #
4473
4902
  # @!attribute [rw] max_results
4474
4903
  # An optional parameter. The maximum number of results returned per
4475
4904
  # request.
@@ -4478,7 +4907,7 @@ module Aws::LocationService
4478
4907
  # @return [Integer]
4479
4908
  #
4480
4909
  # @!attribute [rw] text
4481
- # The address, name, city, or region to be used in the search. In
4910
+ # The address, name, city, or region to be used in the search in
4482
4911
  # free-form text format. For example, `123 Any Street`.
4483
4912
  # @return [String]
4484
4913
  #
@@ -4489,6 +4918,7 @@ module Aws::LocationService
4489
4918
  :filter_b_box,
4490
4919
  :filter_countries,
4491
4920
  :index_name,
4921
+ :language,
4492
4922
  :max_results,
4493
4923
  :text)
4494
4924
  SENSITIVE = [:bias_position, :filter_b_box, :text]
@@ -4496,15 +4926,16 @@ module Aws::LocationService
4496
4926
  end
4497
4927
 
4498
4928
  # @!attribute [rw] results
4499
- # A list of Places closest to the specified position. Each result
4500
- # contains additional information about the specific point of
4501
- # interest.
4929
+ # A list of Places matching the input text. Each result contains
4930
+ # additional information about the specific point of interest.
4502
4931
  # @return [Array<Types::SearchForTextResult>]
4503
4932
  #
4504
4933
  # @!attribute [rw] summary
4505
- # Contains a summary of the request. Contains the `BiasPosition`,
4506
- # `DataSource`, `FilterBBox`, `FilterCountries`, `MaxResults`,
4507
- # `ResultBBox`, and `Text`.
4934
+ # Contains a summary of the request. Echoes the input values for
4935
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4936
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4937
+ # place index and the bounding box, `ResultBBox`, which surrounds the
4938
+ # search results.
4508
4939
  # @return [Types::SearchPlaceIndexForTextSummary]
4509
4940
  #
4510
4941
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextResponse AWS API Documentation
@@ -4516,23 +4947,29 @@ module Aws::LocationService
4516
4947
  include Aws::Structure
4517
4948
  end
4518
4949
 
4519
- # A summary of the geocoding request sent using
4520
- # `SearchPlaceIndexForText`.
4950
+ # A summary of the request sent by using `SearchPlaceIndexForText`.
4521
4951
  #
4522
4952
  # @!attribute [rw] bias_position
4523
- # Contains the coordinates for the bias position entered in the
4524
- # geocoding request.
4953
+ # Contains the coordinates for the optional bias position specified in
4954
+ # the request.
4955
+ #
4956
+ # This parameter contains a pair of numbers. The first number
4957
+ # represents the X coordinate, or longitude; the second number
4958
+ # represents the Y coordinate, or latitude.
4959
+ #
4960
+ # For example, `[-123.1174, 49.2847]` represents the position with
4961
+ # longitude `-123.1174` and latitude `49.2847`.
4525
4962
  # @return [Array<Float>]
4526
4963
  #
4527
4964
  # @!attribute [rw] data_source
4528
- # The data provider of geospatial data. Indicates one of the available
4529
- # providers:
4965
+ # The geospatial data provider attached to the place index resource
4966
+ # specified in the request. Values can be one of the following:
4530
4967
  #
4531
4968
  # * Esri
4532
4969
  #
4533
- # * HERE
4970
+ # * Here
4534
4971
  #
4535
- # For additional details on data providers, see [Amazon Location
4972
+ # For more information about data providers, see [Amazon Location
4536
4973
  # Service data providers][1].
4537
4974
  #
4538
4975
  #
@@ -4541,27 +4978,39 @@ module Aws::LocationService
4541
4978
  # @return [String]
4542
4979
  #
4543
4980
  # @!attribute [rw] filter_b_box
4544
- # Contains the coordinates for the optional bounding box coordinated
4545
- # entered in the geocoding request.
4981
+ # Contains the coordinates for the optional bounding box specified in
4982
+ # the request.
4546
4983
  # @return [Array<Float>]
4547
4984
  #
4548
4985
  # @!attribute [rw] filter_countries
4549
- # Contains the country filter entered in the geocoding request.
4986
+ # Contains the optional country filter specified in the request.
4550
4987
  # @return [Array<String>]
4551
4988
  #
4989
+ # @!attribute [rw] language
4990
+ # The preferred language used to return results. Matches the language
4991
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4992
+ # example, `en` for English.
4993
+ #
4994
+ #
4995
+ #
4996
+ # [1]: https://tools.ietf.org/search/bcp47
4997
+ # @return [String]
4998
+ #
4552
4999
  # @!attribute [rw] max_results
4553
- # Contains the maximum number of results indicated for the request.
5000
+ # Contains the optional result count limit specified in the request.
4554
5001
  # @return [Integer]
4555
5002
  #
4556
5003
  # @!attribute [rw] result_b_box
4557
- # A bounding box that contains the search results within the specified
4558
- # area indicated by `FilterBBox`. A subset of bounding box specified
4559
- # using `FilterBBox`.
5004
+ # The bounding box that fully contains all search results.
5005
+ #
5006
+ # <note markdown="1"> If you specified the optional `FilterBBox` parameter in the request,
5007
+ # `ResultBBox` is contained within `FilterBBox`.
5008
+ #
5009
+ # </note>
4560
5010
  # @return [Array<Float>]
4561
5011
  #
4562
5012
  # @!attribute [rw] text
4563
- # The address, name, city or region to be used in the geocoding
4564
- # request. In free-form text format. For example, `Vancouver`.
5013
+ # The search text specified in the request.
4565
5014
  # @return [String]
4566
5015
  #
4567
5016
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextSummary AWS API Documentation
@@ -4571,6 +5020,7 @@ module Aws::LocationService
4571
5020
  :data_source,
4572
5021
  :filter_b_box,
4573
5022
  :filter_countries,
5023
+ :language,
4574
5024
  :max_results,
4575
5025
  :result_b_box,
4576
5026
  :text)
@@ -4666,12 +5116,27 @@ module Aws::LocationService
4666
5116
  # @return [String]
4667
5117
  #
4668
5118
  # @!attribute [rw] tags
4669
- # Tags that have been applied to the specified resource. Tags are
4670
- # mapped from the tag key to the tag value: `"TagKey" : "TagValue"`.
5119
+ # Applies one or more tags to specific resource. A tag is a key-value
5120
+ # pair that helps you manage, identify, search, and filter your
5121
+ # resources.
4671
5122
  #
4672
- # * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
5123
+ # Format: `"key" : "value"`
4673
5124
  #
4674
- # ^
5125
+ # Restrictions:
5126
+ #
5127
+ # * Maximum 50 tags per resource.
5128
+ #
5129
+ # * Each tag key must be unique and must have exactly one associated
5130
+ # value.
5131
+ #
5132
+ # * Maximum key length: 128 Unicode characters in UTF-8.
5133
+ #
5134
+ # * Maximum value length: 256 Unicode characters in UTF-8.
5135
+ #
5136
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
5137
+ # characters: + - = . \_ : / @
5138
+ #
5139
+ # * Cannot use "aws:" as a prefix for a key.
4675
5140
  # @return [Hash<String,String>]
4676
5141
  #
4677
5142
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceRequest AWS API Documentation
@@ -4700,6 +5165,31 @@ module Aws::LocationService
4700
5165
  include Aws::Structure
4701
5166
  end
4702
5167
 
5168
+ # Information about a time zone. Includes the name of the time zone and
5169
+ # the offset from UTC in seconds.
5170
+ #
5171
+ # @!attribute [rw] name
5172
+ # The name of the time zone, following the [ IANA time zone
5173
+ # standard][1]. For example, `America/Los_Angeles`.
5174
+ #
5175
+ #
5176
+ #
5177
+ # [1]: https://www.iana.org/time-zones
5178
+ # @return [String]
5179
+ #
5180
+ # @!attribute [rw] offset
5181
+ # The time zone's offset, in seconds, from UTC.
5182
+ # @return [Integer]
5183
+ #
5184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TimeZone AWS API Documentation
5185
+ #
5186
+ class TimeZone < Struct.new(
5187
+ :name,
5188
+ :offset)
5189
+ SENSITIVE = []
5190
+ include Aws::Structure
5191
+ end
5192
+
4703
5193
  # Contains details about the truck dimensions in the unit of measurement
4704
5194
  # that you specify. Used to filter out roads that can't support or
4705
5195
  # allow the specified dimensions for requests that specify `TravelMode`
@@ -5149,7 +5639,7 @@ module Aws::LocationService
5149
5639
  #
5150
5640
  # {
5151
5641
  # description: "ResourceDescription",
5152
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
5642
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
5153
5643
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
5154
5644
  # pricing_plan_data_source: "String",
5155
5645
  # tracker_name: "ResourceName", # required
@@ -5173,9 +5663,19 @@ module Aws::LocationService
5173
5663
  # ft), location updates are ignored. Location updates within this
5174
5664
  # distance are neither evaluated against linked geofence
5175
5665
  # collections, nor stored. This helps control costs by reducing the
5176
- # number of geofence evaluations and device positions to retrieve.
5177
- # Distance-based filtering can also reduce the jitter effect when
5178
- # displaying device trajectory on a map.
5666
+ # number of geofence evaluations and historical device positions to
5667
+ # paginate through. Distance-based filtering can also reduce the
5668
+ # effects of GPS noise when displaying device trajectories on a map.
5669
+ #
5670
+ # * `AccuracyBased` - If the device has moved less than the measured
5671
+ # accuracy, location updates are ignored. For example, if two
5672
+ # consecutive updates from a device have a horizontal accuracy of 5
5673
+ # m and 10 m, the second update is ignored if the device has moved
5674
+ # less than 15 m. Ignored location updates are neither evaluated
5675
+ # against linked geofence collections, nor stored. This helps educe
5676
+ # the effects of GPS noise when displaying device trajectories on a
5677
+ # map, and can help control costs by reducing the number of geofence
5678
+ # evaluations.
5179
5679
  # @return [String]
5180
5680
  #
5181
5681
  # @!attribute [rw] pricing_plan