lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.11.0 vs lib/aws-sdk-locationservice/client.rb in aws-sdk-locationservice-1.12.0

- old
+ new

@@ -680,11 +680,11 @@ req.send_request(options) end # [Calculates a route][1] given the following required parameters: # `DeparturePostiton` and `DestinationPosition`. Requires that you first - # [create a route calculator resource][2] + # [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. # @@ -693,11 +693,12 @@ # * [Specifying a departure time][3] using either `DepartureTime` or # `DepartureNow`. 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 an error message. + # 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 @@ -712,11 +713,11 @@ # [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 # # @option params [required, String] :calculator_name # The name of the route calculator resource that you want to use to - # calculate a route. + # calculate the route. # # @option params [Types::CalculateRouteCarModeOptions] :car_mode_options # Specifies route preferences when traveling by `Car`, such as avoiding # routes that use ferries or tolls. # @@ -753,12 +754,12 @@ # [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 # # @option params [Time,DateTime,Date,Integer,String] :departure_time # Specifies the desired time of departure. Uses the given time to - # calculate a route. Otherwise, the best time of day to travel with the - # best traffic conditions is used to calculate the route. + # calculate the route. Otherwise, the best time of day to travel with + # the best traffic conditions is used to calculate the route. # # <note markdown="1"> Setting a departure time in the past returns a `400 # ValidationException` error. # # </note> @@ -1007,10 +1008,12 @@ # * 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 [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String # * {Types::CreateGeofenceCollectionResponse#collection_name #collection_name} => String # * {Types::CreateGeofenceCollectionResponse#create_time #create_time} => Time @@ -1092,10 +1095,12 @@ # * 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 [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateMapResponse#create_time #create_time} => Time # * {Types::CreateMapResponse#map_arn #map_arn} => String # * {Types::CreateMapResponse#map_name #map_name} => String @@ -1127,15 +1132,17 @@ def create_map(params = {}, options = {}) req = build_request(:create_map, params) req.send_request(options) end - # Creates a place index resource in your AWS account, which supports - # functions with geospatial data sourced from your chosen data provider. + # Creates a place index resource in your AWS account. Use a place index + # resource to geocode addresses and other text queries by using the + # `SearchPlaceIndexForText` operation, and reverse geocode coordinates + # by using the `SearchPlaceIndexForPosition` operation. # # @option params [required, String] :data_source - # Specifies the data provider of geospatial data. + # 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. # # </note> @@ -1148,12 +1155,12 @@ # # * `Here` – For additional information about [HERE Technologies][3]' # coverage in your region of interest, see [HERE details on goecoding # coverage][4]. # - # Place index resources using HERE Technologies as a data provider - # can't [store results][5] for locations in Japan. For more + # If you specify HERE Technologies (`Here`) as the data provider, you + # may not [store results][5] for locations in Japan. For more # information, see the [AWS Service Terms][6] for Amazon Location # Service. # # For additional information , see [Data providers][7] on the *Amazon # Location Service Developer Guide*. @@ -1196,28 +1203,31 @@ # # [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 helps manage, identify, search, and filter your - # resources by labelling them. + # key-value pair that helps you manage, identify, search, and filter + # your resources. # # Format: `"key" : "value"` # # Restrictions: # - # * Maximum 50 tags per resource + # * Maximum 50 tags per resource. # - # * Each resource tag must be unique with a maximum of one value. + # * Each tag key must be unique and must have exactly one associated + # value. # - # * Maximum key length: 128 Unicode characters in UTF-8 + # * Maximum key length: 128 Unicode characters in UTF-8. # - # * Maximum value length: 256 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: + - = . \_ : / @. + # characters: + - = . \_ : / @ # + # * Cannot use "aws:" as a prefix for a key. + # # @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreatePlaceIndexResponse#create_time #create_time} => Time # * {Types::CreatePlaceIndexResponse#index_arn #index_arn} => String # * {Types::CreatePlaceIndexResponse#index_name #index_name} => String @@ -1337,10 +1347,12 @@ # * 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 [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String # * {Types::CreateRouteCalculatorResponse#calculator_name #calculator_name} => String # * {Types::CreateRouteCalculatorResponse#create_time #create_time} => Time @@ -1395,16 +1407,16 @@ # 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 device positions to retrieve. Distance-based - # filtering can also reduce the jitter effect when displaying device - # trajectory on a map. + # location updates are ignored. Location updates within this area 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. # # This field is optional. If not specified, the default value is # `TimeBased`. # # @option params [required, String] :pricing_plan @@ -1460,10 +1472,12 @@ # * 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. + # # @option params [required, String] :tracker_name # The name for the tracker resource. # # Requirements: # @@ -1483,11 +1497,11 @@ # @example Request syntax with placeholder values # # resp = client.create_tracker({ # description: "ResourceDescription", # kms_key_id: "KmsKeyId", - # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased # pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tags: { # "TagKey" => "TagValue", # }, @@ -1849,11 +1863,11 @@ # @example Response structure # # resp.create_time #=> Time # resp.description #=> String # resp.kms_key_id #=> String - # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased" + # resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased" # resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement" # resp.pricing_plan_data_source #=> String # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # resp.tracker_arn #=> String @@ -2768,54 +2782,73 @@ # position. # # @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. 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. + # + # + # + # [1]: https://tools.ietf.org/search/bcp47 + # # @option params [Integer] :max_results - # An optional paramer. The maximum number of results returned per + # An optional parameter. The maximum number of results returned per # request. # # Default value: `50` # # @option params [required, Array<Float>] :position - # Specifies a coordinate for the query defined by a longitude, and - # latitude. + # Specifies the longitude and latitude of the position to query. # - # * The first position is the X coordinate, or longitude. + # This parameter must contain a pair of numbers. The first number + # represents the X coordinate, or longitude; the second number + # represents the Y coordinate, or latitude. # - # * The second position is the Y coordinate, or latitude. + # For example, `[-123.1174, 49.2847]` represents a position with + # longitude `-123.1174` and latitude `49.2847`. # - # For example, `position=xLongitude&position=yLatitude` . - # # @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::SearchPlaceIndexForPositionResponse#results #results} => Array&lt;Types::SearchForPositionResult&gt; # * {Types::SearchPlaceIndexForPositionResponse#summary #summary} => Types::SearchPlaceIndexForPositionSummary # # @example Request syntax with placeholder values # # resp = client.search_place_index_for_position({ # index_name: "ResourceName", # required + # language: "LanguageTag", # max_results: 1, # position: [1.0], # 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.summary.data_source #=> String + # resp.summary.language #=> String # resp.summary.max_results #=> Integer # resp.summary.position #=> Array # resp.summary.position[0] #=> Float # # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForPosition AWS API Documentation @@ -2828,77 +2861,96 @@ end # Geocodes free-form text, such as an address, name, city, or region to # allow you to search for Places or points of interest. # - # Includes the option to apply additional parameters to narrow your list - # of results. + # Optional parameters let you narrow your search results by bounding box + # or country, or bias your search toward a specific position on the + # globe. # # <note markdown="1"> You can search for places near a given position using `BiasPosition`, # or filter results within a bounding box using `FilterBBox`. Providing # both parameters simultaneously returns an error. # # </note> # + # Search results are returned in order of highest to lowest relevance. + # # @option params [Array<Float>] :bias_position - # Searches for results closest to the given position. An optional - # parameter defined by longitude, and latitude. + # An optional parameter that indicates a preference for places that are + # closer to a specified position. # - # * The first `bias` position is the X coordinate, or longitude. + # If provided, this parameter must contain a pair of numbers. The first + # number represents the X coordinate, or longitude; the second number + # represents the Y coordinate, or latitude. # - # * The second `bias` position is the Y coordinate, or latitude. + # For example, `[-123.1174, 49.2847]` represents the position with + # longitude `-123.1174` and latitude `49.2847`. # - # For example, `bias=xLongitude&bias=yLatitude`. + # <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying + # both options results in an error. # + # </note> + # # @option params [Array<Float>] :filter_b_box - # Filters the results by returning only Places within the provided - # bounding box. An optional parameter. + # An optional parameter that limits the search results by returning only + # places that are within the provided bounding box. # - # The first 2 `bbox` parameters describe the lower southwest corner: + # If provided, this parameter must contain a total of four consecutive + # numbers in two pairs. The first pair of numbers represents the X and Y + # coordinates (longitude and latitude, respectively) of the southwest + # corner of the bounding box; the second pair of numbers represents the + # X and Y coordinates (longitude and latitude, respectively) of the + # northeast corner of the bounding box. # - # * The first `bbox` position is the X coordinate or longitude of the - # lower southwest corner. + # For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a + # bounding box where the southwest corner has longitude `-12.7935` and + # latitude `-37.4835`, and the northeast corner has longitude `-12.0684` + # and latitude `-36.9542`. # - # * The second `bbox` position is the Y coordinate or latitude of the - # lower southwest corner. + # <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying + # both options results in an error. # - # For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`. + # </note> # - # The next `bbox` parameters describe the upper northeast corner: - # - # * The third `bbox` position is the X coordinate, or longitude of the - # upper northeast corner. - # - # * The fourth `bbox` position is the Y coordinate, or longitude of the - # upper northeast corner. - # - # For example, `bbox=xLongitudeNE&bbox=yLatitudeNE` - # # @option params [Array<String>] :filter_countries - # Limits the search to the given a list of countries/regions. An - # optional parameter. + # An optional parameter that limits the search results by returning only + # places that are in a specified list of countries. # - # * Use the [ISO 3166][1] 3-digit country code. For example, Australia - # uses three upper-case characters: `AUS`. + # * 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. 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. + # + # + # + # [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 + # 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&lt;Types::SearchForTextResult&gt; @@ -2909,35 +2961,42 @@ # 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: "SyntheticSearchPlaceIndexForTextRequestString", # 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 # @@ -2963,17 +3022,32 @@ # `arn:aws:geo:region:account-id:resourcetype/ExampleResource` # # ^ # # @option params [required, Hash<String,String>] :tags - # Tags that have been applied to the specified resource. Tags are mapped - # from the tag key to the tag value: `"TagKey" : "TagValue"`. + # 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 example: `\{"tag1" : "value1", "tag2" : "value2"\} ` + # 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({ @@ -3312,11 +3386,11 @@ # # @example Request syntax with placeholder values # # resp = client.update_tracker({ # description: "ResourceDescription", - # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased + # position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased # pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement # pricing_plan_data_source: "String", # tracker_name: "ResourceName", # required # }) # @@ -3346,10 +3420,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-locationservice' - context[:gem_version] = '1.11.0' + context[:gem_version] = '1.12.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated