client.rb in aws-sdk-locationservice-1.22.0

- old
+ new

@@ -498,10 +498,15 @@
     # <note markdown="1"> Geofence evaluation uses the given device position. It does not
     # account for the optional `Accuracy` of a `DevicePositionUpdate`.
     #
     #  </note>
     #
+    # <note markdown="1"> The `DeviceID` is used as a string to represent the device. You do not
+    # need to have a `Tracker` associated with the `DeviceID`.
+    #
+    #  </note>
+    #
     # @option params [required, String] :collection_name
     #   The geofence collection used in evaluating the position of devices
     #   against its geofences.
     #
     # @option params [required, Array<Types::DevicePositionUpdate>] :device_position_updates
@@ -775,12 +780,12 @@
     #   Default Value: `false`
     #
     #   Valid Values: `false` \| `true`
     #
     # @option params [required, Array<Float>] :departure_position
-    #   The start position for the route. Defined in [WGS 84][1] format:
-    #   `[longitude, latitude]`.
+    #   The start position for the route. Defined in [World Geodetic System
+    #   (WGS 84)][1] format: `[longitude, latitude]`.
     #
     #   * For example, `[-123.115, 49.285]`
     #
     #   ^
     #
@@ -793,11 +798,11 @@
     #
     #   Valid Values: `[-180 to 180,-90 to 90]`
     #
     #
     #
-    #   [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
+    #   [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84
     #   [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
@@ -816,12 +821,12 @@
     #
     #
     #   [1]: https://www.iso.org/iso-8601-date-and-time-format.html
     #
     # @option params [required, Array<Float>] :destination_position
-    #   The finish position for the route. Defined in [WGS 84][1] format:
-    #   `[longitude, latitude]`.
+    #   The finish position for the route. Defined in [World Geodetic System
+    #   (WGS 84)][1] format: `[longitude, latitude]`.
     #
     #   * For example, `[-122.339, 47.615]`
     #
     #   ^
     #
@@ -832,11 +837,11 @@
     #
     #   Valid Values: `[-180 to 180,-90 to 90]`
     #
     #
     #
-    #   [1]: https://earth-info.nga.mil/GandG/wgs84/index.html
+    #   [1]: https://earth-info.nga.mil/index.php?dir=wgs84&amp;action=wgs84
     #   [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.
     #
@@ -2666,10 +2671,16 @@
     # Lists geofences stored in a given geofence collection.
     #
     # @option params [required, String] :collection_name
     #   The name of the geofence collection storing the list of geofences.
     #
+    # @option params [Integer] :max_results
+    #   An optional limit for the number of geofences returned in a single
+    #   call.
+    #
+    #   Default value: `100`
+    #
     # @option params [String] :next_token
     #   The pagination token specifying which page of results to return in the
     #   response. If no token is provided, the default page is the first page.
     #
     #   Default value: `null`
@@ -2683,10 +2694,11 @@
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_geofences({
     #     collection_name: "ResourceName", # required
+    #     max_results: 1,
     #     next_token: "Token",
     #   })
     #
     # @example Response structure
     #
@@ -3051,17 +3063,28 @@
     #
     # @option params [String] :language
     #   The preferred language used to return results. The value must be a
     #   valid [BCP 47][1] language tag, for example, `en` for English.
     #
-    #   This setting affects the languages used in the results. It does not
-    #   change which results are returned. If the language is not specified,
-    #   or not supported for a particular result, the partner automatically
-    #   chooses a language for the result.
+    #   This setting affects the languages used in the results, but not the
+    #   results themselves. If no language is specified, or not supported for
+    #   a particular result, the partner automatically chooses a language for
+    #   the result.
     #
+    #   For an example, we'll use the Greek language. You search for a
+    #   location around Athens, Greece, with the `language` parameter set to
+    #   `en`. The `city` in the results will most likely be returned as
+    #   `Athens`.
     #
+    #   If you set the `language` parameter to `el`, for Greek, then the
+    #   `city` in the results will more likely be returned as `Αθήνα`.
     #
+    #   If the data provider does not have a value for Greek, the result will
+    #   be in a language that the provider does support.
+    #
+    #
+    #
     #   [1]: https://tools.ietf.org/search/bcp47
     #
     # @option params [Integer] :max_results
     #   An optional parameter. The maximum number of results returned per
     #   request.
@@ -3195,19 +3218,26 @@
     #
     # @option params [String] :language
     #   The preferred language used to return results. The value must be a
     #   valid [BCP 47][1] language tag, for example, `en` for English.
     #
-    #   This setting affects the languages used in the results. It does not
-    #   change which results are returned. If the language is not specified,
-    #   or not supported for a particular result, the partner automatically
-    #   chooses a language for the result.
+    #   This setting affects the languages used in the results. If no language
+    #   is specified, or not supported for a particular result, the partner
+    #   automatically chooses a language for the result.
     #
-    #   Used only when the partner selected is Here.
+    #   For an example, we'll use the Greek language. You search for `Athens,
+    #   Gr` to get suggestions with the `language` parameter set to `en`. The
+    #   results found will most likely be returned as `Athens, Greece`.
     #
+    #   If you set the `language` parameter to `el`, for Greek, then the
+    #   result found will more likely be returned as `Αθήνα, Ελλάδα`.
     #
+    #   If the data provider does not have a value for Greek, the result will
+    #   be in a language that the provider does support.
     #
+    #
+    #
     #   [1]: https://tools.ietf.org/search/bcp47
     #
     # @option params [Integer] :max_results
     #   An optional parameter. The maximum number of results returned per
     #   request.
@@ -3230,11 +3260,11 @@
     #     filter_b_box: [1.0],
     #     filter_countries: ["CountryCode"],
     #     index_name: "ResourceName", # required
     #     language: "LanguageTag",
     #     max_results: 1,
-    #     text: "SyntheticSearchPlaceIndexForSuggestionsRequestString", # required
+    #     text: "SearchPlaceIndexForSuggestionsRequestTextString", # required
     #   })
     #
     # @example Response structure
     #
     #   resp.results #=> Array
@@ -3329,17 +3359,27 @@
     #
     # @option params [String] :language
     #   The preferred language used to return results. The value must be a
     #   valid [BCP 47][1] language tag, for example, `en` for English.
     #
-    #   This setting affects the languages used in the results. It does not
-    #   change which results are returned. If the language is not specified,
-    #   or not supported for a particular result, the partner automatically
-    #   chooses a language for the result.
+    #   This setting affects the languages used in the results, but not the
+    #   results themselves. If no language is specified, or not supported for
+    #   a particular result, the partner automatically chooses a language for
+    #   the result.
     #
+    #   For an example, we'll use the Greek language. You search for `Athens,
+    #   Greece`, with the `language` parameter set to `en`. The result found
+    #   will most likely be returned as `Athens`.
     #
+    #   If you set the `language` parameter to `el`, for Greek, then the
+    #   result found will more likely be returned as `Αθήνα`.
     #
+    #   If the data provider does not have a value for Greek, the result will
+    #   be in a language that the provider does support.
+    #
+    #
+    #
     #   [1]: https://tools.ietf.org/search/bcp47
     #
     # @option params [Integer] :max_results
     #   An optional parameter. The maximum number of results returned per
     #   request.
@@ -3362,11 +3402,11 @@
     #     filter_b_box: [1.0],
     #     filter_countries: ["CountryCode"],
     #     index_name: "ResourceName", # required
     #     language: "LanguageTag",
     #     max_results: 1,
-    #     text: "SyntheticSearchPlaceIndexForTextRequestString", # required
+    #     text: "SearchPlaceIndexForTextRequestTextString", # required
     #   })
     #
     # @example Response structure
     #
     #   resp.results #=> Array
@@ -3757,10 +3797,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-locationservice'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated