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
@@ -119,7 +119,9 @@ module Aws::LocationService
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::LocationService
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -471,6 +482,11 @@ module Aws::LocationService
|
|
471
482
|
#
|
472
483
|
# </note>
|
473
484
|
#
|
485
|
+
# <note markdown="1"> Geofence evaluation uses the given device position. It does not
|
486
|
+
# account for the optional `Accuracy` of a `DevicePositionUpdate`.
|
487
|
+
#
|
488
|
+
# </note>
|
489
|
+
#
|
474
490
|
# @option params [required, String] :collection_name
|
475
491
|
# The geofence collection used in evaluating the position of devices
|
476
492
|
# against its geofences.
|
@@ -489,8 +505,14 @@ module Aws::LocationService
|
|
489
505
|
# collection_name: "ResourceName", # required
|
490
506
|
# device_position_updates: [ # required
|
491
507
|
# {
|
508
|
+
# accuracy: {
|
509
|
+
# horizontal: 1.0, # required
|
510
|
+
# },
|
492
511
|
# device_id: "Id", # required
|
493
512
|
# position: [1.0], # required
|
513
|
+
# position_properties: {
|
514
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
515
|
+
# },
|
494
516
|
# sample_time: Time.now, # required
|
495
517
|
# },
|
496
518
|
# ],
|
@@ -541,9 +563,12 @@ module Aws::LocationService
|
|
541
563
|
# @example Response structure
|
542
564
|
#
|
543
565
|
# resp.device_positions #=> Array
|
566
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
544
567
|
# resp.device_positions[0].device_id #=> String
|
545
568
|
# resp.device_positions[0].position #=> Array
|
546
569
|
# resp.device_positions[0].position[0] #=> Float
|
570
|
+
# resp.device_positions[0].position_properties #=> Hash
|
571
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
547
572
|
# resp.device_positions[0].received_time #=> Time
|
548
573
|
# resp.device_positions[0].sample_time #=> Time
|
549
574
|
# resp.errors #=> Array
|
@@ -624,10 +649,21 @@ module Aws::LocationService
|
|
624
649
|
# location data is stored at a maximum of one position per 30 second
|
625
650
|
# interval. If your update frequency is more often than every 30
|
626
651
|
# seconds, only one update per 30 seconds is stored for each unique
|
627
|
-
# device ID.
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
652
|
+
# device ID.
|
653
|
+
#
|
654
|
+
# When `PositionFiltering` is set to `DistanceBased` filtering, location
|
655
|
+
# data is stored and evaluated against linked geofence collections only
|
656
|
+
# if the device has moved more than 30 m (98.4 ft).
|
657
|
+
#
|
658
|
+
# When `PositionFiltering` is set to `AccuracyBased` filtering, location
|
659
|
+
# data is stored and evaluated against linked geofence collections only
|
660
|
+
# if the device has moved more than the measured accuracy. For example,
|
661
|
+
# if two consecutive updates from a device have a horizontal accuracy of
|
662
|
+
# 5 m and 10 m, the second update is neither stored or evaluated if the
|
663
|
+
# device has moved less than 15 m. If `PositionFiltering` is set to
|
664
|
+
# `AccuracyBased` filtering, Amazon Location uses the default value `\{
|
665
|
+
# "Horizontal": 0\}` when accuracy is not provided on a
|
666
|
+
# `DevicePositionUpdate`.
|
631
667
|
#
|
632
668
|
# </note>
|
633
669
|
#
|
@@ -647,8 +683,14 @@ module Aws::LocationService
|
|
647
683
|
# tracker_name: "ResourceName", # required
|
648
684
|
# updates: [ # required
|
649
685
|
# {
|
686
|
+
# accuracy: {
|
687
|
+
# horizontal: 1.0, # required
|
688
|
+
# },
|
650
689
|
# device_id: "Id", # required
|
651
690
|
# position: [1.0], # required
|
691
|
+
# position_properties: {
|
692
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
693
|
+
# },
|
652
694
|
# sample_time: Time.now, # required
|
653
695
|
# },
|
654
696
|
# ],
|
@@ -673,7 +715,7 @@ module Aws::LocationService
|
|
673
715
|
|
674
716
|
# [Calculates a route][1] given the following required parameters:
|
675
717
|
# `DeparturePostiton` and `DestinationPosition`. Requires that you first
|
676
|
-
# [create a route calculator resource][2]
|
718
|
+
# [create a route calculator resource][2].
|
677
719
|
#
|
678
720
|
# By default, a request that doesn't specify a departure time uses the
|
679
721
|
# best time of day to travel with the best traffic conditions when
|
@@ -686,7 +728,8 @@ module Aws::LocationService
|
|
686
728
|
# data at the given time.
|
687
729
|
#
|
688
730
|
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
|
689
|
-
# single request. Specifying both parameters returns
|
731
|
+
# single request. Specifying both parameters returns a validation
|
732
|
+
# error.
|
690
733
|
#
|
691
734
|
# </note>
|
692
735
|
#
|
@@ -705,7 +748,7 @@ module Aws::LocationService
|
|
705
748
|
#
|
706
749
|
# @option params [required, String] :calculator_name
|
707
750
|
# The name of the route calculator resource that you want to use to
|
708
|
-
# calculate
|
751
|
+
# calculate the route.
|
709
752
|
#
|
710
753
|
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
711
754
|
# Specifies route preferences when traveling by `Car`, such as avoiding
|
@@ -746,8 +789,8 @@ module Aws::LocationService
|
|
746
789
|
#
|
747
790
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
748
791
|
# Specifies the desired time of departure. Uses the given time to
|
749
|
-
# calculate
|
750
|
-
# best traffic conditions is used to calculate the route.
|
792
|
+
# calculate the route. Otherwise, the best time of day to travel with
|
793
|
+
# the best traffic conditions is used to calculate the route.
|
751
794
|
#
|
752
795
|
# <note markdown="1"> Setting a departure time in the past returns a `400
|
753
796
|
# ValidationException` error.
|
@@ -1000,6 +1043,8 @@ module Aws::LocationService
|
|
1000
1043
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1001
1044
|
# characters: + - = . \_ : / @.
|
1002
1045
|
#
|
1046
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1047
|
+
#
|
1003
1048
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1004
1049
|
#
|
1005
1050
|
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
@@ -1085,6 +1130,8 @@ module Aws::LocationService
|
|
1085
1130
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1086
1131
|
# characters: + - = . \_ : / @.
|
1087
1132
|
#
|
1133
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1134
|
+
#
|
1088
1135
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1089
1136
|
#
|
1090
1137
|
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
@@ -1120,11 +1167,15 @@ module Aws::LocationService
|
|
1120
1167
|
req.send_request(options)
|
1121
1168
|
end
|
1122
1169
|
|
1123
|
-
# Creates a place index resource in your AWS account
|
1124
|
-
#
|
1170
|
+
# Creates a place index resource in your AWS account. Use a place index
|
1171
|
+
# resource to geocode addresses and other text queries by using the
|
1172
|
+
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
|
1173
|
+
# by using the `SearchPlaceIndexForPosition` operation, and enable
|
1174
|
+
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
|
1175
|
+
# operation.
|
1125
1176
|
#
|
1126
1177
|
# @option params [required, String] :data_source
|
1127
|
-
# Specifies the data provider
|
1178
|
+
# Specifies the geospatial data provider for the new place index.
|
1128
1179
|
#
|
1129
1180
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1130
1181
|
# example, entering `HERE` returns an error.
|
@@ -1141,8 +1192,8 @@ module Aws::LocationService
|
|
1141
1192
|
# coverage in your region of interest, see [HERE details on goecoding
|
1142
1193
|
# coverage][4].
|
1143
1194
|
#
|
1144
|
-
#
|
1145
|
-
#
|
1195
|
+
# If you specify HERE Technologies (`Here`) as the data provider, you
|
1196
|
+
# may not [store results][5] for locations in Japan. For more
|
1146
1197
|
# information, see the [AWS Service Terms][6] for Amazon Location
|
1147
1198
|
# Service.
|
1148
1199
|
#
|
@@ -1189,23 +1240,26 @@ module Aws::LocationService
|
|
1189
1240
|
#
|
1190
1241
|
# @option params [Hash<String,String>] :tags
|
1191
1242
|
# Applies one or more tags to the place index resource. A tag is a
|
1192
|
-
# key-value pair helps manage, identify, search, and filter
|
1193
|
-
# resources
|
1243
|
+
# key-value pair that helps you manage, identify, search, and filter
|
1244
|
+
# your resources.
|
1194
1245
|
#
|
1195
1246
|
# Format: `"key" : "value"`
|
1196
1247
|
#
|
1197
1248
|
# Restrictions:
|
1198
1249
|
#
|
1199
|
-
# * Maximum 50 tags per resource
|
1250
|
+
# * Maximum 50 tags per resource.
|
1200
1251
|
#
|
1201
|
-
# * Each
|
1252
|
+
# * Each tag key must be unique and must have exactly one associated
|
1253
|
+
# value.
|
1202
1254
|
#
|
1203
|
-
# * Maximum key length: 128 Unicode characters in UTF-8
|
1255
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1204
1256
|
#
|
1205
|
-
# * Maximum value length: 256 Unicode characters in UTF-8
|
1257
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1206
1258
|
#
|
1207
1259
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1208
|
-
# characters: + - = . \_ : /
|
1260
|
+
# characters: + - = . \_ : / @
|
1261
|
+
#
|
1262
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1209
1263
|
#
|
1210
1264
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1211
1265
|
#
|
@@ -1330,6 +1384,8 @@ module Aws::LocationService
|
|
1330
1384
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1331
1385
|
# characters: + - = . \_ : / @.
|
1332
1386
|
#
|
1387
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1388
|
+
#
|
1333
1389
|
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1334
1390
|
#
|
1335
1391
|
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
@@ -1388,12 +1444,22 @@ module Aws::LocationService
|
|
1388
1444
|
# seconds is stored for each unique device ID.
|
1389
1445
|
#
|
1390
1446
|
# * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
|
1391
|
-
# location updates are ignored. Location updates within this
|
1392
|
-
#
|
1393
|
-
#
|
1394
|
-
# evaluations and device positions to
|
1395
|
-
# filtering can also reduce the
|
1396
|
-
#
|
1447
|
+
# location updates are ignored. Location updates within this area are
|
1448
|
+
# neither evaluated against linked geofence collections, nor stored.
|
1449
|
+
# This helps control costs by reducing the number of geofence
|
1450
|
+
# evaluations and historical device positions to paginate through.
|
1451
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
1452
|
+
# when displaying device trajectories on a map.
|
1453
|
+
#
|
1454
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
1455
|
+
# accuracy, location updates are ignored. For example, if two
|
1456
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
1457
|
+
# and 10 m, the second update is ignored if the device has moved less
|
1458
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
1459
|
+
# linked geofence collections, nor stored. This can reduce the effects
|
1460
|
+
# of GPS noise when displaying device trajectories on a map, and can
|
1461
|
+
# help control your costs by reducing the number of geofence
|
1462
|
+
# evaluations.
|
1397
1463
|
#
|
1398
1464
|
# This field is optional. If not specified, the default value is
|
1399
1465
|
# `TimeBased`.
|
@@ -1453,6 +1519,8 @@ module Aws::LocationService
|
|
1453
1519
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1454
1520
|
# characters: + - = . \_ : / @.
|
1455
1521
|
#
|
1522
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1523
|
+
#
|
1456
1524
|
# @option params [required, String] :tracker_name
|
1457
1525
|
# The name for the tracker resource.
|
1458
1526
|
#
|
@@ -1476,7 +1544,7 @@ module Aws::LocationService
|
|
1476
1544
|
# resp = client.create_tracker({
|
1477
1545
|
# description: "ResourceDescription",
|
1478
1546
|
# kms_key_id: "KmsKeyId",
|
1479
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
1547
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1480
1548
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1481
1549
|
# pricing_plan_data_source: "String",
|
1482
1550
|
# tags: {
|
@@ -1842,7 +1910,7 @@ module Aws::LocationService
|
|
1842
1910
|
# resp.create_time #=> Time
|
1843
1911
|
# resp.description #=> String
|
1844
1912
|
# resp.kms_key_id #=> String
|
1845
|
-
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased"
|
1913
|
+
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
|
1846
1914
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1847
1915
|
# resp.pricing_plan_data_source #=> String
|
1848
1916
|
# resp.tags #=> Hash
|
@@ -1915,8 +1983,10 @@ module Aws::LocationService
|
|
1915
1983
|
#
|
1916
1984
|
# @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1917
1985
|
#
|
1986
|
+
# * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
|
1918
1987
|
# * {Types::GetDevicePositionResponse#device_id #device_id} => String
|
1919
1988
|
# * {Types::GetDevicePositionResponse#position #position} => Array<Float>
|
1989
|
+
# * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash<String,String>
|
1920
1990
|
# * {Types::GetDevicePositionResponse#received_time #received_time} => Time
|
1921
1991
|
# * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
|
1922
1992
|
#
|
@@ -1929,9 +1999,12 @@ module Aws::LocationService
|
|
1929
1999
|
#
|
1930
2000
|
# @example Response structure
|
1931
2001
|
#
|
2002
|
+
# resp.accuracy.horizontal #=> Float
|
1932
2003
|
# resp.device_id #=> String
|
1933
2004
|
# resp.position #=> Array
|
1934
2005
|
# resp.position[0] #=> Float
|
2006
|
+
# resp.position_properties #=> Hash
|
2007
|
+
# resp.position_properties["PropertyMapKeyString"] #=> String
|
1935
2008
|
# resp.received_time #=> Time
|
1936
2009
|
# resp.sample_time #=> Time
|
1937
2010
|
#
|
@@ -2016,9 +2089,12 @@ module Aws::LocationService
|
|
2016
2089
|
# @example Response structure
|
2017
2090
|
#
|
2018
2091
|
# resp.device_positions #=> Array
|
2092
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
2019
2093
|
# resp.device_positions[0].device_id #=> String
|
2020
2094
|
# resp.device_positions[0].position #=> Array
|
2021
2095
|
# resp.device_positions[0].position[0] #=> Float
|
2096
|
+
# resp.device_positions[0].position_properties #=> Hash
|
2097
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
2022
2098
|
# resp.device_positions[0].received_time #=> Time
|
2023
2099
|
# resp.device_positions[0].sample_time #=> Time
|
2024
2100
|
# resp.next_token #=> String
|
@@ -2312,9 +2388,12 @@ module Aws::LocationService
|
|
2312
2388
|
# @example Response structure
|
2313
2389
|
#
|
2314
2390
|
# resp.data.entries #=> Array
|
2391
|
+
# resp.data.entries[0].accuracy.horizontal #=> Float
|
2315
2392
|
# resp.data.entries[0].device_id #=> String
|
2316
2393
|
# resp.data.entries[0].position #=> Array
|
2317
2394
|
# resp.data.entries[0].position[0] #=> Float
|
2395
|
+
# resp.data.entries[0].position_properties #=> Hash
|
2396
|
+
# resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
|
2318
2397
|
# resp.data.entries[0].sample_time #=> Time
|
2319
2398
|
# resp.next_token #=> String
|
2320
2399
|
#
|
@@ -2761,21 +2840,34 @@ module Aws::LocationService
|
|
2761
2840
|
# @option params [required, String] :index_name
|
2762
2841
|
# The name of the place index resource you want to use for the search.
|
2763
2842
|
#
|
2843
|
+
# @option params [String] :language
|
2844
|
+
# The preferred language used to return results. The value must be a
|
2845
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2846
|
+
#
|
2847
|
+
# This setting affects the languages used in the results. It does not
|
2848
|
+
# change which results are returned. If the language is not specified,
|
2849
|
+
# or not supported for a particular result, the partner automatically
|
2850
|
+
# chooses a language for the result.
|
2851
|
+
#
|
2852
|
+
#
|
2853
|
+
#
|
2854
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2855
|
+
#
|
2764
2856
|
# @option params [Integer] :max_results
|
2765
|
-
# An optional
|
2857
|
+
# An optional parameter. The maximum number of results returned per
|
2766
2858
|
# request.
|
2767
2859
|
#
|
2768
2860
|
# Default value: `50`
|
2769
2861
|
#
|
2770
2862
|
# @option params [required, Array<Float>] :position
|
2771
|
-
# Specifies
|
2772
|
-
# latitude.
|
2773
|
-
#
|
2774
|
-
# * The first position is the X coordinate, or longitude.
|
2863
|
+
# Specifies the longitude and latitude of the position to query.
|
2775
2864
|
#
|
2776
|
-
#
|
2865
|
+
# This parameter must contain a pair of numbers. The first number
|
2866
|
+
# represents the X coordinate, or longitude; the second number
|
2867
|
+
# represents the Y coordinate, or latitude.
|
2777
2868
|
#
|
2778
|
-
# For example, `
|
2869
|
+
# For example, `[-123.1174, 49.2847]` represents a position with
|
2870
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2779
2871
|
#
|
2780
2872
|
# @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2781
2873
|
#
|
@@ -2786,6 +2878,7 @@ module Aws::LocationService
|
|
2786
2878
|
#
|
2787
2879
|
# resp = client.search_place_index_for_position({
|
2788
2880
|
# index_name: "ResourceName", # required
|
2881
|
+
# language: "LanguageTag",
|
2789
2882
|
# max_results: 1,
|
2790
2883
|
# position: [1.0], # required
|
2791
2884
|
# })
|
@@ -2793,10 +2886,12 @@ module Aws::LocationService
|
|
2793
2886
|
# @example Response structure
|
2794
2887
|
#
|
2795
2888
|
# resp.results #=> Array
|
2889
|
+
# resp.results[0].distance #=> Float
|
2796
2890
|
# resp.results[0].place.address_number #=> String
|
2797
2891
|
# resp.results[0].place.country #=> String
|
2798
2892
|
# resp.results[0].place.geometry.point #=> Array
|
2799
2893
|
# resp.results[0].place.geometry.point[0] #=> Float
|
2894
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2800
2895
|
# resp.results[0].place.label #=> String
|
2801
2896
|
# resp.results[0].place.municipality #=> String
|
2802
2897
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2804,7 +2899,10 @@ module Aws::LocationService
|
|
2804
2899
|
# resp.results[0].place.region #=> String
|
2805
2900
|
# resp.results[0].place.street #=> String
|
2806
2901
|
# resp.results[0].place.sub_region #=> String
|
2902
|
+
# resp.results[0].place.time_zone.name #=> String
|
2903
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
2807
2904
|
# resp.summary.data_source #=> String
|
2905
|
+
# resp.summary.language #=> String
|
2808
2906
|
# resp.summary.max_results #=> Integer
|
2809
2907
|
# resp.summary.position #=> Array
|
2810
2908
|
# resp.summary.position[0] #=> Float
|
@@ -2818,11 +2916,146 @@ module Aws::LocationService
|
|
2818
2916
|
req.send_request(options)
|
2819
2917
|
end
|
2820
2918
|
|
2919
|
+
# Generates suggestions for addresses and points of interest based on
|
2920
|
+
# partial or misspelled free-form text. This operation is also known as
|
2921
|
+
# autocomplete, autosuggest, or fuzzy matching.
|
2922
|
+
#
|
2923
|
+
# Optional parameters let you narrow your search results by bounding box
|
2924
|
+
# or country, or bias your search toward a specific position on the
|
2925
|
+
# globe.
|
2926
|
+
#
|
2927
|
+
# <note markdown="1"> You can search for suggested place names near a specified position by
|
2928
|
+
# using `BiasPosition`, or filter results within a bounding box by using
|
2929
|
+
# `FilterBBox`. These parameters are mutually exclusive; using both
|
2930
|
+
# `BiasPosition` and `FilterBBox` in the same command returns an error.
|
2931
|
+
#
|
2932
|
+
# </note>
|
2933
|
+
#
|
2934
|
+
# @option params [Array<Float>] :bias_position
|
2935
|
+
# An optional parameter that indicates a preference for place
|
2936
|
+
# suggestions that are closer to a specified position.
|
2937
|
+
#
|
2938
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
2939
|
+
# number represents the X coordinate, or longitude; the second number
|
2940
|
+
# represents the Y coordinate, or latitude.
|
2941
|
+
#
|
2942
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
2943
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2944
|
+
#
|
2945
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
2946
|
+
# both options results in an error.
|
2947
|
+
#
|
2948
|
+
# </note>
|
2949
|
+
#
|
2950
|
+
# @option params [Array<Float>] :filter_b_box
|
2951
|
+
# An optional parameter that limits the search results by returning only
|
2952
|
+
# suggestions within a specified bounding box.
|
2953
|
+
#
|
2954
|
+
# If provided, this parameter must contain a total of four consecutive
|
2955
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
2956
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
2957
|
+
# corner of the bounding box; the second pair of numbers represents the
|
2958
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
2959
|
+
# northeast corner of the bounding box.
|
2960
|
+
#
|
2961
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
2962
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
2963
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
2964
|
+
# and latitude `-36.9542`.
|
2965
|
+
#
|
2966
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
2967
|
+
# both options results in an error.
|
2968
|
+
#
|
2969
|
+
# </note>
|
2970
|
+
#
|
2971
|
+
# @option params [Array<String>] :filter_countries
|
2972
|
+
# An optional parameter that limits the search results by returning only
|
2973
|
+
# suggestions within the provided list of countries.
|
2974
|
+
#
|
2975
|
+
# * Use the [ISO 3166][1] 3-digit country code. For example, Australia
|
2976
|
+
# uses three upper-case characters: `AUS`.
|
2977
|
+
#
|
2978
|
+
# ^
|
2979
|
+
#
|
2980
|
+
#
|
2981
|
+
#
|
2982
|
+
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
2983
|
+
#
|
2984
|
+
# @option params [required, String] :index_name
|
2985
|
+
# The name of the place index resource you want to use for the search.
|
2986
|
+
#
|
2987
|
+
# @option params [String] :language
|
2988
|
+
# The preferred language used to return results. The value must be a
|
2989
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2990
|
+
#
|
2991
|
+
# This setting affects the languages used in the results. It does not
|
2992
|
+
# change which results are returned. If the language is not specified,
|
2993
|
+
# or not supported for a particular result, the partner automatically
|
2994
|
+
# chooses a language for the result.
|
2995
|
+
#
|
2996
|
+
# Used only when the partner selected is Here.
|
2997
|
+
#
|
2998
|
+
#
|
2999
|
+
#
|
3000
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
3001
|
+
#
|
3002
|
+
# @option params [Integer] :max_results
|
3003
|
+
# An optional parameter. The maximum number of results returned per
|
3004
|
+
# request.
|
3005
|
+
#
|
3006
|
+
# The default: `5`
|
3007
|
+
#
|
3008
|
+
# @option params [required, String] :text
|
3009
|
+
# The free-form partial text to use to generate place suggestions. For
|
3010
|
+
# example, `eiffel tow`.
|
3011
|
+
#
|
3012
|
+
# @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3013
|
+
#
|
3014
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array<Types::SearchForSuggestionsResult>
|
3015
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
|
3016
|
+
#
|
3017
|
+
# @example Request syntax with placeholder values
|
3018
|
+
#
|
3019
|
+
# resp = client.search_place_index_for_suggestions({
|
3020
|
+
# bias_position: [1.0],
|
3021
|
+
# filter_b_box: [1.0],
|
3022
|
+
# filter_countries: ["CountryCode"],
|
3023
|
+
# index_name: "ResourceName", # required
|
3024
|
+
# language: "LanguageTag",
|
3025
|
+
# max_results: 1,
|
3026
|
+
# text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
|
3027
|
+
# })
|
3028
|
+
#
|
3029
|
+
# @example Response structure
|
3030
|
+
#
|
3031
|
+
# resp.results #=> Array
|
3032
|
+
# resp.results[0].text #=> String
|
3033
|
+
# resp.summary.bias_position #=> Array
|
3034
|
+
# resp.summary.bias_position[0] #=> Float
|
3035
|
+
# resp.summary.data_source #=> String
|
3036
|
+
# resp.summary.filter_b_box #=> Array
|
3037
|
+
# resp.summary.filter_b_box[0] #=> Float
|
3038
|
+
# resp.summary.filter_countries #=> Array
|
3039
|
+
# resp.summary.filter_countries[0] #=> String
|
3040
|
+
# resp.summary.language #=> String
|
3041
|
+
# resp.summary.max_results #=> Integer
|
3042
|
+
# resp.summary.text #=> String
|
3043
|
+
#
|
3044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
|
3045
|
+
#
|
3046
|
+
# @overload search_place_index_for_suggestions(params = {})
|
3047
|
+
# @param [Hash] params ({})
|
3048
|
+
def search_place_index_for_suggestions(params = {}, options = {})
|
3049
|
+
req = build_request(:search_place_index_for_suggestions, params)
|
3050
|
+
req.send_request(options)
|
3051
|
+
end
|
3052
|
+
|
2821
3053
|
# Geocodes free-form text, such as an address, name, city, or region to
|
2822
3054
|
# allow you to search for Places or points of interest.
|
2823
3055
|
#
|
2824
|
-
#
|
2825
|
-
#
|
3056
|
+
# Optional parameters let you narrow your search results by bounding box
|
3057
|
+
# or country, or bias your search toward a specific position on the
|
3058
|
+
# globe.
|
2826
3059
|
#
|
2827
3060
|
# <note markdown="1"> You can search for places near a given position using `BiasPosition`,
|
2828
3061
|
# or filter results within a bounding box using `FilterBBox`. Providing
|
@@ -2830,46 +3063,51 @@ module Aws::LocationService
|
|
2830
3063
|
#
|
2831
3064
|
# </note>
|
2832
3065
|
#
|
2833
|
-
#
|
2834
|
-
# Searches for results closest to the given position. An optional
|
2835
|
-
# parameter defined by longitude, and latitude.
|
3066
|
+
# Search results are returned in order of highest to lowest relevance.
|
2836
3067
|
#
|
2837
|
-
#
|
2838
|
-
#
|
2839
|
-
#
|
2840
|
-
#
|
2841
|
-
# For example, `bias=xLongitude&bias=yLatitude`.
|
3068
|
+
# @option params [Array<Float>] :bias_position
|
3069
|
+
# An optional parameter that indicates a preference for places that are
|
3070
|
+
# closer to a specified position.
|
2842
3071
|
#
|
2843
|
-
#
|
2844
|
-
#
|
2845
|
-
#
|
3072
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
3073
|
+
# number represents the X coordinate, or longitude; the second number
|
3074
|
+
# represents the Y coordinate, or latitude.
|
2846
3075
|
#
|
2847
|
-
#
|
3076
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
3077
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2848
3078
|
#
|
2849
|
-
#
|
2850
|
-
#
|
3079
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
3080
|
+
# both options results in an error.
|
2851
3081
|
#
|
2852
|
-
#
|
2853
|
-
# lower southwest corner.
|
3082
|
+
# </note>
|
2854
3083
|
#
|
2855
|
-
#
|
3084
|
+
# @option params [Array<Float>] :filter_b_box
|
3085
|
+
# An optional parameter that limits the search results by returning only
|
3086
|
+
# places that are within the provided bounding box.
|
2856
3087
|
#
|
2857
|
-
#
|
3088
|
+
# If provided, this parameter must contain a total of four consecutive
|
3089
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
3090
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
3091
|
+
# corner of the bounding box; the second pair of numbers represents the
|
3092
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
3093
|
+
# northeast corner of the bounding box.
|
2858
3094
|
#
|
2859
|
-
#
|
2860
|
-
#
|
3095
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
3096
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
3097
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
3098
|
+
# and latitude `-36.9542`.
|
2861
3099
|
#
|
2862
|
-
#
|
2863
|
-
#
|
3100
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
3101
|
+
# both options results in an error.
|
2864
3102
|
#
|
2865
|
-
#
|
3103
|
+
# </note>
|
2866
3104
|
#
|
2867
3105
|
# @option params [Array<String>] :filter_countries
|
2868
|
-
#
|
2869
|
-
#
|
3106
|
+
# An optional parameter that limits the search results by returning only
|
3107
|
+
# places that are in a specified list of countries.
|
2870
3108
|
#
|
2871
|
-
# *
|
2872
|
-
# uses three upper-case characters: `AUS`.
|
3109
|
+
# * Valid values include [ISO 3166][1] 3-digit country codes. For
|
3110
|
+
# example, Australia uses three upper-case characters: `AUS`.
|
2873
3111
|
#
|
2874
3112
|
# ^
|
2875
3113
|
#
|
@@ -2880,6 +3118,19 @@ module Aws::LocationService
|
|
2880
3118
|
# @option params [required, String] :index_name
|
2881
3119
|
# The name of the place index resource you want to use for the search.
|
2882
3120
|
#
|
3121
|
+
# @option params [String] :language
|
3122
|
+
# The preferred language used to return results. The value must be a
|
3123
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
3124
|
+
#
|
3125
|
+
# This setting affects the languages used in the results. It does not
|
3126
|
+
# change which results are returned. If the language is not specified,
|
3127
|
+
# or not supported for a particular result, the partner automatically
|
3128
|
+
# chooses a language for the result.
|
3129
|
+
#
|
3130
|
+
#
|
3131
|
+
#
|
3132
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
3133
|
+
#
|
2883
3134
|
# @option params [Integer] :max_results
|
2884
3135
|
# An optional parameter. The maximum number of results returned per
|
2885
3136
|
# request.
|
@@ -2887,7 +3138,7 @@ module Aws::LocationService
|
|
2887
3138
|
# The default: `50`
|
2888
3139
|
#
|
2889
3140
|
# @option params [required, String] :text
|
2890
|
-
# The address, name, city, or region to be used in the search
|
3141
|
+
# The address, name, city, or region to be used in the search in
|
2891
3142
|
# free-form text format. For example, `123 Any Street`.
|
2892
3143
|
#
|
2893
3144
|
# @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2902,6 +3153,7 @@ module Aws::LocationService
|
|
2902
3153
|
# filter_b_box: [1.0],
|
2903
3154
|
# filter_countries: ["CountryCode"],
|
2904
3155
|
# index_name: "ResourceName", # required
|
3156
|
+
# language: "LanguageTag",
|
2905
3157
|
# max_results: 1,
|
2906
3158
|
# text: "SyntheticSearchPlaceIndexForTextRequestString", # required
|
2907
3159
|
# })
|
@@ -2909,10 +3161,12 @@ module Aws::LocationService
|
|
2909
3161
|
# @example Response structure
|
2910
3162
|
#
|
2911
3163
|
# resp.results #=> Array
|
3164
|
+
# resp.results[0].distance #=> Float
|
2912
3165
|
# resp.results[0].place.address_number #=> String
|
2913
3166
|
# resp.results[0].place.country #=> String
|
2914
3167
|
# resp.results[0].place.geometry.point #=> Array
|
2915
3168
|
# resp.results[0].place.geometry.point[0] #=> Float
|
3169
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2916
3170
|
# resp.results[0].place.label #=> String
|
2917
3171
|
# resp.results[0].place.municipality #=> String
|
2918
3172
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2920,6 +3174,9 @@ module Aws::LocationService
|
|
2920
3174
|
# resp.results[0].place.region #=> String
|
2921
3175
|
# resp.results[0].place.street #=> String
|
2922
3176
|
# resp.results[0].place.sub_region #=> String
|
3177
|
+
# resp.results[0].place.time_zone.name #=> String
|
3178
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
3179
|
+
# resp.results[0].relevance #=> Float
|
2923
3180
|
# resp.summary.bias_position #=> Array
|
2924
3181
|
# resp.summary.bias_position[0] #=> Float
|
2925
3182
|
# resp.summary.data_source #=> String
|
@@ -2927,6 +3184,7 @@ module Aws::LocationService
|
|
2927
3184
|
# resp.summary.filter_b_box[0] #=> Float
|
2928
3185
|
# resp.summary.filter_countries #=> Array
|
2929
3186
|
# resp.summary.filter_countries[0] #=> String
|
3187
|
+
# resp.summary.language #=> String
|
2930
3188
|
# resp.summary.max_results #=> Integer
|
2931
3189
|
# resp.summary.result_b_box #=> Array
|
2932
3190
|
# resp.summary.result_b_box[0] #=> Float
|
@@ -2956,12 +3214,27 @@ module Aws::LocationService
|
|
2956
3214
|
# ^
|
2957
3215
|
#
|
2958
3216
|
# @option params [required, Hash<String,String>] :tags
|
2959
|
-
#
|
2960
|
-
#
|
3217
|
+
# Applies one or more tags to specific resource. A tag is a key-value
|
3218
|
+
# pair that helps you manage, identify, search, and filter your
|
3219
|
+
# resources.
|
2961
3220
|
#
|
2962
|
-
#
|
3221
|
+
# Format: `"key" : "value"`
|
2963
3222
|
#
|
2964
|
-
#
|
3223
|
+
# Restrictions:
|
3224
|
+
#
|
3225
|
+
# * Maximum 50 tags per resource.
|
3226
|
+
#
|
3227
|
+
# * Each tag key must be unique and must have exactly one associated
|
3228
|
+
# value.
|
3229
|
+
#
|
3230
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
3231
|
+
#
|
3232
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
3233
|
+
#
|
3234
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
3235
|
+
# characters: + - = . \_ : / @
|
3236
|
+
#
|
3237
|
+
# * Cannot use "aws:" as a prefix for a key.
|
2965
3238
|
#
|
2966
3239
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2967
3240
|
#
|
@@ -3254,9 +3527,19 @@ module Aws::LocationService
|
|
3254
3527
|
# location updates are ignored. Location updates within this distance
|
3255
3528
|
# are neither evaluated against linked geofence collections, nor
|
3256
3529
|
# stored. This helps control costs by reducing the number of geofence
|
3257
|
-
# evaluations and device positions to
|
3258
|
-
# filtering can also reduce the
|
3259
|
-
#
|
3530
|
+
# evaluations and historical device positions to paginate through.
|
3531
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
3532
|
+
# when displaying device trajectories on a map.
|
3533
|
+
#
|
3534
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
3535
|
+
# accuracy, location updates are ignored. For example, if two
|
3536
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
3537
|
+
# and 10 m, the second update is ignored if the device has moved less
|
3538
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
3539
|
+
# linked geofence collections, nor stored. This helps educe the
|
3540
|
+
# effects of GPS noise when displaying device trajectories on a map,
|
3541
|
+
# and can help control costs by reducing the number of geofence
|
3542
|
+
# evaluations.
|
3260
3543
|
#
|
3261
3544
|
# @option params [String] :pricing_plan
|
3262
3545
|
# Updates the pricing plan for the tracker resource.
|
@@ -3305,7 +3588,7 @@ module Aws::LocationService
|
|
3305
3588
|
#
|
3306
3589
|
# resp = client.update_tracker({
|
3307
3590
|
# description: "ResourceDescription",
|
3308
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
3591
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
3309
3592
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3310
3593
|
# pricing_plan_data_source: "String",
|
3311
3594
|
# tracker_name: "ResourceName", # required
|
@@ -3339,7 +3622,7 @@ module Aws::LocationService
|
|
3339
3622
|
params: params,
|
3340
3623
|
config: config)
|
3341
3624
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3342
|
-
context[:gem_version] = '1.
|
3625
|
+
context[:gem_version] = '1.14.0'
|
3343
3626
|
Seahorse::Client::Request.new(handlers, context)
|
3344
3627
|
end
|
3345
3628
|
|