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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3d4adbe650ceebc191b06aa89c2ac44c8da907d11cfef681240bcb3dd4cc691e
|
4
|
+
data.tar.gz: cf9d9352fa4c58f8b43093863fd508a9f1471c17d0332cbf7d9d14be323d40fd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e406af614c552a95b155c39072a263f978a3be5ecb4cb35bf0b4fd23abc68219034ccb2761687bedb926995f94afc92cfb99bd5fe2f6ef3919534f0826fef86e
|
7
|
+
data.tar.gz: 255b535f7def2e5ec86e534b9546b762d4ff9f4bf1c0d440c893cd565a8efce88ea7136df58dd6978f1171b3a645542c62106de3414d4188b750f639e656b71d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.16.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.15.0 (2021-12-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Making PricingPlan optional as part of create resource API.
|
13
|
+
|
14
|
+
1.14.0 (2021-12-06)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds support for Accuracy position filtering, position metadata and autocomplete for addresses and points of interest based on partial or misspelled free-form text.
|
18
|
+
|
19
|
+
1.13.0 (2021-11-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.12.0 (2021-11-16)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.16.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::LocationService
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::LocationService
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::LocationService
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -295,7 +303,7 @@ module Aws::LocationService
|
|
295
303
|
# seconds to wait when opening a HTTP session before raising a
|
296
304
|
# `Timeout::Error`.
|
297
305
|
#
|
298
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
307
|
# number of seconds to wait for response data. This value can
|
300
308
|
# safely be set per-request on the session.
|
301
309
|
#
|
@@ -311,6 +319,9 @@ module Aws::LocationService
|
|
311
319
|
# disables this behaviour. This value can safely be set per
|
312
320
|
# request on the session.
|
313
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
314
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
326
|
# HTTP debug output will be sent to the `:logger`.
|
316
327
|
#
|
@@ -480,6 +491,11 @@ module Aws::LocationService
|
|
480
491
|
#
|
481
492
|
# </note>
|
482
493
|
#
|
494
|
+
# <note markdown="1"> Geofence evaluation uses the given device position. It does not
|
495
|
+
# account for the optional `Accuracy` of a `DevicePositionUpdate`.
|
496
|
+
#
|
497
|
+
# </note>
|
498
|
+
#
|
483
499
|
# @option params [required, String] :collection_name
|
484
500
|
# The geofence collection used in evaluating the position of devices
|
485
501
|
# against its geofences.
|
@@ -498,8 +514,14 @@ module Aws::LocationService
|
|
498
514
|
# collection_name: "ResourceName", # required
|
499
515
|
# device_position_updates: [ # required
|
500
516
|
# {
|
517
|
+
# accuracy: {
|
518
|
+
# horizontal: 1.0, # required
|
519
|
+
# },
|
501
520
|
# device_id: "Id", # required
|
502
521
|
# position: [1.0], # required
|
522
|
+
# position_properties: {
|
523
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
524
|
+
# },
|
503
525
|
# sample_time: Time.now, # required
|
504
526
|
# },
|
505
527
|
# ],
|
@@ -550,9 +572,12 @@ module Aws::LocationService
|
|
550
572
|
# @example Response structure
|
551
573
|
#
|
552
574
|
# resp.device_positions #=> Array
|
575
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
553
576
|
# resp.device_positions[0].device_id #=> String
|
554
577
|
# resp.device_positions[0].position #=> Array
|
555
578
|
# resp.device_positions[0].position[0] #=> Float
|
579
|
+
# resp.device_positions[0].position_properties #=> Hash
|
580
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
556
581
|
# resp.device_positions[0].received_time #=> Time
|
557
582
|
# resp.device_positions[0].sample_time #=> Time
|
558
583
|
# resp.errors #=> Array
|
@@ -633,10 +658,21 @@ module Aws::LocationService
|
|
633
658
|
# location data is stored at a maximum of one position per 30 second
|
634
659
|
# interval. If your update frequency is more often than every 30
|
635
660
|
# seconds, only one update per 30 seconds is stored for each unique
|
636
|
-
# device ID.
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
661
|
+
# device ID.
|
662
|
+
#
|
663
|
+
# When `PositionFiltering` is set to `DistanceBased` filtering, location
|
664
|
+
# data is stored and evaluated against linked geofence collections only
|
665
|
+
# if the device has moved more than 30 m (98.4 ft).
|
666
|
+
#
|
667
|
+
# When `PositionFiltering` is set to `AccuracyBased` filtering, location
|
668
|
+
# data is stored and evaluated against linked geofence collections only
|
669
|
+
# if the device has moved more than the measured accuracy. For example,
|
670
|
+
# if two consecutive updates from a device have a horizontal accuracy of
|
671
|
+
# 5 m and 10 m, the second update is neither stored or evaluated if the
|
672
|
+
# device has moved less than 15 m. If `PositionFiltering` is set to
|
673
|
+
# `AccuracyBased` filtering, Amazon Location uses the default value `\{
|
674
|
+
# "Horizontal": 0\}` when accuracy is not provided on a
|
675
|
+
# `DevicePositionUpdate`.
|
640
676
|
#
|
641
677
|
# </note>
|
642
678
|
#
|
@@ -656,8 +692,14 @@ module Aws::LocationService
|
|
656
692
|
# tracker_name: "ResourceName", # required
|
657
693
|
# updates: [ # required
|
658
694
|
# {
|
695
|
+
# accuracy: {
|
696
|
+
# horizontal: 1.0, # required
|
697
|
+
# },
|
659
698
|
# device_id: "Id", # required
|
660
699
|
# position: [1.0], # required
|
700
|
+
# position_properties: {
|
701
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
702
|
+
# },
|
661
703
|
# sample_time: Time.now, # required
|
662
704
|
# },
|
663
705
|
# ],
|
@@ -955,8 +997,9 @@ module Aws::LocationService
|
|
955
997
|
#
|
956
998
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
957
999
|
#
|
958
|
-
# @option params [
|
959
|
-
#
|
1000
|
+
# @option params [String] :pricing_plan
|
1001
|
+
# Optionally specifies the pricing plan for the geofence collection.
|
1002
|
+
# Defaults to `RequestBasedUsage`.
|
960
1003
|
#
|
961
1004
|
# For additional details and restrictions on each pricing plan option,
|
962
1005
|
# see the [Amazon Location Service pricing page][1].
|
@@ -1024,7 +1067,7 @@ module Aws::LocationService
|
|
1024
1067
|
# collection_name: "ResourceName", # required
|
1025
1068
|
# description: "ResourceDescription",
|
1026
1069
|
# kms_key_id: "KmsKeyId",
|
1027
|
-
# pricing_plan: "RequestBasedUsage", #
|
1070
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1028
1071
|
# pricing_plan_data_source: "String",
|
1029
1072
|
# tags: {
|
1030
1073
|
# "TagKey" => "TagValue",
|
@@ -1067,8 +1110,9 @@ module Aws::LocationService
|
|
1067
1110
|
#
|
1068
1111
|
# * No spaces allowed. For example, `ExampleMap`.
|
1069
1112
|
#
|
1070
|
-
# @option params [
|
1071
|
-
#
|
1113
|
+
# @option params [String] :pricing_plan
|
1114
|
+
# Optionally specifies the pricing plan for the map resource. Defaults
|
1115
|
+
# to `RequestBasedUsage`.
|
1072
1116
|
#
|
1073
1117
|
# For additional details and restrictions on each pricing plan option,
|
1074
1118
|
# see [Amazon Location Service pricing][1].
|
@@ -1113,7 +1157,7 @@ module Aws::LocationService
|
|
1113
1157
|
# },
|
1114
1158
|
# description: "ResourceDescription",
|
1115
1159
|
# map_name: "ResourceName", # required
|
1116
|
-
# pricing_plan: "RequestBasedUsage", #
|
1160
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1117
1161
|
# tags: {
|
1118
1162
|
# "TagKey" => "TagValue",
|
1119
1163
|
# },
|
@@ -1137,7 +1181,9 @@ module Aws::LocationService
|
|
1137
1181
|
# Creates a place index resource in your AWS account. Use a place index
|
1138
1182
|
# resource to geocode addresses and other text queries by using the
|
1139
1183
|
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
|
1140
|
-
# by using the `SearchPlaceIndexForPosition` operation
|
1184
|
+
# by using the `SearchPlaceIndexForPosition` operation, and enable
|
1185
|
+
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
|
1186
|
+
# operation.
|
1141
1187
|
#
|
1142
1188
|
# @option params [required, String] :data_source
|
1143
1189
|
# Specifies the geospatial data provider for the new place index.
|
@@ -1193,8 +1239,9 @@ module Aws::LocationService
|
|
1193
1239
|
#
|
1194
1240
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1195
1241
|
#
|
1196
|
-
# @option params [
|
1197
|
-
#
|
1242
|
+
# @option params [String] :pricing_plan
|
1243
|
+
# Optionally specifies the pricing plan for the place index resource.
|
1244
|
+
# Defaults to `RequestBasedUsage`.
|
1198
1245
|
#
|
1199
1246
|
# For additional details and restrictions on each pricing plan option,
|
1200
1247
|
# see [Amazon Location Service pricing][1].
|
@@ -1241,7 +1288,7 @@ module Aws::LocationService
|
|
1241
1288
|
# },
|
1242
1289
|
# description: "ResourceDescription",
|
1243
1290
|
# index_name: "ResourceName", # required
|
1244
|
-
# pricing_plan: "RequestBasedUsage", #
|
1291
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1245
1292
|
# tags: {
|
1246
1293
|
# "TagKey" => "TagValue",
|
1247
1294
|
# },
|
@@ -1315,8 +1362,9 @@ module Aws::LocationService
|
|
1315
1362
|
# @option params [String] :description
|
1316
1363
|
# The optional description for the route calculator resource.
|
1317
1364
|
#
|
1318
|
-
# @option params [
|
1319
|
-
#
|
1365
|
+
# @option params [String] :pricing_plan
|
1366
|
+
# Optionally specifies the pricing plan for the route calculator
|
1367
|
+
# resource. Defaults to `RequestBasedUsage`.
|
1320
1368
|
#
|
1321
1369
|
# For additional details and restrictions on each pricing plan option,
|
1322
1370
|
# see [Amazon Location Service pricing][1].
|
@@ -1363,7 +1411,7 @@ module Aws::LocationService
|
|
1363
1411
|
# calculator_name: "ResourceName", # required
|
1364
1412
|
# data_source: "String", # required
|
1365
1413
|
# description: "ResourceDescription",
|
1366
|
-
# pricing_plan: "RequestBasedUsage", #
|
1414
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1367
1415
|
# tags: {
|
1368
1416
|
# "TagKey" => "TagValue",
|
1369
1417
|
# },
|
@@ -1416,11 +1464,22 @@ module Aws::LocationService
|
|
1416
1464
|
# Distance-based filtering can also reduce the effects of GPS noise
|
1417
1465
|
# when displaying device trajectories on a map.
|
1418
1466
|
#
|
1467
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
1468
|
+
# accuracy, location updates are ignored. For example, if two
|
1469
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
1470
|
+
# and 10 m, the second update is ignored if the device has moved less
|
1471
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
1472
|
+
# linked geofence collections, nor stored. This can reduce the effects
|
1473
|
+
# of GPS noise when displaying device trajectories on a map, and can
|
1474
|
+
# help control your costs by reducing the number of geofence
|
1475
|
+
# evaluations.
|
1476
|
+
#
|
1419
1477
|
# This field is optional. If not specified, the default value is
|
1420
1478
|
# `TimeBased`.
|
1421
1479
|
#
|
1422
|
-
# @option params [
|
1423
|
-
#
|
1480
|
+
# @option params [String] :pricing_plan
|
1481
|
+
# Optionally specifies the pricing plan for the tracker resource.
|
1482
|
+
# Defaults to `RequestBasedUsage`.
|
1424
1483
|
#
|
1425
1484
|
# For additional details and restrictions on each pricing plan option,
|
1426
1485
|
# see [Amazon Location Service pricing][1].
|
@@ -1500,7 +1559,7 @@ module Aws::LocationService
|
|
1500
1559
|
# description: "ResourceDescription",
|
1501
1560
|
# kms_key_id: "KmsKeyId",
|
1502
1561
|
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1503
|
-
# pricing_plan: "RequestBasedUsage", #
|
1562
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1504
1563
|
# pricing_plan_data_source: "String",
|
1505
1564
|
# tags: {
|
1506
1565
|
# "TagKey" => "TagValue",
|
@@ -1938,8 +1997,10 @@ module Aws::LocationService
|
|
1938
1997
|
#
|
1939
1998
|
# @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1940
1999
|
#
|
2000
|
+
# * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
|
1941
2001
|
# * {Types::GetDevicePositionResponse#device_id #device_id} => String
|
1942
2002
|
# * {Types::GetDevicePositionResponse#position #position} => Array<Float>
|
2003
|
+
# * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash<String,String>
|
1943
2004
|
# * {Types::GetDevicePositionResponse#received_time #received_time} => Time
|
1944
2005
|
# * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
|
1945
2006
|
#
|
@@ -1952,9 +2013,12 @@ module Aws::LocationService
|
|
1952
2013
|
#
|
1953
2014
|
# @example Response structure
|
1954
2015
|
#
|
2016
|
+
# resp.accuracy.horizontal #=> Float
|
1955
2017
|
# resp.device_id #=> String
|
1956
2018
|
# resp.position #=> Array
|
1957
2019
|
# resp.position[0] #=> Float
|
2020
|
+
# resp.position_properties #=> Hash
|
2021
|
+
# resp.position_properties["PropertyMapKeyString"] #=> String
|
1958
2022
|
# resp.received_time #=> Time
|
1959
2023
|
# resp.sample_time #=> Time
|
1960
2024
|
#
|
@@ -2039,9 +2103,12 @@ module Aws::LocationService
|
|
2039
2103
|
# @example Response structure
|
2040
2104
|
#
|
2041
2105
|
# resp.device_positions #=> Array
|
2106
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
2042
2107
|
# resp.device_positions[0].device_id #=> String
|
2043
2108
|
# resp.device_positions[0].position #=> Array
|
2044
2109
|
# resp.device_positions[0].position[0] #=> Float
|
2110
|
+
# resp.device_positions[0].position_properties #=> Hash
|
2111
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
2045
2112
|
# resp.device_positions[0].received_time #=> Time
|
2046
2113
|
# resp.device_positions[0].sample_time #=> Time
|
2047
2114
|
# resp.next_token #=> String
|
@@ -2335,9 +2402,12 @@ module Aws::LocationService
|
|
2335
2402
|
# @example Response structure
|
2336
2403
|
#
|
2337
2404
|
# resp.data.entries #=> Array
|
2405
|
+
# resp.data.entries[0].accuracy.horizontal #=> Float
|
2338
2406
|
# resp.data.entries[0].device_id #=> String
|
2339
2407
|
# resp.data.entries[0].position #=> Array
|
2340
2408
|
# resp.data.entries[0].position[0] #=> Float
|
2409
|
+
# resp.data.entries[0].position_properties #=> Hash
|
2410
|
+
# resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
|
2341
2411
|
# resp.data.entries[0].sample_time #=> Time
|
2342
2412
|
# resp.next_token #=> String
|
2343
2413
|
#
|
@@ -2860,6 +2930,140 @@ module Aws::LocationService
|
|
2860
2930
|
req.send_request(options)
|
2861
2931
|
end
|
2862
2932
|
|
2933
|
+
# Generates suggestions for addresses and points of interest based on
|
2934
|
+
# partial or misspelled free-form text. This operation is also known as
|
2935
|
+
# autocomplete, autosuggest, or fuzzy matching.
|
2936
|
+
#
|
2937
|
+
# Optional parameters let you narrow your search results by bounding box
|
2938
|
+
# or country, or bias your search toward a specific position on the
|
2939
|
+
# globe.
|
2940
|
+
#
|
2941
|
+
# <note markdown="1"> You can search for suggested place names near a specified position by
|
2942
|
+
# using `BiasPosition`, or filter results within a bounding box by using
|
2943
|
+
# `FilterBBox`. These parameters are mutually exclusive; using both
|
2944
|
+
# `BiasPosition` and `FilterBBox` in the same command returns an error.
|
2945
|
+
#
|
2946
|
+
# </note>
|
2947
|
+
#
|
2948
|
+
# @option params [Array<Float>] :bias_position
|
2949
|
+
# An optional parameter that indicates a preference for place
|
2950
|
+
# suggestions that are closer to a specified position.
|
2951
|
+
#
|
2952
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
2953
|
+
# number represents the X coordinate, or longitude; the second number
|
2954
|
+
# represents the Y coordinate, or latitude.
|
2955
|
+
#
|
2956
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
2957
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2958
|
+
#
|
2959
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
2960
|
+
# both options results in an error.
|
2961
|
+
#
|
2962
|
+
# </note>
|
2963
|
+
#
|
2964
|
+
# @option params [Array<Float>] :filter_b_box
|
2965
|
+
# An optional parameter that limits the search results by returning only
|
2966
|
+
# suggestions within a specified bounding box.
|
2967
|
+
#
|
2968
|
+
# If provided, this parameter must contain a total of four consecutive
|
2969
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
2970
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
2971
|
+
# corner of the bounding box; the second pair of numbers represents the
|
2972
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
2973
|
+
# northeast corner of the bounding box.
|
2974
|
+
#
|
2975
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
2976
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
2977
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
2978
|
+
# and latitude `-36.9542`.
|
2979
|
+
#
|
2980
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
2981
|
+
# both options results in an error.
|
2982
|
+
#
|
2983
|
+
# </note>
|
2984
|
+
#
|
2985
|
+
# @option params [Array<String>] :filter_countries
|
2986
|
+
# An optional parameter that limits the search results by returning only
|
2987
|
+
# suggestions within the provided list of countries.
|
2988
|
+
#
|
2989
|
+
# * Use the [ISO 3166][1] 3-digit country code. For example, Australia
|
2990
|
+
# uses three upper-case characters: `AUS`.
|
2991
|
+
#
|
2992
|
+
# ^
|
2993
|
+
#
|
2994
|
+
#
|
2995
|
+
#
|
2996
|
+
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
2997
|
+
#
|
2998
|
+
# @option params [required, String] :index_name
|
2999
|
+
# The name of the place index resource you want to use for the search.
|
3000
|
+
#
|
3001
|
+
# @option params [String] :language
|
3002
|
+
# The preferred language used to return results. The value must be a
|
3003
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
3004
|
+
#
|
3005
|
+
# This setting affects the languages used in the results. It does not
|
3006
|
+
# change which results are returned. If the language is not specified,
|
3007
|
+
# or not supported for a particular result, the partner automatically
|
3008
|
+
# chooses a language for the result.
|
3009
|
+
#
|
3010
|
+
# Used only when the partner selected is Here.
|
3011
|
+
#
|
3012
|
+
#
|
3013
|
+
#
|
3014
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
3015
|
+
#
|
3016
|
+
# @option params [Integer] :max_results
|
3017
|
+
# An optional parameter. The maximum number of results returned per
|
3018
|
+
# request.
|
3019
|
+
#
|
3020
|
+
# The default: `5`
|
3021
|
+
#
|
3022
|
+
# @option params [required, String] :text
|
3023
|
+
# The free-form partial text to use to generate place suggestions. For
|
3024
|
+
# example, `eiffel tow`.
|
3025
|
+
#
|
3026
|
+
# @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3027
|
+
#
|
3028
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array<Types::SearchForSuggestionsResult>
|
3029
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
|
3030
|
+
#
|
3031
|
+
# @example Request syntax with placeholder values
|
3032
|
+
#
|
3033
|
+
# resp = client.search_place_index_for_suggestions({
|
3034
|
+
# bias_position: [1.0],
|
3035
|
+
# filter_b_box: [1.0],
|
3036
|
+
# filter_countries: ["CountryCode"],
|
3037
|
+
# index_name: "ResourceName", # required
|
3038
|
+
# language: "LanguageTag",
|
3039
|
+
# max_results: 1,
|
3040
|
+
# text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
|
3041
|
+
# })
|
3042
|
+
#
|
3043
|
+
# @example Response structure
|
3044
|
+
#
|
3045
|
+
# resp.results #=> Array
|
3046
|
+
# resp.results[0].text #=> String
|
3047
|
+
# resp.summary.bias_position #=> Array
|
3048
|
+
# resp.summary.bias_position[0] #=> Float
|
3049
|
+
# resp.summary.data_source #=> String
|
3050
|
+
# resp.summary.filter_b_box #=> Array
|
3051
|
+
# resp.summary.filter_b_box[0] #=> Float
|
3052
|
+
# resp.summary.filter_countries #=> Array
|
3053
|
+
# resp.summary.filter_countries[0] #=> String
|
3054
|
+
# resp.summary.language #=> String
|
3055
|
+
# resp.summary.max_results #=> Integer
|
3056
|
+
# resp.summary.text #=> String
|
3057
|
+
#
|
3058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
|
3059
|
+
#
|
3060
|
+
# @overload search_place_index_for_suggestions(params = {})
|
3061
|
+
# @param [Hash] params ({})
|
3062
|
+
def search_place_index_for_suggestions(params = {}, options = {})
|
3063
|
+
req = build_request(:search_place_index_for_suggestions, params)
|
3064
|
+
req.send_request(options)
|
3065
|
+
end
|
3066
|
+
|
2863
3067
|
# Geocodes free-form text, such as an address, name, city, or region to
|
2864
3068
|
# allow you to search for Places or points of interest.
|
2865
3069
|
#
|
@@ -3337,9 +3541,19 @@ module Aws::LocationService
|
|
3337
3541
|
# location updates are ignored. Location updates within this distance
|
3338
3542
|
# are neither evaluated against linked geofence collections, nor
|
3339
3543
|
# stored. This helps control costs by reducing the number of geofence
|
3340
|
-
# evaluations and device positions to
|
3341
|
-
# filtering can also reduce the
|
3342
|
-
#
|
3544
|
+
# evaluations and historical device positions to paginate through.
|
3545
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
3546
|
+
# when displaying device trajectories on a map.
|
3547
|
+
#
|
3548
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
3549
|
+
# accuracy, location updates are ignored. For example, if two
|
3550
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
3551
|
+
# and 10 m, the second update is ignored if the device has moved less
|
3552
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
3553
|
+
# linked geofence collections, nor stored. This helps educe the
|
3554
|
+
# effects of GPS noise when displaying device trajectories on a map,
|
3555
|
+
# and can help control costs by reducing the number of geofence
|
3556
|
+
# evaluations.
|
3343
3557
|
#
|
3344
3558
|
# @option params [String] :pricing_plan
|
3345
3559
|
# Updates the pricing plan for the tracker resource.
|
@@ -3422,7 +3636,7 @@ module Aws::LocationService
|
|
3422
3636
|
params: params,
|
3423
3637
|
config: config)
|
3424
3638
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3425
|
-
context[:gem_version] = '1.
|
3639
|
+
context[:gem_version] = '1.16.0'
|
3426
3640
|
Seahorse::Client::Request.new(handlers, context)
|
3427
3641
|
end
|
3428
3642
|
|