aws-sdk-locationservice 1.8.0 → 1.12.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 +218 -76
- data/lib/aws-sdk-locationservice/client_api.rb +23 -0
- data/lib/aws-sdk-locationservice/types.rb +356 -139
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -275,6 +275,15 @@ module Aws::LocationService
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -614,12 +623,20 @@ module Aws::LocationService
|
|
614
623
|
end
|
615
624
|
|
616
625
|
# Uploads position update data for one or more devices to a tracker
|
617
|
-
# resource. Amazon Location uses the data when
|
618
|
-
# device position and position history.
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
626
|
+
# resource. Amazon Location uses the data when it reports the last known
|
627
|
+
# device position and position history. Amazon Location retains location
|
628
|
+
# data for 30 days.
|
629
|
+
#
|
630
|
+
# <note markdown="1"> Position updates are handled based on the `PositionFiltering` property
|
631
|
+
# of the tracker. When `PositionFiltering` is set to `TimeBased`,
|
632
|
+
# updates are evaluated against linked geofence collections, and
|
633
|
+
# location data is stored at a maximum of one position per 30 second
|
634
|
+
# interval. If your update frequency is more often than every 30
|
635
|
+
# seconds, only one update per 30 seconds is stored for each unique
|
636
|
+
# device ID. When `PositionFiltering` is set to `DistanceBased`
|
637
|
+
# filtering, location data is stored and evaluated against linked
|
638
|
+
# geofence collections only if the device has moved more than 30 m (98.4
|
639
|
+
# ft).
|
623
640
|
#
|
624
641
|
# </note>
|
625
642
|
#
|
@@ -665,7 +682,7 @@ module Aws::LocationService
|
|
665
682
|
|
666
683
|
# [Calculates a route][1] given the following required parameters:
|
667
684
|
# `DeparturePostiton` and `DestinationPosition`. Requires that you first
|
668
|
-
# [create a route calculator resource][2]
|
685
|
+
# [create a route calculator resource][2].
|
669
686
|
#
|
670
687
|
# By default, a request that doesn't specify a departure time uses the
|
671
688
|
# best time of day to travel with the best traffic conditions when
|
@@ -678,7 +695,8 @@ module Aws::LocationService
|
|
678
695
|
# data at the given time.
|
679
696
|
#
|
680
697
|
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
|
681
|
-
# single request. Specifying both parameters returns
|
698
|
+
# single request. Specifying both parameters returns a validation
|
699
|
+
# error.
|
682
700
|
#
|
683
701
|
# </note>
|
684
702
|
#
|
@@ -697,7 +715,7 @@ module Aws::LocationService
|
|
697
715
|
#
|
698
716
|
# @option params [required, String] :calculator_name
|
699
717
|
# The name of the route calculator resource that you want to use to
|
700
|
-
# calculate
|
718
|
+
# calculate the route.
|
701
719
|
#
|
702
720
|
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
703
721
|
# Specifies route preferences when traveling by `Car`, such as avoiding
|
@@ -723,7 +741,9 @@ module Aws::LocationService
|
|
723
741
|
# ^
|
724
742
|
#
|
725
743
|
# <note markdown="1"> If you specify a departure that's not located on a road, Amazon
|
726
|
-
# Location [moves the position to the nearest road][2].
|
744
|
+
# Location [moves the position to the nearest road][2]. If Esri is the
|
745
|
+
# provider for your route calculator, specifying a route that is longer
|
746
|
+
# than 400 km returns a `400 RoutesValidationException` error.
|
727
747
|
#
|
728
748
|
# </note>
|
729
749
|
#
|
@@ -736,8 +756,8 @@ module Aws::LocationService
|
|
736
756
|
#
|
737
757
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
738
758
|
# Specifies the desired time of departure. Uses the given time to
|
739
|
-
# calculate
|
740
|
-
# best traffic conditions is used to calculate the route.
|
759
|
+
# calculate the route. Otherwise, the best time of day to travel with
|
760
|
+
# the best traffic conditions is used to calculate the route.
|
741
761
|
#
|
742
762
|
# <note markdown="1"> Setting a departure time in the past returns a `400
|
743
763
|
# ValidationException` error.
|
@@ -823,6 +843,10 @@ module Aws::LocationService
|
|
823
843
|
# Specifying more than 23 waypoints returns a `400 ValidationException`
|
824
844
|
# error.
|
825
845
|
#
|
846
|
+
# If Esri is the provider for your route calculator, specifying a route
|
847
|
+
# that is longer than 400 km returns a `400 RoutesValidationException`
|
848
|
+
# error.
|
849
|
+
#
|
826
850
|
# </note>
|
827
851
|
#
|
828
852
|
# Valid Values: `[-180 to 180,-90 to 90]`
|
@@ -986,6 +1010,8 @@ module Aws::LocationService
|
|
986
1010
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
987
1011
|
# characters: + - = . \_ : / @.
|
988
1012
|
#
|
1013
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1014
|
+
#
|
989
1015
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
990
1016
|
#
|
991
1017
|
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
@@ -1045,7 +1071,7 @@ module Aws::LocationService
|
|
1045
1071
|
# Specifies the pricing plan for your map resource.
|
1046
1072
|
#
|
1047
1073
|
# For additional details and restrictions on each pricing plan option,
|
1048
|
-
# see
|
1074
|
+
# see [Amazon Location Service pricing][1].
|
1049
1075
|
#
|
1050
1076
|
#
|
1051
1077
|
#
|
@@ -1071,6 +1097,8 @@ module Aws::LocationService
|
|
1071
1097
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1072
1098
|
# characters: + - = . \_ : / @.
|
1073
1099
|
#
|
1100
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1101
|
+
#
|
1074
1102
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
1103
|
#
|
1076
1104
|
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
@@ -1106,11 +1134,13 @@ module Aws::LocationService
|
|
1106
1134
|
req.send_request(options)
|
1107
1135
|
end
|
1108
1136
|
|
1109
|
-
# Creates a place index resource in your AWS account
|
1110
|
-
#
|
1137
|
+
# Creates a place index resource in your AWS account. Use a place index
|
1138
|
+
# resource to geocode addresses and other text queries by using the
|
1139
|
+
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
|
1140
|
+
# by using the `SearchPlaceIndexForPosition` operation.
|
1111
1141
|
#
|
1112
1142
|
# @option params [required, String] :data_source
|
1113
|
-
# Specifies the data provider
|
1143
|
+
# Specifies the geospatial data provider for the new place index.
|
1114
1144
|
#
|
1115
1145
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1116
1146
|
# example, entering `HERE` returns an error.
|
@@ -1123,12 +1153,12 @@ module Aws::LocationService
|
|
1123
1153
|
# your region of interest, see [Esri details on geocoding
|
1124
1154
|
# coverage][2].
|
1125
1155
|
#
|
1126
|
-
# * `Here` – For additional information about [HERE Technologies][3]'
|
1156
|
+
# * `Here` – For additional information about [HERE Technologies][3]'
|
1127
1157
|
# coverage in your region of interest, see [HERE details on goecoding
|
1128
1158
|
# coverage][4].
|
1129
1159
|
#
|
1130
|
-
#
|
1131
|
-
#
|
1160
|
+
# If you specify HERE Technologies (`Here`) as the data provider, you
|
1161
|
+
# may not [store results][5] for locations in Japan. For more
|
1132
1162
|
# information, see the [AWS Service Terms][6] for Amazon Location
|
1133
1163
|
# Service.
|
1134
1164
|
#
|
@@ -1167,7 +1197,7 @@ module Aws::LocationService
|
|
1167
1197
|
# Specifies the pricing plan for your place index resource.
|
1168
1198
|
#
|
1169
1199
|
# For additional details and restrictions on each pricing plan option,
|
1170
|
-
# see
|
1200
|
+
# see [Amazon Location Service pricing][1].
|
1171
1201
|
#
|
1172
1202
|
#
|
1173
1203
|
#
|
@@ -1175,23 +1205,26 @@ module Aws::LocationService
|
|
1175
1205
|
#
|
1176
1206
|
# @option params [Hash<String,String>] :tags
|
1177
1207
|
# Applies one or more tags to the place index resource. A tag is a
|
1178
|
-
# key-value pair helps manage, identify, search, and filter
|
1179
|
-
# resources
|
1208
|
+
# key-value pair that helps you manage, identify, search, and filter
|
1209
|
+
# your resources.
|
1180
1210
|
#
|
1181
1211
|
# Format: `"key" : "value"`
|
1182
1212
|
#
|
1183
1213
|
# Restrictions:
|
1184
1214
|
#
|
1185
|
-
# * Maximum 50 tags per resource
|
1215
|
+
# * Maximum 50 tags per resource.
|
1186
1216
|
#
|
1187
|
-
# * Each
|
1217
|
+
# * Each tag key must be unique and must have exactly one associated
|
1218
|
+
# value.
|
1188
1219
|
#
|
1189
|
-
# * Maximum key length: 128 Unicode characters in UTF-8
|
1220
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1190
1221
|
#
|
1191
|
-
# * Maximum value length: 256 Unicode characters in UTF-8
|
1222
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1192
1223
|
#
|
1193
1224
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1194
|
-
# characters: + - = . \_ : /
|
1225
|
+
# characters: + - = . \_ : / @
|
1226
|
+
#
|
1227
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1195
1228
|
#
|
1196
1229
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1197
1230
|
#
|
@@ -1251,7 +1284,9 @@ module Aws::LocationService
|
|
1251
1284
|
# Specifies the data provider of traffic and road network data.
|
1252
1285
|
#
|
1253
1286
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1254
|
-
# example, entering `HERE` returns an error.
|
1287
|
+
# example, entering `HERE` returns an error. Route calculators that use
|
1288
|
+
# Esri as a data source only calculate routes that are shorter than 400
|
1289
|
+
# km.
|
1255
1290
|
#
|
1256
1291
|
# </note>
|
1257
1292
|
#
|
@@ -1261,7 +1296,7 @@ module Aws::LocationService
|
|
1261
1296
|
# your region of interest, see [Esri details on street networks and
|
1262
1297
|
# traffic coverage][2].
|
1263
1298
|
#
|
1264
|
-
# * `Here` – For additional information about [HERE Technologies][3]'
|
1299
|
+
# * `Here` – For additional information about [HERE Technologies][3]'
|
1265
1300
|
# coverage in your region of interest, see [HERE car routing
|
1266
1301
|
# coverage][4] and [HERE truck routing coverage][5].
|
1267
1302
|
#
|
@@ -1314,6 +1349,8 @@ module Aws::LocationService
|
|
1314
1349
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1315
1350
|
# characters: + - = . \_ : / @.
|
1316
1351
|
#
|
1352
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1353
|
+
#
|
1317
1354
|
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1318
1355
|
#
|
1319
1356
|
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
@@ -1361,11 +1398,32 @@ module Aws::LocationService
|
|
1361
1398
|
#
|
1362
1399
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1363
1400
|
#
|
1401
|
+
# @option params [String] :position_filtering
|
1402
|
+
# Specifies the position filtering for the tracker resource.
|
1403
|
+
#
|
1404
|
+
# Valid values:
|
1405
|
+
#
|
1406
|
+
# * `TimeBased` - Location updates are evaluated against linked geofence
|
1407
|
+
# collections, but not every location update is stored. If your update
|
1408
|
+
# frequency is more often than 30 seconds, only one update per 30
|
1409
|
+
# seconds is stored for each unique device ID.
|
1410
|
+
#
|
1411
|
+
# * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
|
1412
|
+
# location updates are ignored. Location updates within this area are
|
1413
|
+
# neither evaluated against linked geofence collections, nor stored.
|
1414
|
+
# This helps control costs by reducing the number of geofence
|
1415
|
+
# evaluations and historical device positions to paginate through.
|
1416
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
1417
|
+
# when displaying device trajectories on a map.
|
1418
|
+
#
|
1419
|
+
# This field is optional. If not specified, the default value is
|
1420
|
+
# `TimeBased`.
|
1421
|
+
#
|
1364
1422
|
# @option params [required, String] :pricing_plan
|
1365
1423
|
# Specifies the pricing plan for the tracker resource.
|
1366
1424
|
#
|
1367
1425
|
# For additional details and restrictions on each pricing plan option,
|
1368
|
-
# see
|
1426
|
+
# see [Amazon Location Service pricing][1].
|
1369
1427
|
#
|
1370
1428
|
#
|
1371
1429
|
#
|
@@ -1389,7 +1447,7 @@ module Aws::LocationService
|
|
1389
1447
|
#
|
1390
1448
|
# </note>
|
1391
1449
|
#
|
1392
|
-
# Valid
|
1450
|
+
# Valid values: `Esri` \| `Here`
|
1393
1451
|
#
|
1394
1452
|
#
|
1395
1453
|
#
|
@@ -1416,6 +1474,8 @@ module Aws::LocationService
|
|
1416
1474
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1417
1475
|
# characters: + - = . \_ : / @.
|
1418
1476
|
#
|
1477
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1478
|
+
#
|
1419
1479
|
# @option params [required, String] :tracker_name
|
1420
1480
|
# The name for the tracker resource.
|
1421
1481
|
#
|
@@ -1439,6 +1499,7 @@ module Aws::LocationService
|
|
1439
1499
|
# resp = client.create_tracker({
|
1440
1500
|
# description: "ResourceDescription",
|
1441
1501
|
# kms_key_id: "KmsKeyId",
|
1502
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1442
1503
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1443
1504
|
# pricing_plan_data_source: "String",
|
1444
1505
|
# tags: {
|
@@ -1785,6 +1846,7 @@ module Aws::LocationService
|
|
1785
1846
|
# * {Types::DescribeTrackerResponse#create_time #create_time} => Time
|
1786
1847
|
# * {Types::DescribeTrackerResponse#description #description} => String
|
1787
1848
|
# * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
|
1849
|
+
# * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String
|
1788
1850
|
# * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String
|
1789
1851
|
# * {Types::DescribeTrackerResponse#pricing_plan_data_source #pricing_plan_data_source} => String
|
1790
1852
|
# * {Types::DescribeTrackerResponse#tags #tags} => Hash<String,String>
|
@@ -1803,6 +1865,7 @@ module Aws::LocationService
|
|
1803
1865
|
# resp.create_time #=> Time
|
1804
1866
|
# resp.description #=> String
|
1805
1867
|
# resp.kms_key_id #=> String
|
1868
|
+
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
|
1806
1869
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1807
1870
|
# resp.pricing_plan_data_source #=> String
|
1808
1871
|
# resp.tags #=> Hash
|
@@ -2041,7 +2104,7 @@ module Aws::LocationService
|
|
2041
2104
|
# A comma-separated list of fonts to load glyphs from in order of
|
2042
2105
|
# preference. For example, `Noto Sans Regular, Arial Unicode`.
|
2043
2106
|
#
|
2044
|
-
# Valid fonts for [Esri][1] styles:
|
2107
|
+
# Valid fonts stacks for [Esri][1] styles:
|
2045
2108
|
#
|
2046
2109
|
# * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu Medium`
|
2047
2110
|
# \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold`
|
@@ -2059,9 +2122,9 @@ module Aws::LocationService
|
|
2059
2122
|
# * VectorEsriNavigation – `Arial Regular` \| `Arial Italic` \| `Arial
|
2060
2123
|
# Bold`
|
2061
2124
|
#
|
2062
|
-
# Valid
|
2125
|
+
# Valid font stacks for [HERE Technologies][2] styles:
|
2063
2126
|
#
|
2064
|
-
# *
|
2127
|
+
# * VectorHereBerlin – `Fira GO Regular` \| `Fira GO Bold`
|
2065
2128
|
#
|
2066
2129
|
# ^
|
2067
2130
|
#
|
@@ -2721,21 +2784,34 @@ module Aws::LocationService
|
|
2721
2784
|
# @option params [required, String] :index_name
|
2722
2785
|
# The name of the place index resource you want to use for the search.
|
2723
2786
|
#
|
2787
|
+
# @option params [String] :language
|
2788
|
+
# The preferred language used to return results. The value must be a
|
2789
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2790
|
+
#
|
2791
|
+
# This setting affects the languages used in the results. It does not
|
2792
|
+
# change which results are returned. If the language is not specified,
|
2793
|
+
# or not supported for a particular result, the partner automatically
|
2794
|
+
# chooses a language for the result.
|
2795
|
+
#
|
2796
|
+
#
|
2797
|
+
#
|
2798
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2799
|
+
#
|
2724
2800
|
# @option params [Integer] :max_results
|
2725
|
-
# An optional
|
2801
|
+
# An optional parameter. The maximum number of results returned per
|
2726
2802
|
# request.
|
2727
2803
|
#
|
2728
2804
|
# Default value: `50`
|
2729
2805
|
#
|
2730
2806
|
# @option params [required, Array<Float>] :position
|
2731
|
-
# Specifies
|
2732
|
-
# latitude.
|
2807
|
+
# Specifies the longitude and latitude of the position to query.
|
2733
2808
|
#
|
2734
|
-
#
|
2809
|
+
# This parameter must contain a pair of numbers. The first number
|
2810
|
+
# represents the X coordinate, or longitude; the second number
|
2811
|
+
# represents the Y coordinate, or latitude.
|
2735
2812
|
#
|
2736
|
-
#
|
2737
|
-
#
|
2738
|
-
# For example, `position=xLongitude&position=yLatitude` .
|
2813
|
+
# For example, `[-123.1174, 49.2847]` represents a position with
|
2814
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2739
2815
|
#
|
2740
2816
|
# @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2741
2817
|
#
|
@@ -2746,6 +2822,7 @@ module Aws::LocationService
|
|
2746
2822
|
#
|
2747
2823
|
# resp = client.search_place_index_for_position({
|
2748
2824
|
# index_name: "ResourceName", # required
|
2825
|
+
# language: "LanguageTag",
|
2749
2826
|
# max_results: 1,
|
2750
2827
|
# position: [1.0], # required
|
2751
2828
|
# })
|
@@ -2753,10 +2830,12 @@ module Aws::LocationService
|
|
2753
2830
|
# @example Response structure
|
2754
2831
|
#
|
2755
2832
|
# resp.results #=> Array
|
2833
|
+
# resp.results[0].distance #=> Float
|
2756
2834
|
# resp.results[0].place.address_number #=> String
|
2757
2835
|
# resp.results[0].place.country #=> String
|
2758
2836
|
# resp.results[0].place.geometry.point #=> Array
|
2759
2837
|
# resp.results[0].place.geometry.point[0] #=> Float
|
2838
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2760
2839
|
# resp.results[0].place.label #=> String
|
2761
2840
|
# resp.results[0].place.municipality #=> String
|
2762
2841
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2764,7 +2843,10 @@ module Aws::LocationService
|
|
2764
2843
|
# resp.results[0].place.region #=> String
|
2765
2844
|
# resp.results[0].place.street #=> String
|
2766
2845
|
# resp.results[0].place.sub_region #=> String
|
2846
|
+
# resp.results[0].place.time_zone.name #=> String
|
2847
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
2767
2848
|
# resp.summary.data_source #=> String
|
2849
|
+
# resp.summary.language #=> String
|
2768
2850
|
# resp.summary.max_results #=> Integer
|
2769
2851
|
# resp.summary.position #=> Array
|
2770
2852
|
# resp.summary.position[0] #=> Float
|
@@ -2781,8 +2863,9 @@ module Aws::LocationService
|
|
2781
2863
|
# Geocodes free-form text, such as an address, name, city, or region to
|
2782
2864
|
# allow you to search for Places or points of interest.
|
2783
2865
|
#
|
2784
|
-
#
|
2785
|
-
#
|
2866
|
+
# Optional parameters let you narrow your search results by bounding box
|
2867
|
+
# or country, or bias your search toward a specific position on the
|
2868
|
+
# globe.
|
2786
2869
|
#
|
2787
2870
|
# <note markdown="1"> You can search for places near a given position using `BiasPosition`,
|
2788
2871
|
# or filter results within a bounding box using `FilterBBox`. Providing
|
@@ -2790,46 +2873,51 @@ module Aws::LocationService
|
|
2790
2873
|
#
|
2791
2874
|
# </note>
|
2792
2875
|
#
|
2793
|
-
#
|
2794
|
-
# Searches for results closest to the given position. An optional
|
2795
|
-
# parameter defined by longitude, and latitude.
|
2796
|
-
#
|
2797
|
-
# * The first `bias` position is the X coordinate, or longitude.
|
2798
|
-
#
|
2799
|
-
# * The second `bias` position is the Y coordinate, or latitude.
|
2876
|
+
# Search results are returned in order of highest to lowest relevance.
|
2800
2877
|
#
|
2801
|
-
#
|
2878
|
+
# @option params [Array<Float>] :bias_position
|
2879
|
+
# An optional parameter that indicates a preference for places that are
|
2880
|
+
# closer to a specified position.
|
2802
2881
|
#
|
2803
|
-
#
|
2804
|
-
#
|
2805
|
-
#
|
2882
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
2883
|
+
# number represents the X coordinate, or longitude; the second number
|
2884
|
+
# represents the Y coordinate, or latitude.
|
2806
2885
|
#
|
2807
|
-
#
|
2886
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
2887
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2808
2888
|
#
|
2809
|
-
#
|
2810
|
-
#
|
2889
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
2890
|
+
# both options results in an error.
|
2811
2891
|
#
|
2812
|
-
#
|
2813
|
-
# lower southwest corner.
|
2892
|
+
# </note>
|
2814
2893
|
#
|
2815
|
-
#
|
2894
|
+
# @option params [Array<Float>] :filter_b_box
|
2895
|
+
# An optional parameter that limits the search results by returning only
|
2896
|
+
# places that are within the provided bounding box.
|
2816
2897
|
#
|
2817
|
-
#
|
2898
|
+
# If provided, this parameter must contain a total of four consecutive
|
2899
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
2900
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
2901
|
+
# corner of the bounding box; the second pair of numbers represents the
|
2902
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
2903
|
+
# northeast corner of the bounding box.
|
2818
2904
|
#
|
2819
|
-
#
|
2820
|
-
#
|
2905
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
2906
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
2907
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
2908
|
+
# and latitude `-36.9542`.
|
2821
2909
|
#
|
2822
|
-
#
|
2823
|
-
#
|
2910
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
2911
|
+
# both options results in an error.
|
2824
2912
|
#
|
2825
|
-
#
|
2913
|
+
# </note>
|
2826
2914
|
#
|
2827
2915
|
# @option params [Array<String>] :filter_countries
|
2828
|
-
#
|
2829
|
-
#
|
2916
|
+
# An optional parameter that limits the search results by returning only
|
2917
|
+
# places that are in a specified list of countries.
|
2830
2918
|
#
|
2831
|
-
# *
|
2832
|
-
# uses three upper-case characters: `AUS`.
|
2919
|
+
# * Valid values include [ISO 3166][1] 3-digit country codes. For
|
2920
|
+
# example, Australia uses three upper-case characters: `AUS`.
|
2833
2921
|
#
|
2834
2922
|
# ^
|
2835
2923
|
#
|
@@ -2840,6 +2928,19 @@ module Aws::LocationService
|
|
2840
2928
|
# @option params [required, String] :index_name
|
2841
2929
|
# The name of the place index resource you want to use for the search.
|
2842
2930
|
#
|
2931
|
+
# @option params [String] :language
|
2932
|
+
# The preferred language used to return results. The value must be a
|
2933
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2934
|
+
#
|
2935
|
+
# This setting affects the languages used in the results. It does not
|
2936
|
+
# change which results are returned. If the language is not specified,
|
2937
|
+
# or not supported for a particular result, the partner automatically
|
2938
|
+
# chooses a language for the result.
|
2939
|
+
#
|
2940
|
+
#
|
2941
|
+
#
|
2942
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2943
|
+
#
|
2843
2944
|
# @option params [Integer] :max_results
|
2844
2945
|
# An optional parameter. The maximum number of results returned per
|
2845
2946
|
# request.
|
@@ -2847,7 +2948,7 @@ module Aws::LocationService
|
|
2847
2948
|
# The default: `50`
|
2848
2949
|
#
|
2849
2950
|
# @option params [required, String] :text
|
2850
|
-
# The address, name, city, or region to be used in the search
|
2951
|
+
# The address, name, city, or region to be used in the search in
|
2851
2952
|
# free-form text format. For example, `123 Any Street`.
|
2852
2953
|
#
|
2853
2954
|
# @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2862,6 +2963,7 @@ module Aws::LocationService
|
|
2862
2963
|
# filter_b_box: [1.0],
|
2863
2964
|
# filter_countries: ["CountryCode"],
|
2864
2965
|
# index_name: "ResourceName", # required
|
2966
|
+
# language: "LanguageTag",
|
2865
2967
|
# max_results: 1,
|
2866
2968
|
# text: "SyntheticSearchPlaceIndexForTextRequestString", # required
|
2867
2969
|
# })
|
@@ -2869,10 +2971,12 @@ module Aws::LocationService
|
|
2869
2971
|
# @example Response structure
|
2870
2972
|
#
|
2871
2973
|
# resp.results #=> Array
|
2974
|
+
# resp.results[0].distance #=> Float
|
2872
2975
|
# resp.results[0].place.address_number #=> String
|
2873
2976
|
# resp.results[0].place.country #=> String
|
2874
2977
|
# resp.results[0].place.geometry.point #=> Array
|
2875
2978
|
# resp.results[0].place.geometry.point[0] #=> Float
|
2979
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2876
2980
|
# resp.results[0].place.label #=> String
|
2877
2981
|
# resp.results[0].place.municipality #=> String
|
2878
2982
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2880,6 +2984,9 @@ module Aws::LocationService
|
|
2880
2984
|
# resp.results[0].place.region #=> String
|
2881
2985
|
# resp.results[0].place.street #=> String
|
2882
2986
|
# resp.results[0].place.sub_region #=> String
|
2987
|
+
# resp.results[0].place.time_zone.name #=> String
|
2988
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
2989
|
+
# resp.results[0].relevance #=> Float
|
2883
2990
|
# resp.summary.bias_position #=> Array
|
2884
2991
|
# resp.summary.bias_position[0] #=> Float
|
2885
2992
|
# resp.summary.data_source #=> String
|
@@ -2887,6 +2994,7 @@ module Aws::LocationService
|
|
2887
2994
|
# resp.summary.filter_b_box[0] #=> Float
|
2888
2995
|
# resp.summary.filter_countries #=> Array
|
2889
2996
|
# resp.summary.filter_countries[0] #=> String
|
2997
|
+
# resp.summary.language #=> String
|
2890
2998
|
# resp.summary.max_results #=> Integer
|
2891
2999
|
# resp.summary.result_b_box #=> Array
|
2892
3000
|
# resp.summary.result_b_box[0] #=> Float
|
@@ -2916,12 +3024,27 @@ module Aws::LocationService
|
|
2916
3024
|
# ^
|
2917
3025
|
#
|
2918
3026
|
# @option params [required, Hash<String,String>] :tags
|
2919
|
-
#
|
2920
|
-
#
|
3027
|
+
# Applies one or more tags to specific resource. A tag is a key-value
|
3028
|
+
# pair that helps you manage, identify, search, and filter your
|
3029
|
+
# resources.
|
2921
3030
|
#
|
2922
|
-
#
|
3031
|
+
# Format: `"key" : "value"`
|
2923
3032
|
#
|
2924
|
-
#
|
3033
|
+
# Restrictions:
|
3034
|
+
#
|
3035
|
+
# * Maximum 50 tags per resource.
|
3036
|
+
#
|
3037
|
+
# * Each tag key must be unique and must have exactly one associated
|
3038
|
+
# value.
|
3039
|
+
#
|
3040
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
3041
|
+
#
|
3042
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
3043
|
+
#
|
3044
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
3045
|
+
# characters: + - = . \_ : / @
|
3046
|
+
#
|
3047
|
+
# * Cannot use "aws:" as a prefix for a key.
|
2925
3048
|
#
|
2926
3049
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2927
3050
|
#
|
@@ -3200,6 +3323,24 @@ module Aws::LocationService
|
|
3200
3323
|
# @option params [String] :description
|
3201
3324
|
# Updates the description for the tracker resource.
|
3202
3325
|
#
|
3326
|
+
# @option params [String] :position_filtering
|
3327
|
+
# Updates the position filtering for the tracker resource.
|
3328
|
+
#
|
3329
|
+
# Valid values:
|
3330
|
+
#
|
3331
|
+
# * `TimeBased` - Location updates are evaluated against linked geofence
|
3332
|
+
# collections, but not every location update is stored. If your update
|
3333
|
+
# frequency is more often than 30 seconds, only one update per 30
|
3334
|
+
# seconds is stored for each unique device ID.
|
3335
|
+
#
|
3336
|
+
# * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
|
3337
|
+
# location updates are ignored. Location updates within this distance
|
3338
|
+
# are neither evaluated against linked geofence collections, nor
|
3339
|
+
# stored. This helps control costs by reducing the number of geofence
|
3340
|
+
# evaluations and device positions to retrieve. Distance-based
|
3341
|
+
# filtering can also reduce the jitter effect when displaying device
|
3342
|
+
# trajectory on a map.
|
3343
|
+
#
|
3203
3344
|
# @option params [String] :pricing_plan
|
3204
3345
|
# Updates the pricing plan for the tracker resource.
|
3205
3346
|
#
|
@@ -3247,6 +3388,7 @@ module Aws::LocationService
|
|
3247
3388
|
#
|
3248
3389
|
# resp = client.update_tracker({
|
3249
3390
|
# description: "ResourceDescription",
|
3391
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
3250
3392
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3251
3393
|
# pricing_plan_data_source: "String",
|
3252
3394
|
# tracker_name: "ResourceName", # required
|
@@ -3280,7 +3422,7 @@ module Aws::LocationService
|
|
3280
3422
|
params: params,
|
3281
3423
|
config: config)
|
3282
3424
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3283
|
-
context[:gem_version] = '1.
|
3425
|
+
context[:gem_version] = '1.12.0'
|
3284
3426
|
Seahorse::Client::Request.new(handlers, context)
|
3285
3427
|
end
|
3286
3428
|
|