aws-sdk-locationservice 1.16.0 → 1.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +305 -191
- data/lib/aws-sdk-locationservice/client_api.rb +104 -28
- data/lib/aws-sdk-locationservice/types.rb +389 -263
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
@@ -27,7 +27,9 @@ 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/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
31
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
32
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
33
35
|
|
@@ -74,7 +76,9 @@ module Aws::LocationService
|
|
74
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
77
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
78
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
79
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
80
84
|
|
@@ -723,7 +727,7 @@ module Aws::LocationService
|
|
723
727
|
end
|
724
728
|
|
725
729
|
# [Calculates a route][1] given the following required parameters:
|
726
|
-
# `
|
730
|
+
# `DeparturePosition` and `DestinationPosition`. Requires that you first
|
727
731
|
# [create a route calculator resource][2].
|
728
732
|
#
|
729
733
|
# By default, a request that doesn't specify a departure time uses the
|
@@ -733,27 +737,25 @@ module Aws::LocationService
|
|
733
737
|
# Additional options include:
|
734
738
|
#
|
735
739
|
# * [Specifying a departure time][3] using either `DepartureTime` or
|
736
|
-
# `
|
740
|
+
# `DepartNow`. This calculates a route based on predictive traffic
|
737
741
|
# data at the given time.
|
738
742
|
#
|
739
|
-
# <note markdown="1"> You can't specify both `DepartureTime` and `
|
740
|
-
#
|
741
|
-
# error.
|
743
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
744
|
+
# request. Specifying both parameters returns a validation error.
|
742
745
|
#
|
743
746
|
# </note>
|
744
747
|
#
|
745
|
-
# * [Specifying a travel mode][4] using TravelMode
|
746
|
-
#
|
748
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
749
|
+
# transportation mode used to calculate the routes. This also lets you
|
750
|
+
# specify additional route preferences in `CarModeOptions` if
|
747
751
|
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
748
752
|
#
|
749
753
|
#
|
750
754
|
#
|
751
|
-
#
|
752
|
-
#
|
753
755
|
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
|
754
756
|
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
755
|
-
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/
|
756
|
-
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/
|
757
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
758
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
757
759
|
#
|
758
760
|
# @option params [required, String] :calculator_name
|
759
761
|
# The name of the route calculator resource that you want to use to
|
@@ -794,7 +796,7 @@ module Aws::LocationService
|
|
794
796
|
#
|
795
797
|
#
|
796
798
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
797
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
799
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
798
800
|
#
|
799
801
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
800
802
|
# Specifies the desired time of departure. Uses the given time to
|
@@ -833,7 +835,7 @@ module Aws::LocationService
|
|
833
835
|
#
|
834
836
|
#
|
835
837
|
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
836
|
-
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/
|
838
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
837
839
|
#
|
838
840
|
# @option params [String] :distance_unit
|
839
841
|
# Set the unit system to specify the distance.
|
@@ -852,7 +854,7 @@ module Aws::LocationService
|
|
852
854
|
# Specifies the mode of transport when calculating a route. Used in
|
853
855
|
# estimating the speed of travel and road compatibility.
|
854
856
|
#
|
855
|
-
# The `TravelMode` you specify determines how you specify route
|
857
|
+
# The `TravelMode` you specify also determines how you specify route
|
856
858
|
# preferences:
|
857
859
|
#
|
858
860
|
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
@@ -895,7 +897,7 @@ module Aws::LocationService
|
|
895
897
|
#
|
896
898
|
#
|
897
899
|
#
|
898
|
-
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/
|
900
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
899
901
|
#
|
900
902
|
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
903
|
#
|
@@ -972,6 +974,236 @@ module Aws::LocationService
|
|
972
974
|
req.send_request(options)
|
973
975
|
end
|
974
976
|
|
977
|
+
# [ Calculates a route matrix][1] given the following required
|
978
|
+
# parameters: `DeparturePositions` and `DestinationPositions`.
|
979
|
+
# `CalculateRouteMatrix` calculates routes and returns the travel time
|
980
|
+
# and travel distance from each departure position to each destination
|
981
|
+
# position in the request. For example, given departure positions A and
|
982
|
+
# B, and destination positions X and Y, `CalculateRouteMatrix` will
|
983
|
+
# return time and distance for routes from A to X, A to Y, B to X, and B
|
984
|
+
# to Y (in that order). The number of results returned (and routes
|
985
|
+
# calculated) will be the number of `DeparturePositions` times the
|
986
|
+
# number of `DestinationPositions`.
|
987
|
+
#
|
988
|
+
# <note markdown="1"> Your account is charged for each route calculated, not the number of
|
989
|
+
# requests.
|
990
|
+
#
|
991
|
+
# </note>
|
992
|
+
#
|
993
|
+
# Requires that you first [create a route calculator resource][2].
|
994
|
+
#
|
995
|
+
# By default, a request that doesn't specify a departure time uses the
|
996
|
+
# best time of day to travel with the best traffic conditions when
|
997
|
+
# calculating routes.
|
998
|
+
#
|
999
|
+
# Additional options include:
|
1000
|
+
#
|
1001
|
+
# * [ Specifying a departure time][3] using either `DepartureTime` or
|
1002
|
+
# `DepartNow`. This calculates routes based on predictive traffic data
|
1003
|
+
# at the given time.
|
1004
|
+
#
|
1005
|
+
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
|
1006
|
+
# request. Specifying both parameters returns a validation error.
|
1007
|
+
#
|
1008
|
+
# </note>
|
1009
|
+
#
|
1010
|
+
# * [Specifying a travel mode][4] using TravelMode sets the
|
1011
|
+
# transportation mode used to calculate the routes. This also lets you
|
1012
|
+
# specify additional route preferences in `CarModeOptions` if
|
1013
|
+
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
|
1014
|
+
#
|
1015
|
+
#
|
1016
|
+
#
|
1017
|
+
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html
|
1018
|
+
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
|
1019
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
|
1020
|
+
# [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
|
1021
|
+
#
|
1022
|
+
# @option params [required, String] :calculator_name
|
1023
|
+
# The name of the route calculator resource that you want to use to
|
1024
|
+
# calculate the route matrix.
|
1025
|
+
#
|
1026
|
+
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
1027
|
+
# Specifies route preferences when traveling by `Car`, such as avoiding
|
1028
|
+
# routes that use ferries or tolls.
|
1029
|
+
#
|
1030
|
+
# Requirements: `TravelMode` must be specified as `Car`.
|
1031
|
+
#
|
1032
|
+
# @option params [Boolean] :depart_now
|
1033
|
+
# Sets the time of departure as the current time. Uses the current time
|
1034
|
+
# to calculate the route matrix. You can't set both `DepartureTime` and
|
1035
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1036
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1037
|
+
#
|
1038
|
+
# Default Value: `false`
|
1039
|
+
#
|
1040
|
+
# Valid Values: `false` \| `true`
|
1041
|
+
#
|
1042
|
+
# @option params [required, Array<Array>] :departure_positions
|
1043
|
+
# The list of departure (origin) positions for the route matrix. An
|
1044
|
+
# array of points, each of which is itself a 2-value array defined in
|
1045
|
+
# [WGS 84][1] format: `[longitude, latitude]`. For example, `[-123.115,
|
1046
|
+
# 49.285]`.
|
1047
|
+
#
|
1048
|
+
# Depending on the data provider selected in the route calculator
|
1049
|
+
# resource there may be additional restrictions on the inputs you can
|
1050
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1051
|
+
# Service Developer Guide*.
|
1052
|
+
#
|
1053
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1054
|
+
# specify a departure that's not located on a road, Amazon Location [
|
1055
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1056
|
+
# available in the result in `SnappedDeparturePositions`.
|
1057
|
+
#
|
1058
|
+
# </note>
|
1059
|
+
#
|
1060
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1061
|
+
#
|
1062
|
+
#
|
1063
|
+
#
|
1064
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1065
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1066
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1067
|
+
#
|
1068
|
+
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
1069
|
+
# Specifies the desired time of departure. Uses the given time to
|
1070
|
+
# calculate the route matrix. You can't set both `DepartureTime` and
|
1071
|
+
# `DepartNow`. If neither is set, the best time of day to travel with
|
1072
|
+
# the best traffic conditions is used to calculate the route matrix.
|
1073
|
+
#
|
1074
|
+
# <note markdown="1"> Setting a departure time in the past returns a `400
|
1075
|
+
# ValidationException` error.
|
1076
|
+
#
|
1077
|
+
# </note>
|
1078
|
+
#
|
1079
|
+
# * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
|
1080
|
+
# `2020–07-2T12:15:20.000Z+01:00`
|
1081
|
+
#
|
1082
|
+
# ^
|
1083
|
+
#
|
1084
|
+
#
|
1085
|
+
#
|
1086
|
+
# [1]: https://www.iso.org/iso-8601-date-and-time-format.html
|
1087
|
+
#
|
1088
|
+
# @option params [required, Array<Array>] :destination_positions
|
1089
|
+
# The list of destination positions for the route matrix. An array of
|
1090
|
+
# points, each of which is itself a 2-value array defined in [WGS 84][1]
|
1091
|
+
# format: `[longitude, latitude]`. For example, `[-122.339, 47.615]`
|
1092
|
+
#
|
1093
|
+
# Depending on the data provider selected in the route calculator
|
1094
|
+
# resource there may be additional restrictions on the inputs you can
|
1095
|
+
# choose. See [ Position restrictions][2] in the *Amazon Location
|
1096
|
+
# Service Developer Guide*.
|
1097
|
+
#
|
1098
|
+
# <note markdown="1"> For route calculators that use Esri as the data provider, if you
|
1099
|
+
# specify a destination that's not located on a road, Amazon Location [
|
1100
|
+
# moves the position to the nearest road][3]. The snapped value is
|
1101
|
+
# available in the result in `SnappedDestinationPositions`.
|
1102
|
+
#
|
1103
|
+
# </note>
|
1104
|
+
#
|
1105
|
+
# Valid Values: `[-180 to 180,-90 to 90]`
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
#
|
1109
|
+
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
|
1110
|
+
# [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
|
1111
|
+
# [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
|
1112
|
+
#
|
1113
|
+
# @option params [String] :distance_unit
|
1114
|
+
# Set the unit system to specify the distance.
|
1115
|
+
#
|
1116
|
+
# Default Value: `Kilometers`
|
1117
|
+
#
|
1118
|
+
# @option params [String] :travel_mode
|
1119
|
+
# Specifies the mode of transport when calculating a route. Used in
|
1120
|
+
# estimating the speed of travel and road compatibility.
|
1121
|
+
#
|
1122
|
+
# The `TravelMode` you specify also determines how you specify route
|
1123
|
+
# preferences:
|
1124
|
+
#
|
1125
|
+
# * If traveling by `Car` use the `CarModeOptions` parameter.
|
1126
|
+
#
|
1127
|
+
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
|
1128
|
+
#
|
1129
|
+
# Default Value: `Car`
|
1130
|
+
#
|
1131
|
+
# @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
|
1132
|
+
# Specifies route preferences when traveling by `Truck`, such as
|
1133
|
+
# avoiding routes that use ferries or tolls, and truck specifications to
|
1134
|
+
# consider when choosing an optimal road.
|
1135
|
+
#
|
1136
|
+
# Requirements: `TravelMode` must be specified as `Truck`.
|
1137
|
+
#
|
1138
|
+
# @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1139
|
+
#
|
1140
|
+
# * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array<Array<Types::RouteMatrixEntry>>
|
1141
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array<Array<Float>>
|
1142
|
+
# * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array<Array<Float>>
|
1143
|
+
# * {Types::CalculateRouteMatrixResponse#summary #summary} => Types::CalculateRouteMatrixSummary
|
1144
|
+
#
|
1145
|
+
# @example Request syntax with placeholder values
|
1146
|
+
#
|
1147
|
+
# resp = client.calculate_route_matrix({
|
1148
|
+
# calculator_name: "ResourceName", # required
|
1149
|
+
# car_mode_options: {
|
1150
|
+
# avoid_ferries: false,
|
1151
|
+
# avoid_tolls: false,
|
1152
|
+
# },
|
1153
|
+
# depart_now: false,
|
1154
|
+
# departure_positions: [ # required
|
1155
|
+
# [1.0],
|
1156
|
+
# ],
|
1157
|
+
# departure_time: Time.now,
|
1158
|
+
# destination_positions: [ # required
|
1159
|
+
# [1.0],
|
1160
|
+
# ],
|
1161
|
+
# distance_unit: "Kilometers", # accepts Kilometers, Miles
|
1162
|
+
# travel_mode: "Car", # accepts Car, Truck, Walking
|
1163
|
+
# truck_mode_options: {
|
1164
|
+
# avoid_ferries: false,
|
1165
|
+
# avoid_tolls: false,
|
1166
|
+
# dimensions: {
|
1167
|
+
# height: 1.0,
|
1168
|
+
# length: 1.0,
|
1169
|
+
# unit: "Meters", # accepts Meters, Feet
|
1170
|
+
# width: 1.0,
|
1171
|
+
# },
|
1172
|
+
# weight: {
|
1173
|
+
# total: 1.0,
|
1174
|
+
# unit: "Kilograms", # accepts Kilograms, Pounds
|
1175
|
+
# },
|
1176
|
+
# },
|
1177
|
+
# })
|
1178
|
+
#
|
1179
|
+
# @example Response structure
|
1180
|
+
#
|
1181
|
+
# resp.route_matrix #=> Array
|
1182
|
+
# resp.route_matrix[0] #=> Array
|
1183
|
+
# resp.route_matrix[0][0].distance #=> Float
|
1184
|
+
# resp.route_matrix[0][0].duration_seconds #=> Float
|
1185
|
+
# resp.route_matrix[0][0].error.code #=> String, one of "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError"
|
1186
|
+
# resp.route_matrix[0][0].error.message #=> String
|
1187
|
+
# resp.snapped_departure_positions #=> Array
|
1188
|
+
# resp.snapped_departure_positions[0] #=> Array
|
1189
|
+
# resp.snapped_departure_positions[0][0] #=> Float
|
1190
|
+
# resp.snapped_destination_positions #=> Array
|
1191
|
+
# resp.snapped_destination_positions[0] #=> Array
|
1192
|
+
# resp.snapped_destination_positions[0][0] #=> Float
|
1193
|
+
# resp.summary.data_source #=> String
|
1194
|
+
# resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
|
1195
|
+
# resp.summary.error_count #=> Integer
|
1196
|
+
# resp.summary.route_count #=> Integer
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
|
1199
|
+
#
|
1200
|
+
# @overload calculate_route_matrix(params = {})
|
1201
|
+
# @param [Hash] params ({})
|
1202
|
+
def calculate_route_matrix(params = {}, options = {})
|
1203
|
+
req = build_request(:calculate_route_matrix, params)
|
1204
|
+
req.send_request(options)
|
1205
|
+
end
|
1206
|
+
|
975
1207
|
# Creates a geofence collection, which manages and stores geofences.
|
976
1208
|
#
|
977
1209
|
# @option params [required, String] :collection_name
|
@@ -998,40 +1230,11 @@ module Aws::LocationService
|
|
998
1230
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
|
999
1231
|
#
|
1000
1232
|
# @option params [String] :pricing_plan
|
1001
|
-
#
|
1002
|
-
#
|
1003
|
-
#
|
1004
|
-
# For additional details and restrictions on each pricing plan option,
|
1005
|
-
# see the [Amazon Location Service pricing page][1].
|
1006
|
-
#
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1233
|
+
# No longer used. If included, the only allowed value is
|
1234
|
+
# `RequestBasedUsage`.
|
1010
1235
|
#
|
1011
1236
|
# @option params [String] :pricing_plan_data_source
|
1012
|
-
#
|
1013
|
-
#
|
1014
|
-
# * Required value for the following pricing plans: `MobileAssetTracking
|
1015
|
-
# `\| `MobileAssetManagement`
|
1016
|
-
#
|
1017
|
-
# ^
|
1018
|
-
#
|
1019
|
-
# For more information about [Data Providers][1], and [Pricing
|
1020
|
-
# plans][2], see the Amazon Location Service product page.
|
1021
|
-
#
|
1022
|
-
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
1023
|
-
# billing for your geofence collection. Your data won't be shared with
|
1024
|
-
# the data provider, and will remain in your AWS account or Region
|
1025
|
-
# unless you move it.
|
1026
|
-
#
|
1027
|
-
# </note>
|
1028
|
-
#
|
1029
|
-
# Valid Values: `Esri `\| `Here`
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
1034
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
1237
|
+
# This parameter is no longer used.
|
1035
1238
|
#
|
1036
1239
|
# @option params [Hash<String,String>] :tags
|
1037
1240
|
# Applies one or more tags to the geofence collection. A tag is a
|
@@ -1092,6 +1295,17 @@ module Aws::LocationService
|
|
1092
1295
|
# Creates a map resource in your AWS account, which provides map tiles
|
1093
1296
|
# of different styles sourced from global location data providers.
|
1094
1297
|
#
|
1298
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1299
|
+
# business, such as delivery vehicles or employees, you may only use
|
1300
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1301
|
+
# terms][1] for more details.
|
1302
|
+
#
|
1303
|
+
# </note>
|
1304
|
+
#
|
1305
|
+
#
|
1306
|
+
#
|
1307
|
+
# [1]: http://aws.amazon.com/service-terms
|
1308
|
+
#
|
1095
1309
|
# @option params [required, Types::MapConfiguration] :configuration
|
1096
1310
|
# Specifies the map style selected from an available data provider.
|
1097
1311
|
#
|
@@ -1111,15 +1325,8 @@ module Aws::LocationService
|
|
1111
1325
|
# * No spaces allowed. For example, `ExampleMap`.
|
1112
1326
|
#
|
1113
1327
|
# @option params [String] :pricing_plan
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
# For additional details and restrictions on each pricing plan option,
|
1118
|
-
# see [Amazon Location Service pricing][1].
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1328
|
+
# No longer used. If included, the only allowed value is
|
1329
|
+
# `RequestBasedUsage`.
|
1123
1330
|
#
|
1124
1331
|
# @option params [Hash<String,String>] :tags
|
1125
1332
|
# Applies one or more tags to the map resource. A tag is a key-value
|
@@ -1185,6 +1392,17 @@ module Aws::LocationService
|
|
1185
1392
|
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
|
1186
1393
|
# operation.
|
1187
1394
|
#
|
1395
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1396
|
+
# business, such as delivery vehicles or employees, you may only use
|
1397
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1398
|
+
# terms][1] for more details.
|
1399
|
+
#
|
1400
|
+
# </note>
|
1401
|
+
#
|
1402
|
+
#
|
1403
|
+
#
|
1404
|
+
# [1]: http://aws.amazon.com/service-terms
|
1405
|
+
#
|
1188
1406
|
# @option params [required, String] :data_source
|
1189
1407
|
# Specifies the geospatial data provider for the new place index.
|
1190
1408
|
#
|
@@ -1240,15 +1458,8 @@ module Aws::LocationService
|
|
1240
1458
|
# * No spaces allowed. For example, `ExamplePlaceIndex`.
|
1241
1459
|
#
|
1242
1460
|
# @option params [String] :pricing_plan
|
1243
|
-
#
|
1244
|
-
#
|
1245
|
-
#
|
1246
|
-
# For additional details and restrictions on each pricing plan option,
|
1247
|
-
# see [Amazon Location Service pricing][1].
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1461
|
+
# No longer used. If included, the only allowed value is
|
1462
|
+
# `RequestBasedUsage`.
|
1252
1463
|
#
|
1253
1464
|
# @option params [Hash<String,String>] :tags
|
1254
1465
|
# Applies one or more tags to the place index resource. A tag is a
|
@@ -1315,6 +1526,17 @@ module Aws::LocationService
|
|
1315
1526
|
# travel time, distance, and get directions. A route calculator sources
|
1316
1527
|
# traffic and road network data from your chosen data provider.
|
1317
1528
|
#
|
1529
|
+
# <note markdown="1"> If your application is tracking or routing assets you use in your
|
1530
|
+
# business, such as delivery vehicles or employees, you may only use
|
1531
|
+
# HERE as your geolocation provider. See section 82 of the [AWS service
|
1532
|
+
# terms][1] for more details.
|
1533
|
+
#
|
1534
|
+
# </note>
|
1535
|
+
#
|
1536
|
+
#
|
1537
|
+
#
|
1538
|
+
# [1]: http://aws.amazon.com/service-terms
|
1539
|
+
#
|
1318
1540
|
# @option params [required, String] :calculator_name
|
1319
1541
|
# The name of the route calculator resource.
|
1320
1542
|
#
|
@@ -1363,15 +1585,8 @@ module Aws::LocationService
|
|
1363
1585
|
# The optional description for the route calculator resource.
|
1364
1586
|
#
|
1365
1587
|
# @option params [String] :pricing_plan
|
1366
|
-
#
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
# For additional details and restrictions on each pricing plan option,
|
1370
|
-
# see [Amazon Location Service pricing][1].
|
1371
|
-
#
|
1372
|
-
#
|
1373
|
-
#
|
1374
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1588
|
+
# No longer used. If included, the only allowed value is
|
1589
|
+
# `RequestBasedUsage`.
|
1375
1590
|
#
|
1376
1591
|
# @option params [Hash<String,String>] :tags
|
1377
1592
|
# Applies one or more tags to the route calculator resource. A tag is a
|
@@ -1478,40 +1693,11 @@ module Aws::LocationService
|
|
1478
1693
|
# `TimeBased`.
|
1479
1694
|
#
|
1480
1695
|
# @option params [String] :pricing_plan
|
1481
|
-
#
|
1482
|
-
#
|
1483
|
-
#
|
1484
|
-
# For additional details and restrictions on each pricing plan option,
|
1485
|
-
# see [Amazon Location Service pricing][1].
|
1486
|
-
#
|
1487
|
-
#
|
1488
|
-
#
|
1489
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
1696
|
+
# No longer used. If included, the only allowed value is
|
1697
|
+
# `RequestBasedUsage`.
|
1490
1698
|
#
|
1491
1699
|
# @option params [String] :pricing_plan_data_source
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
# * Required value for the following pricing plans: `MobileAssetTracking
|
1495
|
-
# `\| `MobileAssetManagement`
|
1496
|
-
#
|
1497
|
-
# ^
|
1498
|
-
#
|
1499
|
-
# For more information about [Data Providers][1], and [Pricing
|
1500
|
-
# plans][2], see the Amazon Location Service product page.
|
1501
|
-
#
|
1502
|
-
# <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
|
1503
|
-
# billing for your tracker resource. Your data will not be shared with
|
1504
|
-
# the data provider, and will remain in your AWS account or Region
|
1505
|
-
# unless you move it.
|
1506
|
-
#
|
1507
|
-
# </note>
|
1508
|
-
#
|
1509
|
-
# Valid values: `Esri` \| `Here`
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
1514
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
1700
|
+
# This parameter is no longer used.
|
1515
1701
|
#
|
1516
1702
|
# @option params [Hash<String,String>] :tags
|
1517
1703
|
# Applies one or more tags to the tracker resource. A tag is a key-value
|
@@ -3311,38 +3497,11 @@ module Aws::LocationService
|
|
3311
3497
|
# Updates the description for the geofence collection.
|
3312
3498
|
#
|
3313
3499
|
# @option params [String] :pricing_plan
|
3314
|
-
#
|
3315
|
-
#
|
3316
|
-
# For more information about each pricing plan option restrictions, see
|
3317
|
-
# [Amazon Location Service pricing][1].
|
3318
|
-
#
|
3319
|
-
#
|
3320
|
-
#
|
3321
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3500
|
+
# No longer used. If included, the only allowed value is
|
3501
|
+
# `RequestBasedUsage`.
|
3322
3502
|
#
|
3323
3503
|
# @option params [String] :pricing_plan_data_source
|
3324
|
-
#
|
3325
|
-
#
|
3326
|
-
# A required value for the following pricing plans:
|
3327
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3328
|
-
#
|
3329
|
-
# For more information about [data providers][1] and [pricing plans][2],
|
3330
|
-
# see the Amazon Location Service product page.
|
3331
|
-
#
|
3332
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3333
|
-
# request.
|
3334
|
-
#
|
3335
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3336
|
-
# billing for your geofence collection. Your data won't be shared with
|
3337
|
-
# the data provider, and will remain in your AWS account and Region
|
3338
|
-
# unless you move it.
|
3339
|
-
#
|
3340
|
-
# </note>
|
3341
|
-
#
|
3342
|
-
#
|
3343
|
-
#
|
3344
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
3345
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
3504
|
+
# This parameter is no longer used.
|
3346
3505
|
#
|
3347
3506
|
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3348
3507
|
#
|
@@ -3383,14 +3542,8 @@ module Aws::LocationService
|
|
3383
3542
|
# The name of the map resource to update.
|
3384
3543
|
#
|
3385
3544
|
# @option params [String] :pricing_plan
|
3386
|
-
#
|
3387
|
-
#
|
3388
|
-
# For more information about each pricing plan option restrictions, see
|
3389
|
-
# [Amazon Location Service pricing][1].
|
3390
|
-
#
|
3391
|
-
#
|
3392
|
-
#
|
3393
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3545
|
+
# No longer used. If included, the only allowed value is
|
3546
|
+
# `RequestBasedUsage`.
|
3394
3547
|
#
|
3395
3548
|
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3396
3549
|
#
|
@@ -3433,14 +3586,8 @@ module Aws::LocationService
|
|
3433
3586
|
# The name of the place index resource to update.
|
3434
3587
|
#
|
3435
3588
|
# @option params [String] :pricing_plan
|
3436
|
-
#
|
3437
|
-
#
|
3438
|
-
# For more information about each pricing plan option restrictions, see
|
3439
|
-
# [Amazon Location Service pricing][1].
|
3440
|
-
#
|
3441
|
-
#
|
3442
|
-
#
|
3443
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3589
|
+
# No longer used. If included, the only allowed value is
|
3590
|
+
# `RequestBasedUsage`.
|
3444
3591
|
#
|
3445
3592
|
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3446
3593
|
#
|
@@ -3484,14 +3631,8 @@ module Aws::LocationService
|
|
3484
3631
|
# Updates the description for the route calculator resource.
|
3485
3632
|
#
|
3486
3633
|
# @option params [String] :pricing_plan
|
3487
|
-
#
|
3488
|
-
#
|
3489
|
-
# For more information about each pricing plan option restrictions, see
|
3490
|
-
# [Amazon Location Service pricing][1].
|
3491
|
-
#
|
3492
|
-
#
|
3493
|
-
#
|
3494
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3634
|
+
# No longer used. If included, the only allowed value is
|
3635
|
+
# `RequestBasedUsage`.
|
3495
3636
|
#
|
3496
3637
|
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3497
3638
|
#
|
@@ -3556,38 +3697,11 @@ module Aws::LocationService
|
|
3556
3697
|
# evaluations.
|
3557
3698
|
#
|
3558
3699
|
# @option params [String] :pricing_plan
|
3559
|
-
#
|
3560
|
-
#
|
3561
|
-
# For more information about each pricing plan option restrictions, see
|
3562
|
-
# [Amazon Location Service pricing][1].
|
3563
|
-
#
|
3564
|
-
#
|
3565
|
-
#
|
3566
|
-
# [1]: https://aws.amazon.com/location/pricing/
|
3700
|
+
# No longer used. If included, the only allowed value is
|
3701
|
+
# `RequestBasedUsage`.
|
3567
3702
|
#
|
3568
3703
|
# @option params [String] :pricing_plan_data_source
|
3569
|
-
#
|
3570
|
-
#
|
3571
|
-
# A required value for the following pricing plans:
|
3572
|
-
# `MobileAssetTracking`\| `MobileAssetManagement`
|
3573
|
-
#
|
3574
|
-
# For more information about [data providers][1] and [pricing plans][2],
|
3575
|
-
# see the Amazon Location Service product page
|
3576
|
-
#
|
3577
|
-
# <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
|
3578
|
-
# request.
|
3579
|
-
#
|
3580
|
-
# Amazon Location Service uses `PricingPlanDataSource` to calculate
|
3581
|
-
# billing for your tracker resource. Your data won't be shared with the
|
3582
|
-
# data provider, and will remain in your AWS account and Region unless
|
3583
|
-
# you move it.
|
3584
|
-
#
|
3585
|
-
# </note>
|
3586
|
-
#
|
3587
|
-
#
|
3588
|
-
#
|
3589
|
-
# [1]: https://aws.amazon.com/location/data-providers/
|
3590
|
-
# [2]: https://aws.amazon.com/location/pricing/
|
3704
|
+
# This parameter is no longer used.
|
3591
3705
|
#
|
3592
3706
|
# @option params [required, String] :tracker_name
|
3593
3707
|
# The name of the tracker resource to update.
|
@@ -3636,7 +3750,7 @@ module Aws::LocationService
|
|
3636
3750
|
params: params,
|
3637
3751
|
config: config)
|
3638
3752
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3639
|
-
context[:gem_version] = '1.
|
3753
|
+
context[:gem_version] = '1.19.0'
|
3640
3754
|
Seahorse::Client::Request.new(handlers, context)
|
3641
3755
|
end
|
3642
3756
|
|