] :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
# example, Australia uses three upper-case characters: `AUS`.
#
# ^
#
#
#
# [1]: https://www.iso.org/iso-3166-country-codes.html
#
# @option params [required, String] :index_name
# The name of the place index resource you want to use for the search.
#
# @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, 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.
#
# The default: `50`
#
# @option params [required, String] :text
# The address, name, city, or region to be used in the search in
# free-form text format. For example, `123 Any Street`.
#
# @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::SearchPlaceIndexForTextResponse#results #results} => Array<Types::SearchForTextResult>
# * {Types::SearchPlaceIndexForTextResponse#summary #summary} => Types::SearchPlaceIndexForTextSummary
#
# @example Request syntax with placeholder values
#
# resp = client.search_place_index_for_text({
# bias_position: [1.0],
# filter_b_box: [1.0],
# filter_countries: ["CountryCode"],
# index_name: "ResourceName", # required
# language: "LanguageTag",
# max_results: 1,
# text: "SearchPlaceIndexForTextRequestTextString", # required
# })
#
# @example Response structure
#
# resp.results #=> Array
# resp.results[0].distance #=> Float
# resp.results[0].place.address_number #=> 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
# resp.results[0].place.municipality #=> String
# 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.time_zone.name #=> String
# resp.results[0].place.time_zone.offset #=> Integer
# resp.results[0].relevance #=> Float
# 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_countries #=> Array
# resp.summary.filter_countries[0] #=> String
# resp.summary.language #=> String
# resp.summary.max_results #=> Integer
# resp.summary.result_b_box #=> Array
# resp.summary.result_b_box[0] #=> Float
# resp.summary.text #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForText AWS API Documentation
#
# @overload search_place_index_for_text(params = {})
# @param [Hash] params ({})
def search_place_index_for_text(params = {}, options = {})
req = build_request(:search_place_index_for_text, params)
req.send_request(options)
end
# Assigns one or more tags (key-value pairs) to the specified Amazon
# Location Service resource.
#
# Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
You can use the TagResource operation with an Amazon Location Service resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the tags already associated with the resource. If you specify a tag key that's already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate up to 50 tags with a resource.
#
# @option params [required, String] :resource_arn
# The Amazon Resource Name (ARN) of the resource whose tags you want to
# update.
#
# * Format example:
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
#
# ^
#
# @option params [required, Hash] :tags
# Applies one or more tags to specific resource. A tag is a key-value
# pair that helps you manage, identify, search, and filter your
# resources.
#
# Format: `"key" : "value"`
#
# Restrictions:
#
# * Maximum 50 tags per resource.
#
# * Each tag key must be unique and must have exactly one associated
# value.
#
# * Maximum key length: 128 Unicode characters in UTF-8.
#
# * Maximum value length: 256 Unicode characters in UTF-8.
#
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
# characters: + - = . \_ : / @
#
# * Cannot use "aws:" as a prefix for a key.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.tag_resource({
# resource_arn: "Arn", # required
# tags: { # required
# "TagKey" => "TagValue",
# },
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/TagResource AWS API Documentation
#
# @overload tag_resource(params = {})
# @param [Hash] params ({})
def tag_resource(params = {}, options = {})
req = build_request(:tag_resource, params)
req.send_request(options)
end
# Removes one or more tags from the specified Amazon Location resource.
#
# @option params [required, String] :resource_arn
# The Amazon Resource Name (ARN) of the resource from which you want to
# remove tags.
#
# * Format example:
# `arn:aws:geo:region:account-id:resourcetype/ExampleResource`
#
# ^
#
# @option params [required, Array] :tag_keys
# The list of tag keys to remove from the specified resource.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.untag_resource({
# resource_arn: "Arn", # required
# tag_keys: ["String"], # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UntagResource AWS API Documentation
#
# @overload untag_resource(params = {})
# @param [Hash] params ({})
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
# Updates the specified properties of a given geofence collection.
#
# @option params [required, String] :collection_name
# The name of the geofence collection to update.
#
# @option params [String] :description
# Updates the description for the geofence collection.
#
# @option params [String] :pricing_plan
# No longer used. If included, the only allowed value is
# `RequestBasedUsage`.
#
# @option params [String] :pricing_plan_data_source
# This parameter is no longer used.
#
# @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
#
# @example Request syntax with placeholder values
#
# resp = client.update_geofence_collection({
# collection_name: "ResourceName", # required
# description: "ResourceDescription",
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
# pricing_plan_data_source: "String",
# })
#
# @example Response structure
#
# resp.collection_arn #=> String
# resp.collection_name #=> String
# resp.update_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateGeofenceCollection AWS API Documentation
#
# @overload update_geofence_collection(params = {})
# @param [Hash] params ({})
def update_geofence_collection(params = {}, options = {})
req = build_request(:update_geofence_collection, params)
req.send_request(options)
end
# Updates the specified properties of a given map resource.
#
# @option params [String] :description
# Updates the description for the map resource.
#
# @option params [required, String] :map_name
# The name of the map resource to update.
#
# @option params [String] :pricing_plan
# No longer used. If included, the only allowed value is
# `RequestBasedUsage`.
#
# @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
#
# @example Request syntax with placeholder values
#
# resp = client.update_map({
# description: "ResourceDescription",
# map_name: "ResourceName", # required
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
# })
#
# @example Response structure
#
# resp.map_arn #=> String
# resp.map_name #=> String
# resp.update_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateMap AWS API Documentation
#
# @overload update_map(params = {})
# @param [Hash] params ({})
def update_map(params = {}, options = {})
req = build_request(:update_map, params)
req.send_request(options)
end
# Updates the specified properties of a given place index resource.
#
# @option params [Types::DataSourceConfiguration] :data_source_configuration
# Updates the data storage option for the place index resource.
#
# @option params [String] :description
# Updates the description for the place index resource.
#
# @option params [required, String] :index_name
# The name of the place index resource to update.
#
# @option params [String] :pricing_plan
# No longer used. If included, the only allowed value is
# `RequestBasedUsage`.
#
# @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
#
# @example Request syntax with placeholder values
#
# resp = client.update_place_index({
# data_source_configuration: {
# intended_use: "SingleUse", # accepts SingleUse, Storage
# },
# description: "ResourceDescription",
# index_name: "ResourceName", # required
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
# })
#
# @example Response structure
#
# resp.index_arn #=> String
# resp.index_name #=> String
# resp.update_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdatePlaceIndex AWS API Documentation
#
# @overload update_place_index(params = {})
# @param [Hash] params ({})
def update_place_index(params = {}, options = {})
req = build_request(:update_place_index, params)
req.send_request(options)
end
# Updates the specified properties for a given route calculator
# resource.
#
# @option params [required, String] :calculator_name
# The name of the route calculator resource to update.
#
# @option params [String] :description
# Updates the description for the route calculator resource.
#
# @option params [String] :pricing_plan
# No longer used. If included, the only allowed value is
# `RequestBasedUsage`.
#
# @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
#
# @example Request syntax with placeholder values
#
# resp = client.update_route_calculator({
# calculator_name: "ResourceName", # required
# description: "ResourceDescription",
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
# })
#
# @example Response structure
#
# resp.calculator_arn #=> String
# resp.calculator_name #=> String
# resp.update_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateRouteCalculator AWS API Documentation
#
# @overload update_route_calculator(params = {})
# @param [Hash] params ({})
def update_route_calculator(params = {}, options = {})
req = build_request(:update_route_calculator, params)
req.send_request(options)
end
# Updates the specified properties of a given tracker resource.
#
# @option params [String] :description
# Updates the description for the tracker resource.
#
# @option params [String] :position_filtering
# Updates the position filtering for the tracker resource.
#
# Valid values:
#
# * `TimeBased` - Location updates are evaluated against linked geofence
# collections, but not every location update is stored. If your update
# frequency is more often than 30 seconds, only one update per 30
# seconds is stored for each unique device ID.
#
# * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
# location updates are ignored. Location updates within this distance
# are neither evaluated against linked geofence collections, nor
# stored. This helps control costs by reducing the number of geofence
# evaluations and historical device positions to paginate through.
# Distance-based filtering can also reduce the effects of GPS noise
# when displaying device trajectories on a map.
#
# * `AccuracyBased` - If the device has moved less than the measured
# accuracy, location updates are ignored. For example, if two
# consecutive updates from a device have a horizontal accuracy of 5 m
# and 10 m, the second update is ignored if the device has moved less
# than 15 m. Ignored location updates are neither evaluated against
# linked geofence collections, nor stored. This helps educe the
# 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
# No longer used. If included, the only allowed value is
# `RequestBasedUsage`.
#
# @option params [String] :pricing_plan_data_source
# This parameter is no longer used.
#
# @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:
#
# * {Types::UpdateTrackerResponse#tracker_arn #tracker_arn} => String
# * {Types::UpdateTrackerResponse#tracker_name #tracker_name} => String
# * {Types::UpdateTrackerResponse#update_time #update_time} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.update_tracker({
# description: "ResourceDescription",
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
# pricing_plan_data_source: "String",
# tracker_name: "ResourceName", # required
# })
#
# @example Response structure
#
# resp.tracker_arn #=> String
# resp.tracker_name #=> String
# resp.update_time #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/UpdateTracker AWS API Documentation
#
# @overload update_tracker(params = {})
# @param [Hash] params ({})
def update_tracker(params = {}, options = {})
req = build_request(:update_tracker, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-locationservice'
context[:gem_version] = '1.23.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated
def waiter_names
[]
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end