aws-sdk-locationservice 1.13.0 → 1.14.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: caf72f04b3ad6ca0575d8c0a09d2b1ea33005920fca50ed03df012ddc7b7af14
4
- data.tar.gz: ebd39ff994a10f4d463d194f8a78f8eafc7bd8409f60eb003545242a7153b09c
3
+ metadata.gz: ffeda68c223e60fc42182e504c329a14aa8898d4c70d118bd06e1743a467f423
4
+ data.tar.gz: a9874d8dc4ae1d325a8da0b3a3f4a6ccacfffccb1374afffe3649d643effe430
5
5
  SHA512:
6
- metadata.gz: 4a4df27c219a40aa791fb3d5cf3912b102726b060543b813fa5ba585c35c9615d8e98ed302c60dcbca8946e719661bb342a6d4d6790d9077e4b872feda5bf9fc
7
- data.tar.gz: bcf6a3a0c9265c35fafe16456ff49753f8ee7d24eed58fc393aee0c950bcbdea0166911ea4f49af5fd3feeccd64b977daad97c41162060ecf8550d90bbbfb5ec
6
+ metadata.gz: 4a8ef019e8e6ec50fa4ab375562b2706c8408379a6c4f66e965f274587119d86549caea3ccf679f522283ad8611d5e747072683fc986237aee950720029360e9
7
+ data.tar.gz: 0d2a6d6eaf60452fe75e77cd780b019c5befd7510767b9740474f5018e943dcd8bece55e99ad967f8b6160bdbbe19220d4f6be8e44e0520eb8044f1709c9ffbf
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.14.0 (2021-12-06)
5
+ ------------------
6
+
7
+ * Feature - This release adds support for Accuracy position filtering, position metadata and autocomplete for addresses and points of interest based on partial or misspelled free-form text.
8
+
4
9
  1.13.0 (2021-11-30)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.13.0
1
+ 1.14.0
@@ -482,6 +482,11 @@ module Aws::LocationService
482
482
  #
483
483
  # </note>
484
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
+ #
485
490
  # @option params [required, String] :collection_name
486
491
  # The geofence collection used in evaluating the position of devices
487
492
  # against its geofences.
@@ -500,8 +505,14 @@ module Aws::LocationService
500
505
  # collection_name: "ResourceName", # required
501
506
  # device_position_updates: [ # required
502
507
  # {
508
+ # accuracy: {
509
+ # horizontal: 1.0, # required
510
+ # },
503
511
  # device_id: "Id", # required
504
512
  # position: [1.0], # required
513
+ # position_properties: {
514
+ # "PropertyMapKeyString" => "PropertyMapValueString",
515
+ # },
505
516
  # sample_time: Time.now, # required
506
517
  # },
507
518
  # ],
@@ -552,9 +563,12 @@ module Aws::LocationService
552
563
  # @example Response structure
553
564
  #
554
565
  # resp.device_positions #=> Array
566
+ # resp.device_positions[0].accuracy.horizontal #=> Float
555
567
  # resp.device_positions[0].device_id #=> String
556
568
  # resp.device_positions[0].position #=> Array
557
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
558
572
  # resp.device_positions[0].received_time #=> Time
559
573
  # resp.device_positions[0].sample_time #=> Time
560
574
  # resp.errors #=> Array
@@ -635,10 +649,21 @@ module Aws::LocationService
635
649
  # location data is stored at a maximum of one position per 30 second
636
650
  # interval. If your update frequency is more often than every 30
637
651
  # seconds, only one update per 30 seconds is stored for each unique
638
- # device ID. When `PositionFiltering` is set to `DistanceBased`
639
- # filtering, location data is stored and evaluated against linked
640
- # geofence collections only if the device has moved more than 30 m (98.4
641
- # 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`.
642
667
  #
643
668
  # </note>
644
669
  #
@@ -658,8 +683,14 @@ module Aws::LocationService
658
683
  # tracker_name: "ResourceName", # required
659
684
  # updates: [ # required
660
685
  # {
686
+ # accuracy: {
687
+ # horizontal: 1.0, # required
688
+ # },
661
689
  # device_id: "Id", # required
662
690
  # position: [1.0], # required
691
+ # position_properties: {
692
+ # "PropertyMapKeyString" => "PropertyMapValueString",
693
+ # },
663
694
  # sample_time: Time.now, # required
664
695
  # },
665
696
  # ],
@@ -1139,7 +1170,9 @@ module Aws::LocationService
1139
1170
  # Creates a place index resource in your AWS account. Use a place index
1140
1171
  # resource to geocode addresses and other text queries by using the
1141
1172
  # `SearchPlaceIndexForText` operation, and reverse geocode coordinates
1142
- # by using the `SearchPlaceIndexForPosition` operation.
1173
+ # by using the `SearchPlaceIndexForPosition` operation, and enable
1174
+ # autosuggestions by using the `SearchPlaceIndexForSuggestions`
1175
+ # operation.
1143
1176
  #
1144
1177
  # @option params [required, String] :data_source
1145
1178
  # Specifies the geospatial data provider for the new place index.
@@ -1418,6 +1451,16 @@ module Aws::LocationService
1418
1451
  # Distance-based filtering can also reduce the effects of GPS noise
1419
1452
  # when displaying device trajectories on a map.
1420
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.
1463
+ #
1421
1464
  # This field is optional. If not specified, the default value is
1422
1465
  # `TimeBased`.
1423
1466
  #
@@ -1940,8 +1983,10 @@ module Aws::LocationService
1940
1983
  #
1941
1984
  # @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1942
1985
  #
1986
+ # * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
1943
1987
  # * {Types::GetDevicePositionResponse#device_id #device_id} => String
1944
1988
  # * {Types::GetDevicePositionResponse#position #position} => Array&lt;Float&gt;
1989
+ # * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash&lt;String,String&gt;
1945
1990
  # * {Types::GetDevicePositionResponse#received_time #received_time} => Time
1946
1991
  # * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
1947
1992
  #
@@ -1954,9 +1999,12 @@ module Aws::LocationService
1954
1999
  #
1955
2000
  # @example Response structure
1956
2001
  #
2002
+ # resp.accuracy.horizontal #=> Float
1957
2003
  # resp.device_id #=> String
1958
2004
  # resp.position #=> Array
1959
2005
  # resp.position[0] #=> Float
2006
+ # resp.position_properties #=> Hash
2007
+ # resp.position_properties["PropertyMapKeyString"] #=> String
1960
2008
  # resp.received_time #=> Time
1961
2009
  # resp.sample_time #=> Time
1962
2010
  #
@@ -2041,9 +2089,12 @@ module Aws::LocationService
2041
2089
  # @example Response structure
2042
2090
  #
2043
2091
  # resp.device_positions #=> Array
2092
+ # resp.device_positions[0].accuracy.horizontal #=> Float
2044
2093
  # resp.device_positions[0].device_id #=> String
2045
2094
  # resp.device_positions[0].position #=> Array
2046
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
2047
2098
  # resp.device_positions[0].received_time #=> Time
2048
2099
  # resp.device_positions[0].sample_time #=> Time
2049
2100
  # resp.next_token #=> String
@@ -2337,9 +2388,12 @@ module Aws::LocationService
2337
2388
  # @example Response structure
2338
2389
  #
2339
2390
  # resp.data.entries #=> Array
2391
+ # resp.data.entries[0].accuracy.horizontal #=> Float
2340
2392
  # resp.data.entries[0].device_id #=> String
2341
2393
  # resp.data.entries[0].position #=> Array
2342
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
2343
2397
  # resp.data.entries[0].sample_time #=> Time
2344
2398
  # resp.next_token #=> String
2345
2399
  #
@@ -2862,6 +2916,140 @@ module Aws::LocationService
2862
2916
  req.send_request(options)
2863
2917
  end
2864
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&lt;Types::SearchForSuggestionsResult&gt;
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
+
2865
3053
  # Geocodes free-form text, such as an address, name, city, or region to
2866
3054
  # allow you to search for Places or points of interest.
2867
3055
  #
@@ -3339,9 +3527,19 @@ module Aws::LocationService
3339
3527
  # location updates are ignored. Location updates within this distance
3340
3528
  # are neither evaluated against linked geofence collections, nor
3341
3529
  # stored. This helps control costs by reducing the number of geofence
3342
- # evaluations and device positions to retrieve. Distance-based
3343
- # filtering can also reduce the jitter effect when displaying device
3344
- # trajectory on a map.
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.
3345
3543
  #
3346
3544
  # @option params [String] :pricing_plan
3347
3545
  # Updates the pricing plan for the tracker resource.
@@ -3424,7 +3622,7 @@ module Aws::LocationService
3424
3622
  params: params,
3425
3623
  config: config)
3426
3624
  context[:gem_name] = 'aws-sdk-locationservice'
3427
- context[:gem_version] = '1.13.0'
3625
+ context[:gem_version] = '1.14.0'
3428
3626
  Seahorse::Client::Request.new(handlers, context)
3429
3627
  end
3430
3628
 
@@ -187,7 +187,12 @@ module Aws::LocationService
187
187
  PlaceIndexSearchResultLimit = Shapes::IntegerShape.new(name: 'PlaceIndexSearchResultLimit')
188
188
  Position = Shapes::ListShape.new(name: 'Position')
189
189
  PositionFiltering = Shapes::StringShape.new(name: 'PositionFiltering')
190
+ PositionalAccuracy = Shapes::StructureShape.new(name: 'PositionalAccuracy')
191
+ PositionalAccuracyHorizontalDouble = Shapes::FloatShape.new(name: 'PositionalAccuracyHorizontalDouble')
190
192
  PricingPlan = Shapes::StringShape.new(name: 'PricingPlan')
193
+ PropertyMap = Shapes::MapShape.new(name: 'PropertyMap')
194
+ PropertyMapKeyString = Shapes::StringShape.new(name: 'PropertyMapKeyString')
195
+ PropertyMapValueString = Shapes::StringShape.new(name: 'PropertyMapValueString')
191
196
  PutGeofenceRequest = Shapes::StructureShape.new(name: 'PutGeofenceRequest')
192
197
  PutGeofenceResponse = Shapes::StructureShape.new(name: 'PutGeofenceResponse')
193
198
  ResourceDescription = Shapes::StringShape.new(name: 'ResourceDescription')
@@ -196,6 +201,8 @@ module Aws::LocationService
196
201
  SearchForPositionResult = Shapes::StructureShape.new(name: 'SearchForPositionResult')
197
202
  SearchForPositionResultDistanceDouble = Shapes::FloatShape.new(name: 'SearchForPositionResultDistanceDouble')
198
203
  SearchForPositionResultList = Shapes::ListShape.new(name: 'SearchForPositionResultList')
204
+ SearchForSuggestionsResult = Shapes::StructureShape.new(name: 'SearchForSuggestionsResult')
205
+ SearchForSuggestionsResultList = Shapes::ListShape.new(name: 'SearchForSuggestionsResultList')
199
206
  SearchForTextResult = Shapes::StructureShape.new(name: 'SearchForTextResult')
200
207
  SearchForTextResultDistanceDouble = Shapes::FloatShape.new(name: 'SearchForTextResultDistanceDouble')
201
208
  SearchForTextResultList = Shapes::ListShape.new(name: 'SearchForTextResultList')
@@ -203,6 +210,10 @@ module Aws::LocationService
203
210
  SearchPlaceIndexForPositionRequest = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionRequest')
204
211
  SearchPlaceIndexForPositionResponse = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionResponse')
205
212
  SearchPlaceIndexForPositionSummary = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionSummary')
213
+ SearchPlaceIndexForSuggestionsRequest = Shapes::StructureShape.new(name: 'SearchPlaceIndexForSuggestionsRequest')
214
+ SearchPlaceIndexForSuggestionsRequestMaxResultsInteger = Shapes::IntegerShape.new(name: 'SearchPlaceIndexForSuggestionsRequestMaxResultsInteger')
215
+ SearchPlaceIndexForSuggestionsResponse = Shapes::StructureShape.new(name: 'SearchPlaceIndexForSuggestionsResponse')
216
+ SearchPlaceIndexForSuggestionsSummary = Shapes::StructureShape.new(name: 'SearchPlaceIndexForSuggestionsSummary')
206
217
  SearchPlaceIndexForTextRequest = Shapes::StructureShape.new(name: 'SearchPlaceIndexForTextRequest')
207
218
  SearchPlaceIndexForTextResponse = Shapes::StructureShape.new(name: 'SearchPlaceIndexForTextResponse')
208
219
  SearchPlaceIndexForTextSummary = Shapes::StructureShape.new(name: 'SearchPlaceIndexForTextSummary')
@@ -213,6 +224,8 @@ module Aws::LocationService
213
224
  StepGeometryOffsetInteger = Shapes::IntegerShape.new(name: 'StepGeometryOffsetInteger')
214
225
  StepList = Shapes::ListShape.new(name: 'StepList')
215
226
  String = Shapes::StringShape.new(name: 'String')
227
+ SyntheticSearchPlaceIndexForSuggestionsRequestString = Shapes::StringShape.new(name: 'SyntheticSearchPlaceIndexForSuggestionsRequestString')
228
+ SyntheticSearchPlaceIndexForSuggestionsSummaryString = Shapes::StringShape.new(name: 'SyntheticSearchPlaceIndexForSuggestionsSummaryString')
216
229
  SyntheticSearchPlaceIndexForTextRequestString = Shapes::StringShape.new(name: 'SyntheticSearchPlaceIndexForTextRequestString')
217
230
  SyntheticSearchPlaceIndexForTextSummaryString = Shapes::StringShape.new(name: 'SyntheticSearchPlaceIndexForTextSummaryString')
218
231
  TagKey = Shapes::StringShape.new(name: 'TagKey')
@@ -575,16 +588,20 @@ module Aws::LocationService
575
588
  DescribeTrackerResponse.add_member(:update_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "UpdateTime"))
576
589
  DescribeTrackerResponse.struct_class = Types::DescribeTrackerResponse
577
590
 
591
+ DevicePosition.add_member(:accuracy, Shapes::ShapeRef.new(shape: PositionalAccuracy, location_name: "Accuracy"))
578
592
  DevicePosition.add_member(:device_id, Shapes::ShapeRef.new(shape: Id, location_name: "DeviceId"))
579
593
  DevicePosition.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
594
+ DevicePosition.add_member(:position_properties, Shapes::ShapeRef.new(shape: PropertyMap, location_name: "PositionProperties"))
580
595
  DevicePosition.add_member(:received_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "ReceivedTime"))
581
596
  DevicePosition.add_member(:sample_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "SampleTime"))
582
597
  DevicePosition.struct_class = Types::DevicePosition
583
598
 
584
599
  DevicePositionList.member = Shapes::ShapeRef.new(shape: DevicePosition)
585
600
 
601
+ DevicePositionUpdate.add_member(:accuracy, Shapes::ShapeRef.new(shape: PositionalAccuracy, location_name: "Accuracy"))
586
602
  DevicePositionUpdate.add_member(:device_id, Shapes::ShapeRef.new(shape: Id, required: true, location_name: "DeviceId"))
587
603
  DevicePositionUpdate.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
604
+ DevicePositionUpdate.add_member(:position_properties, Shapes::ShapeRef.new(shape: PropertyMap, location_name: "PositionProperties"))
588
605
  DevicePositionUpdate.add_member(:sample_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "SampleTime"))
589
606
  DevicePositionUpdate.struct_class = Types::DevicePositionUpdate
590
607
 
@@ -612,8 +629,10 @@ module Aws::LocationService
612
629
  GetDevicePositionRequest.add_member(:tracker_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "TrackerName"))
613
630
  GetDevicePositionRequest.struct_class = Types::GetDevicePositionRequest
614
631
 
632
+ GetDevicePositionResponse.add_member(:accuracy, Shapes::ShapeRef.new(shape: PositionalAccuracy, location_name: "Accuracy"))
615
633
  GetDevicePositionResponse.add_member(:device_id, Shapes::ShapeRef.new(shape: Id, location_name: "DeviceId"))
616
634
  GetDevicePositionResponse.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
635
+ GetDevicePositionResponse.add_member(:position_properties, Shapes::ShapeRef.new(shape: PropertyMap, location_name: "PositionProperties"))
617
636
  GetDevicePositionResponse.add_member(:received_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "ReceivedTime"))
618
637
  GetDevicePositionResponse.add_member(:sample_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "SampleTime"))
619
638
  GetDevicePositionResponse.struct_class = Types::GetDevicePositionResponse
@@ -702,8 +721,10 @@ module Aws::LocationService
702
721
  ListDevicePositionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
703
722
  ListDevicePositionsResponse.struct_class = Types::ListDevicePositionsResponse
704
723
 
724
+ ListDevicePositionsResponseEntry.add_member(:accuracy, Shapes::ShapeRef.new(shape: PositionalAccuracy, location_name: "Accuracy"))
705
725
  ListDevicePositionsResponseEntry.add_member(:device_id, Shapes::ShapeRef.new(shape: Id, required: true, location_name: "DeviceId"))
706
726
  ListDevicePositionsResponseEntry.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
727
+ ListDevicePositionsResponseEntry.add_member(:position_properties, Shapes::ShapeRef.new(shape: PropertyMap, location_name: "PositionProperties"))
707
728
  ListDevicePositionsResponseEntry.add_member(:sample_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "SampleTime"))
708
729
  ListDevicePositionsResponseEntry.struct_class = Types::ListDevicePositionsResponseEntry
709
730
 
@@ -853,6 +874,12 @@ module Aws::LocationService
853
874
 
854
875
  Position.member = Shapes::ShapeRef.new(shape: Double)
855
876
 
877
+ PositionalAccuracy.add_member(:horizontal, Shapes::ShapeRef.new(shape: PositionalAccuracyHorizontalDouble, required: true, location_name: "Horizontal"))
878
+ PositionalAccuracy.struct_class = Types::PositionalAccuracy
879
+
880
+ PropertyMap.key = Shapes::ShapeRef.new(shape: PropertyMapKeyString)
881
+ PropertyMap.value = Shapes::ShapeRef.new(shape: PropertyMapValueString)
882
+
856
883
  PutGeofenceRequest.add_member(:collection_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "CollectionName"))
857
884
  PutGeofenceRequest.add_member(:geofence_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "GeofenceId"))
858
885
  PutGeofenceRequest.add_member(:geometry, Shapes::ShapeRef.new(shape: GeofenceGeometry, required: true, location_name: "Geometry"))
@@ -872,6 +899,11 @@ module Aws::LocationService
872
899
 
873
900
  SearchForPositionResultList.member = Shapes::ShapeRef.new(shape: SearchForPositionResult)
874
901
 
902
+ SearchForSuggestionsResult.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
903
+ SearchForSuggestionsResult.struct_class = Types::SearchForSuggestionsResult
904
+
905
+ SearchForSuggestionsResultList.member = Shapes::ShapeRef.new(shape: SearchForSuggestionsResult)
906
+
875
907
  SearchForTextResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForTextResultDistanceDouble, location_name: "Distance"))
876
908
  SearchForTextResult.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
877
909
  SearchForTextResult.add_member(:relevance, Shapes::ShapeRef.new(shape: SearchForTextResultRelevanceDouble, location_name: "Relevance"))
@@ -895,6 +927,28 @@ module Aws::LocationService
895
927
  SearchPlaceIndexForPositionSummary.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
896
928
  SearchPlaceIndexForPositionSummary.struct_class = Types::SearchPlaceIndexForPositionSummary
897
929
 
930
+ SearchPlaceIndexForSuggestionsRequest.add_member(:bias_position, Shapes::ShapeRef.new(shape: Position, location_name: "BiasPosition"))
931
+ SearchPlaceIndexForSuggestionsRequest.add_member(:filter_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "FilterBBox"))
932
+ SearchPlaceIndexForSuggestionsRequest.add_member(:filter_countries, Shapes::ShapeRef.new(shape: CountryCodeList, location_name: "FilterCountries"))
933
+ SearchPlaceIndexForSuggestionsRequest.add_member(:index_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "IndexName"))
934
+ SearchPlaceIndexForSuggestionsRequest.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
935
+ SearchPlaceIndexForSuggestionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchPlaceIndexForSuggestionsRequestMaxResultsInteger, location_name: "MaxResults"))
936
+ SearchPlaceIndexForSuggestionsRequest.add_member(:text, Shapes::ShapeRef.new(shape: SyntheticSearchPlaceIndexForSuggestionsRequestString, required: true, location_name: "Text"))
937
+ SearchPlaceIndexForSuggestionsRequest.struct_class = Types::SearchPlaceIndexForSuggestionsRequest
938
+
939
+ SearchPlaceIndexForSuggestionsResponse.add_member(:results, Shapes::ShapeRef.new(shape: SearchForSuggestionsResultList, required: true, location_name: "Results"))
940
+ SearchPlaceIndexForSuggestionsResponse.add_member(:summary, Shapes::ShapeRef.new(shape: SearchPlaceIndexForSuggestionsSummary, required: true, location_name: "Summary"))
941
+ SearchPlaceIndexForSuggestionsResponse.struct_class = Types::SearchPlaceIndexForSuggestionsResponse
942
+
943
+ SearchPlaceIndexForSuggestionsSummary.add_member(:bias_position, Shapes::ShapeRef.new(shape: Position, location_name: "BiasPosition"))
944
+ SearchPlaceIndexForSuggestionsSummary.add_member(:data_source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataSource"))
945
+ SearchPlaceIndexForSuggestionsSummary.add_member(:filter_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "FilterBBox"))
946
+ SearchPlaceIndexForSuggestionsSummary.add_member(:filter_countries, Shapes::ShapeRef.new(shape: CountryCodeList, location_name: "FilterCountries"))
947
+ SearchPlaceIndexForSuggestionsSummary.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
948
+ SearchPlaceIndexForSuggestionsSummary.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxResults"))
949
+ SearchPlaceIndexForSuggestionsSummary.add_member(:text, Shapes::ShapeRef.new(shape: SyntheticSearchPlaceIndexForSuggestionsSummaryString, required: true, location_name: "Text"))
950
+ SearchPlaceIndexForSuggestionsSummary.struct_class = Types::SearchPlaceIndexForSuggestionsSummary
951
+
898
952
  SearchPlaceIndexForTextRequest.add_member(:bias_position, Shapes::ShapeRef.new(shape: Position, location_name: "BiasPosition"))
899
953
  SearchPlaceIndexForTextRequest.add_member(:filter_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "FilterBBox"))
900
954
  SearchPlaceIndexForTextRequest.add_member(:filter_countries, Shapes::ShapeRef.new(shape: CountryCodeList, location_name: "FilterCountries"))
@@ -1768,6 +1822,22 @@ module Aws::LocationService
1768
1822
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1769
1823
  end)
1770
1824
 
1825
+ api.add_operation(:search_place_index_for_suggestions, Seahorse::Model::Operation.new.tap do |o|
1826
+ o.name = "SearchPlaceIndexForSuggestions"
1827
+ o.http_method = "POST"
1828
+ o.http_request_uri = "/places/v0/indexes/{IndexName}/search/suggestions"
1829
+ o.endpoint_pattern = {
1830
+ "hostPrefix" => "places.",
1831
+ }
1832
+ o.input = Shapes::ShapeRef.new(shape: SearchPlaceIndexForSuggestionsRequest)
1833
+ o.output = Shapes::ShapeRef.new(shape: SearchPlaceIndexForSuggestionsResponse)
1834
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1835
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1836
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1837
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1838
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1839
+ end)
1840
+
1771
1841
  api.add_operation(:search_place_index_for_text, Seahorse::Model::Operation.new.tap do |o|
1772
1842
  o.name = "SearchPlaceIndexForText"
1773
1843
  o.http_method = "POST"
@@ -219,8 +219,14 @@ module Aws::LocationService
219
219
  # collection_name: "ResourceName", # required
220
220
  # device_position_updates: [ # required
221
221
  # {
222
+ # accuracy: {
223
+ # horizontal: 1.0, # required
224
+ # },
222
225
  # device_id: "Id", # required
223
226
  # position: [1.0], # required
227
+ # position_properties: {
228
+ # "PropertyMapKeyString" => "PropertyMapValueString",
229
+ # },
224
230
  # sample_time: Time.now, # required
225
231
  # },
226
232
  # ],
@@ -536,8 +542,14 @@ module Aws::LocationService
536
542
  # tracker_name: "ResourceName", # required
537
543
  # updates: [ # required
538
544
  # {
545
+ # accuracy: {
546
+ # horizontal: 1.0, # required
547
+ # },
539
548
  # device_id: "Id", # required
540
549
  # position: [1.0], # required
550
+ # position_properties: {
551
+ # "PropertyMapKeyString" => "PropertyMapValueString",
552
+ # },
541
553
  # sample_time: Time.now, # required
542
554
  # },
543
555
  # ],
@@ -1622,6 +1634,16 @@ module Aws::LocationService
1622
1634
  # through. Distance-based filtering can also reduce the effects of
1623
1635
  # GPS noise when displaying device trajectories on a map.
1624
1636
  #
1637
+ # * `AccuracyBased` - If the device has moved less than the measured
1638
+ # accuracy, location updates are ignored. For example, if two
1639
+ # consecutive updates from a device have a horizontal accuracy of 5
1640
+ # m and 10 m, the second update is ignored if the device has moved
1641
+ # less than 15 m. Ignored location updates are neither evaluated
1642
+ # against linked geofence collections, nor stored. This can reduce
1643
+ # the effects of GPS noise when displaying device trajectories on a
1644
+ # map, and can help control your costs by reducing the number of
1645
+ # geofence evaluations.
1646
+ #
1625
1647
  # This field is optional. If not specified, the default value is
1626
1648
  # `TimeBased`.
1627
1649
  # @return [String]
@@ -2419,6 +2441,10 @@ module Aws::LocationService
2419
2441
 
2420
2442
  # Contains the device position details.
2421
2443
  #
2444
+ # @!attribute [rw] accuracy
2445
+ # The accuracy of the device position.
2446
+ # @return [Types::PositionalAccuracy]
2447
+ #
2422
2448
  # @!attribute [rw] device_id
2423
2449
  # The device whose position you retrieved.
2424
2450
  # @return [String]
@@ -2427,6 +2453,10 @@ module Aws::LocationService
2427
2453
  # The last known device position.
2428
2454
  # @return [Array<Float>]
2429
2455
  #
2456
+ # @!attribute [rw] position_properties
2457
+ # The properties associated with the position.
2458
+ # @return [Hash<String,String>]
2459
+ #
2430
2460
  # @!attribute [rw] received_time
2431
2461
  # The timestamp for when the tracker resource received the device
2432
2462
  # position in [ ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2448,11 +2478,13 @@ module Aws::LocationService
2448
2478
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePosition AWS API Documentation
2449
2479
  #
2450
2480
  class DevicePosition < Struct.new(
2481
+ :accuracy,
2451
2482
  :device_id,
2452
2483
  :position,
2484
+ :position_properties,
2453
2485
  :received_time,
2454
2486
  :sample_time)
2455
- SENSITIVE = [:position]
2487
+ SENSITIVE = [:position, :position_properties]
2456
2488
  include Aws::Structure
2457
2489
  end
2458
2490
 
@@ -2462,11 +2494,21 @@ module Aws::LocationService
2462
2494
  # data as a hash:
2463
2495
  #
2464
2496
  # {
2497
+ # accuracy: {
2498
+ # horizontal: 1.0, # required
2499
+ # },
2465
2500
  # device_id: "Id", # required
2466
2501
  # position: [1.0], # required
2502
+ # position_properties: {
2503
+ # "PropertyMapKeyString" => "PropertyMapValueString",
2504
+ # },
2467
2505
  # sample_time: Time.now, # required
2468
2506
  # }
2469
2507
  #
2508
+ # @!attribute [rw] accuracy
2509
+ # The accuracy of the device position.
2510
+ # @return [Types::PositionalAccuracy]
2511
+ #
2470
2512
  # @!attribute [rw] device_id
2471
2513
  # The device associated to the position update.
2472
2514
  # @return [String]
@@ -2480,6 +2522,14 @@ module Aws::LocationService
2480
2522
  # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
2481
2523
  # @return [Array<Float>]
2482
2524
  #
2525
+ # @!attribute [rw] position_properties
2526
+ # Associates one of more properties with the position update. A
2527
+ # property is a key-value pair stored with the position update and
2528
+ # added to any geofence event the update may trigger.
2529
+ #
2530
+ # Format: `"key" : "value"`
2531
+ # @return [Hash<String,String>]
2532
+ #
2483
2533
  # @!attribute [rw] sample_time
2484
2534
  # The timestamp at which the device's position was determined. Uses
2485
2535
  # [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`
@@ -2492,10 +2542,12 @@ module Aws::LocationService
2492
2542
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DevicePositionUpdate AWS API Documentation
2493
2543
  #
2494
2544
  class DevicePositionUpdate < Struct.new(
2545
+ :accuracy,
2495
2546
  :device_id,
2496
2547
  :position,
2548
+ :position_properties,
2497
2549
  :sample_time)
2498
- SENSITIVE = [:position]
2550
+ SENSITIVE = [:position, :position_properties]
2499
2551
  include Aws::Structure
2500
2552
  end
2501
2553
 
@@ -2696,6 +2748,10 @@ module Aws::LocationService
2696
2748
  include Aws::Structure
2697
2749
  end
2698
2750
 
2751
+ # @!attribute [rw] accuracy
2752
+ # The accuracy of the device position.
2753
+ # @return [Types::PositionalAccuracy]
2754
+ #
2699
2755
  # @!attribute [rw] device_id
2700
2756
  # The device whose position you retrieved.
2701
2757
  # @return [String]
@@ -2704,6 +2760,10 @@ module Aws::LocationService
2704
2760
  # The last known device position.
2705
2761
  # @return [Array<Float>]
2706
2762
  #
2763
+ # @!attribute [rw] position_properties
2764
+ # The properties associated with the position.
2765
+ # @return [Hash<String,String>]
2766
+ #
2707
2767
  # @!attribute [rw] received_time
2708
2768
  # The timestamp for when the tracker resource received the device
2709
2769
  # position in [ ISO 8601 ][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -2725,11 +2785,13 @@ module Aws::LocationService
2725
2785
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetDevicePositionResponse AWS API Documentation
2726
2786
  #
2727
2787
  class GetDevicePositionResponse < Struct.new(
2788
+ :accuracy,
2728
2789
  :device_id,
2729
2790
  :position,
2791
+ :position_properties,
2730
2792
  :received_time,
2731
2793
  :sample_time)
2732
- SENSITIVE = [:position]
2794
+ SENSITIVE = [:position, :position_properties]
2733
2795
  include Aws::Structure
2734
2796
  end
2735
2797
 
@@ -3232,6 +3294,10 @@ module Aws::LocationService
3232
3294
 
3233
3295
  # Contains the tracker resource details.
3234
3296
  #
3297
+ # @!attribute [rw] accuracy
3298
+ # The accuracy of the device position.
3299
+ # @return [Types::PositionalAccuracy]
3300
+ #
3235
3301
  # @!attribute [rw] device_id
3236
3302
  # The ID of the device for this position.
3237
3303
  # @return [String]
@@ -3241,6 +3307,10 @@ module Aws::LocationService
3241
3307
  # stored.
3242
3308
  # @return [Array<Float>]
3243
3309
  #
3310
+ # @!attribute [rw] position_properties
3311
+ # The properties associated with the position.
3312
+ # @return [Hash<String,String>]
3313
+ #
3244
3314
  # @!attribute [rw] sample_time
3245
3315
  # The timestamp at which the device position was determined. Uses [
3246
3316
  # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
@@ -3253,10 +3323,12 @@ module Aws::LocationService
3253
3323
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositionsResponseEntry AWS API Documentation
3254
3324
  #
3255
3325
  class ListDevicePositionsResponseEntry < Struct.new(
3326
+ :accuracy,
3256
3327
  :device_id,
3257
3328
  :position,
3329
+ :position_properties,
3258
3330
  :sample_time)
3259
- SENSITIVE = [:position]
3331
+ SENSITIVE = [:position, :position_properties]
3260
3332
  include Aws::Structure
3261
3333
  end
3262
3334
 
@@ -4215,6 +4287,28 @@ module Aws::LocationService
4215
4287
  include Aws::Structure
4216
4288
  end
4217
4289
 
4290
+ # Defines the level of certainty of the position.
4291
+ #
4292
+ # @note When making an API call, you may pass PositionalAccuracy
4293
+ # data as a hash:
4294
+ #
4295
+ # {
4296
+ # horizontal: 1.0, # required
4297
+ # }
4298
+ #
4299
+ # @!attribute [rw] horizontal
4300
+ # Estimated maximum distance, in meters, between the measured position
4301
+ # and the true position of a device, along the Earth's surface.
4302
+ # @return [Float]
4303
+ #
4304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/PositionalAccuracy AWS API Documentation
4305
+ #
4306
+ class PositionalAccuracy < Struct.new(
4307
+ :horizontal)
4308
+ SENSITIVE = []
4309
+ include Aws::Structure
4310
+ end
4311
+
4218
4312
  # @note When making an API call, you may pass PutGeofenceRequest
4219
4313
  # data as a hash:
4220
4314
  #
@@ -4332,6 +4426,22 @@ module Aws::LocationService
4332
4426
  include Aws::Structure
4333
4427
  end
4334
4428
 
4429
+ # Contains a place suggestion resulting from a place suggestion query
4430
+ # that is run on a place index resource.
4431
+ #
4432
+ # @!attribute [rw] text
4433
+ # The text of the place suggestion, typically formatted as an address
4434
+ # string.
4435
+ # @return [String]
4436
+ #
4437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchForSuggestionsResult AWS API Documentation
4438
+ #
4439
+ class SearchForSuggestionsResult < Struct.new(
4440
+ :text)
4441
+ SENSITIVE = []
4442
+ include Aws::Structure
4443
+ end
4444
+
4335
4445
  # Contains a search result from a text search query that is run on a
4336
4446
  # place index resource.
4337
4447
  #
@@ -4496,6 +4606,210 @@ module Aws::LocationService
4496
4606
  include Aws::Structure
4497
4607
  end
4498
4608
 
4609
+ # @note When making an API call, you may pass SearchPlaceIndexForSuggestionsRequest
4610
+ # data as a hash:
4611
+ #
4612
+ # {
4613
+ # bias_position: [1.0],
4614
+ # filter_b_box: [1.0],
4615
+ # filter_countries: ["CountryCode"],
4616
+ # index_name: "ResourceName", # required
4617
+ # language: "LanguageTag",
4618
+ # max_results: 1,
4619
+ # text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
4620
+ # }
4621
+ #
4622
+ # @!attribute [rw] bias_position
4623
+ # An optional parameter that indicates a preference for place
4624
+ # suggestions that are closer to a specified position.
4625
+ #
4626
+ # If provided, this parameter must contain a pair of numbers. The
4627
+ # first number represents the X coordinate, or longitude; the second
4628
+ # number represents the Y coordinate, or latitude.
4629
+ #
4630
+ # For example, `[-123.1174, 49.2847]` represents the position with
4631
+ # longitude `-123.1174` and latitude `49.2847`.
4632
+ #
4633
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
4634
+ # both options results in an error.
4635
+ #
4636
+ # </note>
4637
+ # @return [Array<Float>]
4638
+ #
4639
+ # @!attribute [rw] filter_b_box
4640
+ # An optional parameter that limits the search results by returning
4641
+ # only suggestions within a specified bounding box.
4642
+ #
4643
+ # If provided, this parameter must contain a total of four consecutive
4644
+ # numbers in two pairs. The first pair of numbers represents the X and
4645
+ # Y coordinates (longitude and latitude, respectively) of the
4646
+ # southwest corner of the bounding box; the second pair of numbers
4647
+ # represents the X and Y coordinates (longitude and latitude,
4648
+ # respectively) of the northeast corner of the bounding box.
4649
+ #
4650
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
4651
+ # bounding box where the southwest corner has longitude `-12.7935` and
4652
+ # latitude `-37.4835`, and the northeast corner has longitude
4653
+ # `-12.0684` and latitude `-36.9542`.
4654
+ #
4655
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
4656
+ # both options results in an error.
4657
+ #
4658
+ # </note>
4659
+ # @return [Array<Float>]
4660
+ #
4661
+ # @!attribute [rw] filter_countries
4662
+ # An optional parameter that limits the search results by returning
4663
+ # only suggestions within the provided list of countries.
4664
+ #
4665
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
4666
+ # uses three upper-case characters: `AUS`.
4667
+ #
4668
+ # ^
4669
+ #
4670
+ #
4671
+ #
4672
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
4673
+ # @return [Array<String>]
4674
+ #
4675
+ # @!attribute [rw] index_name
4676
+ # The name of the place index resource you want to use for the search.
4677
+ # @return [String]
4678
+ #
4679
+ # @!attribute [rw] language
4680
+ # The preferred language used to return results. The value must be a
4681
+ # valid [BCP 47][1] language tag, for example, `en` for English.
4682
+ #
4683
+ # This setting affects the languages used in the results. It does not
4684
+ # change which results are returned. If the language is not specified,
4685
+ # or not supported for a particular result, the partner automatically
4686
+ # chooses a language for the result.
4687
+ #
4688
+ # Used only when the partner selected is Here.
4689
+ #
4690
+ #
4691
+ #
4692
+ # [1]: https://tools.ietf.org/search/bcp47
4693
+ # @return [String]
4694
+ #
4695
+ # @!attribute [rw] max_results
4696
+ # An optional parameter. The maximum number of results returned per
4697
+ # request.
4698
+ #
4699
+ # The default: `5`
4700
+ # @return [Integer]
4701
+ #
4702
+ # @!attribute [rw] text
4703
+ # The free-form partial text to use to generate place suggestions. For
4704
+ # example, `eiffel tow`.
4705
+ # @return [String]
4706
+ #
4707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsRequest AWS API Documentation
4708
+ #
4709
+ class SearchPlaceIndexForSuggestionsRequest < Struct.new(
4710
+ :bias_position,
4711
+ :filter_b_box,
4712
+ :filter_countries,
4713
+ :index_name,
4714
+ :language,
4715
+ :max_results,
4716
+ :text)
4717
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
4718
+ include Aws::Structure
4719
+ end
4720
+
4721
+ # @!attribute [rw] results
4722
+ # A list of place suggestions that best match the search text.
4723
+ # @return [Array<Types::SearchForSuggestionsResult>]
4724
+ #
4725
+ # @!attribute [rw] summary
4726
+ # Contains a summary of the request. Echoes the input values for
4727
+ # `BiasPosition`, `FilterBBox`, `FilterCountries`, `Language`,
4728
+ # `MaxResults`, and `Text`. Also includes the `DataSource` of the
4729
+ # place index.
4730
+ # @return [Types::SearchPlaceIndexForSuggestionsSummary]
4731
+ #
4732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsResponse AWS API Documentation
4733
+ #
4734
+ class SearchPlaceIndexForSuggestionsResponse < Struct.new(
4735
+ :results,
4736
+ :summary)
4737
+ SENSITIVE = []
4738
+ include Aws::Structure
4739
+ end
4740
+
4741
+ # A summary of the request sent by using
4742
+ # `SearchPlaceIndexForSuggestions`.
4743
+ #
4744
+ # @!attribute [rw] bias_position
4745
+ # Contains the coordinates for the optional bias position specified in
4746
+ # the request.
4747
+ #
4748
+ # This parameter contains a pair of numbers. The first number
4749
+ # represents the X coordinate, or longitude; the second number
4750
+ # represents the Y coordinate, or latitude.
4751
+ #
4752
+ # For example, `[-123.1174, 49.2847]` represents the position with
4753
+ # longitude `-123.1174` and latitude `49.2847`.
4754
+ # @return [Array<Float>]
4755
+ #
4756
+ # @!attribute [rw] data_source
4757
+ # The geospatial data provider attached to the place index resource
4758
+ # specified in the request. Values can be one of the following:
4759
+ #
4760
+ # * Esri
4761
+ #
4762
+ # * Here
4763
+ #
4764
+ # For more information about data providers, see [Amazon Location
4765
+ # Service data providers][1].
4766
+ #
4767
+ #
4768
+ #
4769
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
4770
+ # @return [String]
4771
+ #
4772
+ # @!attribute [rw] filter_b_box
4773
+ # Contains the coordinates for the optional bounding box specified in
4774
+ # the request.
4775
+ # @return [Array<Float>]
4776
+ #
4777
+ # @!attribute [rw] filter_countries
4778
+ # Contains the optional country filter specified in the request.
4779
+ # @return [Array<String>]
4780
+ #
4781
+ # @!attribute [rw] language
4782
+ # The preferred language used to return results. Matches the language
4783
+ # in the request. The value is a valid [BCP 47][1] language tag, for
4784
+ # example, `en` for English.
4785
+ #
4786
+ #
4787
+ #
4788
+ # [1]: https://tools.ietf.org/search/bcp47
4789
+ # @return [String]
4790
+ #
4791
+ # @!attribute [rw] max_results
4792
+ # Contains the optional result count limit specified in the request.
4793
+ # @return [Integer]
4794
+ #
4795
+ # @!attribute [rw] text
4796
+ # The free-form partial text input specified in the request.
4797
+ # @return [String]
4798
+ #
4799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestionsSummary AWS API Documentation
4800
+ #
4801
+ class SearchPlaceIndexForSuggestionsSummary < Struct.new(
4802
+ :bias_position,
4803
+ :data_source,
4804
+ :filter_b_box,
4805
+ :filter_countries,
4806
+ :language,
4807
+ :max_results,
4808
+ :text)
4809
+ SENSITIVE = [:bias_position, :filter_b_box, :text]
4810
+ include Aws::Structure
4811
+ end
4812
+
4499
4813
  # @note When making an API call, you may pass SearchPlaceIndexForTextRequest
4500
4814
  # data as a hash:
4501
4815
  #
@@ -4633,6 +4947,13 @@ module Aws::LocationService
4633
4947
  # @!attribute [rw] bias_position
4634
4948
  # Contains the coordinates for the optional bias position specified in
4635
4949
  # the request.
4950
+ #
4951
+ # This parameter contains a pair of numbers. The first number
4952
+ # represents the X coordinate, or longitude; the second number
4953
+ # represents the Y coordinate, or latitude.
4954
+ #
4955
+ # For example, `[-123.1174, 49.2847]` represents the position with
4956
+ # longitude `-123.1174` and latitude `49.2847`.
4636
4957
  # @return [Array<Float>]
4637
4958
  #
4638
4959
  # @!attribute [rw] data_source
@@ -5337,9 +5658,19 @@ module Aws::LocationService
5337
5658
  # ft), location updates are ignored. Location updates within this
5338
5659
  # distance are neither evaluated against linked geofence
5339
5660
  # collections, nor stored. This helps control costs by reducing the
5340
- # number of geofence evaluations and device positions to retrieve.
5341
- # Distance-based filtering can also reduce the jitter effect when
5342
- # displaying device trajectory on a map.
5661
+ # number of geofence evaluations and historical device positions to
5662
+ # paginate through. Distance-based filtering can also reduce the
5663
+ # effects of GPS noise when displaying device trajectories on a map.
5664
+ #
5665
+ # * `AccuracyBased` - If the device has moved less than the measured
5666
+ # accuracy, location updates are ignored. For example, if two
5667
+ # consecutive updates from a device have a horizontal accuracy of 5
5668
+ # m and 10 m, the second update is ignored if the device has moved
5669
+ # less than 15 m. Ignored location updates are neither evaluated
5670
+ # against linked geofence collections, nor stored. This helps educe
5671
+ # the effects of GPS noise when displaying device trajectories on a
5672
+ # map, and can help control costs by reducing the number of geofence
5673
+ # evaluations.
5343
5674
  # @return [String]
5344
5675
  #
5345
5676
  # @!attribute [rw] pricing_plan
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-locationservice/customizations'
48
48
  # @!group service
49
49
  module Aws::LocationService
50
50
 
51
- GEM_VERSION = '1.13.0'
51
+ GEM_VERSION = '1.14.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-locationservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.13.0
4
+ version: 1.14.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-30 00:00:00.000000000 Z
11
+ date: 2021-12-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core