aws-sdk-locationservice 1.11.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -480,6 +482,11 @@ module Aws::LocationService
480
482
  #
481
483
  # </note>
482
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
+ #
483
490
  # @option params [required, String] :collection_name
484
491
  # The geofence collection used in evaluating the position of devices
485
492
  # against its geofences.
@@ -498,8 +505,14 @@ module Aws::LocationService
498
505
  # collection_name: "ResourceName", # required
499
506
  # device_position_updates: [ # required
500
507
  # {
508
+ # accuracy: {
509
+ # horizontal: 1.0, # required
510
+ # },
501
511
  # device_id: "Id", # required
502
512
  # position: [1.0], # required
513
+ # position_properties: {
514
+ # "PropertyMapKeyString" => "PropertyMapValueString",
515
+ # },
503
516
  # sample_time: Time.now, # required
504
517
  # },
505
518
  # ],
@@ -550,9 +563,12 @@ module Aws::LocationService
550
563
  # @example Response structure
551
564
  #
552
565
  # resp.device_positions #=> Array
566
+ # resp.device_positions[0].accuracy.horizontal #=> Float
553
567
  # resp.device_positions[0].device_id #=> String
554
568
  # resp.device_positions[0].position #=> Array
555
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
556
572
  # resp.device_positions[0].received_time #=> Time
557
573
  # resp.device_positions[0].sample_time #=> Time
558
574
  # resp.errors #=> Array
@@ -633,10 +649,21 @@ module Aws::LocationService
633
649
  # location data is stored at a maximum of one position per 30 second
634
650
  # interval. If your update frequency is more often than every 30
635
651
  # 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).
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`.
640
667
  #
641
668
  # </note>
642
669
  #
@@ -656,8 +683,14 @@ module Aws::LocationService
656
683
  # tracker_name: "ResourceName", # required
657
684
  # updates: [ # required
658
685
  # {
686
+ # accuracy: {
687
+ # horizontal: 1.0, # required
688
+ # },
659
689
  # device_id: "Id", # required
660
690
  # position: [1.0], # required
691
+ # position_properties: {
692
+ # "PropertyMapKeyString" => "PropertyMapValueString",
693
+ # },
661
694
  # sample_time: Time.now, # required
662
695
  # },
663
696
  # ],
@@ -682,7 +715,7 @@ module Aws::LocationService
682
715
 
683
716
  # [Calculates a route][1] given the following required parameters:
684
717
  # `DeparturePostiton` and `DestinationPosition`. Requires that you first
685
- # [create a route calculator resource][2]
718
+ # [create a route calculator resource][2].
686
719
  #
687
720
  # By default, a request that doesn't specify a departure time uses the
688
721
  # best time of day to travel with the best traffic conditions when
@@ -695,7 +728,8 @@ module Aws::LocationService
695
728
  # data at the given time.
696
729
  #
697
730
  # <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
698
- # single request. Specifying both parameters returns an error message.
731
+ # single request. Specifying both parameters returns a validation
732
+ # error.
699
733
  #
700
734
  # </note>
701
735
  #
@@ -714,7 +748,7 @@ module Aws::LocationService
714
748
  #
715
749
  # @option params [required, String] :calculator_name
716
750
  # The name of the route calculator resource that you want to use to
717
- # calculate a route.
751
+ # calculate the route.
718
752
  #
719
753
  # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
720
754
  # Specifies route preferences when traveling by `Car`, such as avoiding
@@ -755,8 +789,8 @@ module Aws::LocationService
755
789
  #
756
790
  # @option params [Time,DateTime,Date,Integer,String] :departure_time
757
791
  # Specifies the desired time of departure. Uses the given time to
758
- # calculate a route. Otherwise, the best time of day to travel with the
759
- # 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.
760
794
  #
761
795
  # <note markdown="1"> Setting a departure time in the past returns a `400
762
796
  # ValidationException` error.
@@ -954,8 +988,9 @@ module Aws::LocationService
954
988
  #
955
989
  # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
956
990
  #
957
- # @option params [required, String] :pricing_plan
958
- # Specifies the pricing plan for the geofence collection.
991
+ # @option params [String] :pricing_plan
992
+ # Optionally specifies the pricing plan for the geofence collection.
993
+ # Defaults to `RequestBasedUsage`.
959
994
  #
960
995
  # For additional details and restrictions on each pricing plan option,
961
996
  # see the [Amazon Location Service pricing page][1].
@@ -1009,6 +1044,8 @@ module Aws::LocationService
1009
1044
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1010
1045
  # characters: + - = . \_ : / @.
1011
1046
  #
1047
+ # * Cannot use "aws:" as a prefix for a key.
1048
+ #
1012
1049
  # @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1013
1050
  #
1014
1051
  # * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
@@ -1021,7 +1058,7 @@ module Aws::LocationService
1021
1058
  # collection_name: "ResourceName", # required
1022
1059
  # description: "ResourceDescription",
1023
1060
  # kms_key_id: "KmsKeyId",
1024
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1061
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1025
1062
  # pricing_plan_data_source: "String",
1026
1063
  # tags: {
1027
1064
  # "TagKey" => "TagValue",
@@ -1064,8 +1101,9 @@ module Aws::LocationService
1064
1101
  #
1065
1102
  # * No spaces allowed. For example, `ExampleMap`.
1066
1103
  #
1067
- # @option params [required, String] :pricing_plan
1068
- # Specifies the pricing plan for your map resource.
1104
+ # @option params [String] :pricing_plan
1105
+ # Optionally specifies the pricing plan for the map resource. Defaults
1106
+ # to `RequestBasedUsage`.
1069
1107
  #
1070
1108
  # For additional details and restrictions on each pricing plan option,
1071
1109
  # see [Amazon Location Service pricing][1].
@@ -1094,6 +1132,8 @@ module Aws::LocationService
1094
1132
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1095
1133
  # characters: + - = . \_ : / @.
1096
1134
  #
1135
+ # * Cannot use "aws:" as a prefix for a key.
1136
+ #
1097
1137
  # @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1098
1138
  #
1099
1139
  # * {Types::CreateMapResponse#create_time #create_time} => Time
@@ -1108,7 +1148,7 @@ module Aws::LocationService
1108
1148
  # },
1109
1149
  # description: "ResourceDescription",
1110
1150
  # map_name: "ResourceName", # required
1111
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1151
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1112
1152
  # tags: {
1113
1153
  # "TagKey" => "TagValue",
1114
1154
  # },
@@ -1129,11 +1169,15 @@ module Aws::LocationService
1129
1169
  req.send_request(options)
1130
1170
  end
1131
1171
 
1132
- # Creates a place index resource in your AWS account, which supports
1133
- # functions with geospatial data sourced from your chosen data provider.
1172
+ # Creates a place index resource in your AWS account. Use a place index
1173
+ # resource to geocode addresses and other text queries by using the
1174
+ # `SearchPlaceIndexForText` operation, and reverse geocode coordinates
1175
+ # by using the `SearchPlaceIndexForPosition` operation, and enable
1176
+ # autosuggestions by using the `SearchPlaceIndexForSuggestions`
1177
+ # operation.
1134
1178
  #
1135
1179
  # @option params [required, String] :data_source
1136
- # Specifies the data provider of geospatial data.
1180
+ # Specifies the geospatial data provider for the new place index.
1137
1181
  #
1138
1182
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1139
1183
  # example, entering `HERE` returns an error.
@@ -1150,8 +1194,8 @@ module Aws::LocationService
1150
1194
  # coverage in your region of interest, see [HERE details on goecoding
1151
1195
  # coverage][4].
1152
1196
  #
1153
- # Place index resources using HERE Technologies as a data provider
1154
- # can't [store results][5] for locations in Japan. For more
1197
+ # If you specify HERE Technologies (`Here`) as the data provider, you
1198
+ # may not [store results][5] for locations in Japan. For more
1155
1199
  # information, see the [AWS Service Terms][6] for Amazon Location
1156
1200
  # Service.
1157
1201
  #
@@ -1186,8 +1230,9 @@ module Aws::LocationService
1186
1230
  #
1187
1231
  # * No spaces allowed. For example, `ExamplePlaceIndex`.
1188
1232
  #
1189
- # @option params [required, String] :pricing_plan
1190
- # Specifies the pricing plan for your place index resource.
1233
+ # @option params [String] :pricing_plan
1234
+ # Optionally specifies the pricing plan for the place index resource.
1235
+ # Defaults to `RequestBasedUsage`.
1191
1236
  #
1192
1237
  # For additional details and restrictions on each pricing plan option,
1193
1238
  # see [Amazon Location Service pricing][1].
@@ -1198,23 +1243,26 @@ module Aws::LocationService
1198
1243
  #
1199
1244
  # @option params [Hash<String,String>] :tags
1200
1245
  # Applies one or more tags to the place index resource. A tag is a
1201
- # key-value pair helps manage, identify, search, and filter your
1202
- # resources by labelling them.
1246
+ # key-value pair that helps you manage, identify, search, and filter
1247
+ # your resources.
1203
1248
  #
1204
1249
  # Format: `"key" : "value"`
1205
1250
  #
1206
1251
  # Restrictions:
1207
1252
  #
1208
- # * Maximum 50 tags per resource
1253
+ # * Maximum 50 tags per resource.
1209
1254
  #
1210
- # * Each resource tag must be unique with a maximum of one value.
1255
+ # * Each tag key must be unique and must have exactly one associated
1256
+ # value.
1211
1257
  #
1212
- # * Maximum key length: 128 Unicode characters in UTF-8
1258
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1213
1259
  #
1214
- # * Maximum value length: 256 Unicode characters in UTF-8
1260
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1215
1261
  #
1216
1262
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1217
- # characters: + - = . \_ : / @.
1263
+ # characters: + - = . \_ : / @
1264
+ #
1265
+ # * Cannot use "aws:" as a prefix for a key.
1218
1266
  #
1219
1267
  # @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1220
1268
  #
@@ -1231,7 +1279,7 @@ module Aws::LocationService
1231
1279
  # },
1232
1280
  # description: "ResourceDescription",
1233
1281
  # index_name: "ResourceName", # required
1234
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1282
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1235
1283
  # tags: {
1236
1284
  # "TagKey" => "TagValue",
1237
1285
  # },
@@ -1305,8 +1353,9 @@ module Aws::LocationService
1305
1353
  # @option params [String] :description
1306
1354
  # The optional description for the route calculator resource.
1307
1355
  #
1308
- # @option params [required, String] :pricing_plan
1309
- # Specifies the pricing plan for your route calculator resource.
1356
+ # @option params [String] :pricing_plan
1357
+ # Optionally specifies the pricing plan for the route calculator
1358
+ # resource. Defaults to `RequestBasedUsage`.
1310
1359
  #
1311
1360
  # For additional details and restrictions on each pricing plan option,
1312
1361
  # see [Amazon Location Service pricing][1].
@@ -1339,6 +1388,8 @@ module Aws::LocationService
1339
1388
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1340
1389
  # characters: + - = . \_ : / @.
1341
1390
  #
1391
+ # * Cannot use "aws:" as a prefix for a key.
1392
+ #
1342
1393
  # @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1343
1394
  #
1344
1395
  # * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
@@ -1351,7 +1402,7 @@ module Aws::LocationService
1351
1402
  # calculator_name: "ResourceName", # required
1352
1403
  # data_source: "String", # required
1353
1404
  # description: "ResourceDescription",
1354
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1405
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1355
1406
  # tags: {
1356
1407
  # "TagKey" => "TagValue",
1357
1408
  # },
@@ -1397,18 +1448,29 @@ module Aws::LocationService
1397
1448
  # seconds is stored for each unique device ID.
1398
1449
  #
1399
1450
  # * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
1400
- # location updates are ignored. Location updates within this distance
1401
- # are neither evaluated against linked geofence collections, nor
1402
- # stored. This helps control costs by reducing the number of geofence
1403
- # evaluations and device positions to retrieve. Distance-based
1404
- # filtering can also reduce the jitter effect when displaying device
1405
- # trajectory on a map.
1451
+ # location updates are ignored. Location updates within this area are
1452
+ # neither evaluated against linked geofence collections, nor stored.
1453
+ # This helps control costs by reducing the number of geofence
1454
+ # evaluations and historical device positions to paginate through.
1455
+ # Distance-based filtering can also reduce the effects of GPS noise
1456
+ # when displaying device trajectories on a map.
1457
+ #
1458
+ # * `AccuracyBased` - If the device has moved less than the measured
1459
+ # accuracy, location updates are ignored. For example, if two
1460
+ # consecutive updates from a device have a horizontal accuracy of 5 m
1461
+ # and 10 m, the second update is ignored if the device has moved less
1462
+ # than 15 m. Ignored location updates are neither evaluated against
1463
+ # linked geofence collections, nor stored. This can reduce the effects
1464
+ # of GPS noise when displaying device trajectories on a map, and can
1465
+ # help control your costs by reducing the number of geofence
1466
+ # evaluations.
1406
1467
  #
1407
1468
  # This field is optional. If not specified, the default value is
1408
1469
  # `TimeBased`.
1409
1470
  #
1410
- # @option params [required, String] :pricing_plan
1411
- # Specifies the pricing plan for the tracker resource.
1471
+ # @option params [String] :pricing_plan
1472
+ # Optionally specifies the pricing plan for the tracker resource.
1473
+ # Defaults to `RequestBasedUsage`.
1412
1474
  #
1413
1475
  # For additional details and restrictions on each pricing plan option,
1414
1476
  # see [Amazon Location Service pricing][1].
@@ -1462,6 +1524,8 @@ module Aws::LocationService
1462
1524
  # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1463
1525
  # characters: + - = . \_ : / @.
1464
1526
  #
1527
+ # * Cannot use "aws:" as a prefix for a key.
1528
+ #
1465
1529
  # @option params [required, String] :tracker_name
1466
1530
  # The name for the tracker resource.
1467
1531
  #
@@ -1485,8 +1549,8 @@ module Aws::LocationService
1485
1549
  # resp = client.create_tracker({
1486
1550
  # description: "ResourceDescription",
1487
1551
  # kms_key_id: "KmsKeyId",
1488
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
1489
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1552
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1553
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1490
1554
  # pricing_plan_data_source: "String",
1491
1555
  # tags: {
1492
1556
  # "TagKey" => "TagValue",
@@ -1851,7 +1915,7 @@ module Aws::LocationService
1851
1915
  # resp.create_time #=> Time
1852
1916
  # resp.description #=> String
1853
1917
  # resp.kms_key_id #=> String
1854
- # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased"
1918
+ # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
1855
1919
  # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
1856
1920
  # resp.pricing_plan_data_source #=> String
1857
1921
  # resp.tags #=> Hash
@@ -1924,8 +1988,10 @@ module Aws::LocationService
1924
1988
  #
1925
1989
  # @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1926
1990
  #
1991
+ # * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
1927
1992
  # * {Types::GetDevicePositionResponse#device_id #device_id} => String
1928
1993
  # * {Types::GetDevicePositionResponse#position #position} => Array&lt;Float&gt;
1994
+ # * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash&lt;String,String&gt;
1929
1995
  # * {Types::GetDevicePositionResponse#received_time #received_time} => Time
1930
1996
  # * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
1931
1997
  #
@@ -1938,9 +2004,12 @@ module Aws::LocationService
1938
2004
  #
1939
2005
  # @example Response structure
1940
2006
  #
2007
+ # resp.accuracy.horizontal #=> Float
1941
2008
  # resp.device_id #=> String
1942
2009
  # resp.position #=> Array
1943
2010
  # resp.position[0] #=> Float
2011
+ # resp.position_properties #=> Hash
2012
+ # resp.position_properties["PropertyMapKeyString"] #=> String
1944
2013
  # resp.received_time #=> Time
1945
2014
  # resp.sample_time #=> Time
1946
2015
  #
@@ -2025,9 +2094,12 @@ module Aws::LocationService
2025
2094
  # @example Response structure
2026
2095
  #
2027
2096
  # resp.device_positions #=> Array
2097
+ # resp.device_positions[0].accuracy.horizontal #=> Float
2028
2098
  # resp.device_positions[0].device_id #=> String
2029
2099
  # resp.device_positions[0].position #=> Array
2030
2100
  # resp.device_positions[0].position[0] #=> Float
2101
+ # resp.device_positions[0].position_properties #=> Hash
2102
+ # resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
2031
2103
  # resp.device_positions[0].received_time #=> Time
2032
2104
  # resp.device_positions[0].sample_time #=> Time
2033
2105
  # resp.next_token #=> String
@@ -2321,9 +2393,12 @@ module Aws::LocationService
2321
2393
  # @example Response structure
2322
2394
  #
2323
2395
  # resp.data.entries #=> Array
2396
+ # resp.data.entries[0].accuracy.horizontal #=> Float
2324
2397
  # resp.data.entries[0].device_id #=> String
2325
2398
  # resp.data.entries[0].position #=> Array
2326
2399
  # resp.data.entries[0].position[0] #=> Float
2400
+ # resp.data.entries[0].position_properties #=> Hash
2401
+ # resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
2327
2402
  # resp.data.entries[0].sample_time #=> Time
2328
2403
  # resp.next_token #=> String
2329
2404
  #
@@ -2770,21 +2845,34 @@ module Aws::LocationService
2770
2845
  # @option params [required, String] :index_name
2771
2846
  # The name of the place index resource you want to use for the search.
2772
2847
  #
2848
+ # @option params [String] :language
2849
+ # The preferred language used to return results. The value must be a
2850
+ # valid [BCP 47][1] language tag, for example, `en` for English.
2851
+ #
2852
+ # This setting affects the languages used in the results. It does not
2853
+ # change which results are returned. If the language is not specified,
2854
+ # or not supported for a particular result, the partner automatically
2855
+ # chooses a language for the result.
2856
+ #
2857
+ #
2858
+ #
2859
+ # [1]: https://tools.ietf.org/search/bcp47
2860
+ #
2773
2861
  # @option params [Integer] :max_results
2774
- # An optional paramer. The maximum number of results returned per
2862
+ # An optional parameter. The maximum number of results returned per
2775
2863
  # request.
2776
2864
  #
2777
2865
  # Default value: `50`
2778
2866
  #
2779
2867
  # @option params [required, Array<Float>] :position
2780
- # Specifies a coordinate for the query defined by a longitude, and
2781
- # latitude.
2782
- #
2783
- # * The first position is the X coordinate, or longitude.
2868
+ # Specifies the longitude and latitude of the position to query.
2784
2869
  #
2785
- # * The second position is the Y coordinate, or latitude.
2870
+ # This parameter must contain a pair of numbers. The first number
2871
+ # represents the X coordinate, or longitude; the second number
2872
+ # represents the Y coordinate, or latitude.
2786
2873
  #
2787
- # For example, `position=xLongitude&position=yLatitude` .
2874
+ # For example, `[-123.1174, 49.2847]` represents a position with
2875
+ # longitude `-123.1174` and latitude `49.2847`.
2788
2876
  #
2789
2877
  # @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2790
2878
  #
@@ -2795,6 +2883,7 @@ module Aws::LocationService
2795
2883
  #
2796
2884
  # resp = client.search_place_index_for_position({
2797
2885
  # index_name: "ResourceName", # required
2886
+ # language: "LanguageTag",
2798
2887
  # max_results: 1,
2799
2888
  # position: [1.0], # required
2800
2889
  # })
@@ -2802,10 +2891,12 @@ module Aws::LocationService
2802
2891
  # @example Response structure
2803
2892
  #
2804
2893
  # resp.results #=> Array
2894
+ # resp.results[0].distance #=> Float
2805
2895
  # resp.results[0].place.address_number #=> String
2806
2896
  # resp.results[0].place.country #=> String
2807
2897
  # resp.results[0].place.geometry.point #=> Array
2808
2898
  # resp.results[0].place.geometry.point[0] #=> Float
2899
+ # resp.results[0].place.interpolated #=> Boolean
2809
2900
  # resp.results[0].place.label #=> String
2810
2901
  # resp.results[0].place.municipality #=> String
2811
2902
  # resp.results[0].place.neighborhood #=> String
@@ -2813,7 +2904,10 @@ module Aws::LocationService
2813
2904
  # resp.results[0].place.region #=> String
2814
2905
  # resp.results[0].place.street #=> String
2815
2906
  # resp.results[0].place.sub_region #=> String
2907
+ # resp.results[0].place.time_zone.name #=> String
2908
+ # resp.results[0].place.time_zone.offset #=> Integer
2816
2909
  # resp.summary.data_source #=> String
2910
+ # resp.summary.language #=> String
2817
2911
  # resp.summary.max_results #=> Integer
2818
2912
  # resp.summary.position #=> Array
2819
2913
  # resp.summary.position[0] #=> Float
@@ -2827,11 +2921,146 @@ module Aws::LocationService
2827
2921
  req.send_request(options)
2828
2922
  end
2829
2923
 
2924
+ # Generates suggestions for addresses and points of interest based on
2925
+ # partial or misspelled free-form text. This operation is also known as
2926
+ # autocomplete, autosuggest, or fuzzy matching.
2927
+ #
2928
+ # Optional parameters let you narrow your search results by bounding box
2929
+ # or country, or bias your search toward a specific position on the
2930
+ # globe.
2931
+ #
2932
+ # <note markdown="1"> You can search for suggested place names near a specified position by
2933
+ # using `BiasPosition`, or filter results within a bounding box by using
2934
+ # `FilterBBox`. These parameters are mutually exclusive; using both
2935
+ # `BiasPosition` and `FilterBBox` in the same command returns an error.
2936
+ #
2937
+ # </note>
2938
+ #
2939
+ # @option params [Array<Float>] :bias_position
2940
+ # An optional parameter that indicates a preference for place
2941
+ # suggestions that are closer to a specified position.
2942
+ #
2943
+ # If provided, this parameter must contain a pair of numbers. The first
2944
+ # number represents the X coordinate, or longitude; the second number
2945
+ # represents the Y coordinate, or latitude.
2946
+ #
2947
+ # For example, `[-123.1174, 49.2847]` represents the position with
2948
+ # longitude `-123.1174` and latitude `49.2847`.
2949
+ #
2950
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
2951
+ # both options results in an error.
2952
+ #
2953
+ # </note>
2954
+ #
2955
+ # @option params [Array<Float>] :filter_b_box
2956
+ # An optional parameter that limits the search results by returning only
2957
+ # suggestions within a specified bounding box.
2958
+ #
2959
+ # If provided, this parameter must contain a total of four consecutive
2960
+ # numbers in two pairs. The first pair of numbers represents the X and Y
2961
+ # coordinates (longitude and latitude, respectively) of the southwest
2962
+ # corner of the bounding box; the second pair of numbers represents the
2963
+ # X and Y coordinates (longitude and latitude, respectively) of the
2964
+ # northeast corner of the bounding box.
2965
+ #
2966
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
2967
+ # bounding box where the southwest corner has longitude `-12.7935` and
2968
+ # latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
2969
+ # and latitude `-36.9542`.
2970
+ #
2971
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
2972
+ # both options results in an error.
2973
+ #
2974
+ # </note>
2975
+ #
2976
+ # @option params [Array<String>] :filter_countries
2977
+ # An optional parameter that limits the search results by returning only
2978
+ # suggestions within the provided list of countries.
2979
+ #
2980
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
2981
+ # uses three upper-case characters: `AUS`.
2982
+ #
2983
+ # ^
2984
+ #
2985
+ #
2986
+ #
2987
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
2988
+ #
2989
+ # @option params [required, String] :index_name
2990
+ # The name of the place index resource you want to use for the search.
2991
+ #
2992
+ # @option params [String] :language
2993
+ # The preferred language used to return results. The value must be a
2994
+ # valid [BCP 47][1] language tag, for example, `en` for English.
2995
+ #
2996
+ # This setting affects the languages used in the results. It does not
2997
+ # change which results are returned. If the language is not specified,
2998
+ # or not supported for a particular result, the partner automatically
2999
+ # chooses a language for the result.
3000
+ #
3001
+ # Used only when the partner selected is Here.
3002
+ #
3003
+ #
3004
+ #
3005
+ # [1]: https://tools.ietf.org/search/bcp47
3006
+ #
3007
+ # @option params [Integer] :max_results
3008
+ # An optional parameter. The maximum number of results returned per
3009
+ # request.
3010
+ #
3011
+ # The default: `5`
3012
+ #
3013
+ # @option params [required, String] :text
3014
+ # The free-form partial text to use to generate place suggestions. For
3015
+ # example, `eiffel tow`.
3016
+ #
3017
+ # @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3018
+ #
3019
+ # * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array&lt;Types::SearchForSuggestionsResult&gt;
3020
+ # * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
3021
+ #
3022
+ # @example Request syntax with placeholder values
3023
+ #
3024
+ # resp = client.search_place_index_for_suggestions({
3025
+ # bias_position: [1.0],
3026
+ # filter_b_box: [1.0],
3027
+ # filter_countries: ["CountryCode"],
3028
+ # index_name: "ResourceName", # required
3029
+ # language: "LanguageTag",
3030
+ # max_results: 1,
3031
+ # text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
3032
+ # })
3033
+ #
3034
+ # @example Response structure
3035
+ #
3036
+ # resp.results #=> Array
3037
+ # resp.results[0].text #=> String
3038
+ # resp.summary.bias_position #=> Array
3039
+ # resp.summary.bias_position[0] #=> Float
3040
+ # resp.summary.data_source #=> String
3041
+ # resp.summary.filter_b_box #=> Array
3042
+ # resp.summary.filter_b_box[0] #=> Float
3043
+ # resp.summary.filter_countries #=> Array
3044
+ # resp.summary.filter_countries[0] #=> String
3045
+ # resp.summary.language #=> String
3046
+ # resp.summary.max_results #=> Integer
3047
+ # resp.summary.text #=> String
3048
+ #
3049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
3050
+ #
3051
+ # @overload search_place_index_for_suggestions(params = {})
3052
+ # @param [Hash] params ({})
3053
+ def search_place_index_for_suggestions(params = {}, options = {})
3054
+ req = build_request(:search_place_index_for_suggestions, params)
3055
+ req.send_request(options)
3056
+ end
3057
+
2830
3058
  # Geocodes free-form text, such as an address, name, city, or region to
2831
3059
  # allow you to search for Places or points of interest.
2832
3060
  #
2833
- # Includes the option to apply additional parameters to narrow your list
2834
- # of results.
3061
+ # Optional parameters let you narrow your search results by bounding box
3062
+ # or country, or bias your search toward a specific position on the
3063
+ # globe.
2835
3064
  #
2836
3065
  # <note markdown="1"> You can search for places near a given position using `BiasPosition`,
2837
3066
  # or filter results within a bounding box using `FilterBBox`. Providing
@@ -2839,46 +3068,51 @@ module Aws::LocationService
2839
3068
  #
2840
3069
  # </note>
2841
3070
  #
2842
- # @option params [Array<Float>] :bias_position
2843
- # Searches for results closest to the given position. An optional
2844
- # parameter defined by longitude, and latitude.
2845
- #
2846
- # * The first `bias` position is the X coordinate, or longitude.
3071
+ # Search results are returned in order of highest to lowest relevance.
2847
3072
  #
2848
- # * The second `bias` position is the Y coordinate, or latitude.
3073
+ # @option params [Array<Float>] :bias_position
3074
+ # An optional parameter that indicates a preference for places that are
3075
+ # closer to a specified position.
2849
3076
  #
2850
- # For example, `bias=xLongitude&bias=yLatitude`.
3077
+ # If provided, this parameter must contain a pair of numbers. The first
3078
+ # number represents the X coordinate, or longitude; the second number
3079
+ # represents the Y coordinate, or latitude.
2851
3080
  #
2852
- # @option params [Array<Float>] :filter_b_box
2853
- # Filters the results by returning only Places within the provided
2854
- # bounding box. An optional parameter.
3081
+ # For example, `[-123.1174, 49.2847]` represents the position with
3082
+ # longitude `-123.1174` and latitude `49.2847`.
2855
3083
  #
2856
- # The first 2 `bbox` parameters describe the lower southwest corner:
3084
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
3085
+ # both options results in an error.
2857
3086
  #
2858
- # * The first `bbox` position is the X coordinate or longitude of the
2859
- # lower southwest corner.
2860
- #
2861
- # * The second `bbox` position is the Y coordinate or latitude of the
2862
- # lower southwest corner.
3087
+ # </note>
2863
3088
  #
2864
- # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`.
3089
+ # @option params [Array<Float>] :filter_b_box
3090
+ # An optional parameter that limits the search results by returning only
3091
+ # places that are within the provided bounding box.
2865
3092
  #
2866
- # The next `bbox` parameters describe the upper northeast corner:
3093
+ # If provided, this parameter must contain a total of four consecutive
3094
+ # numbers in two pairs. The first pair of numbers represents the X and Y
3095
+ # coordinates (longitude and latitude, respectively) of the southwest
3096
+ # corner of the bounding box; the second pair of numbers represents the
3097
+ # X and Y coordinates (longitude and latitude, respectively) of the
3098
+ # northeast corner of the bounding box.
2867
3099
  #
2868
- # * The third `bbox` position is the X coordinate, or longitude of the
2869
- # upper northeast corner.
3100
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
3101
+ # bounding box where the southwest corner has longitude `-12.7935` and
3102
+ # latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
3103
+ # and latitude `-36.9542`.
2870
3104
  #
2871
- # * The fourth `bbox` position is the Y coordinate, or longitude of the
2872
- # upper northeast corner.
3105
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
3106
+ # both options results in an error.
2873
3107
  #
2874
- # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE`
3108
+ # </note>
2875
3109
  #
2876
3110
  # @option params [Array<String>] :filter_countries
2877
- # Limits the search to the given a list of countries/regions. An
2878
- # optional parameter.
3111
+ # An optional parameter that limits the search results by returning only
3112
+ # places that are in a specified list of countries.
2879
3113
  #
2880
- # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
2881
- # uses three upper-case characters: `AUS`.
3114
+ # * Valid values include [ISO 3166][1] 3-digit country codes. For
3115
+ # example, Australia uses three upper-case characters: `AUS`.
2882
3116
  #
2883
3117
  # ^
2884
3118
  #
@@ -2889,6 +3123,19 @@ module Aws::LocationService
2889
3123
  # @option params [required, String] :index_name
2890
3124
  # The name of the place index resource you want to use for the search.
2891
3125
  #
3126
+ # @option params [String] :language
3127
+ # The preferred language used to return results. The value must be a
3128
+ # valid [BCP 47][1] language tag, for example, `en` for English.
3129
+ #
3130
+ # This setting affects the languages used in the results. It does not
3131
+ # change which results are returned. If the language is not specified,
3132
+ # or not supported for a particular result, the partner automatically
3133
+ # chooses a language for the result.
3134
+ #
3135
+ #
3136
+ #
3137
+ # [1]: https://tools.ietf.org/search/bcp47
3138
+ #
2892
3139
  # @option params [Integer] :max_results
2893
3140
  # An optional parameter. The maximum number of results returned per
2894
3141
  # request.
@@ -2896,7 +3143,7 @@ module Aws::LocationService
2896
3143
  # The default: `50`
2897
3144
  #
2898
3145
  # @option params [required, String] :text
2899
- # The address, name, city, or region to be used in the search. In
3146
+ # The address, name, city, or region to be used in the search in
2900
3147
  # free-form text format. For example, `123 Any Street`.
2901
3148
  #
2902
3149
  # @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2911,6 +3158,7 @@ module Aws::LocationService
2911
3158
  # filter_b_box: [1.0],
2912
3159
  # filter_countries: ["CountryCode"],
2913
3160
  # index_name: "ResourceName", # required
3161
+ # language: "LanguageTag",
2914
3162
  # max_results: 1,
2915
3163
  # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
2916
3164
  # })
@@ -2918,10 +3166,12 @@ module Aws::LocationService
2918
3166
  # @example Response structure
2919
3167
  #
2920
3168
  # resp.results #=> Array
3169
+ # resp.results[0].distance #=> Float
2921
3170
  # resp.results[0].place.address_number #=> String
2922
3171
  # resp.results[0].place.country #=> String
2923
3172
  # resp.results[0].place.geometry.point #=> Array
2924
3173
  # resp.results[0].place.geometry.point[0] #=> Float
3174
+ # resp.results[0].place.interpolated #=> Boolean
2925
3175
  # resp.results[0].place.label #=> String
2926
3176
  # resp.results[0].place.municipality #=> String
2927
3177
  # resp.results[0].place.neighborhood #=> String
@@ -2929,6 +3179,9 @@ module Aws::LocationService
2929
3179
  # resp.results[0].place.region #=> String
2930
3180
  # resp.results[0].place.street #=> String
2931
3181
  # resp.results[0].place.sub_region #=> String
3182
+ # resp.results[0].place.time_zone.name #=> String
3183
+ # resp.results[0].place.time_zone.offset #=> Integer
3184
+ # resp.results[0].relevance #=> Float
2932
3185
  # resp.summary.bias_position #=> Array
2933
3186
  # resp.summary.bias_position[0] #=> Float
2934
3187
  # resp.summary.data_source #=> String
@@ -2936,6 +3189,7 @@ module Aws::LocationService
2936
3189
  # resp.summary.filter_b_box[0] #=> Float
2937
3190
  # resp.summary.filter_countries #=> Array
2938
3191
  # resp.summary.filter_countries[0] #=> String
3192
+ # resp.summary.language #=> String
2939
3193
  # resp.summary.max_results #=> Integer
2940
3194
  # resp.summary.result_b_box #=> Array
2941
3195
  # resp.summary.result_b_box[0] #=> Float
@@ -2965,12 +3219,27 @@ module Aws::LocationService
2965
3219
  # ^
2966
3220
  #
2967
3221
  # @option params [required, Hash<String,String>] :tags
2968
- # Tags that have been applied to the specified resource. Tags are mapped
2969
- # from the tag key to the tag value: `"TagKey" : "TagValue"`.
3222
+ # Applies one or more tags to specific resource. A tag is a key-value
3223
+ # pair that helps you manage, identify, search, and filter your
3224
+ # resources.
2970
3225
  #
2971
- # * Format example: `\{"tag1" : "value1", "tag2" : "value2"\} `
3226
+ # Format: `"key" : "value"`
2972
3227
  #
2973
- # ^
3228
+ # Restrictions:
3229
+ #
3230
+ # * Maximum 50 tags per resource.
3231
+ #
3232
+ # * Each tag key must be unique and must have exactly one associated
3233
+ # value.
3234
+ #
3235
+ # * Maximum key length: 128 Unicode characters in UTF-8.
3236
+ #
3237
+ # * Maximum value length: 256 Unicode characters in UTF-8.
3238
+ #
3239
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
3240
+ # characters: + - = . \_ : / @
3241
+ #
3242
+ # * Cannot use "aws:" as a prefix for a key.
2974
3243
  #
2975
3244
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2976
3245
  #
@@ -3263,9 +3532,19 @@ module Aws::LocationService
3263
3532
  # location updates are ignored. Location updates within this distance
3264
3533
  # are neither evaluated against linked geofence collections, nor
3265
3534
  # stored. This helps control costs by reducing the number of geofence
3266
- # evaluations and device positions to retrieve. Distance-based
3267
- # filtering can also reduce the jitter effect when displaying device
3268
- # trajectory on a map.
3535
+ # evaluations and historical device positions to paginate through.
3536
+ # Distance-based filtering can also reduce the effects of GPS noise
3537
+ # when displaying device trajectories on a map.
3538
+ #
3539
+ # * `AccuracyBased` - If the device has moved less than the measured
3540
+ # accuracy, location updates are ignored. For example, if two
3541
+ # consecutive updates from a device have a horizontal accuracy of 5 m
3542
+ # and 10 m, the second update is ignored if the device has moved less
3543
+ # than 15 m. Ignored location updates are neither evaluated against
3544
+ # linked geofence collections, nor stored. This helps educe the
3545
+ # effects of GPS noise when displaying device trajectories on a map,
3546
+ # and can help control costs by reducing the number of geofence
3547
+ # evaluations.
3269
3548
  #
3270
3549
  # @option params [String] :pricing_plan
3271
3550
  # Updates the pricing plan for the tracker resource.
@@ -3314,7 +3593,7 @@ module Aws::LocationService
3314
3593
  #
3315
3594
  # resp = client.update_tracker({
3316
3595
  # description: "ResourceDescription",
3317
- # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
3596
+ # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
3318
3597
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
3319
3598
  # pricing_plan_data_source: "String",
3320
3599
  # tracker_name: "ResourceName", # required
@@ -3348,7 +3627,7 @@ module Aws::LocationService
3348
3627
  params: params,
3349
3628
  config: config)
3350
3629
  context[:gem_name] = 'aws-sdk-locationservice'
3351
- context[:gem_version] = '1.11.0'
3630
+ context[:gem_version] = '1.15.0'
3352
3631
  Seahorse::Client::Request.new(handlers, context)
3353
3632
  end
3354
3633