aws-sdk-locationservice 1.13.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +527 -205
- data/lib/aws-sdk-locationservice/client_api.rb +174 -28
- data/lib/aws-sdk-locationservice/types.rb +732 -270
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,7 @@ 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/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::LocationService
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -175,6 +177,10 @@ module Aws::LocationService
|
|
175
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
178
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
185
|
# Set to true to disable SDK automatically adding host prefix
|
180
186
|
# to default service endpoint when available.
|
@@ -297,7 +303,7 @@ module Aws::LocationService
|
|
297
303
|
# seconds to wait when opening a HTTP session before raising a
|
298
304
|
# `Timeout::Error`.
|
299
305
|
#
|
300
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
307
|
# number of seconds to wait for response data. This value can
|
302
308
|
# safely be set per-request on the session.
|
303
309
|
#
|
@@ -313,6 +319,9 @@ module Aws::LocationService
|
|
313
319
|
# disables this behaviour. This value can safely be set per
|
314
320
|
# request on the session.
|
315
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
316
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
326
|
# HTTP debug output will be sent to the `:logger`.
|
318
327
|
#
|
@@ -482,6 +491,11 @@ module Aws::LocationService
|
|
482
491
|
#
|
483
492
|
# </note>
|
484
493
|
#
|
494
|
+
# <note markdown="1"> Geofence evaluation uses the given device position. It does not
|
495
|
+
# account for the optional `Accuracy` of a `DevicePositionUpdate`.
|
496
|
+
#
|
497
|
+
# </note>
|
498
|
+
#
|
485
499
|
# @option params [required, String] :collection_name
|
486
500
|
# The geofence collection used in evaluating the position of devices
|
487
501
|
# against its geofences.
|
@@ -500,8 +514,14 @@ module Aws::LocationService
|
|
500
514
|
# collection_name: "ResourceName", # required
|
501
515
|
# device_position_updates: [ # required
|
502
516
|
# {
|
517
|
+
# accuracy: {
|
518
|
+
# horizontal: 1.0, # required
|
519
|
+
# },
|
503
520
|
# device_id: "Id", # required
|
504
521
|
# position: [1.0], # required
|
522
|
+
# position_properties: {
|
523
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
524
|
+
# },
|
505
525
|
# sample_time: Time.now, # required
|
506
526
|
# },
|
507
527
|
# ],
|
@@ -552,9 +572,12 @@ module Aws::LocationService
|
|
552
572
|
# @example Response structure
|
553
573
|
#
|
554
574
|
# resp.device_positions #=> Array
|
575
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
555
576
|
# resp.device_positions[0].device_id #=> String
|
556
577
|
# resp.device_positions[0].position #=> Array
|
557
578
|
# resp.device_positions[0].position[0] #=> Float
|
579
|
+
# resp.device_positions[0].position_properties #=> Hash
|
580
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
558
581
|
# resp.device_positions[0].received_time #=> Time
|
559
582
|
# resp.device_positions[0].sample_time #=> Time
|
560
583
|
# resp.errors #=> Array
|
@@ -635,10 +658,21 @@ module Aws::LocationService
|
|
635
658
|
# location data is stored at a maximum of one position per 30 second
|
636
659
|
# interval. If your update frequency is more often than every 30
|
637
660
|
# seconds, only one update per 30 seconds is stored for each unique
|
638
|
-
# device ID.
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
661
|
+
# device ID.
|
662
|
+
#
|
663
|
+
# When `PositionFiltering` is set to `DistanceBased` filtering, location
|
664
|
+
# data is stored and evaluated against linked geofence collections only
|
665
|
+
# if the device has moved more than 30 m (98.4 ft).
|
666
|
+
#
|
667
|
+
# When `PositionFiltering` is set to `AccuracyBased` filtering, location
|
668
|
+
# data is stored and evaluated against linked geofence collections only
|
669
|
+
# if the device has moved more than the measured accuracy. For example,
|
670
|
+
# if two consecutive updates from a device have a horizontal accuracy of
|
671
|
+
# 5 m and 10 m, the second update is neither stored or evaluated if the
|
672
|
+
# device has moved less than 15 m. If `PositionFiltering` is set to
|
673
|
+
# `AccuracyBased` filtering, Amazon Location uses the default value `\{
|
674
|
+
# "Horizontal": 0\}` when accuracy is not provided on a
|
675
|
+
# `DevicePositionUpdate`.
|
642
676
|
#
|
643
677
|
# </note>
|
644
678
|
#
|
@@ -658,8 +692,14 @@ module Aws::LocationService
|
|
658
692
|
# tracker_name: "ResourceName", # required
|
659
693
|
# updates: [ # required
|
660
694
|
# {
|
695
|
+
# accuracy: {
|
696
|
+
# horizontal: 1.0, # required
|
697
|
+
# },
|
661
698
|
# device_id: "Id", # required
|
662
699
|
# position: [1.0], # required
|
700
|
+
# position_properties: {
|
701
|
+
# "PropertyMapKeyString" => "PropertyMapValueString",
|
702
|
+
# },
|
663
703
|
# sample_time: Time.now, # required
|
664
704
|
# },
|
665
705
|
# ],
|
@@ -683,7 +723,7 @@ module Aws::LocationService
|
|
683
723
|
end
|
684
724
|
|
685
725
|
# [Calculates a route][1] given the following required parameters:
|
686
|
-
# `
|
726
|
+
# `DeparturePosition` and `DestinationPosition`. Requires that you first
|
687
727
|
# [create a route calculator resource][2].
|
688
728
|
#
|
689
729
|
# By default, a request that doesn't specify a departure time uses the
|
@@ -693,27 +733,25 @@ module Aws::LocationService
|
|
693
733
|
# Additional options include:
|
694
734
|
#
|
695
735
|
# * [Specifying a departure time][3] using either `DepartureTime` or
|
696
|
-
# `
|
736
|
+
# `DepartNow`. This calculates a route based on predictive traffic
|
697
737
|
# data at the given time.
|
698
738
|
#
|
699
|
-
# <note markdown="1"> You can't specify both `DepartureTime` and `
|
700
|
-
#
|
701
|
-
# error.
|
739
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
740
|
+
# request. Specifying both parameters returns a validation error.
|
702
741
|
#
|
703
742
|
# </note>
|
704
743
|
#
|
705
|
-
# * [Specifying a travel mode][4] using TravelMode
|
706
|
-
#
|
744
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
745
|
+
# transportation mode used to calculate the routes. This also lets you
|
746
|
+
# specify additional route preferences in `CarModeOptions` if
|
707
747
|
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
708
748
|
#
|
709
749
|
#
|
710
750
|
#
|
711
|
-
#
|
712
|
-
#
|
713
751
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
714
752
|
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
715
|
-
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/
|
716
|
-
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/
|
753
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
754
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
717
755
|
#
|
718
756
|
# @option params [required, String] :calculator_name
|
719
757
|
# The name of the route calculator resource that you want to use to
|
@@ -754,7 +792,7 @@ module Aws::LocationService
|
|
754
792
|
#
|
755
793
|
#
|
756
794
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
757
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
795
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
758
796
|
#
|
759
797
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
760
798
|
# Specifies the desired time of departure. Uses the given time to
|
@@ -793,7 +831,7 @@ module Aws::LocationService
|
|
793
831
|
#
|
794
832
|
#
|
795
833
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
796
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
834
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
797
835
|
#
|
798
836
|
# @option params [String] :distance_unit
|
799
837
|
# Set the unit system to specify the distance.
|
@@ -812,7 +850,7 @@ module Aws::LocationService
|
|
812
850
|
# Specifies the mode of transport when calculating a route. Used in
|
813
851
|
# estimating the speed of travel and road compatibility.
|
814
852
|
#
|
815
|
-
# The `TravelMode` you specify determines how you specify route
|
853
|
+
# The `TravelMode` you specify also determines how you specify route
|
816
854
|
# preferences:
|
817
855
|
#
|
818
856
|
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
@@ -855,7 +893,7 @@ module Aws::LocationService
|
|
855
893
|
#
|
856
894
|
#
|
857
895
|
#
|
858
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
896
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
859
897
|
#
|
860
898
|
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
861
899
|
#
|
@@ -932,65 +970,267 @@ module Aws::LocationService
|
|
932
970
|
req.send_request(options)
|
933
971
|
end
|
934
972
|
|
935
|
-
#
|
973
|
+
# [ Calculates a route matrix][1] given the following required
|
974
|
+
# parameters: `DeparturePositions` and `DestinationPositions`.
|
975
|
+
# `CalculateRouteMatrix` calculates routes and returns the travel time
|
976
|
+
# and travel distance from each departure position to each destination
|
977
|
+
# position in the request. For example, given departure positions A and
|
978
|
+
# B, and destination positions X and Y, `CalculateRouteMatrix` will
|
979
|
+
# return time and distance for routes from A to X, A to Y, B to X, and B
|
980
|
+
# to Y (in that order). The number of results returned (and routes
|
981
|
+
# calculated) will be the number of `DeparturePositions` times the
|
982
|
+
# number of `DestinationPositions`.
|
936
983
|
#
|
937
|
-
#
|
938
|
-
#
|
984
|
+
# <note markdown="1"> Your account is charged for each route calculated, not the number of
|
985
|
+
# requests.
|
939
986
|
#
|
940
|
-
#
|
987
|
+
# </note>
|
941
988
|
#
|
942
|
-
#
|
943
|
-
# periods (.), and underscores (\_).
|
989
|
+
# Requires that you first [create a route calculator resource][2].
|
944
990
|
#
|
945
|
-
#
|
991
|
+
# By default, a request that doesn't specify a departure time uses the
|
992
|
+
# best time of day to travel with the best traffic conditions when
|
993
|
+
# calculating routes.
|
946
994
|
#
|
947
|
-
#
|
995
|
+
# Additional options include:
|
948
996
|
#
|
949
|
-
#
|
950
|
-
#
|
997
|
+
# * [ Specifying a departure time][3] using either `DepartureTime` or
|
998
|
+
# `DepartNow`. This calculates routes based on predictive traffic data
|
999
|
+
# at the given time.
|
951
1000
|
#
|
952
|
-
#
|
953
|
-
#
|
954
|
-
# ID, key ARN, alias name, or alias ARN.
|
1001
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
1002
|
+
# request. Specifying both parameters returns a validation error.
|
955
1003
|
#
|
1004
|
+
# </note>
|
956
1005
|
#
|
1006
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
1007
|
+
# transportation mode used to calculate the routes. This also lets you
|
1008
|
+
# specify additional route preferences in `CarModeOptions` if
|
1009
|
+
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
957
1010
|
#
|
958
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
959
1011
|
#
|
960
|
-
# @option params [required, String] :pricing_plan
|
961
|
-
# Specifies the pricing plan for the geofence collection.
|
962
1012
|
#
|
963
|
-
#
|
964
|
-
#
|
1013
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html
|
1014
|
+
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
1015
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
1016
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
965
1017
|
#
|
1018
|
+
# @option params [required, String] :calculator_name
|
1019
|
+
# The name of the route calculator resource that you want to use to
|
1020
|
+
# calculate the route matrix.
|
966
1021
|
#
|
1022
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
1023
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
1024
|
+
# routes that use ferries or tolls.
|
967
1025
|
#
|
968
|
-
#
|
1026
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
969
1027
|
#
|
970
|
-
# @option params [
|
971
|
-
#
|
1028
|
+
# @option params [Boolean] :depart_now
|
1029
|
+
# Sets the time of departure as the current time. Uses the current time
|
1030
|
+
# to calculate the route matrix. You can't set both `DepartureTime` and
|
1031
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1032
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1033
|
+
#
|
1034
|
+
# Default Value: `false`
|
1035
|
+
#
|
1036
|
+
# Valid Values: `false` \| `true`
|
1037
|
+
#
|
1038
|
+
# @option params [required, Array<Array>] :departure_positions
|
1039
|
+
# The list of departure (origin) positions for the route matrix. An
|
1040
|
+
# array of points, each of which is itself a 2-value array defined in
|
1041
|
+
# [WGS 84][1] format: `[longitude, latitude]`. For example, `[-123.115,
|
1042
|
+
# 49.285]`.
|
972
1043
|
#
|
973
|
-
#
|
974
|
-
#
|
1044
|
+
# Depending on the data provider selected in the route calculator
|
1045
|
+
# resource there may be additional restrictions on the inputs you can
|
1046
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1047
|
+
# Service Developer Guide*.
|
1048
|
+
#
|
1049
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1050
|
+
# specify a departure that's not located on a road, Amazon Location [
|
1051
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1052
|
+
# available in the result in `SnappedDeparturePositions`.
|
1053
|
+
#
|
1054
|
+
# </note>
|
1055
|
+
#
|
1056
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1057
|
+
#
|
1058
|
+
#
|
1059
|
+
#
|
1060
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1061
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1062
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1063
|
+
#
|
1064
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
1065
|
+
# Specifies the desired time of departure. Uses the given time to
|
1066
|
+
# calculate the route matrix. You can't set both `DepartureTime` and
|
1067
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1068
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1069
|
+
#
|
1070
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
1071
|
+
# ValidationException` error.
|
1072
|
+
#
|
1073
|
+
# </note>
|
1074
|
+
#
|
1075
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
1076
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
975
1077
|
#
|
976
1078
|
# ^
|
977
1079
|
#
|
978
|
-
# For more information about [Data Providers][1], and [Pricing
|
979
|
-
# plans][2], see the Amazon Location Service product page.
|
980
1080
|
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
#
|
1081
|
+
#
|
1082
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1083
|
+
#
|
1084
|
+
# @option params [required, Array<Array>] :destination_positions
|
1085
|
+
# The list of destination positions for the route matrix. An array of
|
1086
|
+
# points, each of which is itself a 2-value array defined in [WGS 84][1]
|
1087
|
+
# format: `[longitude, latitude]`. For example, `[-122.339, 47.615]`
|
1088
|
+
#
|
1089
|
+
# Depending on the data provider selected in the route calculator
|
1090
|
+
# resource there may be additional restrictions on the inputs you can
|
1091
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1092
|
+
# Service Developer Guide*.
|
1093
|
+
#
|
1094
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1095
|
+
# specify a destination that's not located on a road, Amazon Location [
|
1096
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1097
|
+
# available in the result in `SnappedDestinationPositions`.
|
985
1098
|
#
|
986
1099
|
# </note>
|
987
1100
|
#
|
988
|
-
# Valid Values: `
|
1101
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1102
|
+
#
|
1103
|
+
#
|
1104
|
+
#
|
1105
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1106
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1107
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1108
|
+
#
|
1109
|
+
# @option params [String] :distance_unit
|
1110
|
+
# Set the unit system to specify the distance.
|
1111
|
+
#
|
1112
|
+
# Default Value: `Kilometers`
|
1113
|
+
#
|
1114
|
+
# @option params [String] :travel_mode
|
1115
|
+
# Specifies the mode of transport when calculating a route. Used in
|
1116
|
+
# estimating the speed of travel and road compatibility.
|
1117
|
+
#
|
1118
|
+
# The `TravelMode` you specify also determines how you specify route
|
1119
|
+
# preferences:
|
1120
|
+
#
|
1121
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
1122
|
+
#
|
1123
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
1124
|
+
#
|
1125
|
+
# Default Value: `Car`
|
1126
|
+
#
|
1127
|
+
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
1128
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
1129
|
+
# avoiding routes that use ferries or tolls, and truck specifications to
|
1130
|
+
# consider when choosing an optimal road.
|
1131
|
+
#
|
1132
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
1133
|
+
#
|
1134
|
+
# @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1135
|
+
#
|
1136
|
+
# * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array<Array<Types::RouteMatrixEntry>>
|
1137
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array<Array<Float>>
|
1138
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array<Array<Float>>
|
1139
|
+
# * {Types::CalculateRouteMatrixResponse#summary #summary} => Types::CalculateRouteMatrixSummary
|
1140
|
+
#
|
1141
|
+
# @example Request syntax with placeholder values
|
1142
|
+
#
|
1143
|
+
# resp = client.calculate_route_matrix({
|
1144
|
+
# calculator_name: "ResourceName", # required
|
1145
|
+
# car_mode_options: {
|
1146
|
+
# avoid_ferries: false,
|
1147
|
+
# avoid_tolls: false,
|
1148
|
+
# },
|
1149
|
+
# depart_now: false,
|
1150
|
+
# departure_positions: [ # required
|
1151
|
+
# [1.0],
|
1152
|
+
# ],
|
1153
|
+
# departure_time: Time.now,
|
1154
|
+
# destination_positions: [ # required
|
1155
|
+
# [1.0],
|
1156
|
+
# ],
|
1157
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1158
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
1159
|
+
# truck_mode_options: {
|
1160
|
+
# avoid_ferries: false,
|
1161
|
+
# avoid_tolls: false,
|
1162
|
+
# dimensions: {
|
1163
|
+
# height: 1.0,
|
1164
|
+
# length: 1.0,
|
1165
|
+
# unit: "Meters", # accepts Meters, Feet
|
1166
|
+
# width: 1.0,
|
1167
|
+
# },
|
1168
|
+
# weight: {
|
1169
|
+
# total: 1.0,
|
1170
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1171
|
+
# },
|
1172
|
+
# },
|
1173
|
+
# })
|
1174
|
+
#
|
1175
|
+
# @example Response structure
|
1176
|
+
#
|
1177
|
+
# resp.route_matrix #=> Array
|
1178
|
+
# resp.route_matrix[0] #=> Array
|
1179
|
+
# resp.route_matrix[0][0].distance #=> Float
|
1180
|
+
# resp.route_matrix[0][0].duration_seconds #=> Float
|
1181
|
+
# resp.route_matrix[0][0].error.code #=> String, one of "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError"
|
1182
|
+
# resp.route_matrix[0][0].error.message #=> String
|
1183
|
+
# resp.snapped_departure_positions #=> Array
|
1184
|
+
# resp.snapped_departure_positions[0] #=> Array
|
1185
|
+
# resp.snapped_departure_positions[0][0] #=> Float
|
1186
|
+
# resp.snapped_destination_positions #=> Array
|
1187
|
+
# resp.snapped_destination_positions[0] #=> Array
|
1188
|
+
# resp.snapped_destination_positions[0][0] #=> Float
|
1189
|
+
# resp.summary.data_source #=> String
|
1190
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1191
|
+
# resp.summary.error_count #=> Integer
|
1192
|
+
# resp.summary.route_count #=> Integer
|
1193
|
+
#
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
|
1195
|
+
#
|
1196
|
+
# @overload calculate_route_matrix(params = {})
|
1197
|
+
# @param [Hash] params ({})
|
1198
|
+
def calculate_route_matrix(params = {}, options = {})
|
1199
|
+
req = build_request(:calculate_route_matrix, params)
|
1200
|
+
req.send_request(options)
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
# Creates a geofence collection, which manages and stores geofences.
|
1204
|
+
#
|
1205
|
+
# @option params [required, String] :collection_name
|
1206
|
+
# A custom name for the geofence collection.
|
1207
|
+
#
|
1208
|
+
# Requirements:
|
1209
|
+
#
|
1210
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1211
|
+
# periods (.), and underscores (\_).
|
1212
|
+
#
|
1213
|
+
# * Must be a unique geofence collection name.
|
1214
|
+
#
|
1215
|
+
# * No spaces allowed. For example, `ExampleGeofenceCollection`.
|
1216
|
+
#
|
1217
|
+
# @option params [String] :description
|
1218
|
+
# An optional description for the geofence collection.
|
989
1219
|
#
|
1220
|
+
# @option params [String] :kms_key_id
|
1221
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
1222
|
+
# ID, key ARN, alias name, or alias ARN.
|
990
1223
|
#
|
991
1224
|
#
|
992
|
-
#
|
993
|
-
# [
|
1225
|
+
#
|
1226
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1227
|
+
#
|
1228
|
+
# @option params [String] :pricing_plan
|
1229
|
+
# No longer used. If included, the only allowed value is
|
1230
|
+
# `RequestBasedUsage`.
|
1231
|
+
#
|
1232
|
+
# @option params [String] :pricing_plan_data_source
|
1233
|
+
# This parameter is no longer used.
|
994
1234
|
#
|
995
1235
|
# @option params [Hash<String,String>] :tags
|
996
1236
|
# Applies one or more tags to the geofence collection. A tag is a
|
@@ -1026,7 +1266,7 @@ module Aws::LocationService
|
|
1026
1266
|
# collection_name: "ResourceName", # required
|
1027
1267
|
# description: "ResourceDescription",
|
1028
1268
|
# kms_key_id: "KmsKeyId",
|
1029
|
-
# pricing_plan: "RequestBasedUsage", #
|
1269
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1030
1270
|
# pricing_plan_data_source: "String",
|
1031
1271
|
# tags: {
|
1032
1272
|
# "TagKey" => "TagValue",
|
@@ -1051,6 +1291,17 @@ module Aws::LocationService
|
|
1051
1291
|
# Creates a map resource in your AWS account, which provides map tiles
|
1052
1292
|
# of different styles sourced from global location data providers.
|
1053
1293
|
#
|
1294
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1295
|
+
# business, such as delivery vehicles or employees, you may only use
|
1296
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1297
|
+
# terms][1] for more details.
|
1298
|
+
#
|
1299
|
+
# </note>
|
1300
|
+
#
|
1301
|
+
#
|
1302
|
+
#
|
1303
|
+
# [1]: http://aws.amazon.com/service-terms
|
1304
|
+
#
|
1054
1305
|
# @option params [required, Types::MapConfiguration] :configuration
|
1055
1306
|
# Specifies the map style selected from an available data provider.
|
1056
1307
|
#
|
@@ -1069,15 +1320,9 @@ module Aws::LocationService
|
|
1069
1320
|
#
|
1070
1321
|
# * No spaces allowed. For example, `ExampleMap`.
|
1071
1322
|
#
|
1072
|
-
# @option params [
|
1073
|
-
#
|
1074
|
-
#
|
1075
|
-
# For additional details and restrictions on each pricing plan option,
|
1076
|
-
# see [Amazon Location Service pricing][1].
|
1077
|
-
#
|
1078
|
-
#
|
1079
|
-
#
|
1080
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1323
|
+
# @option params [String] :pricing_plan
|
1324
|
+
# No longer used. If included, the only allowed value is
|
1325
|
+
# `RequestBasedUsage`.
|
1081
1326
|
#
|
1082
1327
|
# @option params [Hash<String,String>] :tags
|
1083
1328
|
# Applies one or more tags to the map resource. A tag is a key-value
|
@@ -1115,7 +1360,7 @@ module Aws::LocationService
|
|
1115
1360
|
# },
|
1116
1361
|
# description: "ResourceDescription",
|
1117
1362
|
# map_name: "ResourceName", # required
|
1118
|
-
# pricing_plan: "RequestBasedUsage", #
|
1363
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1119
1364
|
# tags: {
|
1120
1365
|
# "TagKey" => "TagValue",
|
1121
1366
|
# },
|
@@ -1139,7 +1384,20 @@ module Aws::LocationService
|
|
1139
1384
|
# Creates a place index resource in your AWS account. Use a place index
|
1140
1385
|
# resource to geocode addresses and other text queries by using the
|
1141
1386
|
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
|
1142
|
-
# by using the `SearchPlaceIndexForPosition` operation
|
1387
|
+
# by using the `SearchPlaceIndexForPosition` operation, and enable
|
1388
|
+
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
|
1389
|
+
# operation.
|
1390
|
+
#
|
1391
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1392
|
+
# business, such as delivery vehicles or employees, you may only use
|
1393
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1394
|
+
# terms][1] for more details.
|
1395
|
+
#
|
1396
|
+
# </note>
|
1397
|
+
#
|
1398
|
+
#
|
1399
|
+
#
|
1400
|
+
# [1]: http://aws.amazon.com/service-terms
|
1143
1401
|
#
|
1144
1402
|
# @option params [required, String] :data_source
|
1145
1403
|
# Specifies the geospatial data provider for the new place index.
|
@@ -1195,15 +1453,9 @@ module Aws::LocationService
|
|
1195
1453
|
#
|
1196
1454
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1197
1455
|
#
|
1198
|
-
# @option params [
|
1199
|
-
#
|
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/
|
1456
|
+
# @option params [String] :pricing_plan
|
1457
|
+
# No longer used. If included, the only allowed value is
|
1458
|
+
# `RequestBasedUsage`.
|
1207
1459
|
#
|
1208
1460
|
# @option params [Hash<String,String>] :tags
|
1209
1461
|
# Applies one or more tags to the place index resource. A tag is a
|
@@ -1243,7 +1495,7 @@ module Aws::LocationService
|
|
1243
1495
|
# },
|
1244
1496
|
# description: "ResourceDescription",
|
1245
1497
|
# index_name: "ResourceName", # required
|
1246
|
-
# pricing_plan: "RequestBasedUsage", #
|
1498
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1247
1499
|
# tags: {
|
1248
1500
|
# "TagKey" => "TagValue",
|
1249
1501
|
# },
|
@@ -1270,6 +1522,17 @@ module Aws::LocationService
|
|
1270
1522
|
# travel time, distance, and get directions. A route calculator sources
|
1271
1523
|
# traffic and road network data from your chosen data provider.
|
1272
1524
|
#
|
1525
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1526
|
+
# business, such as delivery vehicles or employees, you may only use
|
1527
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1528
|
+
# terms][1] for more details.
|
1529
|
+
#
|
1530
|
+
# </note>
|
1531
|
+
#
|
1532
|
+
#
|
1533
|
+
#
|
1534
|
+
# [1]: http://aws.amazon.com/service-terms
|
1535
|
+
#
|
1273
1536
|
# @option params [required, String] :calculator_name
|
1274
1537
|
# The name of the route calculator resource.
|
1275
1538
|
#
|
@@ -1317,15 +1580,9 @@ module Aws::LocationService
|
|
1317
1580
|
# @option params [String] :description
|
1318
1581
|
# The optional description for the route calculator resource.
|
1319
1582
|
#
|
1320
|
-
# @option params [
|
1321
|
-
#
|
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/
|
1583
|
+
# @option params [String] :pricing_plan
|
1584
|
+
# No longer used. If included, the only allowed value is
|
1585
|
+
# `RequestBasedUsage`.
|
1329
1586
|
#
|
1330
1587
|
# @option params [Hash<String,String>] :tags
|
1331
1588
|
# Applies one or more tags to the route calculator resource. A tag is a
|
@@ -1365,7 +1622,7 @@ module Aws::LocationService
|
|
1365
1622
|
# calculator_name: "ResourceName", # required
|
1366
1623
|
# data_source: "String", # required
|
1367
1624
|
# description: "ResourceDescription",
|
1368
|
-
# pricing_plan: "RequestBasedUsage", #
|
1625
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1369
1626
|
# tags: {
|
1370
1627
|
# "TagKey" => "TagValue",
|
1371
1628
|
# },
|
@@ -1418,43 +1675,25 @@ module Aws::LocationService
|
|
1418
1675
|
# Distance-based filtering can also reduce the effects of GPS noise
|
1419
1676
|
# when displaying device trajectories on a map.
|
1420
1677
|
#
|
1678
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
1679
|
+
# accuracy, location updates are ignored. For example, if two
|
1680
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
1681
|
+
# and 10 m, the second update is ignored if the device has moved less
|
1682
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
1683
|
+
# linked geofence collections, nor stored. This can reduce the effects
|
1684
|
+
# of GPS noise when displaying device trajectories on a map, and can
|
1685
|
+
# help control your costs by reducing the number of geofence
|
1686
|
+
# evaluations.
|
1687
|
+
#
|
1421
1688
|
# This field is optional. If not specified, the default value is
|
1422
1689
|
# `TimeBased`.
|
1423
1690
|
#
|
1424
|
-
# @option params [
|
1425
|
-
#
|
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/
|
1691
|
+
# @option params [String] :pricing_plan
|
1692
|
+
# No longer used. If included, the only allowed value is
|
1693
|
+
# `RequestBasedUsage`.
|
1433
1694
|
#
|
1434
1695
|
# @option params [String] :pricing_plan_data_source
|
1435
|
-
#
|
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/
|
1696
|
+
# This parameter is no longer used.
|
1458
1697
|
#
|
1459
1698
|
# @option params [Hash<String,String>] :tags
|
1460
1699
|
# Applies one or more tags to the tracker resource. A tag is a key-value
|
@@ -1502,7 +1741,7 @@ module Aws::LocationService
|
|
1502
1741
|
# description: "ResourceDescription",
|
1503
1742
|
# kms_key_id: "KmsKeyId",
|
1504
1743
|
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1505
|
-
# pricing_plan: "RequestBasedUsage", #
|
1744
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1506
1745
|
# pricing_plan_data_source: "String",
|
1507
1746
|
# tags: {
|
1508
1747
|
# "TagKey" => "TagValue",
|
@@ -1940,8 +2179,10 @@ module Aws::LocationService
|
|
1940
2179
|
#
|
1941
2180
|
# @return [Types::GetDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1942
2181
|
#
|
2182
|
+
# * {Types::GetDevicePositionResponse#accuracy #accuracy} => Types::PositionalAccuracy
|
1943
2183
|
# * {Types::GetDevicePositionResponse#device_id #device_id} => String
|
1944
2184
|
# * {Types::GetDevicePositionResponse#position #position} => Array<Float>
|
2185
|
+
# * {Types::GetDevicePositionResponse#position_properties #position_properties} => Hash<String,String>
|
1945
2186
|
# * {Types::GetDevicePositionResponse#received_time #received_time} => Time
|
1946
2187
|
# * {Types::GetDevicePositionResponse#sample_time #sample_time} => Time
|
1947
2188
|
#
|
@@ -1954,9 +2195,12 @@ module Aws::LocationService
|
|
1954
2195
|
#
|
1955
2196
|
# @example Response structure
|
1956
2197
|
#
|
2198
|
+
# resp.accuracy.horizontal #=> Float
|
1957
2199
|
# resp.device_id #=> String
|
1958
2200
|
# resp.position #=> Array
|
1959
2201
|
# resp.position[0] #=> Float
|
2202
|
+
# resp.position_properties #=> Hash
|
2203
|
+
# resp.position_properties["PropertyMapKeyString"] #=> String
|
1960
2204
|
# resp.received_time #=> Time
|
1961
2205
|
# resp.sample_time #=> Time
|
1962
2206
|
#
|
@@ -2041,9 +2285,12 @@ module Aws::LocationService
|
|
2041
2285
|
# @example Response structure
|
2042
2286
|
#
|
2043
2287
|
# resp.device_positions #=> Array
|
2288
|
+
# resp.device_positions[0].accuracy.horizontal #=> Float
|
2044
2289
|
# resp.device_positions[0].device_id #=> String
|
2045
2290
|
# resp.device_positions[0].position #=> Array
|
2046
2291
|
# resp.device_positions[0].position[0] #=> Float
|
2292
|
+
# resp.device_positions[0].position_properties #=> Hash
|
2293
|
+
# resp.device_positions[0].position_properties["PropertyMapKeyString"] #=> String
|
2047
2294
|
# resp.device_positions[0].received_time #=> Time
|
2048
2295
|
# resp.device_positions[0].sample_time #=> Time
|
2049
2296
|
# resp.next_token #=> String
|
@@ -2337,9 +2584,12 @@ module Aws::LocationService
|
|
2337
2584
|
# @example Response structure
|
2338
2585
|
#
|
2339
2586
|
# resp.data.entries #=> Array
|
2587
|
+
# resp.data.entries[0].accuracy.horizontal #=> Float
|
2340
2588
|
# resp.data.entries[0].device_id #=> String
|
2341
2589
|
# resp.data.entries[0].position #=> Array
|
2342
2590
|
# resp.data.entries[0].position[0] #=> Float
|
2591
|
+
# resp.data.entries[0].position_properties #=> Hash
|
2592
|
+
# resp.data.entries[0].position_properties["PropertyMapKeyString"] #=> String
|
2343
2593
|
# resp.data.entries[0].sample_time #=> Time
|
2344
2594
|
# resp.next_token #=> String
|
2345
2595
|
#
|
@@ -2862,6 +3112,140 @@ module Aws::LocationService
|
|
2862
3112
|
req.send_request(options)
|
2863
3113
|
end
|
2864
3114
|
|
3115
|
+
# Generates suggestions for addresses and points of interest based on
|
3116
|
+
# partial or misspelled free-form text. This operation is also known as
|
3117
|
+
# autocomplete, autosuggest, or fuzzy matching.
|
3118
|
+
#
|
3119
|
+
# Optional parameters let you narrow your search results by bounding box
|
3120
|
+
# or country, or bias your search toward a specific position on the
|
3121
|
+
# globe.
|
3122
|
+
#
|
3123
|
+
# <note markdown="1"> You can search for suggested place names near a specified position by
|
3124
|
+
# using `BiasPosition`, or filter results within a bounding box by using
|
3125
|
+
# `FilterBBox`. These parameters are mutually exclusive; using both
|
3126
|
+
# `BiasPosition` and `FilterBBox` in the same command returns an error.
|
3127
|
+
#
|
3128
|
+
# </note>
|
3129
|
+
#
|
3130
|
+
# @option params [Array<Float>] :bias_position
|
3131
|
+
# An optional parameter that indicates a preference for place
|
3132
|
+
# suggestions that are closer to a specified position.
|
3133
|
+
#
|
3134
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
3135
|
+
# number represents the X coordinate, or longitude; the second number
|
3136
|
+
# represents the Y coordinate, or latitude.
|
3137
|
+
#
|
3138
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
3139
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
3140
|
+
#
|
3141
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
3142
|
+
# both options results in an error.
|
3143
|
+
#
|
3144
|
+
# </note>
|
3145
|
+
#
|
3146
|
+
# @option params [Array<Float>] :filter_b_box
|
3147
|
+
# An optional parameter that limits the search results by returning only
|
3148
|
+
# suggestions within a specified bounding box.
|
3149
|
+
#
|
3150
|
+
# If provided, this parameter must contain a total of four consecutive
|
3151
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
3152
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
3153
|
+
# corner of the bounding box; the second pair of numbers represents the
|
3154
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
3155
|
+
# northeast corner of the bounding box.
|
3156
|
+
#
|
3157
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
3158
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
3159
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
3160
|
+
# and latitude `-36.9542`.
|
3161
|
+
#
|
3162
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
3163
|
+
# both options results in an error.
|
3164
|
+
#
|
3165
|
+
# </note>
|
3166
|
+
#
|
3167
|
+
# @option params [Array<String>] :filter_countries
|
3168
|
+
# An optional parameter that limits the search results by returning only
|
3169
|
+
# suggestions within the provided list of countries.
|
3170
|
+
#
|
3171
|
+
# * Use the [ISO 3166][1] 3-digit country code. For example, Australia
|
3172
|
+
# uses three upper-case characters: `AUS`.
|
3173
|
+
#
|
3174
|
+
# ^
|
3175
|
+
#
|
3176
|
+
#
|
3177
|
+
#
|
3178
|
+
# [1]: https://www.iso.org/iso-3166-country-codes.html
|
3179
|
+
#
|
3180
|
+
# @option params [required, String] :index_name
|
3181
|
+
# The name of the place index resource you want to use for the search.
|
3182
|
+
#
|
3183
|
+
# @option params [String] :language
|
3184
|
+
# The preferred language used to return results. The value must be a
|
3185
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
3186
|
+
#
|
3187
|
+
# This setting affects the languages used in the results. It does not
|
3188
|
+
# change which results are returned. If the language is not specified,
|
3189
|
+
# or not supported for a particular result, the partner automatically
|
3190
|
+
# chooses a language for the result.
|
3191
|
+
#
|
3192
|
+
# Used only when the partner selected is Here.
|
3193
|
+
#
|
3194
|
+
#
|
3195
|
+
#
|
3196
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
3197
|
+
#
|
3198
|
+
# @option params [Integer] :max_results
|
3199
|
+
# An optional parameter. The maximum number of results returned per
|
3200
|
+
# request.
|
3201
|
+
#
|
3202
|
+
# The default: `5`
|
3203
|
+
#
|
3204
|
+
# @option params [required, String] :text
|
3205
|
+
# The free-form partial text to use to generate place suggestions. For
|
3206
|
+
# example, `eiffel tow`.
|
3207
|
+
#
|
3208
|
+
# @return [Types::SearchPlaceIndexForSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3209
|
+
#
|
3210
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#results #results} => Array<Types::SearchForSuggestionsResult>
|
3211
|
+
# * {Types::SearchPlaceIndexForSuggestionsResponse#summary #summary} => Types::SearchPlaceIndexForSuggestionsSummary
|
3212
|
+
#
|
3213
|
+
# @example Request syntax with placeholder values
|
3214
|
+
#
|
3215
|
+
# resp = client.search_place_index_for_suggestions({
|
3216
|
+
# bias_position: [1.0],
|
3217
|
+
# filter_b_box: [1.0],
|
3218
|
+
# filter_countries: ["CountryCode"],
|
3219
|
+
# index_name: "ResourceName", # required
|
3220
|
+
# language: "LanguageTag",
|
3221
|
+
# max_results: 1,
|
3222
|
+
# text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
|
3223
|
+
# })
|
3224
|
+
#
|
3225
|
+
# @example Response structure
|
3226
|
+
#
|
3227
|
+
# resp.results #=> Array
|
3228
|
+
# resp.results[0].text #=> String
|
3229
|
+
# resp.summary.bias_position #=> Array
|
3230
|
+
# resp.summary.bias_position[0] #=> Float
|
3231
|
+
# resp.summary.data_source #=> String
|
3232
|
+
# resp.summary.filter_b_box #=> Array
|
3233
|
+
# resp.summary.filter_b_box[0] #=> Float
|
3234
|
+
# resp.summary.filter_countries #=> Array
|
3235
|
+
# resp.summary.filter_countries[0] #=> String
|
3236
|
+
# resp.summary.language #=> String
|
3237
|
+
# resp.summary.max_results #=> Integer
|
3238
|
+
# resp.summary.text #=> String
|
3239
|
+
#
|
3240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForSuggestions AWS API Documentation
|
3241
|
+
#
|
3242
|
+
# @overload search_place_index_for_suggestions(params = {})
|
3243
|
+
# @param [Hash] params ({})
|
3244
|
+
def search_place_index_for_suggestions(params = {}, options = {})
|
3245
|
+
req = build_request(:search_place_index_for_suggestions, params)
|
3246
|
+
req.send_request(options)
|
3247
|
+
end
|
3248
|
+
|
2865
3249
|
# Geocodes free-form text, such as an address, name, city, or region to
|
2866
3250
|
# allow you to search for Places or points of interest.
|
2867
3251
|
#
|
@@ -3109,38 +3493,11 @@ module Aws::LocationService
|
|
3109
3493
|
# Updates the description for the geofence collection.
|
3110
3494
|
#
|
3111
3495
|
# @option params [String] :pricing_plan
|
3112
|
-
#
|
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/
|
3496
|
+
# No longer used. If included, the only allowed value is
|
3497
|
+
# `RequestBasedUsage`.
|
3120
3498
|
#
|
3121
3499
|
# @option params [String] :pricing_plan_data_source
|
3122
|
-
#
|
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/
|
3500
|
+
# This parameter is no longer used.
|
3144
3501
|
#
|
3145
3502
|
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3146
3503
|
#
|
@@ -3181,14 +3538,8 @@ module Aws::LocationService
|
|
3181
3538
|
# The name of the map resource to update.
|
3182
3539
|
#
|
3183
3540
|
# @option params [String] :pricing_plan
|
3184
|
-
#
|
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/
|
3541
|
+
# No longer used. If included, the only allowed value is
|
3542
|
+
# `RequestBasedUsage`.
|
3192
3543
|
#
|
3193
3544
|
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3194
3545
|
#
|
@@ -3231,14 +3582,8 @@ module Aws::LocationService
|
|
3231
3582
|
# The name of the place index resource to update.
|
3232
3583
|
#
|
3233
3584
|
# @option params [String] :pricing_plan
|
3234
|
-
#
|
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/
|
3585
|
+
# No longer used. If included, the only allowed value is
|
3586
|
+
# `RequestBasedUsage`.
|
3242
3587
|
#
|
3243
3588
|
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3244
3589
|
#
|
@@ -3282,14 +3627,8 @@ module Aws::LocationService
|
|
3282
3627
|
# Updates the description for the route calculator resource.
|
3283
3628
|
#
|
3284
3629
|
# @option params [String] :pricing_plan
|
3285
|
-
#
|
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/
|
3630
|
+
# No longer used. If included, the only allowed value is
|
3631
|
+
# `RequestBasedUsage`.
|
3293
3632
|
#
|
3294
3633
|
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3295
3634
|
#
|
@@ -3339,43 +3678,26 @@ module Aws::LocationService
|
|
3339
3678
|
# location updates are ignored. Location updates within this distance
|
3340
3679
|
# are neither evaluated against linked geofence collections, nor
|
3341
3680
|
# stored. This helps control costs by reducing the number of geofence
|
3342
|
-
# evaluations and device positions to
|
3343
|
-
# filtering can also reduce the
|
3344
|
-
#
|
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
|
-
#
|
3681
|
+
# evaluations and historical device positions to paginate through.
|
3682
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
3683
|
+
# when displaying device trajectories on a map.
|
3352
3684
|
#
|
3685
|
+
# * `AccuracyBased` - If the device has moved less than the measured
|
3686
|
+
# accuracy, location updates are ignored. For example, if two
|
3687
|
+
# consecutive updates from a device have a horizontal accuracy of 5 m
|
3688
|
+
# and 10 m, the second update is ignored if the device has moved less
|
3689
|
+
# than 15 m. Ignored location updates are neither evaluated against
|
3690
|
+
# linked geofence collections, nor stored. This helps educe the
|
3691
|
+
# effects of GPS noise when displaying device trajectories on a map,
|
3692
|
+
# and can help control costs by reducing the number of geofence
|
3693
|
+
# evaluations.
|
3353
3694
|
#
|
3354
|
-
#
|
3695
|
+
# @option params [String] :pricing_plan
|
3696
|
+
# No longer used. If included, the only allowed value is
|
3697
|
+
# `RequestBasedUsage`.
|
3355
3698
|
#
|
3356
3699
|
# @option params [String] :pricing_plan_data_source
|
3357
|
-
#
|
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/
|
3700
|
+
# This parameter is no longer used.
|
3379
3701
|
#
|
3380
3702
|
# @option params [required, String] :tracker_name
|
3381
3703
|
# The name of the tracker resource to update.
|
@@ -3424,7 +3746,7 @@ module Aws::LocationService
|
|
3424
3746
|
params: params,
|
3425
3747
|
config: config)
|
3426
3748
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3427
|
-
context[:gem_version] = '1.
|
3749
|
+
context[:gem_version] = '1.17.0'
|
3428
3750
|
Seahorse::Client::Request.new(handlers, context)
|
3429
3751
|
end
|
3430
3752
|
|