aws-sdk-locationservice 1.13.0 → 1.39.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.
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
- require 'aws-sdk-core/plugins/signature_v4.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/request_compression.rb'
32
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
33
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
34
+ require 'aws-sdk-core/plugins/sign.rb'
31
35
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
36
 
33
37
  Aws::Plugins::GlobalConfiguration.add_identifier(:locationservice)
@@ -73,8 +77,13 @@ module Aws::LocationService
73
77
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
78
  add_plugin(Aws::Plugins::TransferEncoding)
75
79
  add_plugin(Aws::Plugins::HttpChecksum)
76
- add_plugin(Aws::Plugins::SignatureV4)
80
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
81
+ add_plugin(Aws::Plugins::RequestCompression)
82
+ add_plugin(Aws::Plugins::DefaultsMode)
83
+ add_plugin(Aws::Plugins::RecursionDetection)
84
+ add_plugin(Aws::Plugins::Sign)
77
85
  add_plugin(Aws::Plugins::Protocols::RestJson)
86
+ add_plugin(Aws::LocationService::Plugins::Endpoints)
78
87
 
79
88
  # @overload initialize(options)
80
89
  # @param [Hash] options
@@ -175,10 +184,18 @@ module Aws::LocationService
175
184
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
176
185
  # a clock skew correction and retry requests with skewed client clocks.
177
186
  #
187
+ # @option options [String] :defaults_mode ("legacy")
188
+ # See {Aws::DefaultsModeConfiguration} for a list of the
189
+ # accepted modes and the configuration defaults that are included.
190
+ #
178
191
  # @option options [Boolean] :disable_host_prefix_injection (false)
179
192
  # Set to true to disable SDK automatically adding host prefix
180
193
  # to default service endpoint when available.
181
194
  #
195
+ # @option options [Boolean] :disable_request_compression (false)
196
+ # When set to 'true' the request body will not be compressed
197
+ # for supported operations.
198
+ #
182
199
  # @option options [String] :endpoint
183
200
  # The client endpoint is normally constructed from the `:region`
184
201
  # option. You should only configure an `:endpoint` when connecting
@@ -199,6 +216,10 @@ module Aws::LocationService
199
216
  # @option options [Boolean] :endpoint_discovery (false)
200
217
  # When set to `true`, endpoint discovery will be enabled for operations when available.
201
218
  #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
202
223
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
203
224
  # The log formatter.
204
225
  #
@@ -219,6 +240,11 @@ module Aws::LocationService
219
240
  # Used when loading credentials from the shared credentials file
220
241
  # at HOME/.aws/credentials. When not specified, 'default' is used.
221
242
  #
243
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
244
+ # The minimum size in bytes that triggers compression for request
245
+ # bodies. The value must be non-negative integer value between 0
246
+ # and 10485780 bytes inclusive.
247
+ #
222
248
  # @option options [Proc] :retry_backoff
223
249
  # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
224
250
  # This option is only used in the `legacy` retry mode.
@@ -264,6 +290,11 @@ module Aws::LocationService
264
290
  # in the future.
265
291
  #
266
292
  #
293
+ # @option options [String] :sdk_ua_app_id
294
+ # A unique and opaque application ID that is appended to the
295
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
296
+ # maximum length of 50.
297
+ #
267
298
  # @option options [String] :secret_access_key
268
299
  #
269
300
  # @option options [String] :session_token
@@ -277,6 +308,19 @@ module Aws::LocationService
277
308
  # ** Please note ** When response stubbing is enabled, no HTTP
278
309
  # requests are made, and retries are disabled.
279
310
  #
311
+ # @option options [Aws::TokenProvider] :token_provider
312
+ # A Bearer Token Provider. This can be an instance of any one of the
313
+ # following classes:
314
+ #
315
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
316
+ # tokens.
317
+ #
318
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
319
+ # access token generated from `aws login`.
320
+ #
321
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
322
+ # will be used to search for tokens configured for your profile in shared configuration files.
323
+ #
280
324
  # @option options [Boolean] :use_dualstack_endpoint
281
325
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
282
326
  # will be used if available.
@@ -290,6 +334,9 @@ module Aws::LocationService
290
334
  # When `true`, request parameters are validated before
291
335
  # sending the request.
292
336
  #
337
+ # @option options [Aws::LocationService::EndpointProvider] :endpoint_provider
338
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LocationService::EndpointParameters`
339
+ #
293
340
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
294
341
  # requests through. Formatted like 'http://proxy.com:123'.
295
342
  #
@@ -297,7 +344,7 @@ module Aws::LocationService
297
344
  # seconds to wait when opening a HTTP session before raising a
298
345
  # `Timeout::Error`.
299
346
  #
300
- # @option options [Integer] :http_read_timeout (60) The default
347
+ # @option options [Float] :http_read_timeout (60) The default
301
348
  # number of seconds to wait for response data. This value can
302
349
  # safely be set per-request on the session.
303
350
  #
@@ -313,6 +360,9 @@ module Aws::LocationService
313
360
  # disables this behaviour. This value can safely be set per
314
361
  # request on the session.
315
362
  #
363
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
+ # in seconds.
365
+ #
316
366
  # @option options [Boolean] :http_wire_trace (false) When `true`,
317
367
  # HTTP debug output will be sent to the `:logger`.
318
368
  #
@@ -354,7 +404,7 @@ module Aws::LocationService
354
404
  # @option params [required, String] :consumer_arn
355
405
  # The Amazon Resource Name (ARN) for the geofence collection to be
356
406
  # associated to tracker resource. Used when you need to specify a
357
- # resource across all AWS.
407
+ # resource across all Amazon Web Services.
358
408
  #
359
409
  # * Format example:
360
410
  # `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
@@ -482,6 +532,16 @@ module Aws::LocationService
482
532
  #
483
533
  # </note>
484
534
  #
535
+ # <note markdown="1"> Geofence evaluation uses the given device position. It does not
536
+ # account for the optional `Accuracy` of a `DevicePositionUpdate`.
537
+ #
538
+ # </note>
539
+ #
540
+ # <note markdown="1"> The `DeviceID` is used as a string to represent the device. You do not
541
+ # need to have a `Tracker` associated with the `DeviceID`.
542
+ #
543
+ # </note>
544
+ #
485
545
  # @option params [required, String] :collection_name
486
546
  # The geofence collection used in evaluating the position of devices
487
547
  # against its geofences.
@@ -500,8 +560,14 @@ module Aws::LocationService
500
560
  # collection_name: "ResourceName", # required
501
561
  # device_position_updates: [ # required
502
562
  # {
563
+ # accuracy: {
564
+ # horizontal: 1.0, # required
565
+ # },
503
566
  # device_id: "Id", # required
504
567
  # position: [1.0], # required
568
+ # position_properties: {
569
+ # "PropertyMapKeyString" => "PropertyMapValueString",
570
+ # },
505
571
  # sample_time: Time.now, # required
506
572
  # },
507
573
  # ],
@@ -552,9 +618,12 @@ module Aws::LocationService
552
618
  # @example Response structure
553
619
  #
554
620
  # resp.device_positions #=> Array
621
+ # resp.device_positions[0].accuracy.horizontal #=> Float
555
622
  # resp.device_positions[0].device_id #=> String
556
623
  # resp.device_positions[0].position #=> Array
557
624
  # resp.device_positions[0].position[0] #=> Float
625
+ # resp.device_positions[0].position_properties #=> Hash
626
+ # resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
558
627
  # resp.device_positions[0].received_time #=> Time
559
628
  # resp.device_positions[0].sample_time #=> Time
560
629
  # resp.errors #=> Array
@@ -593,7 +662,14 @@ module Aws::LocationService
593
662
  # entries: [ # required
594
663
  # {
595
664
  # geofence_id: "Id", # required
665
+ # geofence_properties: {
666
+ # "PropertyMapKeyString" => "PropertyMapValueString",
667
+ # },
596
668
  # geometry: { # required
669
+ # circle: {
670
+ # center: [1.0], # required
671
+ # radius: 1.0, # required
672
+ # },
597
673
  # polygon: [
598
674
  # [
599
675
  # [1.0],
@@ -625,9 +701,9 @@ module Aws::LocationService
625
701
  end
626
702
 
627
703
  # Uploads position update data for one or more devices to a tracker
628
- # resource. Amazon Location uses the data when it reports the last known
629
- # device position and position history. Amazon Location retains location
630
- # data for 30 days.
704
+ # resource (up to 10 devices per batch). Amazon Location uses the data
705
+ # when it reports the last known device position and position history.
706
+ # Amazon Location retains location data for 30 days.
631
707
  #
632
708
  # <note markdown="1"> Position updates are handled based on the `PositionFiltering` property
633
709
  # of the tracker. When `PositionFiltering` is set to `TimeBased`,
@@ -635,10 +711,21 @@ module Aws::LocationService
635
711
  # location data is stored at a maximum of one position per 30 second
636
712
  # interval. If your update frequency is more often than every 30
637
713
  # 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).
714
+ # device ID.
715
+ #
716
+ # When `PositionFiltering` is set to `DistanceBased` filtering, location
717
+ # data is stored and evaluated against linked geofence collections only
718
+ # if the device has moved more than 30 m (98.4 ft).
719
+ #
720
+ # When `PositionFiltering` is set to `AccuracyBased` filtering, location
721
+ # data is stored and evaluated against linked geofence collections only
722
+ # if the device has moved more than the measured accuracy. For example,
723
+ # if two consecutive updates from a device have a horizontal accuracy of
724
+ # 5 m and 10 m, the second update is neither stored or evaluated if the
725
+ # device has moved less than 15 m. If `PositionFiltering` is set to
726
+ # `AccuracyBased` filtering, Amazon Location uses the default value `\{
727
+ # "Horizontal": 0\}` when accuracy is not provided on a
728
+ # `DevicePositionUpdate`.
642
729
  #
643
730
  # </note>
644
731
  #
@@ -646,7 +733,8 @@ module Aws::LocationService
646
733
  # The name of the tracker resource to update.
647
734
  #
648
735
  # @option params [required, Array<Types::DevicePositionUpdate>] :updates
649
- # Contains the position update details for each device.
736
+ # Contains the position update details for each device, up to 10
737
+ # devices.
650
738
  #
651
739
  # @return [Types::BatchUpdateDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
652
740
  #
@@ -658,8 +746,14 @@ module Aws::LocationService
658
746
  # tracker_name: "ResourceName", # required
659
747
  # updates: [ # required
660
748
  # {
749
+ # accuracy: {
750
+ # horizontal: 1.0, # required
751
+ # },
661
752
  # device_id: "Id", # required
662
753
  # position: [1.0], # required
754
+ # position_properties: {
755
+ # "PropertyMapKeyString" => "PropertyMapValueString",
756
+ # },
663
757
  # sample_time: Time.now, # required
664
758
  # },
665
759
  # ],
@@ -683,7 +777,7 @@ module Aws::LocationService
683
777
  end
684
778
 
685
779
  # [Calculates a route][1] given the following required parameters:
686
- # `DeparturePostiton` and `DestinationPosition`. Requires that you first
780
+ # `DeparturePosition` and `DestinationPosition`. Requires that you first
687
781
  # [create a route calculator resource][2].
688
782
  #
689
783
  # By default, a request that doesn't specify a departure time uses the
@@ -693,27 +787,30 @@ module Aws::LocationService
693
787
  # Additional options include:
694
788
  #
695
789
  # * [Specifying a departure time][3] using either `DepartureTime` or
696
- # `DepartureNow`. This calculates a route based on predictive traffic
790
+ # `DepartNow`. This calculates a route based on predictive traffic
697
791
  # data at the given time.
698
792
  #
699
- # <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
700
- # single request. Specifying both parameters returns a validation
701
- # error.
793
+ # <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
794
+ # request. Specifying both parameters returns a validation error.
702
795
  #
703
796
  # </note>
704
797
  #
705
- # * [Specifying a travel mode][4] using TravelMode. This lets you
706
- # specify an additional route preference such as `CarModeOptions` if
798
+ # * [Specifying a travel mode][4] using TravelMode sets the
799
+ # transportation mode used to calculate the routes. This also lets you
800
+ # specify additional route preferences in `CarModeOptions` if
707
801
  # traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
708
802
  #
803
+ # <note markdown="1"> If you specify `walking` for the travel mode and your data provider
804
+ # is Esri, the start and destination must be within 40km.
709
805
  #
806
+ # </note>
710
807
  #
711
808
  #
712
809
  #
713
810
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
714
811
  # [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
715
- # [3]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time
716
- # [4]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode
812
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
813
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
717
814
  #
718
815
  # @option params [required, String] :calculator_name
719
816
  # The name of the route calculator resource that you want to use to
@@ -735,8 +832,8 @@ module Aws::LocationService
735
832
  # Valid Values: `false` \| `true`
736
833
  #
737
834
  # @option params [required, Array<Float>] :departure_position
738
- # The start position for the route. Defined in [WGS 84][1] format:
739
- # `[longitude, latitude]`.
835
+ # The start position for the route. Defined in [World Geodetic System
836
+ # (WGS 84)][1] format: `[longitude, latitude]`.
740
837
  #
741
838
  # * For example, `[-123.115, 49.285]`
742
839
  #
@@ -753,8 +850,8 @@ module Aws::LocationService
753
850
  #
754
851
  #
755
852
  #
756
- # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
757
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
853
+ # [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84
854
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
758
855
  #
759
856
  # @option params [Time,DateTime,Date,Integer,String] :departure_time
760
857
  # Specifies the desired time of departure. Uses the given time to
@@ -776,8 +873,8 @@ module Aws::LocationService
776
873
  # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
777
874
  #
778
875
  # @option params [required, Array<Float>] :destination_position
779
- # The finish position for the route. Defined in [WGS 84][1] format:
780
- # `[longitude, latitude]`.
876
+ # The finish position for the route. Defined in [World Geodetic System
877
+ # (WGS 84)][1] format: `[longitude, latitude]`.
781
878
  #
782
879
  # * For example, `[-122.339, 47.615]`
783
880
  #
@@ -792,8 +889,8 @@ module Aws::LocationService
792
889
  #
793
890
  #
794
891
  #
795
- # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
796
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
892
+ # [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84
893
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
797
894
  #
798
895
  # @option params [String] :distance_unit
799
896
  # Set the unit system to specify the distance.
@@ -808,11 +905,31 @@ module Aws::LocationService
808
905
  #
809
906
  # Valid Values: `false` \| `true`
810
907
  #
908
+ # @option params [String] :key
909
+ # The optional [API key][1] to authorize the request.
910
+ #
911
+ #
912
+ #
913
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
914
+ #
811
915
  # @option params [String] :travel_mode
812
916
  # Specifies the mode of transport when calculating a route. Used in
813
- # estimating the speed of travel and road compatibility.
917
+ # estimating the speed of travel and road compatibility. You can choose
918
+ # `Car`, `Truck`, `Walking`, `Bicycle` or `Motorcycle` as options for
919
+ # the `TravelMode`.
920
+ #
921
+ # <note markdown="1"> `Bicycle` and `Motorcycle` are only valid when using Grab as a data
922
+ # provider, and only within Southeast Asia.
923
+ #
924
+ # `Truck` is not available for Grab.
925
+ #
926
+ # For more details on the using Grab for routing, including areas of
927
+ # coverage, see [GrabMaps][1] in the *Amazon Location Service Developer
928
+ # Guide*.
814
929
  #
815
- # The `TravelMode` you specify determines how you specify route
930
+ # </note>
931
+ #
932
+ # The `TravelMode` you specify also determines how you specify route
816
933
  # preferences:
817
934
  #
818
935
  # * If traveling by `Car` use the `CarModeOptions` parameter.
@@ -821,6 +938,10 @@ module Aws::LocationService
821
938
  #
822
939
  # Default Value: `Car`
823
940
  #
941
+ #
942
+ #
943
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
944
+ #
824
945
  # @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
825
946
  # Specifies route preferences when traveling by `Truck`, such as
826
947
  # avoiding routes that use ferries or tolls, and truck specifications to
@@ -855,7 +976,7 @@ module Aws::LocationService
855
976
  #
856
977
  #
857
978
  #
858
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
979
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
859
980
  #
860
981
  # @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
861
982
  #
@@ -876,7 +997,8 @@ module Aws::LocationService
876
997
  # destination_position: [1.0], # required
877
998
  # distance_unit: "Kilometers", # accepts Kilometers, Miles
878
999
  # include_leg_geometry: false,
879
- # travel_mode: "Car", # accepts Car, Truck, Walking
1000
+ # key: "ApiKey",
1001
+ # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle
880
1002
  # truck_mode_options: {
881
1003
  # avoid_ferries: false,
882
1004
  # avoid_tolls: false,
@@ -932,65 +1054,289 @@ module Aws::LocationService
932
1054
  req.send_request(options)
933
1055
  end
934
1056
 
935
- # Creates a geofence collection, which manages and stores geofences.
1057
+ # [ Calculates a route matrix][1] given the following required
1058
+ # parameters: `DeparturePositions` and `DestinationPositions`.
1059
+ # `CalculateRouteMatrix` calculates routes and returns the travel time
1060
+ # and travel distance from each departure position to each destination
1061
+ # position in the request. For example, given departure positions A and
1062
+ # B, and destination positions X and Y, `CalculateRouteMatrix` will
1063
+ # return time and distance for routes from A to X, A to Y, B to X, and B
1064
+ # to Y (in that order). The number of results returned (and routes
1065
+ # calculated) will be the number of `DeparturePositions` times the
1066
+ # number of `DestinationPositions`.
1067
+ #
1068
+ # <note markdown="1"> Your account is charged for each route calculated, not the number of
1069
+ # requests.
936
1070
  #
937
- # @option params [required, String] :collection_name
938
- # A custom name for the geofence collection.
1071
+ # </note>
939
1072
  #
940
- # Requirements:
1073
+ # Requires that you first [create a route calculator resource][2].
941
1074
  #
942
- # * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
943
- # periods (.), and underscores (\_).
1075
+ # By default, a request that doesn't specify a departure time uses the
1076
+ # best time of day to travel with the best traffic conditions when
1077
+ # calculating routes.
944
1078
  #
945
- # * Must be a unique geofence collection name.
1079
+ # Additional options include:
946
1080
  #
947
- # * No spaces allowed. For example, `ExampleGeofenceCollection`.
1081
+ # * [ Specifying a departure time][3] using either `DepartureTime` or
1082
+ # `DepartNow`. This calculates routes based on predictive traffic data
1083
+ # at the given time.
948
1084
  #
949
- # @option params [String] :description
950
- # An optional description for the geofence collection.
1085
+ # <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
1086
+ # request. Specifying both parameters returns a validation error.
951
1087
  #
952
- # @option params [String] :kms_key_id
953
- # A key identifier for an [AWS KMS customer managed key][1]. Enter a key
954
- # ID, key ARN, alias name, or alias ARN.
1088
+ # </note>
1089
+ #
1090
+ # * [Specifying a travel mode][4] using TravelMode sets the
1091
+ # transportation mode used to calculate the routes. This also lets you
1092
+ # specify additional route preferences in `CarModeOptions` if
1093
+ # traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
955
1094
  #
956
1095
  #
957
1096
  #
958
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
1097
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html
1098
+ # [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
1099
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
1100
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
1101
+ #
1102
+ # @option params [required, String] :calculator_name
1103
+ # The name of the route calculator resource that you want to use to
1104
+ # calculate the route matrix.
959
1105
  #
960
- # @option params [required, String] :pricing_plan
961
- # Specifies the pricing plan for the geofence collection.
1106
+ # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
1107
+ # Specifies route preferences when traveling by `Car`, such as avoiding
1108
+ # routes that use ferries or tolls.
1109
+ #
1110
+ # Requirements: `TravelMode` must be specified as `Car`.
1111
+ #
1112
+ # @option params [Boolean] :depart_now
1113
+ # Sets the time of departure as the current time. Uses the current time
1114
+ # to calculate the route matrix. You can't set both `DepartureTime` and
1115
+ # `DepartNow`. If neither is set, the best time of day to travel with
1116
+ # the best traffic conditions is used to calculate the route matrix.
962
1117
  #
963
- # For additional details and restrictions on each pricing plan option,
964
- # see the [Amazon Location Service pricing page][1].
1118
+ # Default Value: `false`
1119
+ #
1120
+ # Valid Values: `false` \| `true`
965
1121
  #
1122
+ # @option params [required, Array<Array>] :departure_positions
1123
+ # The list of departure (origin) positions for the route matrix. An
1124
+ # array of points, each of which is itself a 2-value array defined in
1125
+ # [WGS 84][1] format: `[longitude, latitude]`. For example, `[-123.115,
1126
+ # 49.285]`.
966
1127
  #
1128
+ # Depending on the data provider selected in the route calculator
1129
+ # resource there may be additional restrictions on the inputs you can
1130
+ # choose. See [ Position restrictions][2] in the *Amazon Location
1131
+ # Service Developer Guide*.
967
1132
  #
968
- # [1]: https://aws.amazon.com/location/pricing/
1133
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
1134
+ # specify a departure that's not located on a road, Amazon Location [
1135
+ # moves the position to the nearest road][3]. The snapped value is
1136
+ # available in the result in `SnappedDeparturePositions`.
1137
+ #
1138
+ # </note>
1139
+ #
1140
+ # Valid Values: `[-180 to 180,-90 to 90]`
969
1141
  #
970
- # @option params [String] :pricing_plan_data_source
971
- # Specifies the data provider for the geofence collection.
972
1142
  #
973
- # * Required value for the following pricing plans: `MobileAssetTracking
974
- # `\| `MobileAssetManagement`
1143
+ #
1144
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
1145
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
1146
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
1147
+ #
1148
+ # @option params [Time,DateTime,Date,Integer,String] :departure_time
1149
+ # Specifies the desired time of departure. Uses the given time to
1150
+ # calculate the route matrix. You can't set both `DepartureTime` and
1151
+ # `DepartNow`. If neither is set, the best time of day to travel with
1152
+ # the best traffic conditions is used to calculate the route matrix.
1153
+ #
1154
+ # <note markdown="1"> Setting a departure time in the past returns a `400
1155
+ # ValidationException` error.
1156
+ #
1157
+ # </note>
1158
+ #
1159
+ # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
1160
+ # `2020–07-2T12:15:20.000Z+01:00`
975
1161
  #
976
1162
  # ^
977
1163
  #
978
- # For more information about [Data Providers][1], and [Pricing
979
- # plans][2], see the Amazon Location Service product page.
980
1164
  #
981
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
982
- # billing for your geofence collection. Your data won't be shared with
983
- # the data provider, and will remain in your AWS account or Region
984
- # unless you move it.
1165
+ #
1166
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1167
+ #
1168
+ # @option params [required, Array<Array>] :destination_positions
1169
+ # The list of destination positions for the route matrix. An array of
1170
+ # points, each of which is itself a 2-value array defined in [WGS 84][1]
1171
+ # format: `[longitude, latitude]`. For example, `[-122.339, 47.615]`
1172
+ #
1173
+ # Depending on the data provider selected in the route calculator
1174
+ # resource there may be additional restrictions on the inputs you can
1175
+ # choose. See [ Position restrictions][2] in the *Amazon Location
1176
+ # Service Developer Guide*.
1177
+ #
1178
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
1179
+ # specify a destination that's not located on a road, Amazon Location [
1180
+ # moves the position to the nearest road][3]. The snapped value is
1181
+ # available in the result in `SnappedDestinationPositions`.
1182
+ #
1183
+ # </note>
1184
+ #
1185
+ # Valid Values: `[-180 to 180,-90 to 90]`
1186
+ #
1187
+ #
1188
+ #
1189
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
1190
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
1191
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
1192
+ #
1193
+ # @option params [String] :distance_unit
1194
+ # Set the unit system to specify the distance.
1195
+ #
1196
+ # Default Value: `Kilometers`
1197
+ #
1198
+ # @option params [String] :key
1199
+ # The optional [API key][1] to authorize the request.
1200
+ #
1201
+ #
1202
+ #
1203
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
1204
+ #
1205
+ # @option params [String] :travel_mode
1206
+ # Specifies the mode of transport when calculating a route. Used in
1207
+ # estimating the speed of travel and road compatibility.
1208
+ #
1209
+ # The `TravelMode` you specify also determines how you specify route
1210
+ # preferences:
1211
+ #
1212
+ # * If traveling by `Car` use the `CarModeOptions` parameter.
1213
+ #
1214
+ # * If traveling by `Truck` use the `TruckModeOptions` parameter.
1215
+ #
1216
+ # <note markdown="1"> `Bicycle` or `Motorcycle` are only valid when using `Grab` as a data
1217
+ # provider, and only within Southeast Asia.
1218
+ #
1219
+ # `Truck` is not available for Grab.
1220
+ #
1221
+ # For more information about using Grab as a data provider, see
1222
+ # [GrabMaps][1] in the *Amazon Location Service Developer Guide*.
985
1223
  #
986
1224
  # </note>
987
1225
  #
988
- # Valid Values: `Esri `\| `Here`
1226
+ # Default Value: `Car`
1227
+ #
1228
+ #
1229
+ #
1230
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
1231
+ #
1232
+ # @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
1233
+ # Specifies route preferences when traveling by `Truck`, such as
1234
+ # avoiding routes that use ferries or tolls, and truck specifications to
1235
+ # consider when choosing an optimal road.
1236
+ #
1237
+ # Requirements: `TravelMode` must be specified as `Truck`.
1238
+ #
1239
+ # @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1240
+ #
1241
+ # * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array&lt;Array&lt;Types::RouteMatrixEntry&gt;&gt;
1242
+ # * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array&lt;Array&lt;Float&gt;&gt;
1243
+ # * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array&lt;Array&lt;Float&gt;&gt;
1244
+ # * {Types::CalculateRouteMatrixResponse#summary #summary} => Types::CalculateRouteMatrixSummary
1245
+ #
1246
+ # @example Request syntax with placeholder values
1247
+ #
1248
+ # resp = client.calculate_route_matrix({
1249
+ # calculator_name: "ResourceName", # required
1250
+ # car_mode_options: {
1251
+ # avoid_ferries: false,
1252
+ # avoid_tolls: false,
1253
+ # },
1254
+ # depart_now: false,
1255
+ # departure_positions: [ # required
1256
+ # [1.0],
1257
+ # ],
1258
+ # departure_time: Time.now,
1259
+ # destination_positions: [ # required
1260
+ # [1.0],
1261
+ # ],
1262
+ # distance_unit: "Kilometers", # accepts Kilometers, Miles
1263
+ # key: "ApiKey",
1264
+ # travel_mode: "Car", # accepts Car, Truck, Walking, Bicycle, Motorcycle
1265
+ # truck_mode_options: {
1266
+ # avoid_ferries: false,
1267
+ # avoid_tolls: false,
1268
+ # dimensions: {
1269
+ # height: 1.0,
1270
+ # length: 1.0,
1271
+ # unit: "Meters", # accepts Meters, Feet
1272
+ # width: 1.0,
1273
+ # },
1274
+ # weight: {
1275
+ # total: 1.0,
1276
+ # unit: "Kilograms", # accepts Kilograms, Pounds
1277
+ # },
1278
+ # },
1279
+ # })
1280
+ #
1281
+ # @example Response structure
1282
+ #
1283
+ # resp.route_matrix #=> Array
1284
+ # resp.route_matrix[0] #=> Array
1285
+ # resp.route_matrix[0][0].distance #=> Float
1286
+ # resp.route_matrix[0][0].duration_seconds #=> Float
1287
+ # resp.route_matrix[0][0].error.code #=> String, one of "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError"
1288
+ # resp.route_matrix[0][0].error.message #=> String
1289
+ # resp.snapped_departure_positions #=> Array
1290
+ # resp.snapped_departure_positions[0] #=> Array
1291
+ # resp.snapped_departure_positions[0][0] #=> Float
1292
+ # resp.snapped_destination_positions #=> Array
1293
+ # resp.snapped_destination_positions[0] #=> Array
1294
+ # resp.snapped_destination_positions[0][0] #=> Float
1295
+ # resp.summary.data_source #=> String
1296
+ # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
1297
+ # resp.summary.error_count #=> Integer
1298
+ # resp.summary.route_count #=> Integer
1299
+ #
1300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
1301
+ #
1302
+ # @overload calculate_route_matrix(params = {})
1303
+ # @param [Hash] params ({})
1304
+ def calculate_route_matrix(params = {}, options = {})
1305
+ req = build_request(:calculate_route_matrix, params)
1306
+ req.send_request(options)
1307
+ end
1308
+
1309
+ # Creates a geofence collection, which manages and stores geofences.
1310
+ #
1311
+ # @option params [required, String] :collection_name
1312
+ # A custom name for the geofence collection.
1313
+ #
1314
+ # Requirements:
1315
+ #
1316
+ # * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
1317
+ # periods (.), and underscores (\_).
1318
+ #
1319
+ # * Must be a unique geofence collection name.
1320
+ #
1321
+ # * No spaces allowed. For example, `ExampleGeofenceCollection`.
1322
+ #
1323
+ # @option params [String] :description
1324
+ # An optional description for the geofence collection.
1325
+ #
1326
+ # @option params [String] :kms_key_id
1327
+ # A key identifier for an [Amazon Web Services KMS customer managed
1328
+ # key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
989
1329
  #
990
1330
  #
991
1331
  #
992
- # [1]: https://aws.amazon.com/location/data-providers/
993
- # [2]: https://aws.amazon.com/location/pricing/
1332
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
1333
+ #
1334
+ # @option params [String] :pricing_plan
1335
+ # No longer used. If included, the only allowed value is
1336
+ # `RequestBasedUsage`.
1337
+ #
1338
+ # @option params [String] :pricing_plan_data_source
1339
+ # This parameter is no longer used.
994
1340
  #
995
1341
  # @option params [Hash<String,String>] :tags
996
1342
  # Applies one or more tags to the geofence collection. A tag is a
@@ -1026,7 +1372,7 @@ module Aws::LocationService
1026
1372
  # collection_name: "ResourceName", # required
1027
1373
  # description: "ResourceDescription",
1028
1374
  # kms_key_id: "KmsKeyId",
1029
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1375
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1030
1376
  # pricing_plan_data_source: "String",
1031
1377
  # tags: {
1032
1378
  # "TagKey" => "TagValue",
@@ -1048,40 +1394,52 @@ module Aws::LocationService
1048
1394
  req.send_request(options)
1049
1395
  end
1050
1396
 
1051
- # Creates a map resource in your AWS account, which provides map tiles
1052
- # of different styles sourced from global location data providers.
1397
+ # Creates an API key resource in your Amazon Web Services account, which
1398
+ # lets you grant actions for Amazon Location resources to the API key
1399
+ # bearer.
1053
1400
  #
1054
- # @option params [required, Types::MapConfiguration] :configuration
1055
- # Specifies the map style selected from an available data provider.
1401
+ # <note markdown="1"> For more information, see [Using API keys][1].
1402
+ #
1403
+ # </note>
1404
+ #
1405
+ #
1406
+ #
1407
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
1056
1408
  #
1057
1409
  # @option params [String] :description
1058
- # An optional description for the map resource.
1410
+ # An optional description for the API key resource.
1059
1411
  #
1060
- # @option params [required, String] :map_name
1061
- # The name for the map resource.
1412
+ # @option params [Time,DateTime,Date,Integer,String] :expire_time
1413
+ # The optional timestamp for when the API key resource will expire in [
1414
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. One of `NoExpiry` or
1415
+ # `ExpireTime` must be set.
1062
1416
  #
1063
- # Requirements:
1064
1417
  #
1065
- # * Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens
1066
- # (-), periods (.), and underscores (\_).
1067
1418
  #
1068
- # * Must be a unique map resource name.
1419
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1069
1420
  #
1070
- # * No spaces allowed. For example, `ExampleMap`.
1421
+ # @option params [required, String] :key_name
1422
+ # A custom name for the API key resource.
1423
+ #
1424
+ # Requirements:
1071
1425
  #
1072
- # @option params [required, String] :pricing_plan
1073
- # Specifies the pricing plan for your map resource.
1426
+ # * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
1427
+ # periods (.), and underscores (\_).
1074
1428
  #
1075
- # For additional details and restrictions on each pricing plan option,
1076
- # see [Amazon Location Service pricing][1].
1429
+ # * Must be a unique API key name.
1077
1430
  #
1431
+ # * No spaces allowed. For example, `ExampleAPIKey`.
1078
1432
  #
1433
+ # @option params [Boolean] :no_expiry
1434
+ # Optionally set to `true` to set no expiration time for the API key.
1435
+ # One of `NoExpiry` or `ExpireTime` must be set.
1079
1436
  #
1080
- # [1]: https://aws.amazon.com/location/pricing/
1437
+ # @option params [required, Types::ApiKeyRestrictions] :restrictions
1438
+ # The API key restrictions for the API key resource.
1081
1439
  #
1082
1440
  # @option params [Hash<String,String>] :tags
1083
1441
  # Applies one or more tags to the map resource. A tag is a key-value
1084
- # pair helps manage, identify, search, and filter your resources by
1442
+ # pair that helps manage, identify, search, and filter your resources by
1085
1443
  # labelling them.
1086
1444
  #
1087
1445
  # Format: `"key" : "value"`
@@ -1101,21 +1459,25 @@ module Aws::LocationService
1101
1459
  #
1102
1460
  # * Cannot use "aws:" as a prefix for a key.
1103
1461
  #
1104
- # @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1462
+ # @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
1463
  #
1106
- # * {Types::CreateMapResponse#create_time #create_time} => Time
1107
- # * {Types::CreateMapResponse#map_arn #map_arn} => String
1108
- # * {Types::CreateMapResponse#map_name #map_name} => String
1464
+ # * {Types::CreateKeyResponse#create_time #create_time} => Time
1465
+ # * {Types::CreateKeyResponse#key #key} => String
1466
+ # * {Types::CreateKeyResponse#key_arn #key_arn} => String
1467
+ # * {Types::CreateKeyResponse#key_name #key_name} => String
1109
1468
  #
1110
1469
  # @example Request syntax with placeholder values
1111
1470
  #
1112
- # resp = client.create_map({
1113
- # configuration: { # required
1114
- # style: "MapStyle", # required
1115
- # },
1471
+ # resp = client.create_key({
1116
1472
  # description: "ResourceDescription",
1117
- # map_name: "ResourceName", # required
1118
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1473
+ # expire_time: Time.now,
1474
+ # key_name: "ResourceName", # required
1475
+ # no_expiry: false,
1476
+ # restrictions: { # required
1477
+ # allow_actions: ["ApiKeyAction"], # required
1478
+ # allow_referers: ["RefererPattern"],
1479
+ # allow_resources: ["GeoArn"], # required
1480
+ # },
1119
1481
  # tags: {
1120
1482
  # "TagKey" => "TagValue",
1121
1483
  # },
@@ -1124,58 +1486,175 @@ module Aws::LocationService
1124
1486
  # @example Response structure
1125
1487
  #
1126
1488
  # resp.create_time #=> Time
1127
- # resp.map_arn #=> String
1128
- # resp.map_name #=> String
1489
+ # resp.key #=> String
1490
+ # resp.key_arn #=> String
1491
+ # resp.key_name #=> String
1129
1492
  #
1130
- # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap AWS API Documentation
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateKey AWS API Documentation
1131
1494
  #
1132
- # @overload create_map(params = {})
1495
+ # @overload create_key(params = {})
1133
1496
  # @param [Hash] params ({})
1134
- def create_map(params = {}, options = {})
1135
- req = build_request(:create_map, params)
1497
+ def create_key(params = {}, options = {})
1498
+ req = build_request(:create_key, params)
1136
1499
  req.send_request(options)
1137
1500
  end
1138
1501
 
1139
- # Creates a place index resource in your AWS account. Use a place index
1140
- # resource to geocode addresses and other text queries by using the
1141
- # `SearchPlaceIndexForText` operation, and reverse geocode coordinates
1142
- # by using the `SearchPlaceIndexForPosition` operation.
1143
- #
1144
- # @option params [required, String] :data_source
1145
- # Specifies the geospatial data provider for the new place index.
1502
+ # Creates a map resource in your Amazon Web Services account, which
1503
+ # provides map tiles of different styles sourced from global location
1504
+ # data providers.
1146
1505
  #
1147
- # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1148
- # example, entering `HERE` returns an error.
1506
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
1507
+ # business, such as delivery vehicles or employees, you must not use
1508
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1509
+ # Services service terms][1] for more details.
1149
1510
  #
1150
- # </note>
1511
+ # </note>
1151
1512
  #
1152
- # Valid values include:
1153
1513
  #
1154
- # * `Esri` – For additional information about [Esri][1]'s coverage in
1155
- # your region of interest, see [Esri details on geocoding
1156
- # coverage][2].
1157
1514
  #
1158
- # * `Here` – For additional information about [HERE Technologies][3]'
1159
- # coverage in your region of interest, see [HERE details on goecoding
1160
- # coverage][4].
1515
+ # [1]: http://aws.amazon.com/service-terms
1161
1516
  #
1162
- # If you specify HERE Technologies (`Here`) as the data provider, you
1163
- # may not [store results][5] for locations in Japan. For more
1164
- # information, see the [AWS Service Terms][6] for Amazon Location
1165
- # Service.
1517
+ # @option params [required, Types::MapConfiguration] :configuration
1518
+ # Specifies the `MapConfiguration`, including the map style, for the map
1519
+ # resource that you create. The map style defines the look of maps and
1520
+ # the data provider for your map resource.
1166
1521
  #
1167
- # For additional information , see [Data providers][7] on the *Amazon
1522
+ # @option params [String] :description
1523
+ # An optional description for the map resource.
1524
+ #
1525
+ # @option params [required, String] :map_name
1526
+ # The name for the map resource.
1527
+ #
1528
+ # Requirements:
1529
+ #
1530
+ # * Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens
1531
+ # (-), periods (.), and underscores (\_).
1532
+ #
1533
+ # * Must be a unique map resource name.
1534
+ #
1535
+ # * No spaces allowed. For example, `ExampleMap`.
1536
+ #
1537
+ # @option params [String] :pricing_plan
1538
+ # No longer used. If included, the only allowed value is
1539
+ # `RequestBasedUsage`.
1540
+ #
1541
+ # @option params [Hash<String,String>] :tags
1542
+ # Applies one or more tags to the map resource. A tag is a key-value
1543
+ # pair helps manage, identify, search, and filter your resources by
1544
+ # labelling them.
1545
+ #
1546
+ # Format: `"key" : "value"`
1547
+ #
1548
+ # Restrictions:
1549
+ #
1550
+ # * Maximum 50 tags per resource
1551
+ #
1552
+ # * Each resource tag must be unique with a maximum of one value.
1553
+ #
1554
+ # * Maximum key length: 128 Unicode characters in UTF-8
1555
+ #
1556
+ # * Maximum value length: 256 Unicode characters in UTF-8
1557
+ #
1558
+ # * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
1559
+ # characters: + - = . \_ : / @.
1560
+ #
1561
+ # * Cannot use "aws:" as a prefix for a key.
1562
+ #
1563
+ # @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1564
+ #
1565
+ # * {Types::CreateMapResponse#create_time #create_time} => Time
1566
+ # * {Types::CreateMapResponse#map_arn #map_arn} => String
1567
+ # * {Types::CreateMapResponse#map_name #map_name} => String
1568
+ #
1569
+ # @example Request syntax with placeholder values
1570
+ #
1571
+ # resp = client.create_map({
1572
+ # configuration: { # required
1573
+ # political_view: "CountryCode3",
1574
+ # style: "MapStyle", # required
1575
+ # },
1576
+ # description: "ResourceDescription",
1577
+ # map_name: "ResourceName", # required
1578
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1579
+ # tags: {
1580
+ # "TagKey" => "TagValue",
1581
+ # },
1582
+ # })
1583
+ #
1584
+ # @example Response structure
1585
+ #
1586
+ # resp.create_time #=> Time
1587
+ # resp.map_arn #=> String
1588
+ # resp.map_name #=> String
1589
+ #
1590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CreateMap AWS API Documentation
1591
+ #
1592
+ # @overload create_map(params = {})
1593
+ # @param [Hash] params ({})
1594
+ def create_map(params = {}, options = {})
1595
+ req = build_request(:create_map, params)
1596
+ req.send_request(options)
1597
+ end
1598
+
1599
+ # Creates a place index resource in your Amazon Web Services account.
1600
+ # Use a place index resource to geocode addresses and other text queries
1601
+ # by using the `SearchPlaceIndexForText` operation, and reverse geocode
1602
+ # coordinates by using the `SearchPlaceIndexForPosition` operation, and
1603
+ # enable autosuggestions by using the `SearchPlaceIndexForSuggestions`
1604
+ # operation.
1605
+ #
1606
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
1607
+ # business, such as delivery vehicles or employees, you must not use
1608
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1609
+ # Services service terms][1] for more details.
1610
+ #
1611
+ # </note>
1612
+ #
1613
+ #
1614
+ #
1615
+ # [1]: http://aws.amazon.com/service-terms
1616
+ #
1617
+ # @option params [required, String] :data_source
1618
+ # Specifies the geospatial data provider for the new place index.
1619
+ #
1620
+ # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1621
+ # example, entering `HERE` returns an error.
1622
+ #
1623
+ # </note>
1624
+ #
1625
+ # Valid values include:
1626
+ #
1627
+ # * `Esri` – For additional information about [Esri][1]'s coverage in
1628
+ # your region of interest, see [Esri details on geocoding
1629
+ # coverage][2].
1630
+ #
1631
+ # * `Grab` – Grab provides place index functionality for Southeast Asia.
1632
+ # For additional information about [GrabMaps][3]' coverage, see
1633
+ # [GrabMaps countries and areas covered][4].
1634
+ #
1635
+ # * `Here` – For additional information about [HERE Technologies][5]'
1636
+ # coverage in your region of interest, see [HERE details on goecoding
1637
+ # coverage][6].
1638
+ #
1639
+ # If you specify HERE Technologies (`Here`) as the data provider, you
1640
+ # may not [store results][7] for locations in Japan. For more
1641
+ # information, see the [Amazon Web Services Service Terms][8] for
1642
+ # Amazon Location Service.
1643
+ #
1644
+ # For additional information , see [Data providers][9] on the *Amazon
1168
1645
  # Location Service Developer Guide*.
1169
1646
  #
1170
1647
  #
1171
1648
  #
1172
1649
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
1173
1650
  # [2]: https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm
1174
- # [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
1175
- # [4]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
1176
- # [5]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
1177
- # [6]: https://aws.amazon.com/service-terms/
1178
- # [7]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
1651
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
1652
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area
1653
+ # [5]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
1654
+ # [6]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html
1655
+ # [7]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html
1656
+ # [8]: http://aws.amazon.com/service-terms/
1657
+ # [9]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
1179
1658
  #
1180
1659
  # @option params [Types::DataSourceConfiguration] :data_source_configuration
1181
1660
  # Specifies the data storage option requesting Places.
@@ -1195,15 +1674,9 @@ module Aws::LocationService
1195
1674
  #
1196
1675
  # * No spaces allowed. For example, `ExamplePlaceIndex`.
1197
1676
  #
1198
- # @option params [required, String] :pricing_plan
1199
- # Specifies the pricing plan for your place index resource.
1200
- #
1201
- # For additional details and restrictions on each pricing plan option,
1202
- # see [Amazon Location Service pricing][1].
1203
- #
1204
- #
1205
- #
1206
- # [1]: https://aws.amazon.com/location/pricing/
1677
+ # @option params [String] :pricing_plan
1678
+ # No longer used. If included, the only allowed value is
1679
+ # `RequestBasedUsage`.
1207
1680
  #
1208
1681
  # @option params [Hash<String,String>] :tags
1209
1682
  # Applies one or more tags to the place index resource. A tag is a
@@ -1243,7 +1716,7 @@ module Aws::LocationService
1243
1716
  # },
1244
1717
  # description: "ResourceDescription",
1245
1718
  # index_name: "ResourceName", # required
1246
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1719
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1247
1720
  # tags: {
1248
1721
  # "TagKey" => "TagValue",
1249
1722
  # },
@@ -1264,12 +1737,24 @@ module Aws::LocationService
1264
1737
  req.send_request(options)
1265
1738
  end
1266
1739
 
1267
- # Creates a route calculator resource in your AWS account.
1740
+ # Creates a route calculator resource in your Amazon Web Services
1741
+ # account.
1268
1742
  #
1269
1743
  # You can send requests to a route calculator resource to estimate
1270
1744
  # travel time, distance, and get directions. A route calculator sources
1271
1745
  # traffic and road network data from your chosen data provider.
1272
1746
  #
1747
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
1748
+ # business, such as delivery vehicles or employees, you must not use
1749
+ # Esri as your geolocation provider. See section 82 of the [Amazon Web
1750
+ # Services service terms][1] for more details.
1751
+ #
1752
+ # </note>
1753
+ #
1754
+ #
1755
+ #
1756
+ # [1]: http://aws.amazon.com/service-terms
1757
+ #
1273
1758
  # @option params [required, String] :calculator_name
1274
1759
  # The name of the route calculator resource.
1275
1760
  #
@@ -1286,9 +1771,7 @@ module Aws::LocationService
1286
1771
  # Specifies the data provider of traffic and road network data.
1287
1772
  #
1288
1773
  # <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
1289
- # example, entering `HERE` returns an error. Route calculators that use
1290
- # Esri as a data source only calculate routes that are shorter than 400
1291
- # km.
1774
+ # example, entering `HERE` returns an error.
1292
1775
  #
1293
1776
  # </note>
1294
1777
  #
@@ -1298,34 +1781,37 @@ module Aws::LocationService
1298
1781
  # your region of interest, see [Esri details on street networks and
1299
1782
  # traffic coverage][2].
1300
1783
  #
1301
- # * `Here` For additional information about [HERE Technologies][3]'
1784
+ # Route calculators that use Esri as a data source only calculate
1785
+ # routes that are shorter than 400 km.
1786
+ #
1787
+ # * `Grab` – Grab provides routing functionality for Southeast Asia. For
1788
+ # additional information about [GrabMaps][3]' coverage, see [GrabMaps
1789
+ # countries and areas covered][4].
1790
+ #
1791
+ # * `Here` – For additional information about [HERE Technologies][5]'
1302
1792
  # coverage in your region of interest, see [HERE car routing
1303
- # coverage][4] and [HERE truck routing coverage][5].
1793
+ # coverage][6] and [HERE truck routing coverage][7].
1304
1794
  #
1305
- # For additional information , see [Data providers][6] on the *Amazon
1795
+ # For additional information , see [Data providers][8] on the *Amazon
1306
1796
  # Location Service Developer Guide*.
1307
1797
  #
1308
1798
  #
1309
1799
  #
1310
1800
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
1311
1801
  # [2]: https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm
1312
- # [3]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
1313
- # [4]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html
1314
- # [5]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
1315
- # [6]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
1802
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
1803
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area
1804
+ # [5]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
1805
+ # [6]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html
1806
+ # [7]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html
1807
+ # [8]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html
1316
1808
  #
1317
1809
  # @option params [String] :description
1318
1810
  # The optional description for the route calculator resource.
1319
1811
  #
1320
- # @option params [required, String] :pricing_plan
1321
- # Specifies the pricing plan for your route calculator resource.
1322
- #
1323
- # For additional details and restrictions on each pricing plan option,
1324
- # see [Amazon Location Service pricing][1].
1325
- #
1326
- #
1327
- #
1328
- # [1]: https://aws.amazon.com/location/pricing/
1812
+ # @option params [String] :pricing_plan
1813
+ # No longer used. If included, the only allowed value is
1814
+ # `RequestBasedUsage`.
1329
1815
  #
1330
1816
  # @option params [Hash<String,String>] :tags
1331
1817
  # Applies one or more tags to the route calculator resource. A tag is a
@@ -1365,7 +1851,7 @@ module Aws::LocationService
1365
1851
  # calculator_name: "ResourceName", # required
1366
1852
  # data_source: "String", # required
1367
1853
  # description: "ResourceDescription",
1368
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1854
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1369
1855
  # tags: {
1370
1856
  # "TagKey" => "TagValue",
1371
1857
  # },
@@ -1386,15 +1872,49 @@ module Aws::LocationService
1386
1872
  req.send_request(options)
1387
1873
  end
1388
1874
 
1389
- # Creates a tracker resource in your AWS account, which lets you
1390
- # retrieve current and historical location of devices.
1875
+ # Creates a tracker resource in your Amazon Web Services account, which
1876
+ # lets you retrieve current and historical location of devices.
1391
1877
  #
1392
1878
  # @option params [String] :description
1393
1879
  # An optional description for the tracker resource.
1394
1880
  #
1881
+ # @option params [Boolean] :event_bridge_enabled
1882
+ # Whether to enable position `UPDATE` events from this tracker to be
1883
+ # sent to EventBridge.
1884
+ #
1885
+ # <note markdown="1"> You do not need enable this feature to get `ENTER` and `EXIT` events
1886
+ # for geofences with this tracker. Those events are always sent to
1887
+ # EventBridge.
1888
+ #
1889
+ # </note>
1890
+ #
1891
+ # @option params [Boolean] :kms_key_enable_geospatial_queries
1892
+ # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
1893
+ # Services KMS customer managed key][1].
1894
+ #
1895
+ # This parameter is only used if you are using a KMS customer managed
1896
+ # key.
1897
+ #
1898
+ # <note markdown="1"> If you wish to encrypt your data using your own KMS customer managed
1899
+ # key, then the Bounding Polygon Queries feature will be disabled by
1900
+ # default. This is because by using this feature, a representation of
1901
+ # your device positions will not be encrypted using the your KMS managed
1902
+ # key. The exact device position, however; is still encrypted using your
1903
+ # managed key.
1904
+ #
1905
+ # You can choose to opt-in to the Bounding Polygon Quseries feature.
1906
+ # This is done by setting the `KmsKeyEnableGeospatialQueries` parameter
1907
+ # to true when creating or updating a Tracker.
1908
+ #
1909
+ # </note>
1910
+ #
1911
+ #
1912
+ #
1913
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
1914
+ #
1395
1915
  # @option params [String] :kms_key_id
1396
- # A key identifier for an [AWS KMS customer managed key][1]. Enter a key
1397
- # ID, key ARN, alias name, or alias ARN.
1916
+ # A key identifier for an [Amazon Web Services KMS customer managed
1917
+ # key][1]. Enter a key ID, key ARN, alias name, or alias ARN.
1398
1918
  #
1399
1919
  #
1400
1920
  #
@@ -1418,43 +1938,25 @@ module Aws::LocationService
1418
1938
  # Distance-based filtering can also reduce the effects of GPS noise
1419
1939
  # when displaying device trajectories on a map.
1420
1940
  #
1941
+ # * `AccuracyBased` - If the device has moved less than the measured
1942
+ # accuracy, location updates are ignored. For example, if two
1943
+ # consecutive updates from a device have a horizontal accuracy of 5 m
1944
+ # and 10 m, the second update is ignored if the device has moved less
1945
+ # than 15 m. Ignored location updates are neither evaluated against
1946
+ # linked geofence collections, nor stored. This can reduce the effects
1947
+ # of GPS noise when displaying device trajectories on a map, and can
1948
+ # help control your costs by reducing the number of geofence
1949
+ # evaluations.
1950
+ #
1421
1951
  # This field is optional. If not specified, the default value is
1422
1952
  # `TimeBased`.
1423
1953
  #
1424
- # @option params [required, String] :pricing_plan
1425
- # Specifies the pricing plan for the tracker resource.
1426
- #
1427
- # For additional details and restrictions on each pricing plan option,
1428
- # see [Amazon Location Service pricing][1].
1429
- #
1430
- #
1431
- #
1432
- # [1]: https://aws.amazon.com/location/pricing/
1954
+ # @option params [String] :pricing_plan
1955
+ # No longer used. If included, the only allowed value is
1956
+ # `RequestBasedUsage`.
1433
1957
  #
1434
1958
  # @option params [String] :pricing_plan_data_source
1435
- # Specifies the data provider for the tracker resource.
1436
- #
1437
- # * Required value for the following pricing plans: `MobileAssetTracking
1438
- # `\| `MobileAssetManagement`
1439
- #
1440
- # ^
1441
- #
1442
- # For more information about [Data Providers][1], and [Pricing
1443
- # plans][2], see the Amazon Location Service product page.
1444
- #
1445
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
1446
- # billing for your tracker resource. Your data will not be shared with
1447
- # the data provider, and will remain in your AWS account or Region
1448
- # unless you move it.
1449
- #
1450
- # </note>
1451
- #
1452
- # Valid values: `Esri` \| `Here`
1453
- #
1454
- #
1455
- #
1456
- # [1]: https://aws.amazon.com/location/data-providers/
1457
- # [2]: https://aws.amazon.com/location/pricing/
1959
+ # This parameter is no longer used.
1458
1960
  #
1459
1961
  # @option params [Hash<String,String>] :tags
1460
1962
  # Applies one or more tags to the tracker resource. A tag is a key-value
@@ -1500,9 +2002,11 @@ module Aws::LocationService
1500
2002
  #
1501
2003
  # resp = client.create_tracker({
1502
2004
  # description: "ResourceDescription",
2005
+ # event_bridge_enabled: false,
2006
+ # kms_key_enable_geospatial_queries: false,
1503
2007
  # kms_key_id: "KmsKeyId",
1504
2008
  # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
1505
- # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
2009
+ # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
1506
2010
  # pricing_plan_data_source: "String",
1507
2011
  # tags: {
1508
2012
  # "TagKey" => "TagValue",
@@ -1525,7 +2029,7 @@ module Aws::LocationService
1525
2029
  req.send_request(options)
1526
2030
  end
1527
2031
 
1528
- # Deletes a geofence collection from your AWS account.
2032
+ # Deletes a geofence collection from your Amazon Web Services account.
1529
2033
  #
1530
2034
  # <note markdown="1"> This operation deletes the resource permanently. If the geofence
1531
2035
  # collection is the target of a tracker resource, the devices will no
@@ -1553,7 +2057,30 @@ module Aws::LocationService
1553
2057
  req.send_request(options)
1554
2058
  end
1555
2059
 
1556
- # Deletes a map resource from your AWS account.
2060
+ # Deletes the specified API key. The API key must have been deactivated
2061
+ # more than 90 days previously.
2062
+ #
2063
+ # @option params [required, String] :key_name
2064
+ # The name of the API key to delete.
2065
+ #
2066
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2067
+ #
2068
+ # @example Request syntax with placeholder values
2069
+ #
2070
+ # resp = client.delete_key({
2071
+ # key_name: "ResourceName", # required
2072
+ # })
2073
+ #
2074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DeleteKey AWS API Documentation
2075
+ #
2076
+ # @overload delete_key(params = {})
2077
+ # @param [Hash] params ({})
2078
+ def delete_key(params = {}, options = {})
2079
+ req = build_request(:delete_key, params)
2080
+ req.send_request(options)
2081
+ end
2082
+
2083
+ # Deletes a map resource from your Amazon Web Services account.
1557
2084
  #
1558
2085
  # <note markdown="1"> This operation deletes the resource permanently. If the map is being
1559
2086
  # used in an application, the map may not render.
@@ -1580,7 +2107,7 @@ module Aws::LocationService
1580
2107
  req.send_request(options)
1581
2108
  end
1582
2109
 
1583
- # Deletes a place index resource from your AWS account.
2110
+ # Deletes a place index resource from your Amazon Web Services account.
1584
2111
  #
1585
2112
  # <note markdown="1"> This operation deletes the resource permanently.
1586
2113
  #
@@ -1606,7 +2133,8 @@ module Aws::LocationService
1606
2133
  req.send_request(options)
1607
2134
  end
1608
2135
 
1609
- # Deletes a route calculator resource from your AWS account.
2136
+ # Deletes a route calculator resource from your Amazon Web Services
2137
+ # account.
1610
2138
  #
1611
2139
  # <note markdown="1"> This operation deletes the resource permanently.
1612
2140
  #
@@ -1632,7 +2160,7 @@ module Aws::LocationService
1632
2160
  req.send_request(options)
1633
2161
  end
1634
2162
 
1635
- # Deletes a tracker resource from your AWS account.
2163
+ # Deletes a tracker resource from your Amazon Web Services account.
1636
2164
  #
1637
2165
  # <note markdown="1"> This operation deletes the resource permanently. If the tracker
1638
2166
  # resource is in use, you may encounter an error. Make sure that the
@@ -1671,6 +2199,7 @@ module Aws::LocationService
1671
2199
  # * {Types::DescribeGeofenceCollectionResponse#collection_name #collection_name} => String
1672
2200
  # * {Types::DescribeGeofenceCollectionResponse#create_time #create_time} => Time
1673
2201
  # * {Types::DescribeGeofenceCollectionResponse#description #description} => String
2202
+ # * {Types::DescribeGeofenceCollectionResponse#geofence_count #geofence_count} => Integer
1674
2203
  # * {Types::DescribeGeofenceCollectionResponse#kms_key_id #kms_key_id} => String
1675
2204
  # * {Types::DescribeGeofenceCollectionResponse#pricing_plan #pricing_plan} => String
1676
2205
  # * {Types::DescribeGeofenceCollectionResponse#pricing_plan_data_source #pricing_plan_data_source} => String
@@ -1689,6 +2218,7 @@ module Aws::LocationService
1689
2218
  # resp.collection_name #=> String
1690
2219
  # resp.create_time #=> Time
1691
2220
  # resp.description #=> String
2221
+ # resp.geofence_count #=> Integer
1692
2222
  # resp.kms_key_id #=> String
1693
2223
  # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
1694
2224
  # resp.pricing_plan_data_source #=> String
@@ -1705,6 +2235,56 @@ module Aws::LocationService
1705
2235
  req.send_request(options)
1706
2236
  end
1707
2237
 
2238
+ # Retrieves the API key resource details.
2239
+ #
2240
+ # @option params [required, String] :key_name
2241
+ # The name of the API key resource.
2242
+ #
2243
+ # @return [Types::DescribeKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2244
+ #
2245
+ # * {Types::DescribeKeyResponse#create_time #create_time} => Time
2246
+ # * {Types::DescribeKeyResponse#description #description} => String
2247
+ # * {Types::DescribeKeyResponse#expire_time #expire_time} => Time
2248
+ # * {Types::DescribeKeyResponse#key #key} => String
2249
+ # * {Types::DescribeKeyResponse#key_arn #key_arn} => String
2250
+ # * {Types::DescribeKeyResponse#key_name #key_name} => String
2251
+ # * {Types::DescribeKeyResponse#restrictions #restrictions} => Types::ApiKeyRestrictions
2252
+ # * {Types::DescribeKeyResponse#tags #tags} => Hash&lt;String,String&gt;
2253
+ # * {Types::DescribeKeyResponse#update_time #update_time} => Time
2254
+ #
2255
+ # @example Request syntax with placeholder values
2256
+ #
2257
+ # resp = client.describe_key({
2258
+ # key_name: "ResourceName", # required
2259
+ # })
2260
+ #
2261
+ # @example Response structure
2262
+ #
2263
+ # resp.create_time #=> Time
2264
+ # resp.description #=> String
2265
+ # resp.expire_time #=> Time
2266
+ # resp.key #=> String
2267
+ # resp.key_arn #=> String
2268
+ # resp.key_name #=> String
2269
+ # resp.restrictions.allow_actions #=> Array
2270
+ # resp.restrictions.allow_actions[0] #=> String
2271
+ # resp.restrictions.allow_referers #=> Array
2272
+ # resp.restrictions.allow_referers[0] #=> String
2273
+ # resp.restrictions.allow_resources #=> Array
2274
+ # resp.restrictions.allow_resources[0] #=> String
2275
+ # resp.tags #=> Hash
2276
+ # resp.tags["TagKey"] #=> String
2277
+ # resp.update_time #=> Time
2278
+ #
2279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/DescribeKey AWS API Documentation
2280
+ #
2281
+ # @overload describe_key(params = {})
2282
+ # @param [Hash] params ({})
2283
+ def describe_key(params = {}, options = {})
2284
+ req = build_request(:describe_key, params)
2285
+ req.send_request(options)
2286
+ end
2287
+
1708
2288
  # Retrieves the map resource details.
1709
2289
  #
1710
2290
  # @option params [required, String] :map_name
@@ -1730,6 +2310,7 @@ module Aws::LocationService
1730
2310
  #
1731
2311
  # @example Response structure
1732
2312
  #
2313
+ # resp.configuration.political_view #=> String
1733
2314
  # resp.configuration.style #=> String
1734
2315
  # resp.create_time #=> Time
1735
2316
  # resp.data_source #=> String
@@ -1847,6 +2428,8 @@ module Aws::LocationService
1847
2428
  #
1848
2429
  # * {Types::DescribeTrackerResponse#create_time #create_time} => Time
1849
2430
  # * {Types::DescribeTrackerResponse#description #description} => String
2431
+ # * {Types::DescribeTrackerResponse#event_bridge_enabled #event_bridge_enabled} => Boolean
2432
+ # * {Types::DescribeTrackerResponse#kms_key_enable_geospatial_queries #kms_key_enable_geospatial_queries} => Boolean
1850
2433
  # * {Types::DescribeTrackerResponse#kms_key_id #kms_key_id} => String
1851
2434
  # * {Types::DescribeTrackerResponse#position_filtering #position_filtering} => String
1852
2435
  # * {Types::DescribeTrackerResponse#pricing_plan #pricing_plan} => String
@@ -1866,6 +2449,8 @@ module Aws::LocationService
1866
2449
  #
1867
2450
  # resp.create_time #=> Time
1868
2451
  # resp.description #=> String
2452
+ # resp.event_bridge_enabled #=> Boolean
2453
+ # resp.kms_key_enable_geospatial_queries #=> Boolean
1869
2454
  # resp.kms_key_id #=> String
1870
2455
  # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
1871
2456
  # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
@@ -1897,7 +2482,7 @@ module Aws::LocationService
1897
2482
  # @option params [required, String] :consumer_arn
1898
2483
  # The Amazon Resource Name (ARN) for the geofence collection to be
1899
2484
  # disassociated from the tracker resource. Used when you need to specify
1900
- # a resource across all AWS.
2485
+ # a resource across all Amazon Web Services.
1901
2486
  #
1902
2487
  # * Format example:
1903
2488
  # `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`
@@ -1940,8 +2525,10 @@ module Aws::LocationService
1940
2525
  #
1941
2526
  # @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1942
2527
  #
2528
+ # * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
1943
2529
  # * {Types::GetDevicePositionResponse#device_id #device_id} => String
1944
2530
  # * {Types::GetDevicePositionResponse#position #position} => Array&lt;Float&gt;
2531
+ # * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash&lt;String,String&gt;
1945
2532
  # * {Types::GetDevicePositionResponse#received_time #received_time} => Time
1946
2533
  # * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
1947
2534
  #
@@ -1954,9 +2541,12 @@ module Aws::LocationService
1954
2541
  #
1955
2542
  # @example Response structure
1956
2543
  #
2544
+ # resp.accuracy.horizontal #=> Float
1957
2545
  # resp.device_id #=> String
1958
2546
  # resp.position #=> Array
1959
2547
  # resp.position[0] #=> Float
2548
+ # resp.position_properties #=> Hash
2549
+ # resp.position_properties["PropertyMapKeyString"] #=> String
1960
2550
  # resp.received_time #=> Time
1961
2551
  # resp.sample_time #=> Time
1962
2552
  #
@@ -1995,6 +2585,12 @@ module Aws::LocationService
1995
2585
  #
1996
2586
  # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
1997
2587
  #
2588
+ # @option params [Integer] :max_results
2589
+ # An optional limit for the number of device positions returned in a
2590
+ # single call.
2591
+ #
2592
+ # Default value: `100`
2593
+ #
1998
2594
  # @option params [String] :next_token
1999
2595
  # The pagination token specifying which page of results to return in the
2000
2596
  # response. If no token is provided, the default page is the first page.
@@ -2033,6 +2629,7 @@ module Aws::LocationService
2033
2629
  # resp = client.get_device_position_history({
2034
2630
  # device_id: "Id", # required
2035
2631
  # end_time_exclusive: Time.now,
2632
+ # max_results: 1,
2036
2633
  # next_token: "Token",
2037
2634
  # start_time_inclusive: Time.now,
2038
2635
  # tracker_name: "ResourceName", # required
@@ -2041,9 +2638,12 @@ module Aws::LocationService
2041
2638
  # @example Response structure
2042
2639
  #
2043
2640
  # resp.device_positions #=> Array
2641
+ # resp.device_positions[0].accuracy.horizontal #=> Float
2044
2642
  # resp.device_positions[0].device_id #=> String
2045
2643
  # resp.device_positions[0].position #=> Array
2046
2644
  # resp.device_positions[0].position[0] #=> Float
2645
+ # resp.device_positions[0].position_properties #=> Hash
2646
+ # resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
2047
2647
  # resp.device_positions[0].received_time #=> Time
2048
2648
  # resp.device_positions[0].sample_time #=> Time
2049
2649
  # resp.next_token #=> String
@@ -2069,6 +2669,7 @@ module Aws::LocationService
2069
2669
  #
2070
2670
  # * {Types::GetGeofenceResponse#create_time #create_time} => Time
2071
2671
  # * {Types::GetGeofenceResponse#geofence_id #geofence_id} => String
2672
+ # * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash&lt;String,String&gt;
2072
2673
  # * {Types::GetGeofenceResponse#geometry #geometry} => Types::GeofenceGeometry
2073
2674
  # * {Types::GetGeofenceResponse#status #status} => String
2074
2675
  # * {Types::GetGeofenceResponse#update_time #update_time} => Time
@@ -2084,6 +2685,11 @@ module Aws::LocationService
2084
2685
  #
2085
2686
  # resp.create_time #=> Time
2086
2687
  # resp.geofence_id #=> String
2688
+ # resp.geofence_properties #=> Hash
2689
+ # resp.geofence_properties["PropertyMapKeyString"] #=> String
2690
+ # resp.geometry.circle.center #=> Array
2691
+ # resp.geometry.circle.center[0] #=> Float
2692
+ # resp.geometry.circle.radius #=> Float
2087
2693
  # resp.geometry.polygon #=> Array
2088
2694
  # resp.geometry.polygon[0] #=> Array
2089
2695
  # resp.geometry.polygon[0][0] #=> Array
@@ -2106,7 +2712,7 @@ module Aws::LocationService
2106
2712
  # A comma-separated list of fonts to load glyphs from in order of
2107
2713
  # preference. For example, `Noto Sans Regular, Arial Unicode`.
2108
2714
  #
2109
- # Valid fonts stacks for [Esri][1] styles:
2715
+ # Valid font stacks for [Esri][1] styles:
2110
2716
  #
2111
2717
  # * VectorEsriDarkGrayCanvas – `Ubuntu Medium Italic` \| `Ubuntu Medium`
2112
2718
  # \| `Ubuntu Italic` \| `Ubuntu Regular` \| `Ubuntu Bold`
@@ -2126,14 +2732,51 @@ module Aws::LocationService
2126
2732
  #
2127
2733
  # Valid font stacks for [HERE Technologies][2] styles:
2128
2734
  #
2129
- # * VectorHereBerlin – `Fira GO Regular` \| `Fira GO Bold`
2735
+ # * VectorHereContrast – `Fira GO Regular` \| `Fira GO Bold`
2736
+ #
2737
+ # * VectorHereExplore, VectorHereExploreTruck,
2738
+ # HybridHereExploreSatellite – `Fira GO Italic` \| `Fira GO Map` \|
2739
+ # `Fira GO Map Bold` \| `Noto Sans CJK JP Bold` \| `Noto Sans CJK JP
2740
+ # Light` \| `Noto Sans CJK JP Regular`
2741
+ #
2742
+ # Valid font stacks for [GrabMaps][3] styles:
2743
+ #
2744
+ # * VectorGrabStandardLight, VectorGrabStandardDark – `Noto Sans
2745
+ # Regular` \| `Noto Sans Medium` \| `Noto Sans Bold`
2746
+ #
2747
+ # ^
2748
+ #
2749
+ # Valid font stacks for [Open Data][4] styles:
2750
+ #
2751
+ # * VectorOpenDataStandardLight, VectorOpenDataStandardDark,
2752
+ # VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark –
2753
+ # `Amazon Ember Regular,Noto Sans Regular` \| `Amazon Ember Bold,Noto
2754
+ # Sans Bold` \| `Amazon Ember Medium,Noto Sans Medium` \| `Amazon
2755
+ # Ember Regular Italic,Noto Sans Italic` \| `Amazon Ember Condensed RC
2756
+ # Regular,Noto Sans Regular` \| `Amazon Ember Condensed RC Bold,Noto
2757
+ # Sans Bold` \| `Amazon Ember Regular,Noto Sans Regular,Noto Sans
2758
+ # Arabic Regular` \| `Amazon Ember Condensed RC Bold,Noto Sans
2759
+ # Bold,Noto Sans Arabic Condensed Bold` \| `Amazon Ember Bold,Noto
2760
+ # Sans Bold,Noto Sans Arabic Bold` \| `Amazon Ember Regular
2761
+ # Italic,Noto Sans Italic,Noto Sans Arabic Regular` \| `Amazon Ember
2762
+ # Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed
2763
+ # Regular` \| `Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic
2764
+ # Medium`
2130
2765
  #
2131
2766
  # ^
2132
2767
  #
2768
+ # <note markdown="1"> The fonts used by the Open Data map styles are combined fonts that use
2769
+ # `Amazon Ember` for most glyphs but `Noto Sans` for glyphs unsupported
2770
+ # by `Amazon Ember`.
2771
+ #
2772
+ # </note>
2773
+ #
2133
2774
  #
2134
2775
  #
2135
2776
  # [1]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html
2136
2777
  # [2]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html
2778
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html
2779
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html
2137
2780
  #
2138
2781
  # @option params [required, String] :font_unicode_range
2139
2782
  # A Unicode range of characters to download glyphs for. Each response
@@ -2141,12 +2784,20 @@ module Aws::LocationService
2141
2784
  # characters from range `U+0000` to `00FF`. Must be aligned to multiples
2142
2785
  # of 256.
2143
2786
  #
2787
+ # @option params [String] :key
2788
+ # The optional [API key][1] to authorize the request.
2789
+ #
2790
+ #
2791
+ #
2792
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2793
+ #
2144
2794
  # @option params [required, String] :map_name
2145
2795
  # The map resource associated with the glyph file.
2146
2796
  #
2147
2797
  # @return [Types::GetMapGlyphsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2148
2798
  #
2149
2799
  # * {Types::GetMapGlyphsResponse#blob #blob} => IO
2800
+ # * {Types::GetMapGlyphsResponse#cache_control #cache_control} => String
2150
2801
  # * {Types::GetMapGlyphsResponse#content_type #content_type} => String
2151
2802
  #
2152
2803
  # @example Request syntax with placeholder values
@@ -2154,12 +2805,14 @@ module Aws::LocationService
2154
2805
  # resp = client.get_map_glyphs({
2155
2806
  # font_stack: "String", # required
2156
2807
  # font_unicode_range: "GetMapGlyphsRequestFontUnicodeRangeString", # required
2808
+ # key: "ApiKey",
2157
2809
  # map_name: "ResourceName", # required
2158
2810
  # })
2159
2811
  #
2160
2812
  # @example Response structure
2161
2813
  #
2162
2814
  # resp.blob #=> IO
2815
+ # resp.cache_control #=> String
2163
2816
  # resp.content_type #=> String
2164
2817
  #
2165
2818
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapGlyphs AWS API Documentation
@@ -2183,31 +2836,41 @@ module Aws::LocationService
2183
2836
  #
2184
2837
  # * `sprites@2x.png` for high pixel density displays
2185
2838
  #
2186
- # For the JSON document contain image offsets. Use the following file
2839
+ # For the JSON document containing image offsets. Use the following file
2187
2840
  # names:
2188
2841
  #
2189
2842
  # * `sprites.json`
2190
2843
  #
2191
2844
  # * `sprites@2x.json` for high pixel density displays
2192
2845
  #
2846
+ # @option params [String] :key
2847
+ # The optional [API key][1] to authorize the request.
2848
+ #
2849
+ #
2850
+ #
2851
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2852
+ #
2193
2853
  # @option params [required, String] :map_name
2194
2854
  # The map resource associated with the sprite file.
2195
2855
  #
2196
2856
  # @return [Types::GetMapSpritesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2197
2857
  #
2198
2858
  # * {Types::GetMapSpritesResponse#blob #blob} => IO
2859
+ # * {Types::GetMapSpritesResponse#cache_control #cache_control} => String
2199
2860
  # * {Types::GetMapSpritesResponse#content_type #content_type} => String
2200
2861
  #
2201
2862
  # @example Request syntax with placeholder values
2202
2863
  #
2203
2864
  # resp = client.get_map_sprites({
2204
2865
  # file_name: "GetMapSpritesRequestFileNameString", # required
2866
+ # key: "ApiKey",
2205
2867
  # map_name: "ResourceName", # required
2206
2868
  # })
2207
2869
  #
2208
2870
  # @example Response structure
2209
2871
  #
2210
2872
  # resp.blob #=> IO
2873
+ # resp.cache_control #=> String
2211
2874
  # resp.content_type #=> String
2212
2875
  #
2213
2876
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapSprites AWS API Documentation
@@ -2226,23 +2889,33 @@ module Aws::LocationService
2226
2889
  # data in, and the style for the data. Style descriptors follow the
2227
2890
  # Mapbox Style Specification.
2228
2891
  #
2892
+ # @option params [String] :key
2893
+ # The optional [API key][1] to authorize the request.
2894
+ #
2895
+ #
2896
+ #
2897
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2898
+ #
2229
2899
  # @option params [required, String] :map_name
2230
2900
  # The map resource to retrieve the style descriptor from.
2231
2901
  #
2232
2902
  # @return [Types::GetMapStyleDescriptorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2233
2903
  #
2234
2904
  # * {Types::GetMapStyleDescriptorResponse#blob #blob} => IO
2905
+ # * {Types::GetMapStyleDescriptorResponse#cache_control #cache_control} => String
2235
2906
  # * {Types::GetMapStyleDescriptorResponse#content_type #content_type} => String
2236
2907
  #
2237
2908
  # @example Request syntax with placeholder values
2238
2909
  #
2239
2910
  # resp = client.get_map_style_descriptor({
2911
+ # key: "ApiKey",
2240
2912
  # map_name: "ResourceName", # required
2241
2913
  # })
2242
2914
  #
2243
2915
  # @example Response structure
2244
2916
  #
2245
2917
  # resp.blob #=> IO
2918
+ # resp.cache_control #=> String
2246
2919
  # resp.content_type #=> String
2247
2920
  #
2248
2921
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapStyleDescriptor AWS API Documentation
@@ -2263,6 +2936,13 @@ module Aws::LocationService
2263
2936
  # data for the entire world at (0/0/0) will be split into 4 tiles at
2264
2937
  # zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).
2265
2938
  #
2939
+ # @option params [String] :key
2940
+ # The optional [API key][1] to authorize the request.
2941
+ #
2942
+ #
2943
+ #
2944
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
2945
+ #
2266
2946
  # @option params [required, String] :map_name
2267
2947
  # The map resource to retrieve the map tiles from.
2268
2948
  #
@@ -2278,11 +2958,13 @@ module Aws::LocationService
2278
2958
  # @return [Types::GetMapTileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2279
2959
  #
2280
2960
  # * {Types::GetMapTileResponse#blob #blob} => IO
2961
+ # * {Types::GetMapTileResponse#cache_control #cache_control} => String
2281
2962
  # * {Types::GetMapTileResponse#content_type #content_type} => String
2282
2963
  #
2283
2964
  # @example Request syntax with placeholder values
2284
2965
  #
2285
2966
  # resp = client.get_map_tile({
2967
+ # key: "ApiKey",
2286
2968
  # map_name: "ResourceName", # required
2287
2969
  # x: "GetMapTileRequestXString", # required
2288
2970
  # y: "GetMapTileRequestYString", # required
@@ -2292,6 +2974,7 @@ module Aws::LocationService
2292
2974
  # @example Response structure
2293
2975
  #
2294
2976
  # resp.blob #=> IO
2977
+ # resp.cache_control #=> String
2295
2978
  # resp.content_type #=> String
2296
2979
  #
2297
2980
  # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetMapTile AWS API Documentation
@@ -2303,43 +2986,153 @@ module Aws::LocationService
2303
2986
  req.send_request(options, &block)
2304
2987
  end
2305
2988
 
2306
- # A batch request to retrieve all device positions.
2989
+ # Finds a place by its unique ID. A `PlaceId` is returned by other
2990
+ # search operations.
2307
2991
  #
2308
- # @option params [Integer] :max_results
2309
- # An optional limit for the number of entries returned in a single call.
2992
+ # <note markdown="1"> A PlaceId is valid only if all of the following are the same in the
2993
+ # original search request and the call to `GetPlace`.
2310
2994
  #
2311
- # Default value: `100`
2995
+ # * Customer Amazon Web Services account
2312
2996
  #
2313
- # @option params [String] :next_token
2314
- # The pagination token specifying which page of results to return in the
2315
- # response. If no token is provided, the default page is the first page.
2997
+ # * Amazon Web Services Region
2316
2998
  #
2317
- # Default value: `null`
2999
+ # * Data provider specified in the place index resource
2318
3000
  #
2319
- # @option params [required, String] :tracker_name
2320
- # The tracker resource containing the requested devices.
3001
+ # </note>
2321
3002
  #
2322
- # @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3003
+ # @option params [required, String] :index_name
3004
+ # The name of the place index resource that you want to use for the
3005
+ # search.
2323
3006
  #
2324
- # * {Types::ListDevicePositionsResponse#entries #data.entries} => Array&lt;Types::ListDevicePositionsResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member)
2325
- # * {Types::ListDevicePositionsResponse#next_token #next_token} => String
3007
+ # @option params [String] :key
3008
+ # The optional [API key][1] to authorize the request.
2326
3009
  #
2327
- # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3010
+ #
3011
+ #
3012
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
3013
+ #
3014
+ # @option params [String] :language
3015
+ # The preferred language used to return results. The value must be a
3016
+ # valid [BCP 47][1] language tag, for example, `en` for English.
3017
+ #
3018
+ # This setting affects the languages used in the results, but not the
3019
+ # results themselves. If no language is specified, or not supported for
3020
+ # a particular result, the partner automatically chooses a language for
3021
+ # the result.
3022
+ #
3023
+ # For an example, we'll use the Greek language. You search for a
3024
+ # location around Athens, Greece, with the `language` parameter set to
3025
+ # `en`. The `city` in the results will most likely be returned as
3026
+ # `Athens`.
3027
+ #
3028
+ # If you set the `language` parameter to `el`, for Greek, then the
3029
+ # `city` in the results will more likely be returned as `Αθήνα`.
3030
+ #
3031
+ # If the data provider does not have a value for Greek, the result will
3032
+ # be in a language that the provider does support.
3033
+ #
3034
+ #
3035
+ #
3036
+ # [1]: https://tools.ietf.org/search/bcp47
3037
+ #
3038
+ # @option params [required, String] :place_id
3039
+ # The identifier of the place to find.
3040
+ #
3041
+ # @return [Types::GetPlaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3042
+ #
3043
+ # * {Types::GetPlaceResponse#place #place} => Types::Place
2328
3044
  #
2329
3045
  # @example Request syntax with placeholder values
2330
3046
  #
2331
- # resp = client.list_device_positions({
2332
- # max_results: 1,
2333
- # next_token: "Token",
2334
- # tracker_name: "ResourceName", # required
3047
+ # resp = client.get_place({
3048
+ # index_name: "ResourceName", # required
3049
+ # key: "ApiKey",
3050
+ # language: "LanguageTag",
3051
+ # place_id: "PlaceId", # required
3052
+ # })
3053
+ #
3054
+ # @example Response structure
3055
+ #
3056
+ # resp.place.address_number #=> String
3057
+ # resp.place.categories #=> Array
3058
+ # resp.place.categories[0] #=> String
3059
+ # resp.place.country #=> String
3060
+ # resp.place.geometry.point #=> Array
3061
+ # resp.place.geometry.point[0] #=> Float
3062
+ # resp.place.interpolated #=> Boolean
3063
+ # resp.place.label #=> String
3064
+ # resp.place.municipality #=> String
3065
+ # resp.place.neighborhood #=> String
3066
+ # resp.place.postal_code #=> String
3067
+ # resp.place.region #=> String
3068
+ # resp.place.street #=> String
3069
+ # resp.place.sub_region #=> String
3070
+ # resp.place.supplemental_categories #=> Array
3071
+ # resp.place.supplemental_categories[0] #=> String
3072
+ # resp.place.time_zone.name #=> String
3073
+ # resp.place.time_zone.offset #=> Integer
3074
+ # resp.place.unit_number #=> String
3075
+ # resp.place.unit_type #=> String
3076
+ #
3077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetPlace AWS API Documentation
3078
+ #
3079
+ # @overload get_place(params = {})
3080
+ # @param [Hash] params ({})
3081
+ def get_place(params = {}, options = {})
3082
+ req = build_request(:get_place, params)
3083
+ req.send_request(options)
3084
+ end
3085
+
3086
+ # A batch request to retrieve all device positions.
3087
+ #
3088
+ # @option params [Types::TrackingFilterGeometry] :filter_geometry
3089
+ # The geomerty used to filter device positions.
3090
+ #
3091
+ # @option params [Integer] :max_results
3092
+ # An optional limit for the number of entries returned in a single call.
3093
+ #
3094
+ # Default value: `100`
3095
+ #
3096
+ # @option params [String] :next_token
3097
+ # The pagination token specifying which page of results to return in the
3098
+ # response. If no token is provided, the default page is the first page.
3099
+ #
3100
+ # Default value: `null`
3101
+ #
3102
+ # @option params [required, String] :tracker_name
3103
+ # The tracker resource containing the requested devices.
3104
+ #
3105
+ # @return [Types::ListDevicePositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3106
+ #
3107
+ # * {Types::ListDevicePositionsResponse#entries #data.entries} => Array&lt;Types::ListDevicePositionsResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member)
3108
+ # * {Types::ListDevicePositionsResponse#next_token #next_token} => String
3109
+ #
3110
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3111
+ #
3112
+ # @example Request syntax with placeholder values
3113
+ #
3114
+ # resp = client.list_device_positions({
3115
+ # filter_geometry: {
3116
+ # polygon: [
3117
+ # [
3118
+ # [1.0],
3119
+ # ],
3120
+ # ],
3121
+ # },
3122
+ # max_results: 1,
3123
+ # next_token: "Token",
3124
+ # tracker_name: "ResourceName", # required
2335
3125
  # })
2336
3126
  #
2337
3127
  # @example Response structure
2338
3128
  #
2339
3129
  # resp.data.entries #=> Array
3130
+ # resp.data.entries[0].accuracy.horizontal #=> Float
2340
3131
  # resp.data.entries[0].device_id #=> String
2341
3132
  # resp.data.entries[0].position #=> Array
2342
3133
  # resp.data.entries[0].position[0] #=> Float
3134
+ # resp.data.entries[0].position_properties #=> Hash
3135
+ # resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
2343
3136
  # resp.data.entries[0].sample_time #=> Time
2344
3137
  # resp.next_token #=> String
2345
3138
  #
@@ -2352,7 +3145,7 @@ module Aws::LocationService
2352
3145
  req.send_request(options)
2353
3146
  end
2354
3147
 
2355
- # Lists geofence collections in your AWS account.
3148
+ # Lists geofence collections in your Amazon Web Services account.
2356
3149
  #
2357
3150
  # @option params [Integer] :max_results
2358
3151
  # An optional limit for the number of resources returned in a single
@@ -2405,6 +3198,12 @@ module Aws::LocationService
2405
3198
  # @option params [required, String] :collection_name
2406
3199
  # The name of the geofence collection storing the list of geofences.
2407
3200
  #
3201
+ # @option params [Integer] :max_results
3202
+ # An optional limit for the number of geofences returned in a single
3203
+ # call.
3204
+ #
3205
+ # Default value: `100`
3206
+ #
2408
3207
  # @option params [String] :next_token
2409
3208
  # The pagination token specifying which page of results to return in the
2410
3209
  # response. If no token is provided, the default page is the first page.
@@ -2422,6 +3221,7 @@ module Aws::LocationService
2422
3221
  #
2423
3222
  # resp = client.list_geofences({
2424
3223
  # collection_name: "ResourceName", # required
3224
+ # max_results: 1,
2425
3225
  # next_token: "Token",
2426
3226
  # })
2427
3227
  #
@@ -2430,6 +3230,11 @@ module Aws::LocationService
2430
3230
  # resp.data.entries #=> Array
2431
3231
  # resp.data.entries[0].create_time #=> Time
2432
3232
  # resp.data.entries[0].geofence_id #=> String
3233
+ # resp.data.entries[0].geofence_properties #=> Hash
3234
+ # resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String
3235
+ # resp.data.entries[0].geometry.circle.center #=> Array
3236
+ # resp.data.entries[0].geometry.circle.center[0] #=> Float
3237
+ # resp.data.entries[0].geometry.circle.radius #=> Float
2433
3238
  # resp.data.entries[0].geometry.polygon #=> Array
2434
3239
  # resp.data.entries[0].geometry.polygon[0] #=> Array
2435
3240
  # resp.data.entries[0].geometry.polygon[0][0] #=> Array
@@ -2447,7 +3252,66 @@ module Aws::LocationService
2447
3252
  req.send_request(options)
2448
3253
  end
2449
3254
 
2450
- # Lists map resources in your AWS account.
3255
+ # Lists API key resources in your Amazon Web Services account.
3256
+ #
3257
+ # @option params [Types::ApiKeyFilter] :filter
3258
+ # Optionally filter the list to only `Active` or `Expired` API keys.
3259
+ #
3260
+ # @option params [Integer] :max_results
3261
+ # An optional limit for the number of resources returned in a single
3262
+ # call.
3263
+ #
3264
+ # Default value: `100`
3265
+ #
3266
+ # @option params [String] :next_token
3267
+ # The pagination token specifying which page of results to return in the
3268
+ # response. If no token is provided, the default page is the first page.
3269
+ #
3270
+ # Default value: `null`
3271
+ #
3272
+ # @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3273
+ #
3274
+ # * {Types::ListKeysResponse#entries #data.entries} => Array&lt;Types::ListKeysResponseEntry&gt; (This method conflicts with a method on Response, call it through the data member)
3275
+ # * {Types::ListKeysResponse#next_token #next_token} => String
3276
+ #
3277
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3278
+ #
3279
+ # @example Request syntax with placeholder values
3280
+ #
3281
+ # resp = client.list_keys({
3282
+ # filter: {
3283
+ # key_status: "Active", # accepts Active, Expired
3284
+ # },
3285
+ # max_results: 1,
3286
+ # next_token: "Token",
3287
+ # })
3288
+ #
3289
+ # @example Response structure
3290
+ #
3291
+ # resp.data.entries #=> Array
3292
+ # resp.data.entries[0].create_time #=> Time
3293
+ # resp.data.entries[0].description #=> String
3294
+ # resp.data.entries[0].expire_time #=> Time
3295
+ # resp.data.entries[0].key_name #=> String
3296
+ # resp.data.entries[0].restrictions.allow_actions #=> Array
3297
+ # resp.data.entries[0].restrictions.allow_actions[0] #=> String
3298
+ # resp.data.entries[0].restrictions.allow_referers #=> Array
3299
+ # resp.data.entries[0].restrictions.allow_referers[0] #=> String
3300
+ # resp.data.entries[0].restrictions.allow_resources #=> Array
3301
+ # resp.data.entries[0].restrictions.allow_resources[0] #=> String
3302
+ # resp.data.entries[0].update_time #=> Time
3303
+ # resp.next_token #=> String
3304
+ #
3305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListKeys AWS API Documentation
3306
+ #
3307
+ # @overload list_keys(params = {})
3308
+ # @param [Hash] params ({})
3309
+ def list_keys(params = {}, options = {})
3310
+ req = build_request(:list_keys, params)
3311
+ req.send_request(options)
3312
+ end
3313
+
3314
+ # Lists map resources in your Amazon Web Services account.
2451
3315
  #
2452
3316
  # @option params [Integer] :max_results
2453
3317
  # An optional limit for the number of resources returned in a single
@@ -2495,7 +3359,7 @@ module Aws::LocationService
2495
3359
  req.send_request(options)
2496
3360
  end
2497
3361
 
2498
- # Lists place index resources in your AWS account.
3362
+ # Lists place index resources in your Amazon Web Services account.
2499
3363
  #
2500
3364
  # @option params [Integer] :max_results
2501
3365
  # An optional limit for the maximum number of results returned in a
@@ -2543,7 +3407,7 @@ module Aws::LocationService
2543
3407
  req.send_request(options)
2544
3408
  end
2545
3409
 
2546
- # Lists route calculator resources in your AWS account.
3410
+ # Lists route calculator resources in your Amazon Web Services account.
2547
3411
  #
2548
3412
  # @option params [Integer] :max_results
2549
3413
  # An optional maximum number of results returned in a single call.
@@ -2675,7 +3539,7 @@ module Aws::LocationService
2675
3539
  req.send_request(options)
2676
3540
  end
2677
3541
 
2678
- # Lists tracker resources in your AWS account.
3542
+ # Lists tracker resources in your Amazon Web Services account.
2679
3543
  #
2680
3544
  # @option params [Integer] :max_results
2681
3545
  # An optional limit for the number of resources returned in a single
@@ -2733,10 +3597,19 @@ module Aws::LocationService
2733
3597
  # @option params [required, String] :geofence_id
2734
3598
  # An identifier for the geofence. For example, `ExampleGeofence-1`.
2735
3599
  #
3600
+ # @option params [Hash<String,String>] :geofence_properties
3601
+ # Associates one of more properties with the geofence. A property is a
3602
+ # key-value pair stored with the geofence and added to any geofence
3603
+ # event triggered with that geofence.
3604
+ #
3605
+ # Format: `"key" : "value"`
3606
+ #
2736
3607
  # @option params [required, Types::GeofenceGeometry] :geometry
2737
- # Contains the polygon details to specify the position of the geofence.
3608
+ # Contains the details to specify the position of the geofence. Can be
3609
+ # either a polygon or a circle. Including both will return a validation
3610
+ # error.
2738
3611
  #
2739
- # <note markdown="1"> Each [geofence polygon][1] can have a maximum of 1,000 vertices.
3612
+ # <note markdown="1"> Each [ geofence polygon][1] can have a maximum of 1,000 vertices.
2740
3613
  #
2741
3614
  # </note>
2742
3615
  #
@@ -2755,7 +3628,14 @@ module Aws::LocationService
2755
3628
  # resp = client.put_geofence({
2756
3629
  # collection_name: "ResourceName", # required
2757
3630
  # geofence_id: "Id", # required
3631
+ # geofence_properties: {
3632
+ # "PropertyMapKeyString" => "PropertyMapValueString",
3633
+ # },
2758
3634
  # geometry: { # required
3635
+ # circle: {
3636
+ # center: [1.0], # required
3637
+ # radius: 1.0, # required
3638
+ # },
2759
3639
  # polygon: [
2760
3640
  # [
2761
3641
  # [1.0],
@@ -2786,14 +3666,32 @@ module Aws::LocationService
2786
3666
  # @option params [required, String] :index_name
2787
3667
  # The name of the place index resource you want to use for the search.
2788
3668
  #
3669
+ # @option params [String] :key
3670
+ # The optional [API key][1] to authorize the request.
3671
+ #
3672
+ #
3673
+ #
3674
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
3675
+ #
2789
3676
  # @option params [String] :language
2790
3677
  # The preferred language used to return results. The value must be a
2791
3678
  # valid [BCP 47][1] language tag, for example, `en` for English.
2792
3679
  #
2793
- # This setting affects the languages used in the results. It does not
2794
- # change which results are returned. If the language is not specified,
2795
- # or not supported for a particular result, the partner automatically
2796
- # chooses a language for the result.
3680
+ # This setting affects the languages used in the results, but not the
3681
+ # results themselves. If no language is specified, or not supported for
3682
+ # a particular result, the partner automatically chooses a language for
3683
+ # the result.
3684
+ #
3685
+ # For an example, we'll use the Greek language. You search for a
3686
+ # location around Athens, Greece, with the `language` parameter set to
3687
+ # `en`. The `city` in the results will most likely be returned as
3688
+ # `Athens`.
3689
+ #
3690
+ # If you set the `language` parameter to `el`, for Greek, then the
3691
+ # `city` in the results will more likely be returned as `Αθήνα`.
3692
+ #
3693
+ # If the data provider does not have a value for Greek, the result will
3694
+ # be in a language that the provider does support.
2797
3695
  #
2798
3696
  #
2799
3697
  #
@@ -2824,6 +3722,7 @@ module Aws::LocationService
2824
3722
  #
2825
3723
  # resp = client.search_place_index_for_position({
2826
3724
  # index_name: "ResourceName", # required
3725
+ # key: "ApiKey",
2827
3726
  # language: "LanguageTag",
2828
3727
  # max_results: 1,
2829
3728
  # position: [1.0], # required
@@ -2834,6 +3733,8 @@ module Aws::LocationService
2834
3733
  # resp.results #=> Array
2835
3734
  # resp.results[0].distance #=> Float
2836
3735
  # resp.results[0].place.address_number #=> String
3736
+ # resp.results[0].place.categories #=> Array
3737
+ # resp.results[0].place.categories[0] #=> String
2837
3738
  # resp.results[0].place.country #=> String
2838
3739
  # resp.results[0].place.geometry.point #=> Array
2839
3740
  # resp.results[0].place.geometry.point[0] #=> Float
@@ -2845,8 +3746,13 @@ module Aws::LocationService
2845
3746
  # resp.results[0].place.region #=> String
2846
3747
  # resp.results[0].place.street #=> String
2847
3748
  # resp.results[0].place.sub_region #=> String
3749
+ # resp.results[0].place.supplemental_categories #=> Array
3750
+ # resp.results[0].place.supplemental_categories[0] #=> String
2848
3751
  # resp.results[0].place.time_zone.name #=> String
2849
3752
  # resp.results[0].place.time_zone.offset #=> Integer
3753
+ # resp.results[0].place.unit_number #=> String
3754
+ # resp.results[0].place.unit_type #=> String
3755
+ # resp.results[0].place_id #=> String
2850
3756
  # resp.summary.data_source #=> String
2851
3757
  # resp.summary.language #=> String
2852
3758
  # resp.summary.max_results #=> Integer
@@ -2862,6 +3768,176 @@ module Aws::LocationService
2862
3768
  req.send_request(options)
2863
3769
  end
2864
3770
 
3771
+ # Generates suggestions for addresses and points of interest based on
3772
+ # partial or misspelled free-form text. This operation is also known as
3773
+ # autocomplete, autosuggest, or fuzzy matching.
3774
+ #
3775
+ # Optional parameters let you narrow your search results by bounding box
3776
+ # or country, or bias your search toward a specific position on the
3777
+ # globe.
3778
+ #
3779
+ # <note markdown="1"> You can search for suggested place names near a specified position by
3780
+ # using `BiasPosition`, or filter results within a bounding box by using
3781
+ # `FilterBBox`. These parameters are mutually exclusive; using both
3782
+ # `BiasPosition` and `FilterBBox` in the same command returns an error.
3783
+ #
3784
+ # </note>
3785
+ #
3786
+ # @option params [Array<Float>] :bias_position
3787
+ # An optional parameter that indicates a preference for place
3788
+ # suggestions that are closer to a specified position.
3789
+ #
3790
+ # If provided, this parameter must contain a pair of numbers. The first
3791
+ # number represents the X coordinate, or longitude; the second number
3792
+ # represents the Y coordinate, or latitude.
3793
+ #
3794
+ # For example, `[-123.1174, 49.2847]` represents the position with
3795
+ # longitude `-123.1174` and latitude `49.2847`.
3796
+ #
3797
+ # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
3798
+ # both options results in an error.
3799
+ #
3800
+ # </note>
3801
+ #
3802
+ # @option params [Array<Float>] :filter_b_box
3803
+ # An optional parameter that limits the search results by returning only
3804
+ # suggestions within a specified bounding box.
3805
+ #
3806
+ # If provided, this parameter must contain a total of four consecutive
3807
+ # numbers in two pairs. The first pair of numbers represents the X and Y
3808
+ # coordinates (longitude and latitude, respectively) of the southwest
3809
+ # corner of the bounding box; the second pair of numbers represents the
3810
+ # X and Y coordinates (longitude and latitude, respectively) of the
3811
+ # northeast corner of the bounding box.
3812
+ #
3813
+ # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
3814
+ # bounding box where the southwest corner has longitude `-12.7935` and
3815
+ # latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
3816
+ # and latitude `-36.9542`.
3817
+ #
3818
+ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
3819
+ # both options results in an error.
3820
+ #
3821
+ # </note>
3822
+ #
3823
+ # @option params [Array<String>] :filter_categories
3824
+ # A list of one or more Amazon Location categories to filter the
3825
+ # returned places. If you include more than one category, the results
3826
+ # will include results that match *any* of the categories listed.
3827
+ #
3828
+ # For more information about using categories, including a list of
3829
+ # Amazon Location categories, see [Categories and filtering][1], in the
3830
+ # *Amazon Location Service Developer Guide*.
3831
+ #
3832
+ #
3833
+ #
3834
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
3835
+ #
3836
+ # @option params [Array<String>] :filter_countries
3837
+ # An optional parameter that limits the search results by returning only
3838
+ # suggestions within the provided list of countries.
3839
+ #
3840
+ # * Use the [ISO 3166][1] 3-digit country code. For example, Australia
3841
+ # uses three upper-case characters: `AUS`.
3842
+ #
3843
+ # ^
3844
+ #
3845
+ #
3846
+ #
3847
+ # [1]: https://www.iso.org/iso-3166-country-codes.html
3848
+ #
3849
+ # @option params [required, String] :index_name
3850
+ # The name of the place index resource you want to use for the search.
3851
+ #
3852
+ # @option params [String] :key
3853
+ # The optional [API key][1] to authorize the request.
3854
+ #
3855
+ #
3856
+ #
3857
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
3858
+ #
3859
+ # @option params [String] :language
3860
+ # The preferred language used to return results. The value must be a
3861
+ # valid [BCP 47][1] language tag, for example, `en` for English.
3862
+ #
3863
+ # This setting affects the languages used in the results. If no language
3864
+ # is specified, or not supported for a particular result, the partner
3865
+ # automatically chooses a language for the result.
3866
+ #
3867
+ # For an example, we'll use the Greek language. You search for `Athens,
3868
+ # Gr` to get suggestions with the `language` parameter set to `en`. The
3869
+ # results found will most likely be returned as `Athens, Greece`.
3870
+ #
3871
+ # If you set the `language` parameter to `el`, for Greek, then the
3872
+ # result found will more likely be returned as `Αθήνα, Ελλάδα`.
3873
+ #
3874
+ # If the data provider does not have a value for Greek, the result will
3875
+ # be in a language that the provider does support.
3876
+ #
3877
+ #
3878
+ #
3879
+ # [1]: https://tools.ietf.org/search/bcp47
3880
+ #
3881
+ # @option params [Integer] :max_results
3882
+ # An optional parameter. The maximum number of results returned per
3883
+ # request.
3884
+ #
3885
+ # The default: `5`
3886
+ #
3887
+ # @option params [required, String] :text
3888
+ # The free-form partial text to use to generate place suggestions. For
3889
+ # example, `eiffel tow`.
3890
+ #
3891
+ # @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3892
+ #
3893
+ # * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array&lt;Types::SearchForSuggestionsResult&gt;
3894
+ # * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
3895
+ #
3896
+ # @example Request syntax with placeholder values
3897
+ #
3898
+ # resp = client.search_place_index_for_suggestions({
3899
+ # bias_position: [1.0],
3900
+ # filter_b_box: [1.0],
3901
+ # filter_categories: ["PlaceCategory"],
3902
+ # filter_countries: ["CountryCode"],
3903
+ # index_name: "ResourceName", # required
3904
+ # key: "ApiKey",
3905
+ # language: "LanguageTag",
3906
+ # max_results: 1,
3907
+ # text: "SearchPlaceIndexForSuggestionsRequestTextString", # required
3908
+ # })
3909
+ #
3910
+ # @example Response structure
3911
+ #
3912
+ # resp.results #=> Array
3913
+ # resp.results[0].categories #=> Array
3914
+ # resp.results[0].categories[0] #=> String
3915
+ # resp.results[0].place_id #=> String
3916
+ # resp.results[0].supplemental_categories #=> Array
3917
+ # resp.results[0].supplemental_categories[0] #=> String
3918
+ # resp.results[0].text #=> String
3919
+ # resp.summary.bias_position #=> Array
3920
+ # resp.summary.bias_position[0] #=> Float
3921
+ # resp.summary.data_source #=> String
3922
+ # resp.summary.filter_b_box #=> Array
3923
+ # resp.summary.filter_b_box[0] #=> Float
3924
+ # resp.summary.filter_categories #=> Array
3925
+ # resp.summary.filter_categories[0] #=> String
3926
+ # resp.summary.filter_countries #=> Array
3927
+ # resp.summary.filter_countries[0] #=> String
3928
+ # resp.summary.language #=> String
3929
+ # resp.summary.max_results #=> Integer
3930
+ # resp.summary.text #=> String
3931
+ #
3932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
3933
+ #
3934
+ # @overload search_place_index_for_suggestions(params = {})
3935
+ # @param [Hash] params ({})
3936
+ def search_place_index_for_suggestions(params = {}, options = {})
3937
+ req = build_request(:search_place_index_for_suggestions, params)
3938
+ req.send_request(options)
3939
+ end
3940
+
2865
3941
  # Geocodes free-form text, such as an address, name, city, or region to
2866
3942
  # allow you to search for Places or points of interest.
2867
3943
  #
@@ -2914,6 +3990,19 @@ module Aws::LocationService
2914
3990
  #
2915
3991
  # </note>
2916
3992
  #
3993
+ # @option params [Array<String>] :filter_categories
3994
+ # A list of one or more Amazon Location categories to filter the
3995
+ # returned places. If you include more than one category, the results
3996
+ # will include results that match *any* of the categories listed.
3997
+ #
3998
+ # For more information about using categories, including a list of
3999
+ # Amazon Location categories, see [Categories and filtering][1], in the
4000
+ # *Amazon Location Service Developer Guide*.
4001
+ #
4002
+ #
4003
+ #
4004
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html
4005
+ #
2917
4006
  # @option params [Array<String>] :filter_countries
2918
4007
  # An optional parameter that limits the search results by returning only
2919
4008
  # places that are in a specified list of countries.
@@ -2930,14 +4019,31 @@ module Aws::LocationService
2930
4019
  # @option params [required, String] :index_name
2931
4020
  # The name of the place index resource you want to use for the search.
2932
4021
  #
4022
+ # @option params [String] :key
4023
+ # The optional [API key][1] to authorize the request.
4024
+ #
4025
+ #
4026
+ #
4027
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html
4028
+ #
2933
4029
  # @option params [String] :language
2934
4030
  # The preferred language used to return results. The value must be a
2935
4031
  # valid [BCP 47][1] language tag, for example, `en` for English.
2936
4032
  #
2937
- # This setting affects the languages used in the results. It does not
2938
- # change which results are returned. If the language is not specified,
2939
- # or not supported for a particular result, the partner automatically
2940
- # chooses a language for the result.
4033
+ # This setting affects the languages used in the results, but not the
4034
+ # results themselves. If no language is specified, or not supported for
4035
+ # a particular result, the partner automatically chooses a language for
4036
+ # the result.
4037
+ #
4038
+ # For an example, we'll use the Greek language. You search for `Athens,
4039
+ # Greece`, with the `language` parameter set to `en`. The result found
4040
+ # will most likely be returned as `Athens`.
4041
+ #
4042
+ # If you set the `language` parameter to `el`, for Greek, then the
4043
+ # result found will more likely be returned as `Αθήνα`.
4044
+ #
4045
+ # If the data provider does not have a value for Greek, the result will
4046
+ # be in a language that the provider does support.
2941
4047
  #
2942
4048
  #
2943
4049
  #
@@ -2963,11 +4069,13 @@ module Aws::LocationService
2963
4069
  # resp = client.search_place_index_for_text({
2964
4070
  # bias_position: [1.0],
2965
4071
  # filter_b_box: [1.0],
4072
+ # filter_categories: ["PlaceCategory"],
2966
4073
  # filter_countries: ["CountryCode"],
2967
4074
  # index_name: "ResourceName", # required
4075
+ # key: "ApiKey",
2968
4076
  # language: "LanguageTag",
2969
4077
  # max_results: 1,
2970
- # text: "SyntheticSearchPlaceIndexForTextRequestString", # required
4078
+ # text: "SearchPlaceIndexForTextRequestTextString", # required
2971
4079
  # })
2972
4080
  #
2973
4081
  # @example Response structure
@@ -2975,6 +4083,8 @@ module Aws::LocationService
2975
4083
  # resp.results #=> Array
2976
4084
  # resp.results[0].distance #=> Float
2977
4085
  # resp.results[0].place.address_number #=> String
4086
+ # resp.results[0].place.categories #=> Array
4087
+ # resp.results[0].place.categories[0] #=> String
2978
4088
  # resp.results[0].place.country #=> String
2979
4089
  # resp.results[0].place.geometry.point #=> Array
2980
4090
  # resp.results[0].place.geometry.point[0] #=> Float
@@ -2986,14 +4096,21 @@ module Aws::LocationService
2986
4096
  # resp.results[0].place.region #=> String
2987
4097
  # resp.results[0].place.street #=> String
2988
4098
  # resp.results[0].place.sub_region #=> String
4099
+ # resp.results[0].place.supplemental_categories #=> Array
4100
+ # resp.results[0].place.supplemental_categories[0] #=> String
2989
4101
  # resp.results[0].place.time_zone.name #=> String
2990
4102
  # resp.results[0].place.time_zone.offset #=> Integer
4103
+ # resp.results[0].place.unit_number #=> String
4104
+ # resp.results[0].place.unit_type #=> String
4105
+ # resp.results[0].place_id #=> String
2991
4106
  # resp.results[0].relevance #=> Float
2992
4107
  # resp.summary.bias_position #=> Array
2993
4108
  # resp.summary.bias_position[0] #=> Float
2994
4109
  # resp.summary.data_source #=> String
2995
4110
  # resp.summary.filter_b_box #=> Array
2996
4111
  # resp.summary.filter_b_box[0] #=> Float
4112
+ # resp.summary.filter_categories #=> Array
4113
+ # resp.summary.filter_categories[0] #=> String
2997
4114
  # resp.summary.filter_countries #=> Array
2998
4115
  # resp.summary.filter_countries[0] #=> String
2999
4116
  # resp.summary.language #=> String
@@ -3014,7 +4131,18 @@ module Aws::LocationService
3014
4131
  # Assigns one or more tags (key-value pairs) to the specified Amazon
3015
4132
  # Location Service resource.
3016
4133
  #
3017
- # <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p> <p>You can use the <code>TagResource</code> operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </p> <p>You can associate up to 50 tags with a resource.</p>
4134
+ # Tags can help you organize and categorize your resources. You can also
4135
+ # use them to scope user permissions, by granting a user permission to
4136
+ # access or change only resources with certain tag values.
4137
+ #
4138
+ # You can use the `TagResource` operation with an Amazon Location
4139
+ # Service resource that already has tags. If you specify a new tag key
4140
+ # for the resource, this tag is appended to the tags already associated
4141
+ # with the resource. If you specify a tag key that's already associated
4142
+ # with the resource, the new tag value that you specify replaces the
4143
+ # previous value for that tag.
4144
+ #
4145
+ # You can associate up to 50 tags with a resource.
3018
4146
  #
3019
4147
  # @option params [required, String] :resource_arn
3020
4148
  # The Amazon Resource Name (ARN) of the resource whose tags you want to
@@ -3109,38 +4237,11 @@ module Aws::LocationService
3109
4237
  # Updates the description for the geofence collection.
3110
4238
  #
3111
4239
  # @option params [String] :pricing_plan
3112
- # Updates the pricing plan for the geofence collection.
3113
- #
3114
- # For more information about each pricing plan option restrictions, see
3115
- # [Amazon Location Service pricing][1].
3116
- #
3117
- #
3118
- #
3119
- # [1]: https://aws.amazon.com/location/pricing/
4240
+ # No longer used. If included, the only allowed value is
4241
+ # `RequestBasedUsage`.
3120
4242
  #
3121
4243
  # @option params [String] :pricing_plan_data_source
3122
- # Updates the data provider for the geofence collection.
3123
- #
3124
- # A required value for the following pricing plans:
3125
- # `MobileAssetTracking`\| `MobileAssetManagement`
3126
- #
3127
- # For more information about [data providers][1] and [pricing plans][2],
3128
- # see the Amazon Location Service product page.
3129
- #
3130
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
3131
- # request.
3132
- #
3133
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
3134
- # billing for your geofence collection. Your data won't be shared with
3135
- # the data provider, and will remain in your AWS account and Region
3136
- # unless you move it.
3137
- #
3138
- # </note>
3139
- #
3140
- #
3141
- #
3142
- # [1]: https://aws.amazon.com/location/data-providers/
3143
- # [2]: https://aws.amazon.com/location/pricing/
4244
+ # This parameter is no longer used.
3144
4245
  #
3145
4246
  # @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3146
4247
  #
@@ -3172,8 +4273,82 @@ module Aws::LocationService
3172
4273
  req.send_request(options)
3173
4274
  end
3174
4275
 
4276
+ # Updates the specified properties of a given API key resource.
4277
+ #
4278
+ # @option params [String] :description
4279
+ # Updates the description for the API key resource.
4280
+ #
4281
+ # @option params [Time,DateTime,Date,Integer,String] :expire_time
4282
+ # Updates the timestamp for when the API key resource will expire in [
4283
+ # ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`.
4284
+ #
4285
+ #
4286
+ #
4287
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
4288
+ #
4289
+ # @option params [Boolean] :force_update
4290
+ # The boolean flag to be included for updating `ExpireTime` or
4291
+ # `Restrictions` details.
4292
+ #
4293
+ # Must be set to `true` to update an API key resource that has been used
4294
+ # in the past 7 days.
4295
+ #
4296
+ # `False` if force update is not preferred
4297
+ #
4298
+ # Default value: `False`
4299
+ #
4300
+ # @option params [required, String] :key_name
4301
+ # The name of the API key resource to update.
4302
+ #
4303
+ # @option params [Boolean] :no_expiry
4304
+ # Whether the API key should expire. Set to `true` to set the API key to
4305
+ # have no expiration time.
4306
+ #
4307
+ # @option params [Types::ApiKeyRestrictions] :restrictions
4308
+ # Updates the API key restrictions for the API key resource.
4309
+ #
4310
+ # @return [Types::UpdateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4311
+ #
4312
+ # * {Types::UpdateKeyResponse#key_arn #key_arn} => String
4313
+ # * {Types::UpdateKeyResponse#key_name #key_name} => String
4314
+ # * {Types::UpdateKeyResponse#update_time #update_time} => Time
4315
+ #
4316
+ # @example Request syntax with placeholder values
4317
+ #
4318
+ # resp = client.update_key({
4319
+ # description: "ResourceDescription",
4320
+ # expire_time: Time.now,
4321
+ # force_update: false,
4322
+ # key_name: "ResourceName", # required
4323
+ # no_expiry: false,
4324
+ # restrictions: {
4325
+ # allow_actions: ["ApiKeyAction"], # required
4326
+ # allow_referers: ["RefererPattern"],
4327
+ # allow_resources: ["GeoArn"], # required
4328
+ # },
4329
+ # })
4330
+ #
4331
+ # @example Response structure
4332
+ #
4333
+ # resp.key_arn #=> String
4334
+ # resp.key_name #=> String
4335
+ # resp.update_time #=> Time
4336
+ #
4337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateKey AWS API Documentation
4338
+ #
4339
+ # @overload update_key(params = {})
4340
+ # @param [Hash] params ({})
4341
+ def update_key(params = {}, options = {})
4342
+ req = build_request(:update_key, params)
4343
+ req.send_request(options)
4344
+ end
4345
+
3175
4346
  # Updates the specified properties of a given map resource.
3176
4347
  #
4348
+ # @option params [Types::MapConfigurationUpdate] :configuration_update
4349
+ # Updates the parts of the map configuration that can be updated,
4350
+ # including the political view.
4351
+ #
3177
4352
  # @option params [String] :description
3178
4353
  # Updates the description for the map resource.
3179
4354
  #
@@ -3181,14 +4356,8 @@ module Aws::LocationService
3181
4356
  # The name of the map resource to update.
3182
4357
  #
3183
4358
  # @option params [String] :pricing_plan
3184
- # Updates the pricing plan for the map resource.
3185
- #
3186
- # For more information about each pricing plan option restrictions, see
3187
- # [Amazon Location Service pricing][1].
3188
- #
3189
- #
3190
- #
3191
- # [1]: https://aws.amazon.com/location/pricing/
4359
+ # No longer used. If included, the only allowed value is
4360
+ # `RequestBasedUsage`.
3192
4361
  #
3193
4362
  # @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3194
4363
  #
@@ -3199,6 +4368,9 @@ module Aws::LocationService
3199
4368
  # @example Request syntax with placeholder values
3200
4369
  #
3201
4370
  # resp = client.update_map({
4371
+ # configuration_update: {
4372
+ # political_view: "CountryCode3OrEmpty",
4373
+ # },
3202
4374
  # description: "ResourceDescription",
3203
4375
  # map_name: "ResourceName", # required
3204
4376
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
@@ -3231,14 +4403,8 @@ module Aws::LocationService
3231
4403
  # The name of the place index resource to update.
3232
4404
  #
3233
4405
  # @option params [String] :pricing_plan
3234
- # Updates the pricing plan for the place index resource.
3235
- #
3236
- # For more information about each pricing plan option restrictions, see
3237
- # [Amazon Location Service pricing][1].
3238
- #
3239
- #
3240
- #
3241
- # [1]: https://aws.amazon.com/location/pricing/
4406
+ # No longer used. If included, the only allowed value is
4407
+ # `RequestBasedUsage`.
3242
4408
  #
3243
4409
  # @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3244
4410
  #
@@ -3282,14 +4448,8 @@ module Aws::LocationService
3282
4448
  # Updates the description for the route calculator resource.
3283
4449
  #
3284
4450
  # @option params [String] :pricing_plan
3285
- # Updates the pricing plan for the route calculator resource.
3286
- #
3287
- # For more information about each pricing plan option restrictions, see
3288
- # [Amazon Location Service pricing][1].
3289
- #
3290
- #
3291
- #
3292
- # [1]: https://aws.amazon.com/location/pricing/
4451
+ # No longer used. If included, the only allowed value is
4452
+ # `RequestBasedUsage`.
3293
4453
  #
3294
4454
  # @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3295
4455
  #
@@ -3325,6 +4485,27 @@ module Aws::LocationService
3325
4485
  # @option params [String] :description
3326
4486
  # Updates the description for the tracker resource.
3327
4487
  #
4488
+ # @option params [Boolean] :event_bridge_enabled
4489
+ # Whether to enable position `UPDATE` events from this tracker to be
4490
+ # sent to EventBridge.
4491
+ #
4492
+ # <note markdown="1"> You do not need enable this feature to get `ENTER` and `EXIT` events
4493
+ # for geofences with this tracker. Those events are always sent to
4494
+ # EventBridge.
4495
+ #
4496
+ # </note>
4497
+ #
4498
+ # @option params [Boolean] :kms_key_enable_geospatial_queries
4499
+ # Enables `GeospatialQueries` for a tracker that uses a [Amazon Web
4500
+ # Services KMS customer managed key][1].
4501
+ #
4502
+ # This parameter is only used if you are using a KMS customer managed
4503
+ # key.
4504
+ #
4505
+ #
4506
+ #
4507
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
4508
+ #
3328
4509
  # @option params [String] :position_filtering
3329
4510
  # Updates the position filtering for the tracker resource.
3330
4511
  #
@@ -3339,43 +4520,26 @@ module Aws::LocationService
3339
4520
  # location updates are ignored. Location updates within this distance
3340
4521
  # are neither evaluated against linked geofence collections, nor
3341
4522
  # 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.
3345
- #
3346
- # @option params [String] :pricing_plan
3347
- # Updates the pricing plan for the tracker resource.
3348
- #
3349
- # For more information about each pricing plan option restrictions, see
3350
- # [Amazon Location Service pricing][1].
3351
- #
4523
+ # evaluations and historical device positions to paginate through.
4524
+ # Distance-based filtering can also reduce the effects of GPS noise
4525
+ # when displaying device trajectories on a map.
3352
4526
  #
4527
+ # * `AccuracyBased` - If the device has moved less than the measured
4528
+ # accuracy, location updates are ignored. For example, if two
4529
+ # consecutive updates from a device have a horizontal accuracy of 5 m
4530
+ # and 10 m, the second update is ignored if the device has moved less
4531
+ # than 15 m. Ignored location updates are neither evaluated against
4532
+ # linked geofence collections, nor stored. This helps educe the
4533
+ # effects of GPS noise when displaying device trajectories on a map,
4534
+ # and can help control costs by reducing the number of geofence
4535
+ # evaluations.
3353
4536
  #
3354
- # [1]: https://aws.amazon.com/location/pricing/
4537
+ # @option params [String] :pricing_plan
4538
+ # No longer used. If included, the only allowed value is
4539
+ # `RequestBasedUsage`.
3355
4540
  #
3356
4541
  # @option params [String] :pricing_plan_data_source
3357
- # Updates the data provider for the tracker resource.
3358
- #
3359
- # A required value for the following pricing plans:
3360
- # `MobileAssetTracking`\| `MobileAssetManagement`
3361
- #
3362
- # For more information about [data providers][1] and [pricing plans][2],
3363
- # see the Amazon Location Service product page
3364
- #
3365
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
3366
- # request.
3367
- #
3368
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
3369
- # billing for your tracker resource. Your data won't be shared with the
3370
- # data provider, and will remain in your AWS account and Region unless
3371
- # you move it.
3372
- #
3373
- # </note>
3374
- #
3375
- #
3376
- #
3377
- # [1]: https://aws.amazon.com/location/data-providers/
3378
- # [2]: https://aws.amazon.com/location/pricing/
4542
+ # This parameter is no longer used.
3379
4543
  #
3380
4544
  # @option params [required, String] :tracker_name
3381
4545
  # The name of the tracker resource to update.
@@ -3390,6 +4554,8 @@ module Aws::LocationService
3390
4554
  #
3391
4555
  # resp = client.update_tracker({
3392
4556
  # description: "ResourceDescription",
4557
+ # event_bridge_enabled: false,
4558
+ # kms_key_enable_geospatial_queries: false,
3393
4559
  # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
3394
4560
  # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
3395
4561
  # pricing_plan_data_source: "String",
@@ -3424,7 +4590,7 @@ module Aws::LocationService
3424
4590
  params: params,
3425
4591
  config: config)
3426
4592
  context[:gem_name] = 'aws-sdk-locationservice'
3427
- context[:gem_version] = '1.13.0'
4593
+ context[:gem_version] = '1.39.0'
3428
4594
  Seahorse::Client::Request.new(handlers, context)
3429
4595
  end
3430
4596