aws-sdk-locationservice 1.14.0 → 1.18.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 +323 -197
- data/lib/aws-sdk-locationservice/client_api.rb +104 -28
- data/lib/aws-sdk-locationservice/types.rb +394 -263
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,8 @@ 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'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::LocationService
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
82
|
|
@@ -175,6 +179,10 @@ module Aws::LocationService
|
|
175
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
178
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
187
|
# Set to true to disable SDK automatically adding host prefix
|
180
188
|
# to default service endpoint when available.
|
@@ -297,7 +305,7 @@ module Aws::LocationService
|
|
297
305
|
# seconds to wait when opening a HTTP session before raising a
|
298
306
|
# `Timeout::Error`.
|
299
307
|
#
|
300
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
309
|
# number of seconds to wait for response data. This value can
|
302
310
|
# safely be set per-request on the session.
|
303
311
|
#
|
@@ -313,6 +321,9 @@ module Aws::LocationService
|
|
313
321
|
# disables this behaviour. This value can safely be set per
|
314
322
|
# request on the session.
|
315
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
316
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
328
|
# HTTP debug output will be sent to the `:logger`.
|
318
329
|
#
|
@@ -714,7 +725,7 @@ module Aws::LocationService
|
|
714
725
|
end
|
715
726
|
|
716
727
|
# [Calculates a route][1] given the following required parameters:
|
717
|
-
# `
|
728
|
+
# `DeparturePosition` and `DestinationPosition`. Requires that you first
|
718
729
|
# [create a route calculator resource][2].
|
719
730
|
#
|
720
731
|
# By default, a request that doesn't specify a departure time uses the
|
@@ -724,27 +735,25 @@ module Aws::LocationService
|
|
724
735
|
# Additional options include:
|
725
736
|
#
|
726
737
|
# * [Specifying a departure time][3] using either `DepartureTime` or
|
727
|
-
# `
|
738
|
+
# `DepartNow`. This calculates a route based on predictive traffic
|
728
739
|
# data at the given time.
|
729
740
|
#
|
730
|
-
# <note markdown="1"> You can't specify both `DepartureTime` and `
|
731
|
-
#
|
732
|
-
# error.
|
741
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
742
|
+
# request. Specifying both parameters returns a validation error.
|
733
743
|
#
|
734
744
|
# </note>
|
735
745
|
#
|
736
|
-
# * [Specifying a travel mode][4] using TravelMode
|
737
|
-
#
|
746
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
747
|
+
# transportation mode used to calculate the routes. This also lets you
|
748
|
+
# specify additional route preferences in `CarModeOptions` if
|
738
749
|
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
739
750
|
#
|
740
751
|
#
|
741
752
|
#
|
742
|
-
#
|
743
|
-
#
|
744
753
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
745
754
|
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
746
|
-
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/
|
747
|
-
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/
|
755
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
756
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
748
757
|
#
|
749
758
|
# @option params [required, String] :calculator_name
|
750
759
|
# The name of the route calculator resource that you want to use to
|
@@ -785,7 +794,7 @@ module Aws::LocationService
|
|
785
794
|
#
|
786
795
|
#
|
787
796
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
788
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
797
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
789
798
|
#
|
790
799
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
791
800
|
# Specifies the desired time of departure. Uses the given time to
|
@@ -824,7 +833,7 @@ module Aws::LocationService
|
|
824
833
|
#
|
825
834
|
#
|
826
835
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
827
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
836
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
828
837
|
#
|
829
838
|
# @option params [String] :distance_unit
|
830
839
|
# Set the unit system to specify the distance.
|
@@ -843,7 +852,7 @@ module Aws::LocationService
|
|
843
852
|
# Specifies the mode of transport when calculating a route. Used in
|
844
853
|
# estimating the speed of travel and road compatibility.
|
845
854
|
#
|
846
|
-
# The `TravelMode` you specify determines how you specify route
|
855
|
+
# The `TravelMode` you specify also determines how you specify route
|
847
856
|
# preferences:
|
848
857
|
#
|
849
858
|
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
@@ -886,7 +895,7 @@ module Aws::LocationService
|
|
886
895
|
#
|
887
896
|
#
|
888
897
|
#
|
889
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
898
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
890
899
|
#
|
891
900
|
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
892
901
|
#
|
@@ -963,65 +972,267 @@ module Aws::LocationService
|
|
963
972
|
req.send_request(options)
|
964
973
|
end
|
965
974
|
|
966
|
-
#
|
975
|
+
# [ Calculates a route matrix][1] given the following required
|
976
|
+
# parameters: `DeparturePositions` and `DestinationPositions`.
|
977
|
+
# `CalculateRouteMatrix` calculates routes and returns the travel time
|
978
|
+
# and travel distance from each departure position to each destination
|
979
|
+
# position in the request. For example, given departure positions A and
|
980
|
+
# B, and destination positions X and Y, `CalculateRouteMatrix` will
|
981
|
+
# return time and distance for routes from A to X, A to Y, B to X, and B
|
982
|
+
# to Y (in that order). The number of results returned (and routes
|
983
|
+
# calculated) will be the number of `DeparturePositions` times the
|
984
|
+
# number of `DestinationPositions`.
|
967
985
|
#
|
968
|
-
#
|
969
|
-
#
|
986
|
+
# <note markdown="1"> Your account is charged for each route calculated, not the number of
|
987
|
+
# requests.
|
970
988
|
#
|
971
|
-
#
|
989
|
+
# </note>
|
972
990
|
#
|
973
|
-
#
|
974
|
-
# periods (.), and underscores (\_).
|
991
|
+
# Requires that you first [create a route calculator resource][2].
|
975
992
|
#
|
976
|
-
#
|
993
|
+
# By default, a request that doesn't specify a departure time uses the
|
994
|
+
# best time of day to travel with the best traffic conditions when
|
995
|
+
# calculating routes.
|
977
996
|
#
|
978
|
-
#
|
997
|
+
# Additional options include:
|
979
998
|
#
|
980
|
-
#
|
981
|
-
#
|
999
|
+
# * [ Specifying a departure time][3] using either `DepartureTime` or
|
1000
|
+
# `DepartNow`. This calculates routes based on predictive traffic data
|
1001
|
+
# at the given time.
|
982
1002
|
#
|
983
|
-
#
|
984
|
-
#
|
985
|
-
# ID, key ARN, alias name, or alias ARN.
|
1003
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
1004
|
+
# request. Specifying both parameters returns a validation error.
|
986
1005
|
#
|
1006
|
+
# </note>
|
987
1007
|
#
|
1008
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
1009
|
+
# transportation mode used to calculate the routes. This also lets you
|
1010
|
+
# specify additional route preferences in `CarModeOptions` if
|
1011
|
+
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
988
1012
|
#
|
989
|
-
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
990
1013
|
#
|
991
|
-
# @option params [required, String] :pricing_plan
|
992
|
-
# Specifies the pricing plan for the geofence collection.
|
993
1014
|
#
|
994
|
-
#
|
995
|
-
#
|
1015
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html
|
1016
|
+
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
1017
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
1018
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
996
1019
|
#
|
1020
|
+
# @option params [required, String] :calculator_name
|
1021
|
+
# The name of the route calculator resource that you want to use to
|
1022
|
+
# calculate the route matrix.
|
997
1023
|
#
|
1024
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
1025
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
1026
|
+
# routes that use ferries or tolls.
|
998
1027
|
#
|
999
|
-
#
|
1028
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
1000
1029
|
#
|
1001
|
-
# @option params [
|
1002
|
-
#
|
1030
|
+
# @option params [Boolean] :depart_now
|
1031
|
+
# Sets the time of departure as the current time. Uses the current time
|
1032
|
+
# to calculate the route matrix. You can't set both `DepartureTime` and
|
1033
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1034
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1035
|
+
#
|
1036
|
+
# Default Value: `false`
|
1037
|
+
#
|
1038
|
+
# Valid Values: `false` \| `true`
|
1039
|
+
#
|
1040
|
+
# @option params [required, Array<Array>] :departure_positions
|
1041
|
+
# The list of departure (origin) positions for the route matrix. An
|
1042
|
+
# array of points, each of which is itself a 2-value array defined in
|
1043
|
+
# [WGS 84][1] format: `[longitude, latitude]`. For example, `[-123.115,
|
1044
|
+
# 49.285]`.
|
1045
|
+
#
|
1046
|
+
# Depending on the data provider selected in the route calculator
|
1047
|
+
# resource there may be additional restrictions on the inputs you can
|
1048
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1049
|
+
# Service Developer Guide*.
|
1050
|
+
#
|
1051
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1052
|
+
# specify a departure that's not located on a road, Amazon Location [
|
1053
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1054
|
+
# available in the result in `SnappedDeparturePositions`.
|
1055
|
+
#
|
1056
|
+
# </note>
|
1057
|
+
#
|
1058
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1059
|
+
#
|
1060
|
+
#
|
1061
|
+
#
|
1062
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1063
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1064
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1065
|
+
#
|
1066
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
1067
|
+
# Specifies the desired time of departure. Uses the given time to
|
1068
|
+
# calculate the route matrix. You can't set both `DepartureTime` and
|
1069
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1070
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1071
|
+
#
|
1072
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
1073
|
+
# ValidationException` error.
|
1074
|
+
#
|
1075
|
+
# </note>
|
1003
1076
|
#
|
1004
|
-
# *
|
1005
|
-
#
|
1077
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
1078
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
1006
1079
|
#
|
1007
1080
|
# ^
|
1008
1081
|
#
|
1009
|
-
# For more information about [Data Providers][1], and [Pricing
|
1010
|
-
# plans][2], see the Amazon Location Service product page.
|
1011
1082
|
#
|
1012
|
-
#
|
1013
|
-
#
|
1014
|
-
#
|
1015
|
-
#
|
1083
|
+
#
|
1084
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1085
|
+
#
|
1086
|
+
# @option params [required, Array<Array>] :destination_positions
|
1087
|
+
# The list of destination positions for the route matrix. An array of
|
1088
|
+
# points, each of which is itself a 2-value array defined in [WGS 84][1]
|
1089
|
+
# format: `[longitude, latitude]`. For example, `[-122.339, 47.615]`
|
1090
|
+
#
|
1091
|
+
# Depending on the data provider selected in the route calculator
|
1092
|
+
# resource there may be additional restrictions on the inputs you can
|
1093
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1094
|
+
# Service Developer Guide*.
|
1095
|
+
#
|
1096
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1097
|
+
# specify a destination that's not located on a road, Amazon Location [
|
1098
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1099
|
+
# available in the result in `SnappedDestinationPositions`.
|
1016
1100
|
#
|
1017
1101
|
# </note>
|
1018
1102
|
#
|
1019
|
-
# Valid Values: `
|
1103
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1104
|
+
#
|
1105
|
+
#
|
1106
|
+
#
|
1107
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1108
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1109
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1110
|
+
#
|
1111
|
+
# @option params [String] :distance_unit
|
1112
|
+
# Set the unit system to specify the distance.
|
1113
|
+
#
|
1114
|
+
# Default Value: `Kilometers`
|
1115
|
+
#
|
1116
|
+
# @option params [String] :travel_mode
|
1117
|
+
# Specifies the mode of transport when calculating a route. Used in
|
1118
|
+
# estimating the speed of travel and road compatibility.
|
1119
|
+
#
|
1120
|
+
# The `TravelMode` you specify also determines how you specify route
|
1121
|
+
# preferences:
|
1122
|
+
#
|
1123
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
1124
|
+
#
|
1125
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
1126
|
+
#
|
1127
|
+
# Default Value: `Car`
|
1128
|
+
#
|
1129
|
+
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
1130
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
1131
|
+
# avoiding routes that use ferries or tolls, and truck specifications to
|
1132
|
+
# consider when choosing an optimal road.
|
1133
|
+
#
|
1134
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
1135
|
+
#
|
1136
|
+
# @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1137
|
+
#
|
1138
|
+
# * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array<Array<Types::RouteMatrixEntry>>
|
1139
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array<Array<Float>>
|
1140
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array<Array<Float>>
|
1141
|
+
# * {Types::CalculateRouteMatrixResponse#summary #summary} => Types::CalculateRouteMatrixSummary
|
1142
|
+
#
|
1143
|
+
# @example Request syntax with placeholder values
|
1020
1144
|
#
|
1145
|
+
# resp = client.calculate_route_matrix({
|
1146
|
+
# calculator_name: "ResourceName", # required
|
1147
|
+
# car_mode_options: {
|
1148
|
+
# avoid_ferries: false,
|
1149
|
+
# avoid_tolls: false,
|
1150
|
+
# },
|
1151
|
+
# depart_now: false,
|
1152
|
+
# departure_positions: [ # required
|
1153
|
+
# [1.0],
|
1154
|
+
# ],
|
1155
|
+
# departure_time: Time.now,
|
1156
|
+
# destination_positions: [ # required
|
1157
|
+
# [1.0],
|
1158
|
+
# ],
|
1159
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1160
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
1161
|
+
# truck_mode_options: {
|
1162
|
+
# avoid_ferries: false,
|
1163
|
+
# avoid_tolls: false,
|
1164
|
+
# dimensions: {
|
1165
|
+
# height: 1.0,
|
1166
|
+
# length: 1.0,
|
1167
|
+
# unit: "Meters", # accepts Meters, Feet
|
1168
|
+
# width: 1.0,
|
1169
|
+
# },
|
1170
|
+
# weight: {
|
1171
|
+
# total: 1.0,
|
1172
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1173
|
+
# },
|
1174
|
+
# },
|
1175
|
+
# })
|
1021
1176
|
#
|
1177
|
+
# @example Response structure
|
1022
1178
|
#
|
1023
|
-
#
|
1024
|
-
# [
|
1179
|
+
# resp.route_matrix #=> Array
|
1180
|
+
# resp.route_matrix[0] #=> Array
|
1181
|
+
# resp.route_matrix[0][0].distance #=> Float
|
1182
|
+
# resp.route_matrix[0][0].duration_seconds #=> Float
|
1183
|
+
# resp.route_matrix[0][0].error.code #=> String, one of "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError"
|
1184
|
+
# resp.route_matrix[0][0].error.message #=> String
|
1185
|
+
# resp.snapped_departure_positions #=> Array
|
1186
|
+
# resp.snapped_departure_positions[0] #=> Array
|
1187
|
+
# resp.snapped_departure_positions[0][0] #=> Float
|
1188
|
+
# resp.snapped_destination_positions #=> Array
|
1189
|
+
# resp.snapped_destination_positions[0] #=> Array
|
1190
|
+
# resp.snapped_destination_positions[0][0] #=> Float
|
1191
|
+
# resp.summary.data_source #=> String
|
1192
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1193
|
+
# resp.summary.error_count #=> Integer
|
1194
|
+
# resp.summary.route_count #=> Integer
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
|
1197
|
+
#
|
1198
|
+
# @overload calculate_route_matrix(params = {})
|
1199
|
+
# @param [Hash] params ({})
|
1200
|
+
def calculate_route_matrix(params = {}, options = {})
|
1201
|
+
req = build_request(:calculate_route_matrix, params)
|
1202
|
+
req.send_request(options)
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# Creates a geofence collection, which manages and stores geofences.
|
1206
|
+
#
|
1207
|
+
# @option params [required, String] :collection_name
|
1208
|
+
# A custom name for the geofence collection.
|
1209
|
+
#
|
1210
|
+
# Requirements:
|
1211
|
+
#
|
1212
|
+
# * Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-),
|
1213
|
+
# periods (.), and underscores (\_).
|
1214
|
+
#
|
1215
|
+
# * Must be a unique geofence collection name.
|
1216
|
+
#
|
1217
|
+
# * No spaces allowed. For example, `ExampleGeofenceCollection`.
|
1218
|
+
#
|
1219
|
+
# @option params [String] :description
|
1220
|
+
# An optional description for the geofence collection.
|
1221
|
+
#
|
1222
|
+
# @option params [String] :kms_key_id
|
1223
|
+
# A key identifier for an [AWS KMS customer managed key][1]. Enter a key
|
1224
|
+
# ID, key ARN, alias name, or alias ARN.
|
1225
|
+
#
|
1226
|
+
#
|
1227
|
+
#
|
1228
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
1229
|
+
#
|
1230
|
+
# @option params [String] :pricing_plan
|
1231
|
+
# No longer used. If included, the only allowed value is
|
1232
|
+
# `RequestBasedUsage`.
|
1233
|
+
#
|
1234
|
+
# @option params [String] :pricing_plan_data_source
|
1235
|
+
# This parameter is no longer used.
|
1025
1236
|
#
|
1026
1237
|
# @option params [Hash<String,String>] :tags
|
1027
1238
|
# Applies one or more tags to the geofence collection. A tag is a
|
@@ -1057,7 +1268,7 @@ module Aws::LocationService
|
|
1057
1268
|
# collection_name: "ResourceName", # required
|
1058
1269
|
# description: "ResourceDescription",
|
1059
1270
|
# kms_key_id: "KmsKeyId",
|
1060
|
-
# pricing_plan: "RequestBasedUsage", #
|
1271
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1061
1272
|
# pricing_plan_data_source: "String",
|
1062
1273
|
# tags: {
|
1063
1274
|
# "TagKey" => "TagValue",
|
@@ -1082,6 +1293,17 @@ module Aws::LocationService
|
|
1082
1293
|
# Creates a map resource in your AWS account, which provides map tiles
|
1083
1294
|
# of different styles sourced from global location data providers.
|
1084
1295
|
#
|
1296
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1297
|
+
# business, such as delivery vehicles or employees, you may only use
|
1298
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1299
|
+
# terms][1] for more details.
|
1300
|
+
#
|
1301
|
+
# </note>
|
1302
|
+
#
|
1303
|
+
#
|
1304
|
+
#
|
1305
|
+
# [1]: http://aws.amazon.com/service-terms
|
1306
|
+
#
|
1085
1307
|
# @option params [required, Types::MapConfiguration] :configuration
|
1086
1308
|
# Specifies the map style selected from an available data provider.
|
1087
1309
|
#
|
@@ -1100,15 +1322,9 @@ module Aws::LocationService
|
|
1100
1322
|
#
|
1101
1323
|
# * No spaces allowed. For example, `ExampleMap`.
|
1102
1324
|
#
|
1103
|
-
# @option params [
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
# For additional details and restrictions on each pricing plan option,
|
1107
|
-
# see [Amazon Location Service pricing][1].
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1325
|
+
# @option params [String] :pricing_plan
|
1326
|
+
# No longer used. If included, the only allowed value is
|
1327
|
+
# `RequestBasedUsage`.
|
1112
1328
|
#
|
1113
1329
|
# @option params [Hash<String,String>] :tags
|
1114
1330
|
# Applies one or more tags to the map resource. A tag is a key-value
|
@@ -1146,7 +1362,7 @@ module Aws::LocationService
|
|
1146
1362
|
# },
|
1147
1363
|
# description: "ResourceDescription",
|
1148
1364
|
# map_name: "ResourceName", # required
|
1149
|
-
# pricing_plan: "RequestBasedUsage", #
|
1365
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1150
1366
|
# tags: {
|
1151
1367
|
# "TagKey" => "TagValue",
|
1152
1368
|
# },
|
@@ -1174,6 +1390,17 @@ module Aws::LocationService
|
|
1174
1390
|
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
|
1175
1391
|
# operation.
|
1176
1392
|
#
|
1393
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1394
|
+
# business, such as delivery vehicles or employees, you may only use
|
1395
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1396
|
+
# terms][1] for more details.
|
1397
|
+
#
|
1398
|
+
# </note>
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
# [1]: http://aws.amazon.com/service-terms
|
1403
|
+
#
|
1177
1404
|
# @option params [required, String] :data_source
|
1178
1405
|
# Specifies the geospatial data provider for the new place index.
|
1179
1406
|
#
|
@@ -1228,15 +1455,9 @@ module Aws::LocationService
|
|
1228
1455
|
#
|
1229
1456
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1230
1457
|
#
|
1231
|
-
# @option params [
|
1232
|
-
#
|
1233
|
-
#
|
1234
|
-
# For additional details and restrictions on each pricing plan option,
|
1235
|
-
# see [Amazon Location Service pricing][1].
|
1236
|
-
#
|
1237
|
-
#
|
1238
|
-
#
|
1239
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1458
|
+
# @option params [String] :pricing_plan
|
1459
|
+
# No longer used. If included, the only allowed value is
|
1460
|
+
# `RequestBasedUsage`.
|
1240
1461
|
#
|
1241
1462
|
# @option params [Hash<String,String>] :tags
|
1242
1463
|
# Applies one or more tags to the place index resource. A tag is a
|
@@ -1276,7 +1497,7 @@ module Aws::LocationService
|
|
1276
1497
|
# },
|
1277
1498
|
# description: "ResourceDescription",
|
1278
1499
|
# index_name: "ResourceName", # required
|
1279
|
-
# pricing_plan: "RequestBasedUsage", #
|
1500
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1280
1501
|
# tags: {
|
1281
1502
|
# "TagKey" => "TagValue",
|
1282
1503
|
# },
|
@@ -1303,6 +1524,17 @@ module Aws::LocationService
|
|
1303
1524
|
# travel time, distance, and get directions. A route calculator sources
|
1304
1525
|
# traffic and road network data from your chosen data provider.
|
1305
1526
|
#
|
1527
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1528
|
+
# business, such as delivery vehicles or employees, you may only use
|
1529
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1530
|
+
# terms][1] for more details.
|
1531
|
+
#
|
1532
|
+
# </note>
|
1533
|
+
#
|
1534
|
+
#
|
1535
|
+
#
|
1536
|
+
# [1]: http://aws.amazon.com/service-terms
|
1537
|
+
#
|
1306
1538
|
# @option params [required, String] :calculator_name
|
1307
1539
|
# The name of the route calculator resource.
|
1308
1540
|
#
|
@@ -1350,15 +1582,9 @@ module Aws::LocationService
|
|
1350
1582
|
# @option params [String] :description
|
1351
1583
|
# The optional description for the route calculator resource.
|
1352
1584
|
#
|
1353
|
-
# @option params [
|
1354
|
-
#
|
1355
|
-
#
|
1356
|
-
# For additional details and restrictions on each pricing plan option,
|
1357
|
-
# see [Amazon Location Service pricing][1].
|
1358
|
-
#
|
1359
|
-
#
|
1360
|
-
#
|
1361
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1585
|
+
# @option params [String] :pricing_plan
|
1586
|
+
# No longer used. If included, the only allowed value is
|
1587
|
+
# `RequestBasedUsage`.
|
1362
1588
|
#
|
1363
1589
|
# @option params [Hash<String,String>] :tags
|
1364
1590
|
# Applies one or more tags to the route calculator resource. A tag is a
|
@@ -1398,7 +1624,7 @@ module Aws::LocationService
|
|
1398
1624
|
# calculator_name: "ResourceName", # required
|
1399
1625
|
# data_source: "String", # required
|
1400
1626
|
# description: "ResourceDescription",
|
1401
|
-
# pricing_plan: "RequestBasedUsage", #
|
1627
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1402
1628
|
# tags: {
|
1403
1629
|
# "TagKey" => "TagValue",
|
1404
1630
|
# },
|
@@ -1464,40 +1690,12 @@ module Aws::LocationService
|
|
1464
1690
|
# This field is optional. If not specified, the default value is
|
1465
1691
|
# `TimeBased`.
|
1466
1692
|
#
|
1467
|
-
# @option params [
|
1468
|
-
#
|
1469
|
-
#
|
1470
|
-
# For additional details and restrictions on each pricing plan option,
|
1471
|
-
# see [Amazon Location Service pricing][1].
|
1472
|
-
#
|
1473
|
-
#
|
1474
|
-
#
|
1475
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1693
|
+
# @option params [String] :pricing_plan
|
1694
|
+
# No longer used. If included, the only allowed value is
|
1695
|
+
# `RequestBasedUsage`.
|
1476
1696
|
#
|
1477
1697
|
# @option params [String] :pricing_plan_data_source
|
1478
|
-
#
|
1479
|
-
#
|
1480
|
-
# * Required value for the following pricing plans: `MobileAssetTracking
|
1481
|
-
# `\| `MobileAssetManagement`
|
1482
|
-
#
|
1483
|
-
# ^
|
1484
|
-
#
|
1485
|
-
# For more information about [Data Providers][1], and [Pricing
|
1486
|
-
# plans][2], see the Amazon Location Service product page.
|
1487
|
-
#
|
1488
|
-
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
1489
|
-
# billing for your tracker resource. Your data will not be shared with
|
1490
|
-
# the data provider, and will remain in your AWS account or Region
|
1491
|
-
# unless you move it.
|
1492
|
-
#
|
1493
|
-
# </note>
|
1494
|
-
#
|
1495
|
-
# Valid values: `Esri` \| `Here`
|
1496
|
-
#
|
1497
|
-
#
|
1498
|
-
#
|
1499
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
1500
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
1698
|
+
# This parameter is no longer used.
|
1501
1699
|
#
|
1502
1700
|
# @option params [Hash<String,String>] :tags
|
1503
1701
|
# Applies one or more tags to the tracker resource. A tag is a key-value
|
@@ -1545,7 +1743,7 @@ module Aws::LocationService
|
|
1545
1743
|
# description: "ResourceDescription",
|
1546
1744
|
# kms_key_id: "KmsKeyId",
|
1547
1745
|
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1548
|
-
# pricing_plan: "RequestBasedUsage", #
|
1746
|
+
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1549
1747
|
# pricing_plan_data_source: "String",
|
1550
1748
|
# tags: {
|
1551
1749
|
# "TagKey" => "TagValue",
|
@@ -3297,38 +3495,11 @@ module Aws::LocationService
|
|
3297
3495
|
# Updates the description for the geofence collection.
|
3298
3496
|
#
|
3299
3497
|
# @option params [String] :pricing_plan
|
3300
|
-
#
|
3301
|
-
#
|
3302
|
-
# For more information about each pricing plan option restrictions, see
|
3303
|
-
# [Amazon Location Service pricing][1].
|
3304
|
-
#
|
3305
|
-
#
|
3306
|
-
#
|
3307
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3498
|
+
# No longer used. If included, the only allowed value is
|
3499
|
+
# `RequestBasedUsage`.
|
3308
3500
|
#
|
3309
3501
|
# @option params [String] :pricing_plan_data_source
|
3310
|
-
#
|
3311
|
-
#
|
3312
|
-
# A required value for the following pricing plans:
|
3313
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3314
|
-
#
|
3315
|
-
# For more information about [data providers][1] and [pricing plans][2],
|
3316
|
-
# see the Amazon Location Service product page.
|
3317
|
-
#
|
3318
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3319
|
-
# request.
|
3320
|
-
#
|
3321
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3322
|
-
# billing for your geofence collection. Your data won't be shared with
|
3323
|
-
# the data provider, and will remain in your AWS account and Region
|
3324
|
-
# unless you move it.
|
3325
|
-
#
|
3326
|
-
# </note>
|
3327
|
-
#
|
3328
|
-
#
|
3329
|
-
#
|
3330
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
3331
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
3502
|
+
# This parameter is no longer used.
|
3332
3503
|
#
|
3333
3504
|
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3334
3505
|
#
|
@@ -3369,14 +3540,8 @@ module Aws::LocationService
|
|
3369
3540
|
# The name of the map resource to update.
|
3370
3541
|
#
|
3371
3542
|
# @option params [String] :pricing_plan
|
3372
|
-
#
|
3373
|
-
#
|
3374
|
-
# For more information about each pricing plan option restrictions, see
|
3375
|
-
# [Amazon Location Service pricing][1].
|
3376
|
-
#
|
3377
|
-
#
|
3378
|
-
#
|
3379
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3543
|
+
# No longer used. If included, the only allowed value is
|
3544
|
+
# `RequestBasedUsage`.
|
3380
3545
|
#
|
3381
3546
|
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3382
3547
|
#
|
@@ -3419,14 +3584,8 @@ module Aws::LocationService
|
|
3419
3584
|
# The name of the place index resource to update.
|
3420
3585
|
#
|
3421
3586
|
# @option params [String] :pricing_plan
|
3422
|
-
#
|
3423
|
-
#
|
3424
|
-
# For more information about each pricing plan option restrictions, see
|
3425
|
-
# [Amazon Location Service pricing][1].
|
3426
|
-
#
|
3427
|
-
#
|
3428
|
-
#
|
3429
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3587
|
+
# No longer used. If included, the only allowed value is
|
3588
|
+
# `RequestBasedUsage`.
|
3430
3589
|
#
|
3431
3590
|
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3432
3591
|
#
|
@@ -3470,14 +3629,8 @@ module Aws::LocationService
|
|
3470
3629
|
# Updates the description for the route calculator resource.
|
3471
3630
|
#
|
3472
3631
|
# @option params [String] :pricing_plan
|
3473
|
-
#
|
3474
|
-
#
|
3475
|
-
# For more information about each pricing plan option restrictions, see
|
3476
|
-
# [Amazon Location Service pricing][1].
|
3477
|
-
#
|
3478
|
-
#
|
3479
|
-
#
|
3480
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3632
|
+
# No longer used. If included, the only allowed value is
|
3633
|
+
# `RequestBasedUsage`.
|
3481
3634
|
#
|
3482
3635
|
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3483
3636
|
#
|
@@ -3542,38 +3695,11 @@ module Aws::LocationService
|
|
3542
3695
|
# evaluations.
|
3543
3696
|
#
|
3544
3697
|
# @option params [String] :pricing_plan
|
3545
|
-
#
|
3546
|
-
#
|
3547
|
-
# For more information about each pricing plan option restrictions, see
|
3548
|
-
# [Amazon Location Service pricing][1].
|
3549
|
-
#
|
3550
|
-
#
|
3551
|
-
#
|
3552
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3698
|
+
# No longer used. If included, the only allowed value is
|
3699
|
+
# `RequestBasedUsage`.
|
3553
3700
|
#
|
3554
3701
|
# @option params [String] :pricing_plan_data_source
|
3555
|
-
#
|
3556
|
-
#
|
3557
|
-
# A required value for the following pricing plans:
|
3558
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3559
|
-
#
|
3560
|
-
# For more information about [data providers][1] and [pricing plans][2],
|
3561
|
-
# see the Amazon Location Service product page
|
3562
|
-
#
|
3563
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3564
|
-
# request.
|
3565
|
-
#
|
3566
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3567
|
-
# billing for your tracker resource. Your data won't be shared with the
|
3568
|
-
# data provider, and will remain in your AWS account and Region unless
|
3569
|
-
# you move it.
|
3570
|
-
#
|
3571
|
-
# </note>
|
3572
|
-
#
|
3573
|
-
#
|
3574
|
-
#
|
3575
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
3576
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
3702
|
+
# This parameter is no longer used.
|
3577
3703
|
#
|
3578
3704
|
# @option params [required, String] :tracker_name
|
3579
3705
|
# The name of the tracker resource to update.
|
@@ -3622,7 +3748,7 @@ module Aws::LocationService
|
|
3622
3748
|
params: params,
|
3623
3749
|
config: config)
|
3624
3750
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3625
|
-
context[:gem_version] = '1.
|
3751
|
+
context[:gem_version] = '1.18.0'
|
3626
3752
|
Seahorse::Client::Request.new(handlers, context)
|
3627
3753
|
end
|
3628
3754
|
|