aws-sdk-locationservice 1.9.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-locationservice/client.rb +154 -69
- data/lib/aws-sdk-locationservice/client_api.rb +19 -0
- data/lib/aws-sdk-locationservice/types.rb +273 -109
- data/lib/aws-sdk-locationservice.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: caf72f04b3ad6ca0575d8c0a09d2b1ea33005920fca50ed03df012ddc7b7af14
|
4
|
+
data.tar.gz: ebd39ff994a10f4d463d194f8a78f8eafc7bd8409f60eb003545242a7153b09c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a4df27c219a40aa791fb3d5cf3912b102726b060543b813fa5ba585c35c9615d8e98ed302c60dcbca8946e719661bb342a6d4d6790d9077e4b872feda5bf9fc
|
7
|
+
data.tar.gz: bcf6a3a0c9265c35fafe16456ff49753f8ee7d24eed58fc393aee0c950bcbdea0166911ea4f49af5fd3feeccd64b977daad97c41162060ecf8550d90bbbfb5ec
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.13.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.12.0 (2021-11-16)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds the support for Relevance, Distance, Time Zone, Language and Interpolated Address for Geocoding and Reverse Geocoding.
|
13
|
+
|
14
|
+
1.11.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.10.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.9.0 (2021-10-05)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.13.0
|
@@ -119,7 +119,9 @@ module Aws::LocationService
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::LocationService
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -673,7 +684,7 @@ module Aws::LocationService
|
|
673
684
|
|
674
685
|
# [Calculates a route][1] given the following required parameters:
|
675
686
|
# `DeparturePostiton` and `DestinationPosition`. Requires that you first
|
676
|
-
# [create a route calculator resource][2]
|
687
|
+
# [create a route calculator resource][2].
|
677
688
|
#
|
678
689
|
# By default, a request that doesn't specify a departure time uses the
|
679
690
|
# best time of day to travel with the best traffic conditions when
|
@@ -686,7 +697,8 @@ module Aws::LocationService
|
|
686
697
|
# data at the given time.
|
687
698
|
#
|
688
699
|
# <note markdown="1"> You can't specify both `DepartureTime` and `DepartureNow` in a
|
689
|
-
# single request. Specifying both parameters returns
|
700
|
+
# single request. Specifying both parameters returns a validation
|
701
|
+
# error.
|
690
702
|
#
|
691
703
|
# </note>
|
692
704
|
#
|
@@ -705,7 +717,7 @@ module Aws::LocationService
|
|
705
717
|
#
|
706
718
|
# @option params [required, String] :calculator_name
|
707
719
|
# The name of the route calculator resource that you want to use to
|
708
|
-
# calculate
|
720
|
+
# calculate the route.
|
709
721
|
#
|
710
722
|
# @option params [Types::CalculateRouteCarModeOptions] :car_mode_options
|
711
723
|
# Specifies route preferences when traveling by `Car`, such as avoiding
|
@@ -746,8 +758,8 @@ module Aws::LocationService
|
|
746
758
|
#
|
747
759
|
# @option params [Time,DateTime,Date,Integer,String] :departure_time
|
748
760
|
# Specifies the desired time of departure. Uses the given time to
|
749
|
-
# calculate
|
750
|
-
# best traffic conditions is used to calculate the route.
|
761
|
+
# calculate the route. Otherwise, the best time of day to travel with
|
762
|
+
# the best traffic conditions is used to calculate the route.
|
751
763
|
#
|
752
764
|
# <note markdown="1"> Setting a departure time in the past returns a `400
|
753
765
|
# ValidationException` error.
|
@@ -1000,6 +1012,8 @@ module Aws::LocationService
|
|
1000
1012
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1001
1013
|
# characters: + - = . \_ : / @.
|
1002
1014
|
#
|
1015
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1016
|
+
#
|
1003
1017
|
# @return [Types::CreateGeofenceCollectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1004
1018
|
#
|
1005
1019
|
# * {Types::CreateGeofenceCollectionResponse#collection_arn #collection_arn} => String
|
@@ -1085,6 +1099,8 @@ module Aws::LocationService
|
|
1085
1099
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1086
1100
|
# characters: + - = . \_ : / @.
|
1087
1101
|
#
|
1102
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1103
|
+
#
|
1088
1104
|
# @return [Types::CreateMapResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1089
1105
|
#
|
1090
1106
|
# * {Types::CreateMapResponse#create_time #create_time} => Time
|
@@ -1120,11 +1136,13 @@ module Aws::LocationService
|
|
1120
1136
|
req.send_request(options)
|
1121
1137
|
end
|
1122
1138
|
|
1123
|
-
# Creates a place index resource in your AWS account
|
1124
|
-
#
|
1139
|
+
# Creates a place index resource in your AWS account. Use a place index
|
1140
|
+
# resource to geocode addresses and other text queries by using the
|
1141
|
+
# `SearchPlaceIndexForText` operation, and reverse geocode coordinates
|
1142
|
+
# by using the `SearchPlaceIndexForPosition` operation.
|
1125
1143
|
#
|
1126
1144
|
# @option params [required, String] :data_source
|
1127
|
-
# Specifies the data provider
|
1145
|
+
# Specifies the geospatial data provider for the new place index.
|
1128
1146
|
#
|
1129
1147
|
# <note markdown="1"> This field is case-sensitive. Enter the valid values as shown. For
|
1130
1148
|
# example, entering `HERE` returns an error.
|
@@ -1141,8 +1159,8 @@ module Aws::LocationService
|
|
1141
1159
|
# coverage in your region of interest, see [HERE details on goecoding
|
1142
1160
|
# coverage][4].
|
1143
1161
|
#
|
1144
|
-
#
|
1145
|
-
#
|
1162
|
+
# If you specify HERE Technologies (`Here`) as the data provider, you
|
1163
|
+
# may not [store results][5] for locations in Japan. For more
|
1146
1164
|
# information, see the [AWS Service Terms][6] for Amazon Location
|
1147
1165
|
# Service.
|
1148
1166
|
#
|
@@ -1189,23 +1207,26 @@ module Aws::LocationService
|
|
1189
1207
|
#
|
1190
1208
|
# @option params [Hash<String,String>] :tags
|
1191
1209
|
# Applies one or more tags to the place index resource. A tag is a
|
1192
|
-
# key-value pair helps manage, identify, search, and filter
|
1193
|
-
# resources
|
1210
|
+
# key-value pair that helps you manage, identify, search, and filter
|
1211
|
+
# your resources.
|
1194
1212
|
#
|
1195
1213
|
# Format: `"key" : "value"`
|
1196
1214
|
#
|
1197
1215
|
# Restrictions:
|
1198
1216
|
#
|
1199
|
-
# * Maximum 50 tags per resource
|
1217
|
+
# * Maximum 50 tags per resource.
|
1200
1218
|
#
|
1201
|
-
# * Each
|
1219
|
+
# * Each tag key must be unique and must have exactly one associated
|
1220
|
+
# value.
|
1202
1221
|
#
|
1203
|
-
# * Maximum key length: 128 Unicode characters in UTF-8
|
1222
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1204
1223
|
#
|
1205
|
-
# * Maximum value length: 256 Unicode characters in UTF-8
|
1224
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1206
1225
|
#
|
1207
1226
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1208
|
-
# characters: + - = . \_ : /
|
1227
|
+
# characters: + - = . \_ : / @
|
1228
|
+
#
|
1229
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1209
1230
|
#
|
1210
1231
|
# @return [Types::CreatePlaceIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1211
1232
|
#
|
@@ -1330,6 +1351,8 @@ module Aws::LocationService
|
|
1330
1351
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1331
1352
|
# characters: + - = . \_ : / @.
|
1332
1353
|
#
|
1354
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1355
|
+
#
|
1333
1356
|
# @return [Types::CreateRouteCalculatorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1334
1357
|
#
|
1335
1358
|
# * {Types::CreateRouteCalculatorResponse#calculator_arn #calculator_arn} => String
|
@@ -1388,12 +1411,12 @@ module Aws::LocationService
|
|
1388
1411
|
# seconds is stored for each unique device ID.
|
1389
1412
|
#
|
1390
1413
|
# * `DistanceBased` - If the device has moved less than 30 m (98.4 ft),
|
1391
|
-
# location updates are ignored. Location updates within this
|
1392
|
-
#
|
1393
|
-
#
|
1394
|
-
# evaluations and device positions to
|
1395
|
-
# filtering can also reduce the
|
1396
|
-
#
|
1414
|
+
# location updates are ignored. Location updates within this area are
|
1415
|
+
# neither evaluated against linked geofence collections, nor stored.
|
1416
|
+
# This helps control costs by reducing the number of geofence
|
1417
|
+
# evaluations and historical device positions to paginate through.
|
1418
|
+
# Distance-based filtering can also reduce the effects of GPS noise
|
1419
|
+
# when displaying device trajectories on a map.
|
1397
1420
|
#
|
1398
1421
|
# This field is optional. If not specified, the default value is
|
1399
1422
|
# `TimeBased`.
|
@@ -1453,6 +1476,8 @@ module Aws::LocationService
|
|
1453
1476
|
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
1454
1477
|
# characters: + - = . \_ : / @.
|
1455
1478
|
#
|
1479
|
+
# * Cannot use "aws:" as a prefix for a key.
|
1480
|
+
#
|
1456
1481
|
# @option params [required, String] :tracker_name
|
1457
1482
|
# The name for the tracker resource.
|
1458
1483
|
#
|
@@ -1476,7 +1501,7 @@ module Aws::LocationService
|
|
1476
1501
|
# resp = client.create_tracker({
|
1477
1502
|
# description: "ResourceDescription",
|
1478
1503
|
# kms_key_id: "KmsKeyId",
|
1479
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
1504
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
1480
1505
|
# pricing_plan: "RequestBasedUsage", # required, accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
1481
1506
|
# pricing_plan_data_source: "String",
|
1482
1507
|
# tags: {
|
@@ -1842,7 +1867,7 @@ module Aws::LocationService
|
|
1842
1867
|
# resp.create_time #=> Time
|
1843
1868
|
# resp.description #=> String
|
1844
1869
|
# resp.kms_key_id #=> String
|
1845
|
-
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased"
|
1870
|
+
# resp.position_filtering #=> String, one of "TimeBased", "DistanceBased", "AccuracyBased"
|
1846
1871
|
# resp.pricing_plan #=> String, one of "RequestBasedUsage", "MobileAssetTracking", "MobileAssetManagement"
|
1847
1872
|
# resp.pricing_plan_data_source #=> String
|
1848
1873
|
# resp.tags #=> Hash
|
@@ -2761,21 +2786,34 @@ module Aws::LocationService
|
|
2761
2786
|
# @option params [required, String] :index_name
|
2762
2787
|
# The name of the place index resource you want to use for the search.
|
2763
2788
|
#
|
2789
|
+
# @option params [String] :language
|
2790
|
+
# The preferred language used to return results. The value must be a
|
2791
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2792
|
+
#
|
2793
|
+
# This setting affects the languages used in the results. It does not
|
2794
|
+
# change which results are returned. If the language is not specified,
|
2795
|
+
# or not supported for a particular result, the partner automatically
|
2796
|
+
# chooses a language for the result.
|
2797
|
+
#
|
2798
|
+
#
|
2799
|
+
#
|
2800
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2801
|
+
#
|
2764
2802
|
# @option params [Integer] :max_results
|
2765
|
-
# An optional
|
2803
|
+
# An optional parameter. The maximum number of results returned per
|
2766
2804
|
# request.
|
2767
2805
|
#
|
2768
2806
|
# Default value: `50`
|
2769
2807
|
#
|
2770
2808
|
# @option params [required, Array<Float>] :position
|
2771
|
-
# Specifies
|
2772
|
-
# latitude.
|
2809
|
+
# Specifies the longitude and latitude of the position to query.
|
2773
2810
|
#
|
2774
|
-
#
|
2811
|
+
# This parameter must contain a pair of numbers. The first number
|
2812
|
+
# represents the X coordinate, or longitude; the second number
|
2813
|
+
# represents the Y coordinate, or latitude.
|
2775
2814
|
#
|
2776
|
-
#
|
2777
|
-
#
|
2778
|
-
# For example, `position=xLongitude&position=yLatitude` .
|
2815
|
+
# For example, `[-123.1174, 49.2847]` represents a position with
|
2816
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2779
2817
|
#
|
2780
2818
|
# @return [Types::SearchPlaceIndexForPositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2781
2819
|
#
|
@@ -2786,6 +2824,7 @@ module Aws::LocationService
|
|
2786
2824
|
#
|
2787
2825
|
# resp = client.search_place_index_for_position({
|
2788
2826
|
# index_name: "ResourceName", # required
|
2827
|
+
# language: "LanguageTag",
|
2789
2828
|
# max_results: 1,
|
2790
2829
|
# position: [1.0], # required
|
2791
2830
|
# })
|
@@ -2793,10 +2832,12 @@ module Aws::LocationService
|
|
2793
2832
|
# @example Response structure
|
2794
2833
|
#
|
2795
2834
|
# resp.results #=> Array
|
2835
|
+
# resp.results[0].distance #=> Float
|
2796
2836
|
# resp.results[0].place.address_number #=> String
|
2797
2837
|
# resp.results[0].place.country #=> String
|
2798
2838
|
# resp.results[0].place.geometry.point #=> Array
|
2799
2839
|
# resp.results[0].place.geometry.point[0] #=> Float
|
2840
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2800
2841
|
# resp.results[0].place.label #=> String
|
2801
2842
|
# resp.results[0].place.municipality #=> String
|
2802
2843
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2804,7 +2845,10 @@ module Aws::LocationService
|
|
2804
2845
|
# resp.results[0].place.region #=> String
|
2805
2846
|
# resp.results[0].place.street #=> String
|
2806
2847
|
# resp.results[0].place.sub_region #=> String
|
2848
|
+
# resp.results[0].place.time_zone.name #=> String
|
2849
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
2807
2850
|
# resp.summary.data_source #=> String
|
2851
|
+
# resp.summary.language #=> String
|
2808
2852
|
# resp.summary.max_results #=> Integer
|
2809
2853
|
# resp.summary.position #=> Array
|
2810
2854
|
# resp.summary.position[0] #=> Float
|
@@ -2821,8 +2865,9 @@ module Aws::LocationService
|
|
2821
2865
|
# Geocodes free-form text, such as an address, name, city, or region to
|
2822
2866
|
# allow you to search for Places or points of interest.
|
2823
2867
|
#
|
2824
|
-
#
|
2825
|
-
#
|
2868
|
+
# Optional parameters let you narrow your search results by bounding box
|
2869
|
+
# or country, or bias your search toward a specific position on the
|
2870
|
+
# globe.
|
2826
2871
|
#
|
2827
2872
|
# <note markdown="1"> You can search for places near a given position using `BiasPosition`,
|
2828
2873
|
# or filter results within a bounding box using `FilterBBox`. Providing
|
@@ -2830,46 +2875,51 @@ module Aws::LocationService
|
|
2830
2875
|
#
|
2831
2876
|
# </note>
|
2832
2877
|
#
|
2833
|
-
#
|
2834
|
-
# Searches for results closest to the given position. An optional
|
2835
|
-
# parameter defined by longitude, and latitude.
|
2878
|
+
# Search results are returned in order of highest to lowest relevance.
|
2836
2879
|
#
|
2837
|
-
#
|
2838
|
-
#
|
2839
|
-
#
|
2880
|
+
# @option params [Array<Float>] :bias_position
|
2881
|
+
# An optional parameter that indicates a preference for places that are
|
2882
|
+
# closer to a specified position.
|
2840
2883
|
#
|
2841
|
-
#
|
2884
|
+
# If provided, this parameter must contain a pair of numbers. The first
|
2885
|
+
# number represents the X coordinate, or longitude; the second number
|
2886
|
+
# represents the Y coordinate, or latitude.
|
2842
2887
|
#
|
2843
|
-
#
|
2844
|
-
#
|
2845
|
-
# bounding box. An optional parameter.
|
2888
|
+
# For example, `[-123.1174, 49.2847]` represents the position with
|
2889
|
+
# longitude `-123.1174` and latitude `49.2847`.
|
2846
2890
|
#
|
2847
|
-
#
|
2891
|
+
# <note markdown="1"> `BiasPosition` and `FilterBBox` are mutually exclusive. Specifying
|
2892
|
+
# both options results in an error.
|
2848
2893
|
#
|
2849
|
-
#
|
2850
|
-
# lower southwest corner.
|
2851
|
-
#
|
2852
|
-
# * The second `bbox` position is the Y coordinate or latitude of the
|
2853
|
-
# lower southwest corner.
|
2894
|
+
# </note>
|
2854
2895
|
#
|
2855
|
-
#
|
2896
|
+
# @option params [Array<Float>] :filter_b_box
|
2897
|
+
# An optional parameter that limits the search results by returning only
|
2898
|
+
# places that are within the provided bounding box.
|
2856
2899
|
#
|
2857
|
-
#
|
2900
|
+
# If provided, this parameter must contain a total of four consecutive
|
2901
|
+
# numbers in two pairs. The first pair of numbers represents the X and Y
|
2902
|
+
# coordinates (longitude and latitude, respectively) of the southwest
|
2903
|
+
# corner of the bounding box; the second pair of numbers represents the
|
2904
|
+
# X and Y coordinates (longitude and latitude, respectively) of the
|
2905
|
+
# northeast corner of the bounding box.
|
2858
2906
|
#
|
2859
|
-
#
|
2860
|
-
#
|
2907
|
+
# For example, `[-12.7935, -37.4835, -12.0684, -36.9542]` represents a
|
2908
|
+
# bounding box where the southwest corner has longitude `-12.7935` and
|
2909
|
+
# latitude `-37.4835`, and the northeast corner has longitude `-12.0684`
|
2910
|
+
# and latitude `-36.9542`.
|
2861
2911
|
#
|
2862
|
-
#
|
2863
|
-
#
|
2912
|
+
# <note markdown="1"> `FilterBBox` and `BiasPosition` are mutually exclusive. Specifying
|
2913
|
+
# both options results in an error.
|
2864
2914
|
#
|
2865
|
-
#
|
2915
|
+
# </note>
|
2866
2916
|
#
|
2867
2917
|
# @option params [Array<String>] :filter_countries
|
2868
|
-
#
|
2869
|
-
#
|
2918
|
+
# An optional parameter that limits the search results by returning only
|
2919
|
+
# places that are in a specified list of countries.
|
2870
2920
|
#
|
2871
|
-
# *
|
2872
|
-
# uses three upper-case characters: `AUS`.
|
2921
|
+
# * Valid values include [ISO 3166][1] 3-digit country codes. For
|
2922
|
+
# example, Australia uses three upper-case characters: `AUS`.
|
2873
2923
|
#
|
2874
2924
|
# ^
|
2875
2925
|
#
|
@@ -2880,6 +2930,19 @@ module Aws::LocationService
|
|
2880
2930
|
# @option params [required, String] :index_name
|
2881
2931
|
# The name of the place index resource you want to use for the search.
|
2882
2932
|
#
|
2933
|
+
# @option params [String] :language
|
2934
|
+
# The preferred language used to return results. The value must be a
|
2935
|
+
# valid [BCP 47][1] language tag, for example, `en` for English.
|
2936
|
+
#
|
2937
|
+
# This setting affects the languages used in the results. It does not
|
2938
|
+
# change which results are returned. If the language is not specified,
|
2939
|
+
# or not supported for a particular result, the partner automatically
|
2940
|
+
# chooses a language for the result.
|
2941
|
+
#
|
2942
|
+
#
|
2943
|
+
#
|
2944
|
+
# [1]: https://tools.ietf.org/search/bcp47
|
2945
|
+
#
|
2883
2946
|
# @option params [Integer] :max_results
|
2884
2947
|
# An optional parameter. The maximum number of results returned per
|
2885
2948
|
# request.
|
@@ -2887,7 +2950,7 @@ module Aws::LocationService
|
|
2887
2950
|
# The default: `50`
|
2888
2951
|
#
|
2889
2952
|
# @option params [required, String] :text
|
2890
|
-
# The address, name, city, or region to be used in the search
|
2953
|
+
# The address, name, city, or region to be used in the search in
|
2891
2954
|
# free-form text format. For example, `123 Any Street`.
|
2892
2955
|
#
|
2893
2956
|
# @return [Types::SearchPlaceIndexForTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2902,6 +2965,7 @@ module Aws::LocationService
|
|
2902
2965
|
# filter_b_box: [1.0],
|
2903
2966
|
# filter_countries: ["CountryCode"],
|
2904
2967
|
# index_name: "ResourceName", # required
|
2968
|
+
# language: "LanguageTag",
|
2905
2969
|
# max_results: 1,
|
2906
2970
|
# text: "SyntheticSearchPlaceIndexForTextRequestString", # required
|
2907
2971
|
# })
|
@@ -2909,10 +2973,12 @@ module Aws::LocationService
|
|
2909
2973
|
# @example Response structure
|
2910
2974
|
#
|
2911
2975
|
# resp.results #=> Array
|
2976
|
+
# resp.results[0].distance #=> Float
|
2912
2977
|
# resp.results[0].place.address_number #=> String
|
2913
2978
|
# resp.results[0].place.country #=> String
|
2914
2979
|
# resp.results[0].place.geometry.point #=> Array
|
2915
2980
|
# resp.results[0].place.geometry.point[0] #=> Float
|
2981
|
+
# resp.results[0].place.interpolated #=> Boolean
|
2916
2982
|
# resp.results[0].place.label #=> String
|
2917
2983
|
# resp.results[0].place.municipality #=> String
|
2918
2984
|
# resp.results[0].place.neighborhood #=> String
|
@@ -2920,6 +2986,9 @@ module Aws::LocationService
|
|
2920
2986
|
# resp.results[0].place.region #=> String
|
2921
2987
|
# resp.results[0].place.street #=> String
|
2922
2988
|
# resp.results[0].place.sub_region #=> String
|
2989
|
+
# resp.results[0].place.time_zone.name #=> String
|
2990
|
+
# resp.results[0].place.time_zone.offset #=> Integer
|
2991
|
+
# resp.results[0].relevance #=> Float
|
2923
2992
|
# resp.summary.bias_position #=> Array
|
2924
2993
|
# resp.summary.bias_position[0] #=> Float
|
2925
2994
|
# resp.summary.data_source #=> String
|
@@ -2927,6 +2996,7 @@ module Aws::LocationService
|
|
2927
2996
|
# resp.summary.filter_b_box[0] #=> Float
|
2928
2997
|
# resp.summary.filter_countries #=> Array
|
2929
2998
|
# resp.summary.filter_countries[0] #=> String
|
2999
|
+
# resp.summary.language #=> String
|
2930
3000
|
# resp.summary.max_results #=> Integer
|
2931
3001
|
# resp.summary.result_b_box #=> Array
|
2932
3002
|
# resp.summary.result_b_box[0] #=> Float
|
@@ -2956,12 +3026,27 @@ module Aws::LocationService
|
|
2956
3026
|
# ^
|
2957
3027
|
#
|
2958
3028
|
# @option params [required, Hash<String,String>] :tags
|
2959
|
-
#
|
2960
|
-
#
|
3029
|
+
# Applies one or more tags to specific resource. A tag is a key-value
|
3030
|
+
# pair that helps you manage, identify, search, and filter your
|
3031
|
+
# resources.
|
2961
3032
|
#
|
2962
|
-
#
|
3033
|
+
# Format: `"key" : "value"`
|
2963
3034
|
#
|
2964
|
-
#
|
3035
|
+
# Restrictions:
|
3036
|
+
#
|
3037
|
+
# * Maximum 50 tags per resource.
|
3038
|
+
#
|
3039
|
+
# * Each tag key must be unique and must have exactly one associated
|
3040
|
+
# value.
|
3041
|
+
#
|
3042
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
3043
|
+
#
|
3044
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
3045
|
+
#
|
3046
|
+
# * Can use alphanumeric characters (A–Z, a–z, 0–9), and the following
|
3047
|
+
# characters: + - = . \_ : / @
|
3048
|
+
#
|
3049
|
+
# * Cannot use "aws:" as a prefix for a key.
|
2965
3050
|
#
|
2966
3051
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2967
3052
|
#
|
@@ -3305,7 +3390,7 @@ module Aws::LocationService
|
|
3305
3390
|
#
|
3306
3391
|
# resp = client.update_tracker({
|
3307
3392
|
# description: "ResourceDescription",
|
3308
|
-
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
|
3393
|
+
# position_filtering: "TimeBased", # accepts TimeBased, DistanceBased, AccuracyBased
|
3309
3394
|
# pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
|
3310
3395
|
# pricing_plan_data_source: "String",
|
3311
3396
|
# tracker_name: "ResourceName", # required
|
@@ -3339,7 +3424,7 @@ module Aws::LocationService
|
|
3339
3424
|
params: params,
|
3340
3425
|
config: config)
|
3341
3426
|
context[:gem_name] = 'aws-sdk-locationservice'
|
3342
|
-
context[:gem_version] = '1.
|
3427
|
+
context[:gem_version] = '1.13.0'
|
3343
3428
|
Seahorse::Client::Request.new(handlers, context)
|
3344
3429
|
end
|
3345
3430
|
|
@@ -128,9 +128,11 @@ module Aws::LocationService
|
|
128
128
|
GetMapTileRequestZString = Shapes::StringShape.new(name: 'GetMapTileRequestZString')
|
129
129
|
GetMapTileResponse = Shapes::StructureShape.new(name: 'GetMapTileResponse')
|
130
130
|
Id = Shapes::StringShape.new(name: 'Id')
|
131
|
+
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
131
132
|
IntendedUse = Shapes::StringShape.new(name: 'IntendedUse')
|
132
133
|
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
133
134
|
KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
|
135
|
+
LanguageTag = Shapes::StringShape.new(name: 'LanguageTag')
|
134
136
|
Leg = Shapes::StructureShape.new(name: 'Leg')
|
135
137
|
LegDistanceDouble = Shapes::FloatShape.new(name: 'LegDistanceDouble')
|
136
138
|
LegDurationSecondsDouble = Shapes::FloatShape.new(name: 'LegDurationSecondsDouble')
|
@@ -192,9 +194,12 @@ module Aws::LocationService
|
|
192
194
|
ResourceName = Shapes::StringShape.new(name: 'ResourceName')
|
193
195
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
194
196
|
SearchForPositionResult = Shapes::StructureShape.new(name: 'SearchForPositionResult')
|
197
|
+
SearchForPositionResultDistanceDouble = Shapes::FloatShape.new(name: 'SearchForPositionResultDistanceDouble')
|
195
198
|
SearchForPositionResultList = Shapes::ListShape.new(name: 'SearchForPositionResultList')
|
196
199
|
SearchForTextResult = Shapes::StructureShape.new(name: 'SearchForTextResult')
|
200
|
+
SearchForTextResultDistanceDouble = Shapes::FloatShape.new(name: 'SearchForTextResultDistanceDouble')
|
197
201
|
SearchForTextResultList = Shapes::ListShape.new(name: 'SearchForTextResultList')
|
202
|
+
SearchForTextResultRelevanceDouble = Shapes::FloatShape.new(name: 'SearchForTextResultRelevanceDouble')
|
198
203
|
SearchPlaceIndexForPositionRequest = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionRequest')
|
199
204
|
SearchPlaceIndexForPositionResponse = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionResponse')
|
200
205
|
SearchPlaceIndexForPositionSummary = Shapes::StructureShape.new(name: 'SearchPlaceIndexForPositionSummary')
|
@@ -217,6 +222,7 @@ module Aws::LocationService
|
|
217
222
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
218
223
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
219
224
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
225
|
+
TimeZone = Shapes::StructureShape.new(name: 'TimeZone')
|
220
226
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp', timestampFormat: "iso8601")
|
221
227
|
Token = Shapes::StringShape.new(name: 'Token')
|
222
228
|
TravelMode = Shapes::StringShape.new(name: 'TravelMode')
|
@@ -831,6 +837,7 @@ module Aws::LocationService
|
|
831
837
|
Place.add_member(:address_number, Shapes::ShapeRef.new(shape: String, location_name: "AddressNumber"))
|
832
838
|
Place.add_member(:country, Shapes::ShapeRef.new(shape: String, location_name: "Country"))
|
833
839
|
Place.add_member(:geometry, Shapes::ShapeRef.new(shape: PlaceGeometry, required: true, location_name: "Geometry"))
|
840
|
+
Place.add_member(:interpolated, Shapes::ShapeRef.new(shape: Boolean, location_name: "Interpolated"))
|
834
841
|
Place.add_member(:label, Shapes::ShapeRef.new(shape: String, location_name: "Label"))
|
835
842
|
Place.add_member(:municipality, Shapes::ShapeRef.new(shape: String, location_name: "Municipality"))
|
836
843
|
Place.add_member(:neighborhood, Shapes::ShapeRef.new(shape: String, location_name: "Neighborhood"))
|
@@ -838,6 +845,7 @@ module Aws::LocationService
|
|
838
845
|
Place.add_member(:region, Shapes::ShapeRef.new(shape: String, location_name: "Region"))
|
839
846
|
Place.add_member(:street, Shapes::ShapeRef.new(shape: String, location_name: "Street"))
|
840
847
|
Place.add_member(:sub_region, Shapes::ShapeRef.new(shape: String, location_name: "SubRegion"))
|
848
|
+
Place.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
|
841
849
|
Place.struct_class = Types::Place
|
842
850
|
|
843
851
|
PlaceGeometry.add_member(:point, Shapes::ShapeRef.new(shape: Position, location_name: "Point"))
|
@@ -858,17 +866,21 @@ module Aws::LocationService
|
|
858
866
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
859
867
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
860
868
|
|
869
|
+
SearchForPositionResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForPositionResultDistanceDouble, required: true, location_name: "Distance"))
|
861
870
|
SearchForPositionResult.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
|
862
871
|
SearchForPositionResult.struct_class = Types::SearchForPositionResult
|
863
872
|
|
864
873
|
SearchForPositionResultList.member = Shapes::ShapeRef.new(shape: SearchForPositionResult)
|
865
874
|
|
875
|
+
SearchForTextResult.add_member(:distance, Shapes::ShapeRef.new(shape: SearchForTextResultDistanceDouble, location_name: "Distance"))
|
866
876
|
SearchForTextResult.add_member(:place, Shapes::ShapeRef.new(shape: Place, required: true, location_name: "Place"))
|
877
|
+
SearchForTextResult.add_member(:relevance, Shapes::ShapeRef.new(shape: SearchForTextResultRelevanceDouble, location_name: "Relevance"))
|
867
878
|
SearchForTextResult.struct_class = Types::SearchForTextResult
|
868
879
|
|
869
880
|
SearchForTextResultList.member = Shapes::ShapeRef.new(shape: SearchForTextResult)
|
870
881
|
|
871
882
|
SearchPlaceIndexForPositionRequest.add_member(:index_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "IndexName"))
|
883
|
+
SearchPlaceIndexForPositionRequest.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
|
872
884
|
SearchPlaceIndexForPositionRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PlaceIndexSearchResultLimit, location_name: "MaxResults"))
|
873
885
|
SearchPlaceIndexForPositionRequest.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
|
874
886
|
SearchPlaceIndexForPositionRequest.struct_class = Types::SearchPlaceIndexForPositionRequest
|
@@ -878,6 +890,7 @@ module Aws::LocationService
|
|
878
890
|
SearchPlaceIndexForPositionResponse.struct_class = Types::SearchPlaceIndexForPositionResponse
|
879
891
|
|
880
892
|
SearchPlaceIndexForPositionSummary.add_member(:data_source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataSource"))
|
893
|
+
SearchPlaceIndexForPositionSummary.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
|
881
894
|
SearchPlaceIndexForPositionSummary.add_member(:max_results, Shapes::ShapeRef.new(shape: PlaceIndexSearchResultLimit, location_name: "MaxResults"))
|
882
895
|
SearchPlaceIndexForPositionSummary.add_member(:position, Shapes::ShapeRef.new(shape: Position, required: true, location_name: "Position"))
|
883
896
|
SearchPlaceIndexForPositionSummary.struct_class = Types::SearchPlaceIndexForPositionSummary
|
@@ -886,6 +899,7 @@ module Aws::LocationService
|
|
886
899
|
SearchPlaceIndexForTextRequest.add_member(:filter_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "FilterBBox"))
|
887
900
|
SearchPlaceIndexForTextRequest.add_member(:filter_countries, Shapes::ShapeRef.new(shape: CountryCodeList, location_name: "FilterCountries"))
|
888
901
|
SearchPlaceIndexForTextRequest.add_member(:index_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location: "uri", location_name: "IndexName"))
|
902
|
+
SearchPlaceIndexForTextRequest.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
|
889
903
|
SearchPlaceIndexForTextRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: PlaceIndexSearchResultLimit, location_name: "MaxResults"))
|
890
904
|
SearchPlaceIndexForTextRequest.add_member(:text, Shapes::ShapeRef.new(shape: SyntheticSearchPlaceIndexForTextRequestString, required: true, location_name: "Text"))
|
891
905
|
SearchPlaceIndexForTextRequest.struct_class = Types::SearchPlaceIndexForTextRequest
|
@@ -898,6 +912,7 @@ module Aws::LocationService
|
|
898
912
|
SearchPlaceIndexForTextSummary.add_member(:data_source, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataSource"))
|
899
913
|
SearchPlaceIndexForTextSummary.add_member(:filter_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "FilterBBox"))
|
900
914
|
SearchPlaceIndexForTextSummary.add_member(:filter_countries, Shapes::ShapeRef.new(shape: CountryCodeList, location_name: "FilterCountries"))
|
915
|
+
SearchPlaceIndexForTextSummary.add_member(:language, Shapes::ShapeRef.new(shape: LanguageTag, location_name: "Language"))
|
901
916
|
SearchPlaceIndexForTextSummary.add_member(:max_results, Shapes::ShapeRef.new(shape: PlaceIndexSearchResultLimit, location_name: "MaxResults"))
|
902
917
|
SearchPlaceIndexForTextSummary.add_member(:result_b_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "ResultBBox"))
|
903
918
|
SearchPlaceIndexForTextSummary.add_member(:text, Shapes::ShapeRef.new(shape: SyntheticSearchPlaceIndexForTextSummaryString, required: true, location_name: "Text"))
|
@@ -929,6 +944,10 @@ module Aws::LocationService
|
|
929
944
|
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
930
945
|
ThrottlingException.struct_class = Types::ThrottlingException
|
931
946
|
|
947
|
+
TimeZone.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
|
948
|
+
TimeZone.add_member(:offset, Shapes::ShapeRef.new(shape: Integer, location_name: "Offset"))
|
949
|
+
TimeZone.struct_class = Types::TimeZone
|
950
|
+
|
932
951
|
TruckDimensions.add_member(:height, Shapes::ShapeRef.new(shape: TruckDimensionsHeightDouble, location_name: "Height"))
|
933
952
|
TruckDimensions.add_member(:length, Shapes::ShapeRef.new(shape: TruckDimensionsLengthDouble, location_name: "Length"))
|
934
953
|
TruckDimensions.add_member(:unit, Shapes::ShapeRef.new(shape: DimensionUnit, location_name: "Unit"))
|