lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.32.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.33.0

- old
+ new

@@ -645,10 +645,13 @@ # resp = client.batch_put_geofence({ # collection_name: "ResourceName", # required # entries: [ # required # { # geofence_id: "Id", # required + # geofence_properties: { + # "PropertyMapKeyString" => "PropertyMapValueString", + # }, # geometry: { # required # circle: { # center: [1.0], # required # radius: 1.0, # required # }, @@ -681,13 +684,13 @@ req = build_request(:batch_put_geofence, params) req.send_request(options) end # Uploads position update data for one or more devices to a tracker - # resource. Amazon Location uses the data when it reports the last known - # device position and position history. Amazon Location retains location - # data for 30 days. + # resource (up to 10 devices per batch). Amazon Location uses the data + # when it reports the last known device position and position history. + # Amazon Location retains location data for 30 days. # # <note markdown="1"> Position updates are handled based on the `PositionFiltering` property # of the tracker. When `PositionFiltering` is set to `TimeBased`, # updates are evaluated against linked geofence collections, and # location data is stored at a maximum of one position per 30 second @@ -713,11 +716,12 @@ # # @option params [required, String] :tracker_name # The name of the tracker resource to update. # # @option params [required, Array<Types::DevicePositionUpdate>] :updates - # Contains the position update details for each device. + # Contains the position update details for each device, up to 10 + # devices. # # @return [Types::BatchUpdateDevicePositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::BatchUpdateDevicePositionResponse#errors #errors} => Array&lt;Types::BatchUpdateDevicePositionError&gt; # @@ -2598,10 +2602,11 @@ # # @return [Types::GetGeofenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetGeofenceResponse#create_time #create_time} => Time # * {Types::GetGeofenceResponse#geofence_id #geofence_id} => String + # * {Types::GetGeofenceResponse#geofence_properties #geofence_properties} => Hash&lt;String,String&gt; # * {Types::GetGeofenceResponse#geometry #geometry} => Types::GeofenceGeometry # * {Types::GetGeofenceResponse#status #status} => String # * {Types::GetGeofenceResponse#update_time #update_time} => Time # # @example Request syntax with placeholder values @@ -2613,10 +2618,12 @@ # # @example Response structure # # resp.create_time #=> Time # resp.geofence_id #=> String + # resp.geofence_properties #=> Hash + # resp.geofence_properties["PropertyMapKeyString"] #=> String # resp.geometry.circle.center #=> Array # resp.geometry.circle.center[0] #=> Float # resp.geometry.circle.radius #=> Float # resp.geometry.polygon #=> Array # resp.geometry.polygon[0] #=> Array @@ -2972,10 +2979,12 @@ # }) # # @example Response structure # # resp.place.address_number #=> String + # resp.place.categories #=> Array + # resp.place.categories[0] #=> String # resp.place.country #=> String # resp.place.geometry.point #=> Array # resp.place.geometry.point[0] #=> Float # resp.place.interpolated #=> Boolean # resp.place.label #=> String @@ -2983,10 +2992,12 @@ # resp.place.neighborhood #=> String # resp.place.postal_code #=> String # resp.place.region #=> String # resp.place.street #=> String # resp.place.sub_region #=> String + # resp.place.supplemental_categories #=> Array + # resp.place.supplemental_categories[0] #=> String # resp.place.time_zone.name #=> String # resp.place.time_zone.offset #=> Integer # resp.place.unit_number #=> String # resp.place.unit_type #=> String # @@ -3134,10 +3145,12 @@ # @example Response structure # # resp.data.entries #=> Array # resp.data.entries[0].create_time #=> Time # resp.data.entries[0].geofence_id #=> String + # resp.data.entries[0].geofence_properties #=> Hash + # resp.data.entries[0].geofence_properties["PropertyMapKeyString"] #=> String # resp.data.entries[0].geometry.circle.center #=> Array # resp.data.entries[0].geometry.circle.center[0] #=> Float # resp.data.entries[0].geometry.circle.radius #=> Float # resp.data.entries[0].geometry.polygon #=> Array # resp.data.entries[0].geometry.polygon[0] #=> Array @@ -3507,10 +3520,14 @@ # The geofence collection to store the geofence in. # # @option params [required, String] :geofence_id # An identifier for the geofence. For example, `ExampleGeofence-1`. # + # @option params [Hash<String,String>] :geofence_properties + # Specifies additional user-defined properties to store with the + # Geofence. An array of key-value pairs. + # # @option params [required, Types::GeofenceGeometry] :geometry # Contains the details to specify the position of the geofence. Can be # either a polygon or a circle. Including both will return a validation # error. # @@ -3531,10 +3548,13 @@ # @example Request syntax with placeholder values # # resp = client.put_geofence({ # collection_name: "ResourceName", # required # geofence_id: "Id", # required + # geofence_properties: { + # "PropertyMapKeyString" => "PropertyMapValueString", + # }, # geometry: { # required # circle: { # center: [1.0], # required # radius: 1.0, # required # }, @@ -3625,10 +3645,12 @@ # @example Response structure # # resp.results #=> Array # resp.results[0].distance #=> Float # resp.results[0].place.address_number #=> String + # resp.results[0].place.categories #=> Array + # resp.results[0].place.categories[0] #=> String # resp.results[0].place.country #=> String # resp.results[0].place.geometry.point #=> Array # resp.results[0].place.geometry.point[0] #=> Float # resp.results[0].place.interpolated #=> Boolean # resp.results[0].place.label #=> String @@ -3636,10 +3658,12 @@ # resp.results[0].place.neighborhood #=> String # resp.results[0].place.postal_code #=> String # resp.results[0].place.region #=> String # resp.results[0].place.street #=> String # resp.results[0].place.sub_region #=> String + # resp.results[0].place.supplemental_categories #=> Array + # resp.results[0].place.supplemental_categories[0] #=> String # resp.results[0].place.time_zone.name #=> String # resp.results[0].place.time_zone.offset #=> Integer # resp.results[0].place.unit_number #=> String # resp.results[0].place.unit_type #=> String # resp.results[0].place_id #=> String @@ -3708,10 +3732,23 @@ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying # both options results in an error. # # </note> # + # @option params [Array<String>] :filter_categories + # A list of one or more Amazon Location categories to filter the + # returned places. If you include more than one category, the results + # will include results that match *any* of the categories listed. + # + # For more information about using categories, including a list of + # Amazon Location categories, see [Categories and filtering][1], in the + # *Amazon Location Service Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html + # # @option params [Array<String>] :filter_countries # An optional parameter that limits the search results by returning only # suggestions within the provided list of countries. # # * Use the [ISO 3166][1] 3-digit country code. For example, Australia @@ -3766,27 +3803,34 @@ # @example Request syntax with placeholder values # # resp = client.search_place_index_for_suggestions({ # bias_position: [1.0], # filter_b_box: [1.0], + # filter_categories: ["PlaceCategory"], # filter_countries: ["CountryCode"], # index_name: "ResourceName", # required # language: "LanguageTag", # max_results: 1, # text: "SearchPlaceIndexForSuggestionsRequestTextString", # required # }) # # @example Response structure # # resp.results #=> Array + # resp.results[0].categories #=> Array + # resp.results[0].categories[0] #=> String # resp.results[0].place_id #=> String + # resp.results[0].supplemental_categories #=> Array + # resp.results[0].supplemental_categories[0] #=> String # resp.results[0].text #=> String # resp.summary.bias_position #=> Array # resp.summary.bias_position[0] #=> Float # resp.summary.data_source #=> String # resp.summary.filter_b_box #=> Array # resp.summary.filter_b_box[0] #=> Float + # resp.summary.filter_categories #=> Array + # resp.summary.filter_categories[0] #=> String # resp.summary.filter_countries #=> Array # resp.summary.filter_countries[0] #=> String # resp.summary.language #=> String # resp.summary.max_results #=> Integer # resp.summary.text #=> String @@ -3850,10 +3894,23 @@ # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying # both options results in an error. # # </note> # + # @option params [Array<String>] :filter_categories + # A list of one or more Amazon Location categories to filter the + # returned places. If you include more than one category, the results + # will include results that match *any* of the categories listed. + # + # For more information about using categories, including a list of + # Amazon Location categories, see [Categories and filtering][1], in the + # *Amazon Location Service Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html + # # @option params [Array<String>] :filter_countries # An optional parameter that limits the search results by returning only # places that are in a specified list of countries. # # * Valid values include [ISO 3166][1] 3-digit country codes. For @@ -3909,10 +3966,11 @@ # @example Request syntax with placeholder values # # resp = client.search_place_index_for_text({ # bias_position: [1.0], # filter_b_box: [1.0], + # filter_categories: ["PlaceCategory"], # filter_countries: ["CountryCode"], # index_name: "ResourceName", # required # language: "LanguageTag", # max_results: 1, # text: "SearchPlaceIndexForTextRequestTextString", # required @@ -3921,10 +3979,12 @@ # @example Response structure # # resp.results #=> Array # resp.results[0].distance #=> Float # resp.results[0].place.address_number #=> String + # resp.results[0].place.categories #=> Array + # resp.results[0].place.categories[0] #=> String # resp.results[0].place.country #=> String # resp.results[0].place.geometry.point #=> Array # resp.results[0].place.geometry.point[0] #=> Float # resp.results[0].place.interpolated #=> Boolean # resp.results[0].place.label #=> String @@ -3932,10 +3992,12 @@ # resp.results[0].place.neighborhood #=> String # resp.results[0].place.postal_code #=> String # resp.results[0].place.region #=> String # resp.results[0].place.street #=> String # resp.results[0].place.sub_region #=> String + # resp.results[0].place.supplemental_categories #=> Array + # resp.results[0].place.supplemental_categories[0] #=> String # resp.results[0].place.time_zone.name #=> String # resp.results[0].place.time_zone.offset #=> Integer # resp.results[0].place.unit_number #=> String # resp.results[0].place.unit_type #=> String # resp.results[0].place_id #=> String @@ -3943,10 +4005,12 @@ # resp.summary.bias_position #=> Array # resp.summary.bias_position[0] #=> Float # resp.summary.data_source #=> String # resp.summary.filter_b_box #=> Array # resp.summary.filter_b_box[0] #=> Float + # resp.summary.filter_categories #=> Array + # resp.summary.filter_categories[0] #=> String # resp.summary.filter_countries #=> Array # resp.summary.filter_countries[0] #=> String # resp.summary.language #=> String # resp.summary.max_results #=> Integer # resp.summary.result_b_box #=> Array @@ -4407,10 +4471,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.32.0' + context[:gem_version] = '1.33.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated