aws-sdk-locationservice 1.12.0 → 1.16.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +240 -26
- data/lib/aws-sdk-locationservice/client_api.rb +75 -5
- data/lib/aws-sdk-locationservice/types.rb +353 -17
- 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
|
# ],
|
@@ -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", #
|
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
|
-
#
|
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].
|
@@ -1162,7 +1175,7 @@ module Aws::LocationService
|
|
1162
1175
|
# },
|
1163
1176
|
# description: "ResourceDescription",
|
1164
1177
|
# map_name: "ResourceName", # required
|
1165
|
-
# pricing_plan: "RequestBasedUsage", #
|
1178
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1166
1179
|
# tags: {
|
1167
1180
|
# "TagKey" => "TagValue",
|
1168
1181
|
# },
|
@@ -1190,7 +1203,8 @@ module Aws::LocationService
|
|
1190
1203
|
# @return [String]
|
1191
1204
|
#
|
1192
1205
|
# @!attribute [rw] pricing_plan
|
1193
|
-
#
|
1206
|
+
# Optionally specifies the pricing plan for the map resource. Defaults
|
1207
|
+
# to `RequestBasedUsage`.
|
1194
1208
|
#
|
1195
1209
|
# For additional details and restrictions on each pricing plan option,
|
1196
1210
|
# see [Amazon Location Service pricing][1].
|
@@ -1277,7 +1291,7 @@ module Aws::LocationService
|
|
1277
1291
|
# },
|
1278
1292
|
# description: "ResourceDescription",
|
1279
1293
|
# index_name: "ResourceName", # required
|
1280
|
-
# pricing_plan: "RequestBasedUsage", #
|
1294
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1281
1295
|
# tags: {
|
1282
1296
|
# "TagKey" => "TagValue",
|
1283
1297
|
# },
|
@@ -1342,7 +1356,8 @@ module Aws::LocationService
|
|
1342
1356
|
# @return [String]
|
1343
1357
|
#
|
1344
1358
|
# @!attribute [rw] pricing_plan
|
1345
|
-
#
|
1359
|
+
# Optionally specifies the pricing plan for the place index resource.
|
1360
|
+
# Defaults to `RequestBasedUsage`.
|
1346
1361
|
#
|
1347
1362
|
# For additional details and restrictions on each pricing plan option,
|
1348
1363
|
# see [Amazon Location Service pricing][1].
|
@@ -1429,7 +1444,7 @@ module Aws::LocationService
|
|
1429
1444
|
# calculator_name: "ResourceName", # required
|
1430
1445
|
# data_source: "String", # required
|
1431
1446
|
# description: "ResourceDescription",
|
1432
|
-
# pricing_plan: "RequestBasedUsage", #
|
1447
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1433
1448
|
# tags: {
|
1434
1449
|
# "TagKey" => "TagValue",
|
1435
1450
|
# },
|
@@ -1486,7 +1501,8 @@ module Aws::LocationService
|
|
1486
1501
|
# @return [String]
|
1487
1502
|
#
|
1488
1503
|
# @!attribute [rw] pricing_plan
|
1489
|
-
#
|
1504
|
+
# Optionally specifies the pricing plan for the route calculator
|
1505
|
+
# resource. Defaults to `RequestBasedUsage`.
|
1490
1506
|
#
|
1491
1507
|
# For additional details and restrictions on each pricing plan option,
|
1492
1508
|
# see [Amazon Location Service pricing][1].
|
@@ -1583,7 +1599,7 @@ module Aws::LocationService
|
|
1583
1599
|
# description: "ResourceDescription",
|
1584
1600
|
# kms_key_id: "KmsKeyId",
|
1585
1601
|
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1586
|
-
# pricing_plan: "RequestBasedUsage", #
|
1602
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1587
1603
|
# pricing_plan_data_source: "String",
|
1588
1604
|
# tags: {
|
1589
1605
|
# "TagKey" => "TagValue",
|
@@ -1622,12 +1638,23 @@ module Aws::LocationService
|
|
1622
1638
|
# through. Distance-based filtering can also reduce the effects of
|
1623
1639
|
# GPS noise when displaying device trajectories on a map.
|
1624
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.
|
1650
|
+
#
|
1625
1651
|
# This field is optional. If not specified, the default value is
|
1626
1652
|
# `TimeBased`.
|
1627
1653
|
# @return [String]
|
1628
1654
|
#
|
1629
1655
|
# @!attribute [rw] pricing_plan
|
1630
|
-
#
|
1656
|
+
# Optionally specifies the pricing plan for the tracker resource.
|
1657
|
+
# Defaults to `RequestBasedUsage`.
|
1631
1658
|
#
|
1632
1659
|
# For additional details and restrictions on each pricing plan option,
|
1633
1660
|
# see [Amazon Location Service pricing][1].
|
@@ -2419,6 +2446,10 @@ module Aws::LocationService
|
|
2419
2446
|
|
2420
2447
|
# Contains the device position details.
|
2421
2448
|
#
|
2449
|
+
# @!attribute [rw] accuracy
|
2450
|
+
# The accuracy of the device position.
|
2451
|
+
# @return [Types::PositionalAccuracy]
|
2452
|
+
#
|
2422
2453
|
# @!attribute [rw] device_id
|
2423
2454
|
# The device whose position you retrieved.
|
2424
2455
|
# @return [String]
|
@@ -2427,6 +2458,10 @@ module Aws::LocationService
|
|
2427
2458
|
# The last known device position.
|
2428
2459
|
# @return [Array<Float>]
|
2429
2460
|
#
|
2461
|
+
# @!attribute [rw] position_properties
|
2462
|
+
# The properties associated with the position.
|
2463
|
+
# @return [Hash<String,String>]
|
2464
|
+
#
|
2430
2465
|
# @!attribute [rw] received_time
|
2431
2466
|
# The timestamp for when the tracker resource received the device
|
2432
2467
|
# position in [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -2448,11 +2483,13 @@ module Aws::LocationService
|
|
2448
2483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
|
2449
2484
|
#
|
2450
2485
|
class DevicePosition < Struct.new(
|
2486
|
+
:accuracy,
|
2451
2487
|
:device_id,
|
2452
2488
|
:position,
|
2489
|
+
:position_properties,
|
2453
2490
|
:received_time,
|
2454
2491
|
:sample_time)
|
2455
|
-
SENSITIVE = [:position]
|
2492
|
+
SENSITIVE = [:position, :position_properties]
|
2456
2493
|
include Aws::Structure
|
2457
2494
|
end
|
2458
2495
|
|
@@ -2462,11 +2499,21 @@ module Aws::LocationService
|
|
2462
2499
|
# data as a hash:
|
2463
2500
|
#
|
2464
2501
|
# {
|
2502
|
+
# accuracy: {
|
2503
|
+
# horizontal: 1.0, # required
|
2504
|
+
# },
|
2465
2505
|
# device_id: "Id", # required
|
2466
2506
|
# position: [1.0], # required
|
2507
|
+
# position_properties: {
|
2508
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
2509
|
+
# },
|
2467
2510
|
# sample_time: Time.now, # required
|
2468
2511
|
# }
|
2469
2512
|
#
|
2513
|
+
# @!attribute [rw] accuracy
|
2514
|
+
# The accuracy of the device position.
|
2515
|
+
# @return [Types::PositionalAccuracy]
|
2516
|
+
#
|
2470
2517
|
# @!attribute [rw] device_id
|
2471
2518
|
# The device associated to the position update.
|
2472
2519
|
# @return [String]
|
@@ -2480,6 +2527,14 @@ module Aws::LocationService
|
|
2480
2527
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
2481
2528
|
# @return [Array<Float>]
|
2482
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
|
+
#
|
2483
2538
|
# @!attribute [rw] sample_time
|
2484
2539
|
# The timestamp at which the device's position was determined. Uses
|
2485
2540
|
# [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
|
@@ -2492,10 +2547,12 @@ module Aws::LocationService
|
|
2492
2547
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
|
2493
2548
|
#
|
2494
2549
|
class DevicePositionUpdate < Struct.new(
|
2550
|
+
:accuracy,
|
2495
2551
|
:device_id,
|
2496
2552
|
:position,
|
2553
|
+
:position_properties,
|
2497
2554
|
:sample_time)
|
2498
|
-
SENSITIVE = [:position]
|
2555
|
+
SENSITIVE = [:position, :position_properties]
|
2499
2556
|
include Aws::Structure
|
2500
2557
|
end
|
2501
2558
|
|
@@ -2696,6 +2753,10 @@ module Aws::LocationService
|
|
2696
2753
|
include Aws::Structure
|
2697
2754
|
end
|
2698
2755
|
|
2756
|
+
# @!attribute [rw] accuracy
|
2757
|
+
# The accuracy of the device position.
|
2758
|
+
# @return [Types::PositionalAccuracy]
|
2759
|
+
#
|
2699
2760
|
# @!attribute [rw] device_id
|
2700
2761
|
# The device whose position you retrieved.
|
2701
2762
|
# @return [String]
|
@@ -2704,6 +2765,10 @@ module Aws::LocationService
|
|
2704
2765
|
# The last known device position.
|
2705
2766
|
# @return [Array<Float>]
|
2706
2767
|
#
|
2768
|
+
# @!attribute [rw] position_properties
|
2769
|
+
# The properties associated with the position.
|
2770
|
+
# @return [Hash<String,String>]
|
2771
|
+
#
|
2707
2772
|
# @!attribute [rw] received_time
|
2708
2773
|
# The timestamp for when the tracker resource received the device
|
2709
2774
|
# position in [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -2725,11 +2790,13 @@ module Aws::LocationService
|
|
2725
2790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
|
2726
2791
|
#
|
2727
2792
|
class GetDevicePositionResponse < Struct.new(
|
2793
|
+
:accuracy,
|
2728
2794
|
:device_id,
|
2729
2795
|
:position,
|
2796
|
+
:position_properties,
|
2730
2797
|
:received_time,
|
2731
2798
|
:sample_time)
|
2732
|
-
SENSITIVE = [:position]
|
2799
|
+
SENSITIVE = [:position, :position_properties]
|
2733
2800
|
include Aws::Structure
|
2734
2801
|
end
|
2735
2802
|
|
@@ -3232,6 +3299,10 @@ module Aws::LocationService
|
|
3232
3299
|
|
3233
3300
|
# Contains the tracker resource details.
|
3234
3301
|
#
|
3302
|
+
# @!attribute [rw] accuracy
|
3303
|
+
# The accuracy of the device position.
|
3304
|
+
# @return [Types::PositionalAccuracy]
|
3305
|
+
#
|
3235
3306
|
# @!attribute [rw] device_id
|
3236
3307
|
# The ID of the device for this position.
|
3237
3308
|
# @return [String]
|
@@ -3241,6 +3312,10 @@ module Aws::LocationService
|
|
3241
3312
|
# stored.
|
3242
3313
|
# @return [Array<Float>]
|
3243
3314
|
#
|
3315
|
+
# @!attribute [rw] position_properties
|
3316
|
+
# The properties associated with the position.
|
3317
|
+
# @return [Hash<String,String>]
|
3318
|
+
#
|
3244
3319
|
# @!attribute [rw] sample_time
|
3245
3320
|
# The timestamp at which the device position was determined. Uses [
|
3246
3321
|
# ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
|
@@ -3253,10 +3328,12 @@ module Aws::LocationService
|
|
3253
3328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
|
3254
3329
|
#
|
3255
3330
|
class ListDevicePositionsResponseEntry < Struct.new(
|
3331
|
+
:accuracy,
|
3256
3332
|
:device_id,
|
3257
3333
|
:position,
|
3334
|
+
:position_properties,
|
3258
3335
|
:sample_time)
|
3259
|
-
SENSITIVE = [:position]
|
3336
|
+
SENSITIVE = [:position, :position_properties]
|
3260
3337
|
include Aws::Structure
|
3261
3338
|
end
|
3262
3339
|
|
@@ -4215,6 +4292,28 @@ module Aws::LocationService
|
|
4215
4292
|
include Aws::Structure
|
4216
4293
|
end
|
4217
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
|
+
|
4218
4317
|
# @note When making an API call, you may pass PutGeofenceRequest
|
4219
4318
|
# data as a hash:
|
4220
4319
|
#
|
@@ -4332,6 +4431,22 @@ module Aws::LocationService
|
|
4332
4431
|
include Aws::Structure
|
4333
4432
|
end
|
4334
4433
|
|
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
|
+
|
4335
4450
|
# Contains a search result from a text search query that is run on a
|
4336
4451
|
# place index resource.
|
4337
4452
|
#
|
@@ -4496,6 +4611,210 @@ module Aws::LocationService
|
|
4496
4611
|
include Aws::Structure
|
4497
4612
|
end
|
4498
4613
|
|
4614
|
+
# @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
|
4615
|
+
# data as a hash:
|
4616
|
+
#
|
4617
|
+
# {
|
4618
|
+
# bias_position: [1.0],
|
4619
|
+
# filter_b_box: [1.0],
|
4620
|
+
# filter_countries: ["CountryCode"],
|
4621
|
+
# index_name: "ResourceName", # required
|
4622
|
+
# language: "LanguageTag",
|
4623
|
+
# max_results: 1,
|
4624
|
+
# text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
|
4625
|
+
# }
|
4626
|
+
#
|
4627
|
+
# @!attribute [rw] bias_position
|
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.
|
4634
|
+
#
|
4635
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
4636
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
4637
|
+
#
|
4638
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
4639
|
+
# both options results in an error.
|
4640
|
+
#
|
4641
|
+
# </note>
|
4642
|
+
# @return [Array<Float>]
|
4643
|
+
#
|
4644
|
+
# @!attribute [rw] filter_b_box
|
4645
|
+
# An optional parameter that limits the search results by returning
|
4646
|
+
# only suggestions within a specified bounding box.
|
4647
|
+
#
|
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.
|
4654
|
+
#
|
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`.
|
4659
|
+
#
|
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>]
|
4665
|
+
#
|
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.
|
4669
|
+
#
|
4670
|
+
# * Use the [ISO 3166][1] 3-digit country code. For example, Australia
|
4671
|
+
# uses three upper-case characters: `AUS`.
|
4672
|
+
#
|
4673
|
+
# ^
|
4674
|
+
#
|
4675
|
+
#
|
4676
|
+
#
|
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.
|
4780
|
+
# @return [Array<Float>]
|
4781
|
+
#
|
4782
|
+
# @!attribute [rw] filter_countries
|
4783
|
+
# Contains the optional country filter specified in the request.
|
4784
|
+
# @return [Array<String>]
|
4785
|
+
#
|
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
|
+
|
4499
4818
|
# @note When making an API call, you may pass SearchPlaceIndexForTextRequest
|
4500
4819
|
# data as a hash:
|
4501
4820
|
#
|
@@ -4633,6 +4952,13 @@ module Aws::LocationService
|
|
4633
4952
|
# @!attribute [rw] bias_position
|
4634
4953
|
# Contains the coordinates for the optional bias position specified in
|
4635
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`.
|
4636
4962
|
# @return [Array<Float>]
|
4637
4963
|
#
|
4638
4964
|
# @!attribute [rw] data_source
|
@@ -5337,9 +5663,19 @@ module Aws::LocationService
|
|
5337
5663
|
# ft), location updates are ignored. Location updates within this
|
5338
5664
|
# distance are neither evaluated against linked geofence
|
5339
5665
|
# collections, nor stored. This helps control costs by reducing the
|
5340
|
-
# number of geofence evaluations and device positions to
|
5341
|
-
# Distance-based filtering can also reduce the
|
5342
|
-
# displaying device
|
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.
|
5343
5679
|
# @return [String]
|
5344
5680
|
#
|
5345
5681
|
# @!attribute [rw] pricing_plan
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-locationservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.16.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-12-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.125.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.125.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|