aws-sdk-locationservice 1.10.0 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +359 -76
- data/lib/aws-sdk-locationservice/client_api.rb +89 -0
- data/lib/aws-sdk-locationservice/types.rb +609 -114
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -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
|
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
|
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
|
907
|
+
# The unit of measurement for route distances.
|
896
908
|
# @return [String]
|
897
909
|
#
|
898
910
|
# @!attribute [rw] duration_seconds
|
@@ -1103,6 +1115,8 @@ module Aws::LocationService
|
|
1103
1115
|
#
|
1104
1116
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1105
1117
|
# characters: + - = . \_ : / @.
|
1118
|
+
#
|
1119
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1106
1120
|
# @return [Hash<String,String>]
|
1107
1121
|
#
|
1108
1122
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateGeofenceCollectionRequest AWS API Documentation
|
@@ -1217,6 +1231,8 @@ module Aws::LocationService
|
|
1217
1231
|
#
|
1218
1232
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1219
1233
|
# characters: + - = . \_ : / @.
|
1234
|
+
#
|
1235
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1220
1236
|
# @return [Hash<String,String>]
|
1221
1237
|
#
|
1222
1238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMapRequest AWS API Documentation
|
@@ -1280,7 +1296,7 @@ module Aws::LocationService
|
|
1280
1296
|
# }
|
1281
1297
|
#
|
1282
1298
|
# @!attribute [rw] data_source
|
1283
|
-
# Specifies the data provider
|
1299
|
+
# Specifies the geospatial data provider for the new place index.
|
1284
1300
|
#
|
1285
1301
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1286
1302
|
# example, entering `HERE` returns an error.
|
@@ -1297,8 +1313,8 @@ module Aws::LocationService
|
|
1297
1313
|
# coverage in your region of interest, see [HERE details on
|
1298
1314
|
# goecoding coverage][4].
|
1299
1315
|
#
|
1300
|
-
#
|
1301
|
-
#
|
1316
|
+
# If you specify HERE Technologies (`Here`) as the data provider,
|
1317
|
+
# you may not [store results][5] for locations in Japan. For more
|
1302
1318
|
# information, see the [AWS Service Terms][6] for Amazon Location
|
1303
1319
|
# Service.
|
1304
1320
|
#
|
@@ -1350,23 +1366,26 @@ module Aws::LocationService
|
|
1350
1366
|
#
|
1351
1367
|
# @!attribute [rw] tags
|
1352
1368
|
# Applies one or more tags to the place index resource. A tag is a
|
1353
|
-
# key-value pair helps manage, identify, search, and filter
|
1354
|
-
# resources
|
1369
|
+
# key-value pair that helps you manage, identify, search, and filter
|
1370
|
+
# your resources.
|
1355
1371
|
#
|
1356
1372
|
# Format: `"key" : "value"`
|
1357
1373
|
#
|
1358
1374
|
# Restrictions:
|
1359
1375
|
#
|
1360
|
-
# * Maximum 50 tags per resource
|
1376
|
+
# * Maximum 50 tags per resource.
|
1361
1377
|
#
|
1362
|
-
# * Each
|
1378
|
+
# * Each tag key must be unique and must have exactly one associated
|
1379
|
+
# value.
|
1363
1380
|
#
|
1364
|
-
# * Maximum key length: 128 Unicode characters in UTF-8
|
1381
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1365
1382
|
#
|
1366
|
-
# * Maximum value length: 256 Unicode characters in UTF-8
|
1383
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1367
1384
|
#
|
1368
1385
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1369
|
-
# characters: + - = . \_ : /
|
1386
|
+
# characters: + - = . \_ : / @
|
1387
|
+
#
|
1388
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1370
1389
|
# @return [Hash<String,String>]
|
1371
1390
|
#
|
1372
1391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreatePlaceIndexRequest AWS API Documentation
|
@@ -1512,6 +1531,8 @@ module Aws::LocationService
|
|
1512
1531
|
#
|
1513
1532
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1514
1533
|
# characters: + - = . \_ : / @.
|
1534
|
+
#
|
1535
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1515
1536
|
# @return [Hash<String,String>]
|
1516
1537
|
#
|
1517
1538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateRouteCalculatorRequest AWS API Documentation
|
@@ -1573,7 +1594,7 @@ module Aws::LocationService
|
|
1573
1594
|
# {
|
1574
1595
|
# description: "ResourceDescription",
|
1575
1596
|
# kms_key_id: "KmsKeyId",
|
1576
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
1597
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1577
1598
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1578
1599
|
# pricing_plan_data_source: "String",
|
1579
1600
|
# tags: {
|
@@ -1607,11 +1628,21 @@ module Aws::LocationService
|
|
1607
1628
|
#
|
1608
1629
|
# * `DistanceBased` - If the device has moved less than 30 m (98.4
|
1609
1630
|
# ft), location updates are ignored. Location updates within this
|
1610
|
-
#
|
1611
|
-
#
|
1612
|
-
#
|
1613
|
-
# Distance-based filtering can also reduce the
|
1614
|
-
# displaying device
|
1631
|
+
# area are neither evaluated against linked geofence collections,
|
1632
|
+
# nor stored. This helps control costs by reducing the number of
|
1633
|
+
# geofence evaluations and historical device positions to paginate
|
1634
|
+
# through. Distance-based filtering can also reduce the effects of
|
1635
|
+
# GPS noise when displaying device trajectories on a map.
|
1636
|
+
#
|
1637
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
1638
|
+
# accuracy, location updates are ignored. For example, if two
|
1639
|
+
# consecutive updates from a device have a horizontal accuracy of 5
|
1640
|
+
# m and 10 m, the second update is ignored if the device has moved
|
1641
|
+
# less than 15 m. Ignored location updates are neither evaluated
|
1642
|
+
# against linked geofence collections, nor stored. This can reduce
|
1643
|
+
# the effects of GPS noise when displaying device trajectories on a
|
1644
|
+
# map, and can help control your costs by reducing the number of
|
1645
|
+
# geofence evaluations.
|
1615
1646
|
#
|
1616
1647
|
# This field is optional. If not specified, the default value is
|
1617
1648
|
# `TimeBased`.
|
@@ -1673,6 +1704,8 @@ module Aws::LocationService
|
|
1673
1704
|
#
|
1674
1705
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1675
1706
|
# characters: + - = . \_ : / @.
|
1707
|
+
#
|
1708
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1676
1709
|
# @return [Hash<String,String>]
|
1677
1710
|
#
|
1678
1711
|
# @!attribute [rw] tracker_name
|
@@ -2115,14 +2148,14 @@ module Aws::LocationService
|
|
2115
2148
|
# @return [Time]
|
2116
2149
|
#
|
2117
2150
|
# @!attribute [rw] data_source
|
2118
|
-
# The data provider of geospatial data.
|
2119
|
-
#
|
2151
|
+
# The data provider of geospatial data. Values can be one of the
|
2152
|
+
# following:
|
2120
2153
|
#
|
2121
2154
|
# * `Esri`
|
2122
2155
|
#
|
2123
2156
|
# * `Here`
|
2124
2157
|
#
|
2125
|
-
# For
|
2158
|
+
# For more information about data providers, see [Amazon Location
|
2126
2159
|
# Service data providers][1].
|
2127
2160
|
#
|
2128
2161
|
#
|
@@ -2408,6 +2441,10 @@ module Aws::LocationService
|
|
2408
2441
|
|
2409
2442
|
# Contains the device position details.
|
2410
2443
|
#
|
2444
|
+
# @!attribute [rw] accuracy
|
2445
|
+
# The accuracy of the device position.
|
2446
|
+
# @return [Types::PositionalAccuracy]
|
2447
|
+
#
|
2411
2448
|
# @!attribute [rw] device_id
|
2412
2449
|
# The device whose position you retrieved.
|
2413
2450
|
# @return [String]
|
@@ -2416,6 +2453,10 @@ module Aws::LocationService
|
|
2416
2453
|
# The last known device position.
|
2417
2454
|
# @return [Array<Float>]
|
2418
2455
|
#
|
2456
|
+
# @!attribute [rw] position_properties
|
2457
|
+
# The properties associated with the position.
|
2458
|
+
# @return [Hash<String,String>]
|
2459
|
+
#
|
2419
2460
|
# @!attribute [rw] received_time
|
2420
2461
|
# The timestamp for when the tracker resource received the device
|
2421
2462
|
# position in [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -2437,11 +2478,13 @@ module Aws::LocationService
|
|
2437
2478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
|
2438
2479
|
#
|
2439
2480
|
class DevicePosition < Struct.new(
|
2481
|
+
:accuracy,
|
2440
2482
|
:device_id,
|
2441
2483
|
:position,
|
2484
|
+
:position_properties,
|
2442
2485
|
:received_time,
|
2443
2486
|
:sample_time)
|
2444
|
-
SENSITIVE = [:position]
|
2487
|
+
SENSITIVE = [:position, :position_properties]
|
2445
2488
|
include Aws::Structure
|
2446
2489
|
end
|
2447
2490
|
|
@@ -2451,11 +2494,21 @@ module Aws::LocationService
|
|
2451
2494
|
# data as a hash:
|
2452
2495
|
#
|
2453
2496
|
# {
|
2497
|
+
# accuracy: {
|
2498
|
+
# horizontal: 1.0, # required
|
2499
|
+
# },
|
2454
2500
|
# device_id: "Id", # required
|
2455
2501
|
# position: [1.0], # required
|
2502
|
+
# position_properties: {
|
2503
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
2504
|
+
# },
|
2456
2505
|
# sample_time: Time.now, # required
|
2457
2506
|
# }
|
2458
2507
|
#
|
2508
|
+
# @!attribute [rw] accuracy
|
2509
|
+
# The accuracy of the device position.
|
2510
|
+
# @return [Types::PositionalAccuracy]
|
2511
|
+
#
|
2459
2512
|
# @!attribute [rw] device_id
|
2460
2513
|
# The device associated to the position update.
|
2461
2514
|
# @return [String]
|
@@ -2469,6 +2522,14 @@ module Aws::LocationService
|
|
2469
2522
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
2470
2523
|
# @return [Array<Float>]
|
2471
2524
|
#
|
2525
|
+
# @!attribute [rw] position_properties
|
2526
|
+
# Associates one of more properties with the position update. A
|
2527
|
+
# property is a key-value pair stored with the position update and
|
2528
|
+
# added to any geofence event the update may trigger.
|
2529
|
+
#
|
2530
|
+
# Format: `"key" : "value"`
|
2531
|
+
# @return [Hash<String,String>]
|
2532
|
+
#
|
2472
2533
|
# @!attribute [rw] sample_time
|
2473
2534
|
# The timestamp at which the device's position was determined. Uses
|
2474
2535
|
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
|
@@ -2481,10 +2542,12 @@ module Aws::LocationService
|
|
2481
2542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
|
2482
2543
|
#
|
2483
2544
|
class DevicePositionUpdate < Struct.new(
|
2545
|
+
:accuracy,
|
2484
2546
|
:device_id,
|
2485
2547
|
:position,
|
2548
|
+
:position_properties,
|
2486
2549
|
:sample_time)
|
2487
|
-
SENSITIVE = [:position]
|
2550
|
+
SENSITIVE = [:position, :position_properties]
|
2488
2551
|
include Aws::Structure
|
2489
2552
|
end
|
2490
2553
|
|
@@ -2685,6 +2748,10 @@ module Aws::LocationService
|
|
2685
2748
|
include Aws::Structure
|
2686
2749
|
end
|
2687
2750
|
|
2751
|
+
# @!attribute [rw] accuracy
|
2752
|
+
# The accuracy of the device position.
|
2753
|
+
# @return [Types::PositionalAccuracy]
|
2754
|
+
#
|
2688
2755
|
# @!attribute [rw] device_id
|
2689
2756
|
# The device whose position you retrieved.
|
2690
2757
|
# @return [String]
|
@@ -2693,6 +2760,10 @@ module Aws::LocationService
|
|
2693
2760
|
# The last known device position.
|
2694
2761
|
# @return [Array<Float>]
|
2695
2762
|
#
|
2763
|
+
# @!attribute [rw] position_properties
|
2764
|
+
# The properties associated with the position.
|
2765
|
+
# @return [Hash<String,String>]
|
2766
|
+
#
|
2696
2767
|
# @!attribute [rw] received_time
|
2697
2768
|
# The timestamp for when the tracker resource received the device
|
2698
2769
|
# position in [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -2714,11 +2785,13 @@ module Aws::LocationService
|
|
2714
2785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
|
2715
2786
|
#
|
2716
2787
|
class GetDevicePositionResponse < Struct.new(
|
2788
|
+
:accuracy,
|
2717
2789
|
:device_id,
|
2718
2790
|
:position,
|
2791
|
+
:position_properties,
|
2719
2792
|
:received_time,
|
2720
2793
|
:sample_time)
|
2721
|
-
SENSITIVE = [:position]
|
2794
|
+
SENSITIVE = [:position, :position_properties]
|
2722
2795
|
include Aws::Structure
|
2723
2796
|
end
|
2724
2797
|
|
@@ -3221,6 +3294,10 @@ module Aws::LocationService
|
|
3221
3294
|
|
3222
3295
|
# Contains the tracker resource details.
|
3223
3296
|
#
|
3297
|
+
# @!attribute [rw] accuracy
|
3298
|
+
# The accuracy of the device position.
|
3299
|
+
# @return [Types::PositionalAccuracy]
|
3300
|
+
#
|
3224
3301
|
# @!attribute [rw] device_id
|
3225
3302
|
# The ID of the device for this position.
|
3226
3303
|
# @return [String]
|
@@ -3230,6 +3307,10 @@ module Aws::LocationService
|
|
3230
3307
|
# stored.
|
3231
3308
|
# @return [Array<Float>]
|
3232
3309
|
#
|
3310
|
+
# @!attribute [rw] position_properties
|
3311
|
+
# The properties associated with the position.
|
3312
|
+
# @return [Hash<String,String>]
|
3313
|
+
#
|
3233
3314
|
# @!attribute [rw] sample_time
|
3234
3315
|
# The timestamp at which the device position was determined. Uses [
|
3235
3316
|
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -3242,10 +3323,12 @@ module Aws::LocationService
|
|
3242
3323
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
|
3243
3324
|
#
|
3244
3325
|
class ListDevicePositionsResponseEntry < Struct.new(
|
3326
|
+
:accuracy,
|
3245
3327
|
:device_id,
|
3246
3328
|
:position,
|
3329
|
+
:position_properties,
|
3247
3330
|
:sample_time)
|
3248
|
-
SENSITIVE = [:position]
|
3331
|
+
SENSITIVE = [:position, :position_properties]
|
3249
3332
|
include Aws::Structure
|
3250
3333
|
end
|
3251
3334
|
|
@@ -3603,9 +3686,9 @@ module Aws::LocationService
|
|
3603
3686
|
# @return [Array<Types::ListPlaceIndexesResponseEntry>]
|
3604
3687
|
#
|
3605
3688
|
# @!attribute [rw] next_token
|
3606
|
-
# A pagination token indicating there are additional pages
|
3607
|
-
# You can use the token in a
|
3608
|
-
# of results.
|
3689
|
+
# A pagination token indicating that there are additional pages
|
3690
|
+
# available. You can use the token in a new request to fetch the next
|
3691
|
+
# page of results.
|
3609
3692
|
# @return [String]
|
3610
3693
|
#
|
3611
3694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListPlaceIndexesResponse AWS API Documentation
|
@@ -3629,14 +3712,14 @@ module Aws::LocationService
|
|
3629
3712
|
# @return [Time]
|
3630
3713
|
#
|
3631
3714
|
# @!attribute [rw] data_source
|
3632
|
-
# The data provider of geospatial data.
|
3633
|
-
#
|
3715
|
+
# The data provider of geospatial data. Values can be one of the
|
3716
|
+
# following:
|
3634
3717
|
#
|
3635
3718
|
# * `Esri`
|
3636
3719
|
#
|
3637
3720
|
# * `Here`
|
3638
3721
|
#
|
3639
|
-
# For
|
3722
|
+
# For more information about data providers, see [Amazon Location
|
3640
3723
|
# Service data providers][1].
|
3641
3724
|
#
|
3642
3725
|
#
|
@@ -4110,6 +4193,19 @@ module Aws::LocationService
|
|
4110
4193
|
# Places uses a point geometry to specify a location or a Place.
|
4111
4194
|
# @return [Types::PlaceGeometry]
|
4112
4195
|
#
|
4196
|
+
# @!attribute [rw] interpolated
|
4197
|
+
# `True` if the result is interpolated from other known places.
|
4198
|
+
#
|
4199
|
+
# `False` if the Place is a known place.
|
4200
|
+
#
|
4201
|
+
# Not returned when the partner does not provide the information.
|
4202
|
+
#
|
4203
|
+
# For example, returns `False` for an address location that is found
|
4204
|
+
# in the partner data, but returns `True` if an address does not exist
|
4205
|
+
# in the partner data and its location is calculated by interpolating
|
4206
|
+
# between other known addresses.
|
4207
|
+
# @return [Boolean]
|
4208
|
+
#
|
4113
4209
|
# @!attribute [rw] label
|
4114
4210
|
# The full name and address of the point of interest such as a city,
|
4115
4211
|
# region, or country. For example, `123 Any Street, Any Town, USA`.
|
@@ -4140,23 +4236,30 @@ module Aws::LocationService
|
|
4140
4236
|
# @return [String]
|
4141
4237
|
#
|
4142
4238
|
# @!attribute [rw] sub_region
|
4143
|
-
# A country, or an area that's part of a larger region
|
4239
|
+
# A country, or an area that's part of a larger region. For example,
|
4144
4240
|
# `Metro Vancouver`.
|
4145
4241
|
# @return [String]
|
4146
4242
|
#
|
4243
|
+
# @!attribute [rw] time_zone
|
4244
|
+
# The time zone in which the `Place` is located. Returned only when
|
4245
|
+
# using Here as the selected partner.
|
4246
|
+
# @return [Types::TimeZone]
|
4247
|
+
#
|
4147
4248
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/Place AWS API Documentation
|
4148
4249
|
#
|
4149
4250
|
class Place < Struct.new(
|
4150
4251
|
:address_number,
|
4151
4252
|
:country,
|
4152
4253
|
:geometry,
|
4254
|
+
:interpolated,
|
4153
4255
|
:label,
|
4154
4256
|
:municipality,
|
4155
4257
|
:neighborhood,
|
4156
4258
|
:postal_code,
|
4157
4259
|
:region,
|
4158
4260
|
:street,
|
4159
|
-
:sub_region
|
4261
|
+
:sub_region,
|
4262
|
+
:time_zone)
|
4160
4263
|
SENSITIVE = []
|
4161
4264
|
include Aws::Structure
|
4162
4265
|
end
|
@@ -4184,6 +4287,28 @@ module Aws::LocationService
|
|
4184
4287
|
include Aws::Structure
|
4185
4288
|
end
|
4186
4289
|
|
4290
|
+
# Defines the level of certainty of the position.
|
4291
|
+
#
|
4292
|
+
# @note When making an API call, you may pass PositionalAccuracy
|
4293
|
+
# data as a hash:
|
4294
|
+
#
|
4295
|
+
# {
|
4296
|
+
# horizontal: 1.0, # required
|
4297
|
+
# }
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] horizontal
|
4300
|
+
# Estimated maximum distance, in meters, between the measured position
|
4301
|
+
# and the true position of a device, along the Earth's surface.
|
4302
|
+
# @return [Float]
|
4303
|
+
#
|
4304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PositionalAccuracy AWS API Documentation
|
4305
|
+
#
|
4306
|
+
class PositionalAccuracy < Struct.new(
|
4307
|
+
:horizontal)
|
4308
|
+
SENSITIVE = []
|
4309
|
+
include Aws::Structure
|
4310
|
+
end
|
4311
|
+
|
4187
4312
|
# @note When making an API call, you may pass PutGeofenceRequest
|
4188
4313
|
# data as a hash:
|
4189
4314
|
#
|
@@ -4275,32 +4400,81 @@ module Aws::LocationService
|
|
4275
4400
|
include Aws::Structure
|
4276
4401
|
end
|
4277
4402
|
|
4278
|
-
#
|
4279
|
-
#
|
4403
|
+
# Contains a search result from a position search query that is run on a
|
4404
|
+
# place index resource.
|
4405
|
+
#
|
4406
|
+
# @!attribute [rw] distance
|
4407
|
+
# The distance in meters of a great-circle arc between the query
|
4408
|
+
# position and the result.
|
4409
|
+
#
|
4410
|
+
# <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
|
4411
|
+
# the Earth. This returns the shortest distance between two locations.
|
4412
|
+
#
|
4413
|
+
# </note>
|
4414
|
+
# @return [Float]
|
4280
4415
|
#
|
4281
4416
|
# @!attribute [rw] place
|
4282
|
-
#
|
4417
|
+
# Details about the search result, such as its address and position.
|
4283
4418
|
# @return [Types::Place]
|
4284
4419
|
#
|
4285
4420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForPositionResult AWS API Documentation
|
4286
4421
|
#
|
4287
4422
|
class SearchForPositionResult < Struct.new(
|
4423
|
+
:distance,
|
4288
4424
|
:place)
|
4289
4425
|
SENSITIVE = []
|
4290
4426
|
include Aws::Structure
|
4291
4427
|
end
|
4292
4428
|
|
4293
|
-
# Contains
|
4294
|
-
#
|
4429
|
+
# Contains a place suggestion resulting from a place suggestion query
|
4430
|
+
# that is run on a place index resource.
|
4431
|
+
#
|
4432
|
+
# @!attribute [rw] text
|
4433
|
+
# The text of the place suggestion, typically formatted as an address
|
4434
|
+
# string.
|
4435
|
+
# @return [String]
|
4436
|
+
#
|
4437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
|
4438
|
+
#
|
4439
|
+
class SearchForSuggestionsResult < Struct.new(
|
4440
|
+
:text)
|
4441
|
+
SENSITIVE = []
|
4442
|
+
include Aws::Structure
|
4443
|
+
end
|
4444
|
+
|
4445
|
+
# Contains a search result from a text search query that is run on a
|
4446
|
+
# place index resource.
|
4447
|
+
#
|
4448
|
+
# @!attribute [rw] distance
|
4449
|
+
# The distance in meters of a great-circle arc between the bias
|
4450
|
+
# position specified and the result. `Distance` will be returned only
|
4451
|
+
# if a bias position was specified in the query.
|
4452
|
+
#
|
4453
|
+
# <note markdown="1"> A great-circle arc is the shortest path on a sphere, in this case
|
4454
|
+
# the Earth. This returns the shortest distance between two locations.
|
4455
|
+
#
|
4456
|
+
# </note>
|
4457
|
+
# @return [Float]
|
4295
4458
|
#
|
4296
4459
|
# @!attribute [rw] place
|
4297
|
-
#
|
4460
|
+
# Details about the search result, such as its address and position.
|
4298
4461
|
# @return [Types::Place]
|
4299
4462
|
#
|
4463
|
+
# @!attribute [rw] relevance
|
4464
|
+
# The relative confidence in the match for a result among the results
|
4465
|
+
# returned. For example, if more fields for an address match
|
4466
|
+
# (including house number, street, city, country/region, and postal
|
4467
|
+
# code), the relevance score is closer to 1.
|
4468
|
+
#
|
4469
|
+
# Returned only when the partner selected is Esri.
|
4470
|
+
# @return [Float]
|
4471
|
+
#
|
4300
4472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForTextResult AWS API Documentation
|
4301
4473
|
#
|
4302
4474
|
class SearchForTextResult < Struct.new(
|
4303
|
-
:
|
4475
|
+
:distance,
|
4476
|
+
:place,
|
4477
|
+
:relevance)
|
4304
4478
|
SENSITIVE = []
|
4305
4479
|
include Aws::Structure
|
4306
4480
|
end
|
@@ -4310,6 +4484,7 @@ module Aws::LocationService
|
|
4310
4484
|
#
|
4311
4485
|
# {
|
4312
4486
|
# index_name: "ResourceName", # required
|
4487
|
+
# language: "LanguageTag",
|
4313
4488
|
# max_results: 1,
|
4314
4489
|
# position: [1.0], # required
|
4315
4490
|
# }
|
@@ -4318,28 +4493,43 @@ module Aws::LocationService
|
|
4318
4493
|
# The name of the place index resource you want to use for the search.
|
4319
4494
|
# @return [String]
|
4320
4495
|
#
|
4496
|
+
# @!attribute [rw] language
|
4497
|
+
# The preferred language used to return results. The value must be a
|
4498
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
4499
|
+
#
|
4500
|
+
# This setting affects the languages used in the results. It does not
|
4501
|
+
# change which results are returned. If the language is not specified,
|
4502
|
+
# or not supported for a particular result, the partner automatically
|
4503
|
+
# chooses a language for the result.
|
4504
|
+
#
|
4505
|
+
#
|
4506
|
+
#
|
4507
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4508
|
+
# @return [String]
|
4509
|
+
#
|
4321
4510
|
# @!attribute [rw] max_results
|
4322
|
-
# An optional
|
4511
|
+
# An optional parameter. The maximum number of results returned per
|
4323
4512
|
# request.
|
4324
4513
|
#
|
4325
4514
|
# Default value: `50`
|
4326
4515
|
# @return [Integer]
|
4327
4516
|
#
|
4328
4517
|
# @!attribute [rw] position
|
4329
|
-
# Specifies
|
4330
|
-
# latitude.
|
4518
|
+
# Specifies the longitude and latitude of the position to query.
|
4331
4519
|
#
|
4332
|
-
#
|
4520
|
+
# This parameter must contain a pair of numbers. The first number
|
4521
|
+
# represents the X coordinate, or longitude; the second number
|
4522
|
+
# represents the Y coordinate, or latitude.
|
4333
4523
|
#
|
4334
|
-
#
|
4335
|
-
#
|
4336
|
-
# For example, `position=xLongitude&position=yLatitude` .
|
4524
|
+
# For example, `[-123.1174, 49.2847]` represents a position with
|
4525
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4337
4526
|
# @return [Array<Float>]
|
4338
4527
|
#
|
4339
4528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionRequest AWS API Documentation
|
4340
4529
|
#
|
4341
4530
|
class SearchPlaceIndexForPositionRequest < Struct.new(
|
4342
4531
|
:index_name,
|
4532
|
+
:language,
|
4343
4533
|
:max_results,
|
4344
4534
|
:position)
|
4345
4535
|
SENSITIVE = [:position]
|
@@ -4352,7 +4542,9 @@ module Aws::LocationService
|
|
4352
4542
|
# @return [Array<Types::SearchForPositionResult>]
|
4353
4543
|
#
|
4354
4544
|
# @!attribute [rw] summary
|
4355
|
-
# Contains a summary of the request.
|
4545
|
+
# Contains a summary of the request. Echoes the input values for
|
4546
|
+
# `Position`, `Language`, `MaxResults`, and the `DataSource` of the
|
4547
|
+
# place index.
|
4356
4548
|
# @return [Types::SearchPlaceIndexForPositionSummary]
|
4357
4549
|
#
|
4358
4550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionResponse AWS API Documentation
|
@@ -4364,18 +4556,17 @@ module Aws::LocationService
|
|
4364
4556
|
include Aws::Structure
|
4365
4557
|
end
|
4366
4558
|
|
4367
|
-
# A summary of the
|
4368
|
-
# `SearchPlaceIndexForPosition`.
|
4559
|
+
# A summary of the request sent by using `SearchPlaceIndexForPosition`.
|
4369
4560
|
#
|
4370
4561
|
# @!attribute [rw] data_source
|
4371
|
-
# The data provider
|
4372
|
-
#
|
4562
|
+
# The geospatial data provider attached to the place index resource
|
4563
|
+
# specified in the request. Values can be one of the following:
|
4373
4564
|
#
|
4374
4565
|
# * Esri
|
4375
4566
|
#
|
4376
|
-
# *
|
4567
|
+
# * Here
|
4377
4568
|
#
|
4378
|
-
# For
|
4569
|
+
# For more information about data providers, see [Amazon Location
|
4379
4570
|
# Service data providers][1].
|
4380
4571
|
#
|
4381
4572
|
#
|
@@ -4383,28 +4574,39 @@ module Aws::LocationService
|
|
4383
4574
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
4384
4575
|
# @return [String]
|
4385
4576
|
#
|
4577
|
+
# @!attribute [rw] language
|
4578
|
+
# The preferred language used to return results. Matches the language
|
4579
|
+
# in the request. The value is a valid [BCP 47][1] language tag, for
|
4580
|
+
# example, `en` for English.
|
4581
|
+
#
|
4582
|
+
#
|
4583
|
+
#
|
4584
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4585
|
+
# @return [String]
|
4586
|
+
#
|
4386
4587
|
# @!attribute [rw] max_results
|
4387
|
-
#
|
4588
|
+
# Contains the optional result count limit that is specified in the
|
4388
4589
|
# request.
|
4389
4590
|
#
|
4390
4591
|
# Default value: `50`
|
4391
4592
|
# @return [Integer]
|
4392
4593
|
#
|
4393
4594
|
# @!attribute [rw] position
|
4394
|
-
# The position
|
4595
|
+
# The position specified in the request.
|
4395
4596
|
# @return [Array<Float>]
|
4396
4597
|
#
|
4397
4598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPositionSummary AWS API Documentation
|
4398
4599
|
#
|
4399
4600
|
class SearchPlaceIndexForPositionSummary < Struct.new(
|
4400
4601
|
:data_source,
|
4602
|
+
:language,
|
4401
4603
|
:max_results,
|
4402
4604
|
:position)
|
4403
4605
|
SENSITIVE = [:position]
|
4404
4606
|
include Aws::Structure
|
4405
4607
|
end
|
4406
4608
|
|
4407
|
-
# @note When making an API call, you may pass
|
4609
|
+
# @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
|
4408
4610
|
# data as a hash:
|
4409
4611
|
#
|
4410
4612
|
# {
|
@@ -4412,52 +4614,260 @@ module Aws::LocationService
|
|
4412
4614
|
# filter_b_box: [1.0],
|
4413
4615
|
# filter_countries: ["CountryCode"],
|
4414
4616
|
# index_name: "ResourceName", # required
|
4617
|
+
# language: "LanguageTag",
|
4415
4618
|
# max_results: 1,
|
4416
|
-
# text: "
|
4619
|
+
# text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
|
4417
4620
|
# }
|
4418
4621
|
#
|
4419
4622
|
# @!attribute [rw] bias_position
|
4420
|
-
#
|
4421
|
-
#
|
4623
|
+
# An optional parameter that indicates a preference for place
|
4624
|
+
# suggestions that are closer to a specified position.
|
4625
|
+
#
|
4626
|
+
# If provided, this parameter must contain a pair of numbers. The
|
4627
|
+
# first number represents the X coordinate, or longitude; the second
|
4628
|
+
# number represents the Y coordinate, or latitude.
|
4422
4629
|
#
|
4423
|
-
#
|
4630
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
4631
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4424
4632
|
#
|
4425
|
-
#
|
4633
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
4634
|
+
# both options results in an error.
|
4426
4635
|
#
|
4427
|
-
#
|
4636
|
+
# </note>
|
4428
4637
|
# @return [Array<Float>]
|
4429
4638
|
#
|
4430
4639
|
# @!attribute [rw] filter_b_box
|
4431
|
-
#
|
4432
|
-
#
|
4640
|
+
# An optional parameter that limits the search results by returning
|
4641
|
+
# only suggestions within a specified bounding box.
|
4433
4642
|
#
|
4434
|
-
#
|
4643
|
+
# If provided, this parameter must contain a total of four consecutive
|
4644
|
+
# numbers in two pairs. The first pair of numbers represents the X and
|
4645
|
+
# Y coordinates (longitude and latitude, respectively) of the
|
4646
|
+
# southwest corner of the bounding box; the second pair of numbers
|
4647
|
+
# represents the X and Y coordinates (longitude and latitude,
|
4648
|
+
# respectively) of the northeast corner of the bounding box.
|
4435
4649
|
#
|
4436
|
-
#
|
4437
|
-
#
|
4650
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
4651
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
4652
|
+
# latitude `-37.4835`, and the northeast corner has longitude
|
4653
|
+
# `-12.0684` and latitude `-36.9542`.
|
4438
4654
|
#
|
4439
|
-
#
|
4440
|
-
#
|
4655
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
4656
|
+
# both options results in an error.
|
4657
|
+
#
|
4658
|
+
# </note>
|
4659
|
+
# @return [Array<Float>]
|
4441
4660
|
#
|
4442
|
-
#
|
4661
|
+
# @!attribute [rw] filter_countries
|
4662
|
+
# An optional parameter that limits the search results by returning
|
4663
|
+
# only suggestions within the provided list of countries.
|
4443
4664
|
#
|
4444
|
-
#
|
4665
|
+
# * Use the [ISO 3166][1] 3-digit country code. For example, Australia
|
4666
|
+
# uses three upper-case characters: `AUS`.
|
4445
4667
|
#
|
4446
|
-
#
|
4447
|
-
#
|
4668
|
+
# ^
|
4669
|
+
#
|
4670
|
+
#
|
4671
|
+
#
|
4672
|
+
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
4673
|
+
# @return [Array<String>]
|
4674
|
+
#
|
4675
|
+
# @!attribute [rw] index_name
|
4676
|
+
# The name of the place index resource you want to use for the search.
|
4677
|
+
# @return [String]
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] language
|
4680
|
+
# The preferred language used to return results. The value must be a
|
4681
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
4682
|
+
#
|
4683
|
+
# This setting affects the languages used in the results. It does not
|
4684
|
+
# change which results are returned. If the language is not specified,
|
4685
|
+
# or not supported for a particular result, the partner automatically
|
4686
|
+
# chooses a language for the result.
|
4687
|
+
#
|
4688
|
+
# Used only when the partner selected is Here.
|
4689
|
+
#
|
4690
|
+
#
|
4691
|
+
#
|
4692
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4693
|
+
# @return [String]
|
4694
|
+
#
|
4695
|
+
# @!attribute [rw] max_results
|
4696
|
+
# An optional parameter. The maximum number of results returned per
|
4697
|
+
# request.
|
4698
|
+
#
|
4699
|
+
# The default: `5`
|
4700
|
+
# @return [Integer]
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] text
|
4703
|
+
# The free-form partial text to use to generate place suggestions. For
|
4704
|
+
# example, `eiffel tow`.
|
4705
|
+
# @return [String]
|
4706
|
+
#
|
4707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsRequest AWS API Documentation
|
4708
|
+
#
|
4709
|
+
class SearchPlaceIndexForSuggestionsRequest < Struct.new(
|
4710
|
+
:bias_position,
|
4711
|
+
:filter_b_box,
|
4712
|
+
:filter_countries,
|
4713
|
+
:index_name,
|
4714
|
+
:language,
|
4715
|
+
:max_results,
|
4716
|
+
:text)
|
4717
|
+
SENSITIVE = [:bias_position, :filter_b_box, :text]
|
4718
|
+
include Aws::Structure
|
4719
|
+
end
|
4720
|
+
|
4721
|
+
# @!attribute [rw] results
|
4722
|
+
# A list of place suggestions that best match the search text.
|
4723
|
+
# @return [Array<Types::SearchForSuggestionsResult>]
|
4724
|
+
#
|
4725
|
+
# @!attribute [rw] summary
|
4726
|
+
# Contains a summary of the request. Echoes the input values for
|
4727
|
+
# `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
|
4728
|
+
# `MaxResults`, and `Text`. Also includes the `DataSource` of the
|
4729
|
+
# place index.
|
4730
|
+
# @return [Types::SearchPlaceIndexForSuggestionsSummary]
|
4731
|
+
#
|
4732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsResponse AWS API Documentation
|
4733
|
+
#
|
4734
|
+
class SearchPlaceIndexForSuggestionsResponse < Struct.new(
|
4735
|
+
:results,
|
4736
|
+
:summary)
|
4737
|
+
SENSITIVE = []
|
4738
|
+
include Aws::Structure
|
4739
|
+
end
|
4740
|
+
|
4741
|
+
# A summary of the request sent by using
|
4742
|
+
# `SearchPlaceIndexForSuggestions`.
|
4743
|
+
#
|
4744
|
+
# @!attribute [rw] bias_position
|
4745
|
+
# Contains the coordinates for the optional bias position specified in
|
4746
|
+
# the request.
|
4747
|
+
#
|
4748
|
+
# This parameter contains a pair of numbers. The first number
|
4749
|
+
# represents the X coordinate, or longitude; the second number
|
4750
|
+
# represents the Y coordinate, or latitude.
|
4751
|
+
#
|
4752
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
4753
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4754
|
+
# @return [Array<Float>]
|
4755
|
+
#
|
4756
|
+
# @!attribute [rw] data_source
|
4757
|
+
# The geospatial data provider attached to the place index resource
|
4758
|
+
# specified in the request. Values can be one of the following:
|
4759
|
+
#
|
4760
|
+
# * Esri
|
4448
4761
|
#
|
4449
|
-
# *
|
4450
|
-
# the upper northeast corner.
|
4762
|
+
# * Here
|
4451
4763
|
#
|
4452
|
-
# For
|
4764
|
+
# For more information about data providers, see [Amazon Location
|
4765
|
+
# Service data providers][1].
|
4766
|
+
#
|
4767
|
+
#
|
4768
|
+
#
|
4769
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
|
4770
|
+
# @return [String]
|
4771
|
+
#
|
4772
|
+
# @!attribute [rw] filter_b_box
|
4773
|
+
# Contains the coordinates for the optional bounding box specified in
|
4774
|
+
# the request.
|
4453
4775
|
# @return [Array<Float>]
|
4454
4776
|
#
|
4455
4777
|
# @!attribute [rw] filter_countries
|
4456
|
-
#
|
4457
|
-
#
|
4778
|
+
# Contains the optional country filter specified in the request.
|
4779
|
+
# @return [Array<String>]
|
4458
4780
|
#
|
4459
|
-
#
|
4460
|
-
#
|
4781
|
+
# @!attribute [rw] language
|
4782
|
+
# The preferred language used to return results. Matches the language
|
4783
|
+
# in the request. The value is a valid [BCP 47][1] language tag, for
|
4784
|
+
# example, `en` for English.
|
4785
|
+
#
|
4786
|
+
#
|
4787
|
+
#
|
4788
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4789
|
+
# @return [String]
|
4790
|
+
#
|
4791
|
+
# @!attribute [rw] max_results
|
4792
|
+
# Contains the optional result count limit specified in the request.
|
4793
|
+
# @return [Integer]
|
4794
|
+
#
|
4795
|
+
# @!attribute [rw] text
|
4796
|
+
# The free-form partial text input specified in the request.
|
4797
|
+
# @return [String]
|
4798
|
+
#
|
4799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsSummary AWS API Documentation
|
4800
|
+
#
|
4801
|
+
class SearchPlaceIndexForSuggestionsSummary < Struct.new(
|
4802
|
+
:bias_position,
|
4803
|
+
:data_source,
|
4804
|
+
:filter_b_box,
|
4805
|
+
:filter_countries,
|
4806
|
+
:language,
|
4807
|
+
:max_results,
|
4808
|
+
:text)
|
4809
|
+
SENSITIVE = [:bias_position, :filter_b_box, :text]
|
4810
|
+
include Aws::Structure
|
4811
|
+
end
|
4812
|
+
|
4813
|
+
# @note When making an API call, you may pass SearchPlaceIndexForTextRequest
|
4814
|
+
# data as a hash:
|
4815
|
+
#
|
4816
|
+
# {
|
4817
|
+
# bias_position: [1.0],
|
4818
|
+
# filter_b_box: [1.0],
|
4819
|
+
# filter_countries: ["CountryCode"],
|
4820
|
+
# index_name: "ResourceName", # required
|
4821
|
+
# language: "LanguageTag",
|
4822
|
+
# max_results: 1,
|
4823
|
+
# text: "SyntheticSearchPlaceIndexForTextRequestString", # required
|
4824
|
+
# }
|
4825
|
+
#
|
4826
|
+
# @!attribute [rw] bias_position
|
4827
|
+
# An optional parameter that indicates a preference for places that
|
4828
|
+
# are closer to a specified position.
|
4829
|
+
#
|
4830
|
+
# If provided, this parameter must contain a pair of numbers. The
|
4831
|
+
# first number represents the X coordinate, or longitude; the second
|
4832
|
+
# number represents the Y coordinate, or latitude.
|
4833
|
+
#
|
4834
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
4835
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4836
|
+
#
|
4837
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
4838
|
+
# both options results in an error.
|
4839
|
+
#
|
4840
|
+
# </note>
|
4841
|
+
# @return [Array<Float>]
|
4842
|
+
#
|
4843
|
+
# @!attribute [rw] filter_b_box
|
4844
|
+
# An optional parameter that limits the search results by returning
|
4845
|
+
# only places that are within the provided bounding box.
|
4846
|
+
#
|
4847
|
+
# If provided, this parameter must contain a total of four consecutive
|
4848
|
+
# numbers in two pairs. The first pair of numbers represents the X and
|
4849
|
+
# Y coordinates (longitude and latitude, respectively) of the
|
4850
|
+
# southwest corner of the bounding box; the second pair of numbers
|
4851
|
+
# represents the X and Y coordinates (longitude and latitude,
|
4852
|
+
# respectively) of the northeast corner of the bounding box.
|
4853
|
+
#
|
4854
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
4855
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
4856
|
+
# latitude `-37.4835`, and the northeast corner has longitude
|
4857
|
+
# `-12.0684` and latitude `-36.9542`.
|
4858
|
+
#
|
4859
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
4860
|
+
# both options results in an error.
|
4861
|
+
#
|
4862
|
+
# </note>
|
4863
|
+
# @return [Array<Float>]
|
4864
|
+
#
|
4865
|
+
# @!attribute [rw] filter_countries
|
4866
|
+
# An optional parameter that limits the search results by returning
|
4867
|
+
# only places that are in a specified list of countries.
|
4868
|
+
#
|
4869
|
+
# * Valid values include [ISO 3166][1] 3-digit country codes. For
|
4870
|
+
# example, Australia uses three upper-case characters: `AUS`.
|
4461
4871
|
#
|
4462
4872
|
# ^
|
4463
4873
|
#
|
@@ -4470,6 +4880,20 @@ module Aws::LocationService
|
|
4470
4880
|
# The name of the place index resource you want to use for the search.
|
4471
4881
|
# @return [String]
|
4472
4882
|
#
|
4883
|
+
# @!attribute [rw] language
|
4884
|
+
# The preferred language used to return results. The value must be a
|
4885
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
4886
|
+
#
|
4887
|
+
# This setting affects the languages used in the results. It does not
|
4888
|
+
# change which results are returned. If the language is not specified,
|
4889
|
+
# or not supported for a particular result, the partner automatically
|
4890
|
+
# chooses a language for the result.
|
4891
|
+
#
|
4892
|
+
#
|
4893
|
+
#
|
4894
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4895
|
+
# @return [String]
|
4896
|
+
#
|
4473
4897
|
# @!attribute [rw] max_results
|
4474
4898
|
# An optional parameter. The maximum number of results returned per
|
4475
4899
|
# request.
|
@@ -4478,7 +4902,7 @@ module Aws::LocationService
|
|
4478
4902
|
# @return [Integer]
|
4479
4903
|
#
|
4480
4904
|
# @!attribute [rw] text
|
4481
|
-
# The address, name, city, or region to be used in the search
|
4905
|
+
# The address, name, city, or region to be used in the search in
|
4482
4906
|
# free-form text format. For example, `123 Any Street`.
|
4483
4907
|
# @return [String]
|
4484
4908
|
#
|
@@ -4489,6 +4913,7 @@ module Aws::LocationService
|
|
4489
4913
|
:filter_b_box,
|
4490
4914
|
:filter_countries,
|
4491
4915
|
:index_name,
|
4916
|
+
:language,
|
4492
4917
|
:max_results,
|
4493
4918
|
:text)
|
4494
4919
|
SENSITIVE = [:bias_position, :filter_b_box, :text]
|
@@ -4496,15 +4921,16 @@ module Aws::LocationService
|
|
4496
4921
|
end
|
4497
4922
|
|
4498
4923
|
# @!attribute [rw] results
|
4499
|
-
# A list of Places
|
4500
|
-
#
|
4501
|
-
# interest.
|
4924
|
+
# A list of Places matching the input text. Each result contains
|
4925
|
+
# additional information about the specific point of interest.
|
4502
4926
|
# @return [Array<Types::SearchForTextResult>]
|
4503
4927
|
#
|
4504
4928
|
# @!attribute [rw] summary
|
4505
|
-
# Contains a summary of the request.
|
4506
|
-
# `
|
4507
|
-
# `
|
4929
|
+
# Contains a summary of the request. Echoes the input values for
|
4930
|
+
# `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
|
4931
|
+
# `MaxResults`, and `Text`. Also includes the `DataSource` of the
|
4932
|
+
# place index and the bounding box, `ResultBBox`, which surrounds the
|
4933
|
+
# search results.
|
4508
4934
|
# @return [Types::SearchPlaceIndexForTextSummary]
|
4509
4935
|
#
|
4510
4936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextResponse AWS API Documentation
|
@@ -4516,23 +4942,29 @@ module Aws::LocationService
|
|
4516
4942
|
include Aws::Structure
|
4517
4943
|
end
|
4518
4944
|
|
4519
|
-
# A summary of the
|
4520
|
-
# `SearchPlaceIndexForText`.
|
4945
|
+
# A summary of the request sent by using `SearchPlaceIndexForText`.
|
4521
4946
|
#
|
4522
4947
|
# @!attribute [rw] bias_position
|
4523
|
-
# Contains the coordinates for the bias position
|
4524
|
-
#
|
4948
|
+
# Contains the coordinates for the optional bias position specified in
|
4949
|
+
# the request.
|
4950
|
+
#
|
4951
|
+
# This parameter contains a pair of numbers. The first number
|
4952
|
+
# represents the X coordinate, or longitude; the second number
|
4953
|
+
# represents the Y coordinate, or latitude.
|
4954
|
+
#
|
4955
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
4956
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4525
4957
|
# @return [Array<Float>]
|
4526
4958
|
#
|
4527
4959
|
# @!attribute [rw] data_source
|
4528
|
-
# The data provider
|
4529
|
-
#
|
4960
|
+
# The geospatial data provider attached to the place index resource
|
4961
|
+
# specified in the request. Values can be one of the following:
|
4530
4962
|
#
|
4531
4963
|
# * Esri
|
4532
4964
|
#
|
4533
|
-
# *
|
4965
|
+
# * Here
|
4534
4966
|
#
|
4535
|
-
# For
|
4967
|
+
# For more information about data providers, see [Amazon Location
|
4536
4968
|
# Service data providers][1].
|
4537
4969
|
#
|
4538
4970
|
#
|
@@ -4541,27 +4973,39 @@ module Aws::LocationService
|
|
4541
4973
|
# @return [String]
|
4542
4974
|
#
|
4543
4975
|
# @!attribute [rw] filter_b_box
|
4544
|
-
# Contains the coordinates for the optional bounding box
|
4545
|
-
#
|
4976
|
+
# Contains the coordinates for the optional bounding box specified in
|
4977
|
+
# the request.
|
4546
4978
|
# @return [Array<Float>]
|
4547
4979
|
#
|
4548
4980
|
# @!attribute [rw] filter_countries
|
4549
|
-
# Contains the country filter
|
4981
|
+
# Contains the optional country filter specified in the request.
|
4550
4982
|
# @return [Array<String>]
|
4551
4983
|
#
|
4984
|
+
# @!attribute [rw] language
|
4985
|
+
# The preferred language used to return results. Matches the language
|
4986
|
+
# in the request. The value is a valid [BCP 47][1] language tag, for
|
4987
|
+
# example, `en` for English.
|
4988
|
+
#
|
4989
|
+
#
|
4990
|
+
#
|
4991
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
4992
|
+
# @return [String]
|
4993
|
+
#
|
4552
4994
|
# @!attribute [rw] max_results
|
4553
|
-
# Contains the
|
4995
|
+
# Contains the optional result count limit specified in the request.
|
4554
4996
|
# @return [Integer]
|
4555
4997
|
#
|
4556
4998
|
# @!attribute [rw] result_b_box
|
4557
|
-
#
|
4558
|
-
#
|
4559
|
-
#
|
4999
|
+
# The bounding box that fully contains all search results.
|
5000
|
+
#
|
5001
|
+
# <note markdown="1"> If you specified the optional `FilterBBox` parameter in the request,
|
5002
|
+
# `ResultBBox` is contained within `FilterBBox`.
|
5003
|
+
#
|
5004
|
+
# </note>
|
4560
5005
|
# @return [Array<Float>]
|
4561
5006
|
#
|
4562
5007
|
# @!attribute [rw] text
|
4563
|
-
# The
|
4564
|
-
# request. In free-form text format. For example, `Vancouver`.
|
5008
|
+
# The search text specified in the request.
|
4565
5009
|
# @return [String]
|
4566
5010
|
#
|
4567
5011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextSummary AWS API Documentation
|
@@ -4571,6 +5015,7 @@ module Aws::LocationService
|
|
4571
5015
|
:data_source,
|
4572
5016
|
:filter_b_box,
|
4573
5017
|
:filter_countries,
|
5018
|
+
:language,
|
4574
5019
|
:max_results,
|
4575
5020
|
:result_b_box,
|
4576
5021
|
:text)
|
@@ -4666,12 +5111,27 @@ module Aws::LocationService
|
|
4666
5111
|
# @return [String]
|
4667
5112
|
#
|
4668
5113
|
# @!attribute [rw] tags
|
4669
|
-
#
|
4670
|
-
#
|
5114
|
+
# Applies one or more tags to specific resource. A tag is a key-value
|
5115
|
+
# pair that helps you manage, identify, search, and filter your
|
5116
|
+
# resources.
|
4671
5117
|
#
|
4672
|
-
#
|
5118
|
+
# Format: `"key" : "value"`
|
4673
5119
|
#
|
4674
|
-
#
|
5120
|
+
# Restrictions:
|
5121
|
+
#
|
5122
|
+
# * Maximum 50 tags per resource.
|
5123
|
+
#
|
5124
|
+
# * Each tag key must be unique and must have exactly one associated
|
5125
|
+
# value.
|
5126
|
+
#
|
5127
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
5128
|
+
#
|
5129
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
5130
|
+
#
|
5131
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
5132
|
+
# characters: + - = . \_ : / @
|
5133
|
+
#
|
5134
|
+
# * Cannot use "aws:" as a prefix for a key.
|
4675
5135
|
# @return [Hash<String,String>]
|
4676
5136
|
#
|
4677
5137
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResourceRequest AWS API Documentation
|
@@ -4700,6 +5160,31 @@ module Aws::LocationService
|
|
4700
5160
|
include Aws::Structure
|
4701
5161
|
end
|
4702
5162
|
|
5163
|
+
# Information about a time zone. Includes the name of the time zone and
|
5164
|
+
# the offset from UTC in seconds.
|
5165
|
+
#
|
5166
|
+
# @!attribute [rw] name
|
5167
|
+
# The name of the time zone, following the [ IANA time zone
|
5168
|
+
# standard][1]. For example, `America/Los_Angeles`.
|
5169
|
+
#
|
5170
|
+
#
|
5171
|
+
#
|
5172
|
+
# [1]: https://www.iana.org/time-zones
|
5173
|
+
# @return [String]
|
5174
|
+
#
|
5175
|
+
# @!attribute [rw] offset
|
5176
|
+
# The time zone's offset, in seconds, from UTC.
|
5177
|
+
# @return [Integer]
|
5178
|
+
#
|
5179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TimeZone AWS API Documentation
|
5180
|
+
#
|
5181
|
+
class TimeZone < Struct.new(
|
5182
|
+
:name,
|
5183
|
+
:offset)
|
5184
|
+
SENSITIVE = []
|
5185
|
+
include Aws::Structure
|
5186
|
+
end
|
5187
|
+
|
4703
5188
|
# Contains details about the truck dimensions in the unit of measurement
|
4704
5189
|
# that you specify. Used to filter out roads that can't support or
|
4705
5190
|
# allow the specified dimensions for requests that specify `TravelMode`
|
@@ -5149,7 +5634,7 @@ module Aws::LocationService
|
|
5149
5634
|
#
|
5150
5635
|
# {
|
5151
5636
|
# description: "ResourceDescription",
|
5152
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
5637
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
5153
5638
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
5154
5639
|
# pricing_plan_data_source: "String",
|
5155
5640
|
# tracker_name: "ResourceName", # required
|
@@ -5173,9 +5658,19 @@ module Aws::LocationService
|
|
5173
5658
|
# ft), location updates are ignored. Location updates within this
|
5174
5659
|
# distance are neither evaluated against linked geofence
|
5175
5660
|
# collections, nor stored. This helps control costs by reducing the
|
5176
|
-
# number of geofence evaluations and device positions to
|
5177
|
-
# Distance-based filtering can also reduce the
|
5178
|
-
# displaying device
|
5661
|
+
# number of geofence evaluations and historical device positions to
|
5662
|
+
# paginate through. Distance-based filtering can also reduce the
|
5663
|
+
# effects of GPS noise when displaying device trajectories on a map.
|
5664
|
+
#
|
5665
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
5666
|
+
# accuracy, location updates are ignored. For example, if two
|
5667
|
+
# consecutive updates from a device have a horizontal accuracy of 5
|
5668
|
+
# m and 10 m, the second update is ignored if the device has moved
|
5669
|
+
# less than 15 m. Ignored location updates are neither evaluated
|
5670
|
+
# against linked geofence collections, nor stored. This helps educe
|
5671
|
+
# the effects of GPS noise when displaying device trajectories on a
|
5672
|
+
# map, and can help control costs by reducing the number of geofence
|
5673
|
+
# evaluations.
|
5179
5674
|
# @return [String]
|
5180
5675
|
#
|
5181
5676
|
# @!attribute [rw] pricing_plan
|