lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.16.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.17.0
- old
+ new
@@ -721,41 +721,39 @@
req = build_request(:batch_update_device_position, params)
req.send_request(options)
end
# [Calculates a route][1] given the following required parameters:
- # `DeparturePostiton` and `DestinationPosition`. Requires that you first
+ # `DeparturePosition` and `DestinationPosition`. Requires that you first
# [create a route calculator resource][2].
#
# By default, a request that doesn't specify a departure time uses the
# best time of day to travel with the best traffic conditions when
# calculating the route.
#
# Additional options include:
#
# * [Specifying a departure time][3] using either `DepartureTime` or
- # `DepartureNow`. This calculates a route based on predictive traffic
+ # `DepartNow`. This calculates a route based on predictive traffic
# data at the given time.
#
- # <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
- # single request. Specifying both parameters returns a validation
- # error.
+ # <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
+ # request. Specifying both parameters returns a validation error.
#
# </note>
#
- # * [Specifying a travel mode][4] using TravelMode. This lets you
- # specify an additional route preference such as `CarModeOptions` if
+ # * [Specifying a travel mode][4] using TravelMode sets the
+ # transportation mode used to calculate the routes. This also lets you
+ # specify additional route preferences in `CarModeOptions` if
# traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
#
#
#
- #
- #
# [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html
# [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
- # [3]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#departure-time
- # [4]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#travel-mode
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
#
# @option params [required, String] :calculator_name
# The name of the route calculator resource that you want to use to
# calculate the route.
#
@@ -792,11 +790,11 @@
# Valid Values: `[-180 to 180,-90 to 90]`
#
#
#
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
#
# @option params [Time,DateTime,Date,Integer,String] :departure_time
# Specifies the desired time of departure. Uses the given time to
# calculate the route. Otherwise, the best time of day to travel with
# the best traffic conditions is used to calculate the route.
@@ -831,11 +829,11 @@
# Valid Values: `[-180 to 180,-90 to 90]`
#
#
#
# [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
- # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
#
# @option params [String] :distance_unit
# Set the unit system to specify the distance.
#
# Default Value: `Kilometers`
@@ -850,11 +848,11 @@
#
# @option params [String] :travel_mode
# Specifies the mode of transport when calculating a route. Used in
# estimating the speed of travel and road compatibility.
#
- # The `TravelMode` you specify determines how you specify route
+ # The `TravelMode` you specify also determines how you specify route
# preferences:
#
# * If traveling by `Car` use the `CarModeOptions` parameter.
#
# * If traveling by `Truck` use the `TruckModeOptions` parameter.
@@ -893,11 +891,11 @@
#
# Valid Values: `[-180 to 180,-90 to 90]`
#
#
#
- # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html#snap-to-nearby-road
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
#
# @return [Types::CalculateRouteResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CalculateRouteResponse#legs #legs} => Array<Types::Leg>
# * {Types::CalculateRouteResponse#summary #summary} => Types::CalculateRouteSummary
@@ -970,10 +968,240 @@
def calculate_route(params = {}, options = {})
req = build_request(:calculate_route, params)
req.send_request(options)
end
+ # [ Calculates a route matrix][1] given the following required
+ # parameters: `DeparturePositions` and `DestinationPositions`.
+ # `CalculateRouteMatrix` calculates routes and returns the travel time
+ # and travel distance from each departure position to each destination
+ # position in the request. For example, given departure positions A and
+ # B, and destination positions X and Y, `CalculateRouteMatrix` will
+ # return time and distance for routes from A to X, A to Y, B to X, and B
+ # to Y (in that order). The number of results returned (and routes
+ # calculated) will be the number of `DeparturePositions` times the
+ # number of `DestinationPositions`.
+ #
+ # <note markdown="1"> Your account is charged for each route calculated, not the number of
+ # requests.
+ #
+ # </note>
+ #
+ # Requires that you first [create a route calculator resource][2].
+ #
+ # By default, a request that doesn't specify a departure time uses the
+ # best time of day to travel with the best traffic conditions when
+ # calculating routes.
+ #
+ # Additional options include:
+ #
+ # * [ Specifying a departure time][3] using either `DepartureTime` or
+ # `DepartNow`. This calculates routes based on predictive traffic data
+ # at the given time.
+ #
+ # <note markdown="1"> You can't specify both `DepartureTime` and `DepartNow` in a single
+ # request. Specifying both parameters returns a validation error.
+ #
+ # </note>
+ #
+ # * [Specifying a travel mode][4] using TravelMode sets the
+ # transportation mode used to calculate the routes. This also lets you
+ # specify additional route preferences in `CarModeOptions` if
+ # traveling by `Car`, or `TruckModeOptions` if traveling by `Truck`.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html
+ # [2]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html
+ # [4]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html
+ #
+ # @option params [required, String] :calculator_name
+ # The name of the route calculator resource that you want to use to
+ # calculate the route matrix.
+ #
+ # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
+ # Specifies route preferences when traveling by `Car`, such as avoiding
+ # routes that use ferries or tolls.
+ #
+ # Requirements: `TravelMode` must be specified as `Car`.
+ #
+ # @option params [Boolean] :depart_now
+ # Sets the time of departure as the current time. Uses the current time
+ # to calculate the route matrix. You can't set both `DepartureTime` and
+ # `DepartNow`. If neither is set, the best time of day to travel with
+ # the best traffic conditions is used to calculate the route matrix.
+ #
+ # Default Value: `false`
+ #
+ # Valid Values: `false` \| `true`
+ #
+ # @option params [required, Array<Array>] :departure_positions
+ # The list of departure (origin) positions for the route matrix. An
+ # array of points, each of which is itself a 2-value array defined in
+ # [WGS 84][1] format: `[longitude, latitude]`. For example, `[-123.115,
+ # 49.285]`.
+ #
+ # Depending on the data provider selected in the route calculator
+ # resource there may be additional restrictions on the inputs you can
+ # choose. See [ Position restrictions][2] in the *Amazon Location
+ # Service Developer Guide*.
+ #
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
+ # specify a departure that's not located on a road, Amazon Location [
+ # moves the position to the nearest road][3]. The snapped value is
+ # available in the result in `SnappedDeparturePositions`.
+ #
+ # </note>
+ #
+ # Valid Values: `[-180 to 180,-90 to 90]`
+ #
+ #
+ #
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
+ #
+ # @option params [Time,DateTime,Date,Integer,String] :departure_time
+ # Specifies the desired time of departure. Uses the given time to
+ # calculate the route matrix. You can't set both `DepartureTime` and
+ # `DepartNow`. If neither is set, the best time of day to travel with
+ # the best traffic conditions is used to calculate the route matrix.
+ #
+ # <note markdown="1"> Setting a departure time in the past returns a `400
+ # ValidationException` error.
+ #
+ # </note>
+ #
+ # * In [ISO 8601][1] format: `YYYY-MM-DDThh:mm:ss.sssZ`. For example,
+ # `2020–07-2T12:15:20.000Z+01:00`
+ #
+ # ^
+ #
+ #
+ #
+ # [1]: https://www.iso.org/iso-8601-date-and-time-format.html
+ #
+ # @option params [required, Array<Array>] :destination_positions
+ # The list of destination positions for the route matrix. An array of
+ # points, each of which is itself a 2-value array defined in [WGS 84][1]
+ # format: `[longitude, latitude]`. For example, `[-122.339, 47.615]`
+ #
+ # Depending on the data provider selected in the route calculator
+ # resource there may be additional restrictions on the inputs you can
+ # choose. See [ Position restrictions][2] in the *Amazon Location
+ # Service Developer Guide*.
+ #
+ # <note markdown="1"> For route calculators that use Esri as the data provider, if you
+ # specify a destination that's not located on a road, Amazon Location [
+ # moves the position to the nearest road][3]. The snapped value is
+ # available in the result in `SnappedDestinationPositions`.
+ #
+ # </note>
+ #
+ # Valid Values: `[-180 to 180,-90 to 90]`
+ #
+ #
+ #
+ # [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
+ # [2]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits
+ # [3]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html
+ #
+ # @option params [String] :distance_unit
+ # Set the unit system to specify the distance.
+ #
+ # Default Value: `Kilometers`
+ #
+ # @option params [String] :travel_mode
+ # Specifies the mode of transport when calculating a route. Used in
+ # estimating the speed of travel and road compatibility.
+ #
+ # The `TravelMode` you specify also determines how you specify route
+ # preferences:
+ #
+ # * If traveling by `Car` use the `CarModeOptions` parameter.
+ #
+ # * If traveling by `Truck` use the `TruckModeOptions` parameter.
+ #
+ # Default Value: `Car`
+ #
+ # @option params [Types::CalculateRouteTruckModeOptions] :truck_mode_options
+ # Specifies route preferences when traveling by `Truck`, such as
+ # avoiding routes that use ferries or tolls, and truck specifications to
+ # consider when choosing an optimal road.
+ #
+ # Requirements: `TravelMode` must be specified as `Truck`.
+ #
+ # @return [Types::CalculateRouteMatrixResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::CalculateRouteMatrixResponse#route_matrix #route_matrix} => Array<Array<Types::RouteMatrixEntry>>
+ # * {Types::CalculateRouteMatrixResponse#snapped_departure_positions #snapped_departure_positions} => Array<Array<Float>>
+ # * {Types::CalculateRouteMatrixResponse#snapped_destination_positions #snapped_destination_positions} => Array<Array<Float>>
+ # * {Types::CalculateRouteMatrixResponse#summary #summary} => Types::CalculateRouteMatrixSummary
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.calculate_route_matrix({
+ # calculator_name: "ResourceName", # required
+ # car_mode_options: {
+ # avoid_ferries: false,
+ # avoid_tolls: false,
+ # },
+ # depart_now: false,
+ # departure_positions: [ # required
+ # [1.0],
+ # ],
+ # departure_time: Time.now,
+ # destination_positions: [ # required
+ # [1.0],
+ # ],
+ # distance_unit: "Kilometers", # accepts Kilometers, Miles
+ # travel_mode: "Car", # accepts Car, Truck, Walking
+ # truck_mode_options: {
+ # avoid_ferries: false,
+ # avoid_tolls: false,
+ # dimensions: {
+ # height: 1.0,
+ # length: 1.0,
+ # unit: "Meters", # accepts Meters, Feet
+ # width: 1.0,
+ # },
+ # weight: {
+ # total: 1.0,
+ # unit: "Kilograms", # accepts Kilograms, Pounds
+ # },
+ # },
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.route_matrix #=> Array
+ # resp.route_matrix[0] #=> Array
+ # resp.route_matrix[0][0].distance #=> Float
+ # resp.route_matrix[0][0].duration_seconds #=> Float
+ # resp.route_matrix[0][0].error.code #=> String, one of "RouteNotFound", "RouteTooLong", "PositionsNotFound", "DestinationPositionNotFound", "DeparturePositionNotFound", "OtherValidationError"
+ # resp.route_matrix[0][0].error.message #=> String
+ # resp.snapped_departure_positions #=> Array
+ # resp.snapped_departure_positions[0] #=> Array
+ # resp.snapped_departure_positions[0][0] #=> Float
+ # resp.snapped_destination_positions #=> Array
+ # resp.snapped_destination_positions[0] #=> Array
+ # resp.snapped_destination_positions[0][0] #=> Float
+ # resp.summary.data_source #=> String
+ # resp.summary.distance_unit #=> String, one of "Kilometers", "Miles"
+ # resp.summary.error_count #=> Integer
+ # resp.summary.route_count #=> Integer
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CalculateRouteMatrix AWS API Documentation
+ #
+ # @overload calculate_route_matrix(params = {})
+ # @param [Hash] params ({})
+ def calculate_route_matrix(params = {}, options = {})
+ req = build_request(:calculate_route_matrix, params)
+ req.send_request(options)
+ end
+
# Creates a geofence collection, which manages and stores geofences.
#
# @option params [required, String] :collection_name
# A custom name for the geofence collection.
#
@@ -996,45 +1224,16 @@
#
#
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
#
# @option params [String] :pricing_plan
- # Optionally specifies the pricing plan for the geofence collection.
- # Defaults to `RequestBasedUsage`.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For additional details and restrictions on each pricing plan option,
- # see the [Amazon Location Service pricing page][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [String] :pricing_plan_data_source
- # Specifies the data provider for the geofence collection.
+ # This parameter is no longer used.
#
- # * Required value for the following pricing plans: `MobileAssetTracking
- # `\| `MobileAssetManagement`
- #
- # ^
- #
- # For more information about [Data Providers][1], and [Pricing
- # plans][2], see the Amazon Location Service product page.
- #
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
- # billing for your geofence collection. Your data won't be shared with
- # the data provider, and will remain in your AWS account or Region
- # unless you move it.
- #
- # </note>
- #
- # Valid Values: `Esri `\| `Here`
- #
- #
- #
- # [1]: https://aws.amazon.com/location/data-providers/
- # [2]: https://aws.amazon.com/location/pricing/
- #
# @option params [Hash<String,String>] :tags
# Applies one or more tags to the geofence collection. A tag is a
# key-value pair helps manage, identify, search, and filter your
# resources by labelling them.
#
@@ -1090,10 +1289,21 @@
end
# Creates a map resource in your AWS account, which provides map tiles
# of different styles sourced from global location data providers.
#
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
+ # business, such as delivery vehicles or employees, you may only use
+ # HERE as your geolocation provider. See section 82 of the [AWS service
+ # terms][1] for more details.
+ #
+ # </note>
+ #
+ #
+ #
+ # [1]: http://aws.amazon.com/service-terms
+ #
# @option params [required, Types::MapConfiguration] :configuration
# Specifies the map style selected from an available data provider.
#
# @option params [String] :description
# An optional description for the map resource.
@@ -1109,20 +1319,13 @@
# * Must be a unique map resource name.
#
# * No spaces allowed. For example, `ExampleMap`.
#
# @option params [String] :pricing_plan
- # Optionally specifies the pricing plan for the map resource. Defaults
- # to `RequestBasedUsage`.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For additional details and restrictions on each pricing plan option,
- # see [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [Hash<String,String>] :tags
# Applies one or more tags to the map resource. A tag is a key-value
# pair helps manage, identify, search, and filter your resources by
# labelling them.
#
@@ -1183,10 +1386,21 @@
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
# by using the `SearchPlaceIndexForPosition` operation, and enable
# autosuggestions by using the `SearchPlaceIndexForSuggestions`
# operation.
#
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
+ # business, such as delivery vehicles or employees, you may only use
+ # HERE as your geolocation provider. See section 82 of the [AWS service
+ # terms][1] for more details.
+ #
+ # </note>
+ #
+ #
+ #
+ # [1]: http://aws.amazon.com/service-terms
+ #
# @option params [required, String] :data_source
# Specifies the geospatial data provider for the new place index.
#
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
# example, entering `HERE` returns an error.
@@ -1238,20 +1452,13 @@
# * Must be a unique place index resource name.
#
# * No spaces allowed. For example, `ExamplePlaceIndex`.
#
# @option params [String] :pricing_plan
- # Optionally specifies the pricing plan for the place index resource.
- # Defaults to `RequestBasedUsage`.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For additional details and restrictions on each pricing plan option,
- # see [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [Hash<String,String>] :tags
# Applies one or more tags to the place index resource. A tag is a
# key-value pair that helps you manage, identify, search, and filter
# your resources.
#
@@ -1313,10 +1520,21 @@
#
# You can send requests to a route calculator resource to estimate
# travel time, distance, and get directions. A route calculator sources
# traffic and road network data from your chosen data provider.
#
+ # <note markdown="1"> If your application is tracking or routing assets you use in your
+ # business, such as delivery vehicles or employees, you may only use
+ # HERE as your geolocation provider. See section 82 of the [AWS service
+ # terms][1] for more details.
+ #
+ # </note>
+ #
+ #
+ #
+ # [1]: http://aws.amazon.com/service-terms
+ #
# @option params [required, String] :calculator_name
# The name of the route calculator resource.
#
# Requirements:
#
@@ -1361,20 +1579,13 @@
#
# @option params [String] :description
# The optional description for the route calculator resource.
#
# @option params [String] :pricing_plan
- # Optionally specifies the pricing plan for the route calculator
- # resource. Defaults to `RequestBasedUsage`.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For additional details and restrictions on each pricing plan option,
- # see [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [Hash<String,String>] :tags
# Applies one or more tags to the route calculator resource. A tag is a
# key-value pair helps manage, identify, search, and filter your
# resources by labelling them.
#
@@ -1476,45 +1687,16 @@
#
# This field is optional. If not specified, the default value is
# `TimeBased`.
#
# @option params [String] :pricing_plan
- # Optionally specifies the pricing plan for the tracker resource.
- # Defaults to `RequestBasedUsage`.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For additional details and restrictions on each pricing plan option,
- # see [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [String] :pricing_plan_data_source
- # Specifies the data provider for the tracker resource.
+ # This parameter is no longer used.
#
- # * Required value for the following pricing plans: `MobileAssetTracking
- # `\| `MobileAssetManagement`
- #
- # ^
- #
- # For more information about [Data Providers][1], and [Pricing
- # plans][2], see the Amazon Location Service product page.
- #
- # <note markdown="1"> Amazon Location Service only uses `PricingPlanDataSource` to calculate
- # billing for your tracker resource. Your data will not be shared with
- # the data provider, and will remain in your AWS account or Region
- # unless you move it.
- #
- # </note>
- #
- # Valid values: `Esri` \| `Here`
- #
- #
- #
- # [1]: https://aws.amazon.com/location/data-providers/
- # [2]: https://aws.amazon.com/location/pricing/
- #
# @option params [Hash<String,String>] :tags
# Applies one or more tags to the tracker resource. A tag is a key-value
# pair helps manage, identify, search, and filter your resources by
# labelling them.
#
@@ -3309,43 +3491,16 @@
#
# @option params [String] :description
# Updates the description for the geofence collection.
#
# @option params [String] :pricing_plan
- # Updates the pricing plan for the geofence collection.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For more information about each pricing plan option restrictions, see
- # [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [String] :pricing_plan_data_source
- # Updates the data provider for the geofence collection.
+ # This parameter is no longer used.
#
- # A required value for the following pricing plans:
- # `MobileAssetTracking`\| `MobileAssetManagement`
- #
- # For more information about [data providers][1] and [pricing plans][2],
- # see the Amazon Location Service product page.
- #
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
- # request.
- #
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
- # billing for your geofence collection. Your data won't be shared with
- # the data provider, and will remain in your AWS account and Region
- # unless you move it.
- #
- # </note>
- #
- #
- #
- # [1]: https://aws.amazon.com/location/data-providers/
- # [2]: https://aws.amazon.com/location/pricing/
- #
# @return [Types::UpdateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateGeofenceCollectionResponse#collection_arn #collection_arn} => String
# * {Types::UpdateGeofenceCollectionResponse#collection_name #collection_name} => String
# * {Types::UpdateGeofenceCollectionResponse#update_time #update_time} => Time
@@ -3381,19 +3536,13 @@
#
# @option params [required, String] :map_name
# The name of the map resource to update.
#
# @option params [String] :pricing_plan
- # Updates the pricing plan for the map resource.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For more information about each pricing plan option restrictions, see
- # [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @return [Types::UpdateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateMapResponse#map_arn #map_arn} => String
# * {Types::UpdateMapResponse#map_name #map_name} => String
# * {Types::UpdateMapResponse#update_time #update_time} => Time
@@ -3431,19 +3580,13 @@
#
# @option params [required, String] :index_name
# The name of the place index resource to update.
#
# @option params [String] :pricing_plan
- # Updates the pricing plan for the place index resource.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For more information about each pricing plan option restrictions, see
- # [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @return [Types::UpdatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdatePlaceIndexResponse#index_arn #index_arn} => String
# * {Types::UpdatePlaceIndexResponse#index_name #index_name} => String
# * {Types::UpdatePlaceIndexResponse#update_time #update_time} => Time
@@ -3482,19 +3625,13 @@
#
# @option params [String] :description
# Updates the description for the route calculator resource.
#
# @option params [String] :pricing_plan
- # Updates the pricing plan for the route calculator resource.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For more information about each pricing plan option restrictions, see
- # [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @return [Types::UpdateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
# * {Types::UpdateRouteCalculatorResponse#calculator_name #calculator_name} => String
# * {Types::UpdateRouteCalculatorResponse#update_time #update_time} => Time
@@ -3554,43 +3691,16 @@
# effects of GPS noise when displaying device trajectories on a map,
# and can help control costs by reducing the number of geofence
# evaluations.
#
# @option params [String] :pricing_plan
- # Updates the pricing plan for the tracker resource.
+ # No longer used. If included, the only allowed value is
+ # `RequestBasedUsage`.
#
- # For more information about each pricing plan option restrictions, see
- # [Amazon Location Service pricing][1].
- #
- #
- #
- # [1]: https://aws.amazon.com/location/pricing/
- #
# @option params [String] :pricing_plan_data_source
- # Updates the data provider for the tracker resource.
+ # This parameter is no longer used.
#
- # A required value for the following pricing plans:
- # `MobileAssetTracking`\| `MobileAssetManagement`
- #
- # For more information about [data providers][1] and [pricing plans][2],
- # see the Amazon Location Service product page
- #
- # <note markdown="1"> This can only be updated when updating the `PricingPlan` in the same
- # request.
- #
- # Amazon Location Service uses `PricingPlanDataSource` to calculate
- # billing for your tracker resource. Your data won't be shared with the
- # data provider, and will remain in your AWS account and Region unless
- # you move it.
- #
- # </note>
- #
- #
- #
- # [1]: https://aws.amazon.com/location/data-providers/
- # [2]: https://aws.amazon.com/location/pricing/
- #
# @option params [required, String] :tracker_name
# The name of the tracker resource to update.
#
# @return [Types::UpdateTrackerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3634,10 +3744,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-locationservice'
- context[:gem_version] = '1.16.0'
+ context[:gem_version] = '1.17.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated