aws-sdk-geoplaces 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-geoplaces/client.rb +1960 -0
- data/lib/aws-sdk-geoplaces/client_api.rb +935 -0
- data/lib/aws-sdk-geoplaces/customizations.rb +0 -0
- data/lib/aws-sdk-geoplaces/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-geoplaces/endpoint_provider.rb +78 -0
- data/lib/aws-sdk-geoplaces/endpoints.rb +20 -0
- data/lib/aws-sdk-geoplaces/errors.rb +120 -0
- data/lib/aws-sdk-geoplaces/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-geoplaces/resource.rb +26 -0
- data/lib/aws-sdk-geoplaces/types.rb +2884 -0
- data/lib/aws-sdk-geoplaces.rb +61 -0
- data/sig/client.rbs +281 -0
- data/sig/errors.rbs +30 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +644 -0
- data/sig/waiters.rbs +13 -0
- metadata +99 -0
@@ -0,0 +1,2884 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::GeoPlaces
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Position of the access point represented by longitude and latitude for
|
27
|
+
# a vehicle.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] position
|
30
|
+
# The position, in longitude and latitude.
|
31
|
+
# @return [Array<Float>]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AccessPoint AWS API Documentation
|
34
|
+
#
|
35
|
+
class AccessPoint < Struct.new(
|
36
|
+
:position)
|
37
|
+
SENSITIVE = [:position]
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
# Indicates if the access location is restricted. Index correlates to
|
42
|
+
# that of an access point and indicates if access through this point has
|
43
|
+
# some form of restriction.
|
44
|
+
#
|
45
|
+
# @!attribute [rw] restricted
|
46
|
+
# The restriction.
|
47
|
+
# @return [Boolean]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] categories
|
50
|
+
# Categories of results that results must belong too.
|
51
|
+
# @return [Array<Types::Category>]
|
52
|
+
#
|
53
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AccessRestriction AWS API Documentation
|
54
|
+
#
|
55
|
+
class AccessRestriction < Struct.new(
|
56
|
+
:restricted,
|
57
|
+
:categories)
|
58
|
+
SENSITIVE = []
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
62
|
+
# The place address.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] label
|
65
|
+
# Assembled address value built out of the address components,
|
66
|
+
# according to the regional postal rules. This is the correctly
|
67
|
+
# formatted address.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] country
|
71
|
+
# The country component of the address.
|
72
|
+
# @return [Types::Country]
|
73
|
+
#
|
74
|
+
# @!attribute [rw] region
|
75
|
+
# The region or state results should be present in.
|
76
|
+
#
|
77
|
+
# Example: `North Rhine-Westphalia`.
|
78
|
+
# @return [Types::Region]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] sub_region
|
81
|
+
# The sub-region or county for which results should be present in.
|
82
|
+
# @return [Types::SubRegion]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] locality
|
85
|
+
# The locality or city of the address.
|
86
|
+
#
|
87
|
+
# Example: `Vancouver`.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] district
|
91
|
+
# The district or division of a locality associated with this address.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] sub_district
|
95
|
+
# A subdivision of a district.
|
96
|
+
#
|
97
|
+
# Example: `Minden-Lübbecke`.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] postal_code
|
101
|
+
# An alphanumeric string included in a postal address to facilitate
|
102
|
+
# mail sorting, such as post code, postcode, or ZIP code, for which
|
103
|
+
# the result should posses.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] block
|
107
|
+
# Name of the block.
|
108
|
+
#
|
109
|
+
# Example: `Sunny Mansion 203 block: 2 Chome`
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] sub_block
|
113
|
+
# Name of sub-block.
|
114
|
+
#
|
115
|
+
# Example: `Sunny Mansion 203 sub-block: 4`
|
116
|
+
# @return [String]
|
117
|
+
#
|
118
|
+
# @!attribute [rw] intersection
|
119
|
+
# Name of the streets in the intersection.
|
120
|
+
#
|
121
|
+
# Example: `["Friedrichstraße","Unter den Linden"]`
|
122
|
+
# @return [Array<String>]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] street
|
125
|
+
# The name of the street results should be present in.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] street_components
|
129
|
+
# Components of the street.
|
130
|
+
#
|
131
|
+
# Example: Younge from the "Younge street".
|
132
|
+
# @return [Array<Types::StreetComponents>]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] address_number
|
135
|
+
# The number that identifies an address within a street.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @!attribute [rw] building
|
139
|
+
# The name of the building at the address.
|
140
|
+
# @return [String]
|
141
|
+
#
|
142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Address AWS API Documentation
|
143
|
+
#
|
144
|
+
class Address < Struct.new(
|
145
|
+
:label,
|
146
|
+
:country,
|
147
|
+
:region,
|
148
|
+
:sub_region,
|
149
|
+
:locality,
|
150
|
+
:district,
|
151
|
+
:sub_district,
|
152
|
+
:postal_code,
|
153
|
+
:block,
|
154
|
+
:sub_block,
|
155
|
+
:intersection,
|
156
|
+
:street,
|
157
|
+
:street_components,
|
158
|
+
:address_number,
|
159
|
+
:building)
|
160
|
+
SENSITIVE = []
|
161
|
+
include Aws::Structure
|
162
|
+
end
|
163
|
+
|
164
|
+
# Indicates how well the entire input matches the returned. It is equal
|
165
|
+
# to 1 if all input tokens are recognized and matched.
|
166
|
+
#
|
167
|
+
# @!attribute [rw] country
|
168
|
+
# The alpha-2 or alpha-3 character code for the country that the
|
169
|
+
# results will be present in.
|
170
|
+
# @return [Float]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] region
|
173
|
+
# The region or state results should be to be present in.
|
174
|
+
#
|
175
|
+
# Example: `North Rhine-Westphalia`.
|
176
|
+
# @return [Float]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] sub_region
|
179
|
+
# The sub-region or county for which results should be present in.
|
180
|
+
# @return [Float]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] locality
|
183
|
+
# The city or locality results should be present in.
|
184
|
+
#
|
185
|
+
# Example: `Vancouver`.
|
186
|
+
# @return [Float]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] district
|
189
|
+
# The district or division of a city the results should be present in.
|
190
|
+
# @return [Float]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] sub_district
|
193
|
+
# A subdivision of a district.
|
194
|
+
#
|
195
|
+
# Example: `Minden-Lübbecke`
|
196
|
+
# @return [Float]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] postal_code
|
199
|
+
# An alphanumeric string included in a postal address to facilitate
|
200
|
+
# mail sorting, such as post code, postcode, or ZIP code, for which
|
201
|
+
# the result should posses.
|
202
|
+
# @return [Float]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] block
|
205
|
+
# Name of the block.
|
206
|
+
#
|
207
|
+
# Example: `Sunny Mansion 203 block: 2 Chome`
|
208
|
+
# @return [Float]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] sub_block
|
211
|
+
# Name of sub-block.
|
212
|
+
#
|
213
|
+
# Example: `Sunny Mansion 203 sub-block: 4`
|
214
|
+
# @return [Float]
|
215
|
+
#
|
216
|
+
# @!attribute [rw] intersection
|
217
|
+
# Name of the streets in the intersection.
|
218
|
+
#
|
219
|
+
# Example: `["Friedrichstraße","Unter den Linden"]`
|
220
|
+
# @return [Array<Float>]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] address_number
|
223
|
+
# The house number or address results should have.
|
224
|
+
# @return [Float]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] building
|
227
|
+
# The name of the building at the address.
|
228
|
+
# @return [Float]
|
229
|
+
#
|
230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AddressComponentMatchScores AWS API Documentation
|
231
|
+
#
|
232
|
+
class AddressComponentMatchScores < Struct.new(
|
233
|
+
:country,
|
234
|
+
:region,
|
235
|
+
:sub_region,
|
236
|
+
:locality,
|
237
|
+
:district,
|
238
|
+
:sub_district,
|
239
|
+
:postal_code,
|
240
|
+
:block,
|
241
|
+
:sub_block,
|
242
|
+
:intersection,
|
243
|
+
:address_number,
|
244
|
+
:building)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
249
|
+
# How to pronounce the various components of the address or place.
|
250
|
+
#
|
251
|
+
# @!attribute [rw] country
|
252
|
+
# The alpha-2 or alpha-3 character code for the country that the
|
253
|
+
# results will be present in.
|
254
|
+
# @return [Array<Types::PhonemeTranscription>]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] region
|
257
|
+
# How to pronounce the region or state results should be to be present
|
258
|
+
# in.
|
259
|
+
# @return [Array<Types::PhonemeTranscription>]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] sub_region
|
262
|
+
# How to pronounce the sub-region or county for which results should
|
263
|
+
# be present in.
|
264
|
+
# @return [Array<Types::PhonemeTranscription>]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] locality
|
267
|
+
# How to pronounce the city or locality results should be present in.
|
268
|
+
#
|
269
|
+
# Example: `Vancouver`.
|
270
|
+
# @return [Array<Types::PhonemeTranscription>]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] district
|
273
|
+
# How to pronounce the district or division of a city results should
|
274
|
+
# be present in.
|
275
|
+
# @return [Array<Types::PhonemeTranscription>]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] sub_district
|
278
|
+
# How to pronounce the sub-district or division of a city results
|
279
|
+
# should be present in.
|
280
|
+
# @return [Array<Types::PhonemeTranscription>]
|
281
|
+
#
|
282
|
+
# @!attribute [rw] block
|
283
|
+
# How to pronounce the name of the block.
|
284
|
+
# @return [Array<Types::PhonemeTranscription>]
|
285
|
+
#
|
286
|
+
# @!attribute [rw] sub_block
|
287
|
+
# How to pronounce the name of the sub-block.
|
288
|
+
# @return [Array<Types::PhonemeTranscription>]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] street
|
291
|
+
# How to pronounce the name of the street results should be present
|
292
|
+
# in.
|
293
|
+
# @return [Array<Types::PhonemeTranscription>]
|
294
|
+
#
|
295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AddressComponentPhonemes AWS API Documentation
|
296
|
+
#
|
297
|
+
class AddressComponentPhonemes < Struct.new(
|
298
|
+
:country,
|
299
|
+
:region,
|
300
|
+
:sub_region,
|
301
|
+
:locality,
|
302
|
+
:district,
|
303
|
+
:sub_district,
|
304
|
+
:block,
|
305
|
+
:sub_block,
|
306
|
+
:street)
|
307
|
+
SENSITIVE = []
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# Describes how the parts of the response element matched the input
|
312
|
+
# query by returning the sections of the response which matched to input
|
313
|
+
# query terms.
|
314
|
+
#
|
315
|
+
# @!attribute [rw] label
|
316
|
+
# Indicates the starting and ending indexes for result items where
|
317
|
+
# they are identified to match the input query. This should be used to
|
318
|
+
# provide emphasis to output display to make selecting the correct
|
319
|
+
# result from a list easier for end users.
|
320
|
+
# @return [Array<Types::Highlight>]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] country
|
323
|
+
# The alpha-2 or alpha-3 character code for the country that the
|
324
|
+
# results will be present in.
|
325
|
+
# @return [Types::CountryHighlights]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] region
|
328
|
+
# The region or state results should be to be present in.
|
329
|
+
#
|
330
|
+
# Example: `North Rhine-Westphalia`.
|
331
|
+
# @return [Types::RegionHighlights]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] sub_region
|
334
|
+
# The sub-region or county for which results should be present in.
|
335
|
+
# @return [Types::SubRegionHighlights]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] locality
|
338
|
+
# The city or locality results should be present in.
|
339
|
+
#
|
340
|
+
# Example: `Vancouver`.
|
341
|
+
# @return [Array<Types::Highlight>]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] district
|
344
|
+
# The district or division of a city the results should be present in.
|
345
|
+
# @return [Array<Types::Highlight>]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] sub_district
|
348
|
+
# Indicates the starting and ending index of the title in the text
|
349
|
+
# query that match the found title.
|
350
|
+
# @return [Array<Types::Highlight>]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] street
|
353
|
+
# The name of the street results should be present in.
|
354
|
+
# @return [Array<Types::Highlight>]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] block
|
357
|
+
# Name of the block. Example: Sunny Mansion 203 block: 2 Chome
|
358
|
+
# @return [Array<Types::Highlight>]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] sub_block
|
361
|
+
# Name of sub-block. Example Sunny Mansion 203 sub-block: 4
|
362
|
+
# @return [Array<Types::Highlight>]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] intersection
|
365
|
+
# Name of the streets in the intersection. For example: e.g.
|
366
|
+
# \["Friedrichstraße","Unter den Linden"\]
|
367
|
+
# @return [Array<Array<Types::Highlight>>]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] postal_code
|
370
|
+
# An alphanumeric string included in a postal address to facilitate
|
371
|
+
# mail sorting, such as post code, postcode, or ZIP code for which the
|
372
|
+
# result should posses.
|
373
|
+
# @return [Array<Types::Highlight>]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] address_number
|
376
|
+
# The house number or address results should have.
|
377
|
+
# @return [Array<Types::Highlight>]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] building
|
380
|
+
# The name of the building at the address.
|
381
|
+
# @return [Array<Types::Highlight>]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteAddressHighlights AWS API Documentation
|
384
|
+
#
|
385
|
+
class AutocompleteAddressHighlights < Struct.new(
|
386
|
+
:label,
|
387
|
+
:country,
|
388
|
+
:region,
|
389
|
+
:sub_region,
|
390
|
+
:locality,
|
391
|
+
:district,
|
392
|
+
:sub_district,
|
393
|
+
:street,
|
394
|
+
:block,
|
395
|
+
:sub_block,
|
396
|
+
:intersection,
|
397
|
+
:postal_code,
|
398
|
+
:address_number,
|
399
|
+
:building)
|
400
|
+
SENSITIVE = []
|
401
|
+
include Aws::Structure
|
402
|
+
end
|
403
|
+
|
404
|
+
# Autocomplete structure which contains a set of inclusion/exclusion
|
405
|
+
# properties that results must posses in order to be returned as a
|
406
|
+
# result.
|
407
|
+
#
|
408
|
+
# @!attribute [rw] bounding_box
|
409
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
410
|
+
# an individual result covers.
|
411
|
+
#
|
412
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
413
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
414
|
+
# lat\}]`
|
415
|
+
# @return [Array<Float>]
|
416
|
+
#
|
417
|
+
# @!attribute [rw] circle
|
418
|
+
# The `Circle` that all results must be in.
|
419
|
+
# @return [Types::FilterCircle]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] include_countries
|
422
|
+
# A list of countries that all results must be in. Countries are
|
423
|
+
# represented by either their alpha-2 or alpha-3 character codes.
|
424
|
+
# @return [Array<String>]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] include_place_types
|
427
|
+
# The included place types.
|
428
|
+
# @return [Array<String>]
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteFilter AWS API Documentation
|
431
|
+
#
|
432
|
+
class AutocompleteFilter < Struct.new(
|
433
|
+
:bounding_box,
|
434
|
+
:circle,
|
435
|
+
:include_countries,
|
436
|
+
:include_place_types)
|
437
|
+
SENSITIVE = [:bounding_box, :circle]
|
438
|
+
include Aws::Structure
|
439
|
+
end
|
440
|
+
|
441
|
+
# Describes how the parts of the response element matched the input
|
442
|
+
# query by returning the sections of the response which matched to input
|
443
|
+
# query terms.
|
444
|
+
#
|
445
|
+
# @!attribute [rw] title
|
446
|
+
# Indicates where the title field in the result matches the input
|
447
|
+
# query.
|
448
|
+
# @return [Array<Types::Highlight>]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] address
|
451
|
+
# Describes how part of the result address match the input query.
|
452
|
+
# @return [Types::AutocompleteAddressHighlights]
|
453
|
+
#
|
454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteHighlights AWS API Documentation
|
455
|
+
#
|
456
|
+
class AutocompleteHighlights < Struct.new(
|
457
|
+
:title,
|
458
|
+
:address)
|
459
|
+
SENSITIVE = []
|
460
|
+
include Aws::Structure
|
461
|
+
end
|
462
|
+
|
463
|
+
# @!attribute [rw] query_text
|
464
|
+
# The free-form text query to match addresses against. This is usually
|
465
|
+
# a partially typed address from an end user in an address box or
|
466
|
+
# form.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] max_results
|
470
|
+
# An optional limit for the number of results returned in a single
|
471
|
+
# call.
|
472
|
+
# @return [Integer]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] bias_position
|
475
|
+
# The position in longitude and latitude that the results should be
|
476
|
+
# close to. Typically, place results returned are ranked higher the
|
477
|
+
# closer they are to this position. Stored in `[lng, lat]` and in the
|
478
|
+
# WSG84 format.
|
479
|
+
#
|
480
|
+
# <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
|
481
|
+
# are mutually exclusive.
|
482
|
+
#
|
483
|
+
# </note>
|
484
|
+
# @return [Array<Float>]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] filter
|
487
|
+
# A structure which contains a set of inclusion/exclusion properties
|
488
|
+
# that results must posses in order to be returned as a result.
|
489
|
+
# @return [Types::AutocompleteFilter]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] postal_code_mode
|
492
|
+
# The `PostalCodeMode` affects how postal code results are returned.
|
493
|
+
# If a postal code spans multiple localities and this value is empty,
|
494
|
+
# partial district or locality information may be returned under a
|
495
|
+
# single postal code result entry. If it's populated with the value
|
496
|
+
# `cityLookup`, all cities in that postal code are returned.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] additional_features
|
500
|
+
# A list of optional additional parameters that can be requested for
|
501
|
+
# each result.
|
502
|
+
# @return [Array<String>]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] language
|
505
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
506
|
+
# rendered in. If there is no data for the result in the requested
|
507
|
+
# language, data will be returned in the default language for the
|
508
|
+
# entry.
|
509
|
+
#
|
510
|
+
#
|
511
|
+
#
|
512
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @!attribute [rw] political_view
|
516
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
517
|
+
# country. The political view applies to the results of the request to
|
518
|
+
# represent unresolved territorial claims through the point of view of
|
519
|
+
# the specified country.
|
520
|
+
# @return [String]
|
521
|
+
#
|
522
|
+
# @!attribute [rw] intended_use
|
523
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
524
|
+
# left empty.
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
|
+
# @!attribute [rw] key
|
528
|
+
# Optional: The API key to be used for authorization. Either an API
|
529
|
+
# key or valid SigV4 signature must be provided when making a request.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteRequest AWS API Documentation
|
533
|
+
#
|
534
|
+
class AutocompleteRequest < Struct.new(
|
535
|
+
:query_text,
|
536
|
+
:max_results,
|
537
|
+
:bias_position,
|
538
|
+
:filter,
|
539
|
+
:postal_code_mode,
|
540
|
+
:additional_features,
|
541
|
+
:language,
|
542
|
+
:political_view,
|
543
|
+
:intended_use,
|
544
|
+
:key)
|
545
|
+
SENSITIVE = [:query_text, :bias_position, :key]
|
546
|
+
include Aws::Structure
|
547
|
+
end
|
548
|
+
|
549
|
+
# @!attribute [rw] pricing_bucket
|
550
|
+
# The pricing bucket for which the query is charged at.
|
551
|
+
#
|
552
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
553
|
+
# Service Pricing][1].
|
554
|
+
#
|
555
|
+
#
|
556
|
+
#
|
557
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] result_items
|
561
|
+
# List of places or results returned for a query.
|
562
|
+
# @return [Array<Types::AutocompleteResultItem>]
|
563
|
+
#
|
564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteResponse AWS API Documentation
|
565
|
+
#
|
566
|
+
class AutocompleteResponse < Struct.new(
|
567
|
+
:pricing_bucket,
|
568
|
+
:result_items)
|
569
|
+
SENSITIVE = []
|
570
|
+
include Aws::Structure
|
571
|
+
end
|
572
|
+
|
573
|
+
# A result matching the input query text.
|
574
|
+
#
|
575
|
+
# @!attribute [rw] place_id
|
576
|
+
# The PlaceId of the place associated with this result. This can be
|
577
|
+
# used to look up additional details about the result via GetPlace.
|
578
|
+
# @return [String]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] place_type
|
581
|
+
# PlaceType describes the type of result entry returned.
|
582
|
+
# @return [String]
|
583
|
+
#
|
584
|
+
# @!attribute [rw] title
|
585
|
+
# A formatted string for display when presenting this result to an end
|
586
|
+
# user.
|
587
|
+
# @return [String]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] address
|
590
|
+
# The address associated with this result.
|
591
|
+
# @return [Types::Address]
|
592
|
+
#
|
593
|
+
# @!attribute [rw] distance
|
594
|
+
# The distance in meters between the center of the search area and
|
595
|
+
# this result. Useful to evaluate how far away from the original bias
|
596
|
+
# position the result is.
|
597
|
+
# @return [Integer]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] language
|
600
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
601
|
+
# rendered in. If there is no data for the result in the requested
|
602
|
+
# language, data will be returned in the default language for the
|
603
|
+
# entry.
|
604
|
+
#
|
605
|
+
#
|
606
|
+
#
|
607
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] political_view
|
611
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
612
|
+
# country. The political view applies to the results of the request to
|
613
|
+
# represent unresolved territorial claims through the point of view of
|
614
|
+
# the specified country.
|
615
|
+
# @return [String]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] highlights
|
618
|
+
# Indicates the starting and ending index of the place in the text
|
619
|
+
# query that match the found title.
|
620
|
+
# @return [Types::AutocompleteHighlights]
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/AutocompleteResultItem AWS API Documentation
|
623
|
+
#
|
624
|
+
class AutocompleteResultItem < Struct.new(
|
625
|
+
:place_id,
|
626
|
+
:place_type,
|
627
|
+
:title,
|
628
|
+
:address,
|
629
|
+
:distance,
|
630
|
+
:language,
|
631
|
+
:political_view,
|
632
|
+
:highlights)
|
633
|
+
SENSITIVE = []
|
634
|
+
include Aws::Structure
|
635
|
+
end
|
636
|
+
|
637
|
+
# A businesschain is a chain of businesses that belong to the same
|
638
|
+
# brand. For example `7-11`.
|
639
|
+
#
|
640
|
+
# @!attribute [rw] name
|
641
|
+
# The business chain name.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] id
|
645
|
+
# The Business Chain Id.
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/BusinessChain AWS API Documentation
|
649
|
+
#
|
650
|
+
class BusinessChain < Struct.new(
|
651
|
+
:name,
|
652
|
+
:id)
|
653
|
+
SENSITIVE = []
|
654
|
+
include Aws::Structure
|
655
|
+
end
|
656
|
+
|
657
|
+
# Category of the `Place` returned.
|
658
|
+
#
|
659
|
+
# @!attribute [rw] id
|
660
|
+
# The category ID.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] name
|
664
|
+
# The category name.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] localized_name
|
668
|
+
# Localized name of the category type.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] primary
|
672
|
+
# Boolean which indicates if this category is the primary offered by
|
673
|
+
# the place.
|
674
|
+
# @return [Boolean]
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Category AWS API Documentation
|
677
|
+
#
|
678
|
+
class Category < Struct.new(
|
679
|
+
:id,
|
680
|
+
:name,
|
681
|
+
:localized_name,
|
682
|
+
:primary)
|
683
|
+
SENSITIVE = []
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
687
|
+
# Indicates how well the input matches the returned element. It is equal
|
688
|
+
# to 1 if all input tokens are recognized and matched to the title in
|
689
|
+
# the result.
|
690
|
+
#
|
691
|
+
# @!attribute [rw] title
|
692
|
+
# Indicates the starting and ending index of the title in the text
|
693
|
+
# query that match the found title.
|
694
|
+
# @return [Float]
|
695
|
+
#
|
696
|
+
# @!attribute [rw] address
|
697
|
+
# The place's address.
|
698
|
+
# @return [Types::AddressComponentMatchScores]
|
699
|
+
#
|
700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ComponentMatchScores AWS API Documentation
|
701
|
+
#
|
702
|
+
class ComponentMatchScores < Struct.new(
|
703
|
+
:title,
|
704
|
+
:address)
|
705
|
+
SENSITIVE = []
|
706
|
+
include Aws::Structure
|
707
|
+
end
|
708
|
+
|
709
|
+
# Details related to contacts.
|
710
|
+
#
|
711
|
+
# @!attribute [rw] label
|
712
|
+
# The contact's label.
|
713
|
+
# @return [String]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] value
|
716
|
+
# The contact's value.
|
717
|
+
# @return [String]
|
718
|
+
#
|
719
|
+
# @!attribute [rw] categories
|
720
|
+
# Categories of results that results must belong too.
|
721
|
+
# @return [Array<Types::Category>]
|
722
|
+
#
|
723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ContactDetails AWS API Documentation
|
724
|
+
#
|
725
|
+
class ContactDetails < Struct.new(
|
726
|
+
:label,
|
727
|
+
:value,
|
728
|
+
:categories)
|
729
|
+
SENSITIVE = []
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
733
|
+
# A list of potential contact methods for the result/place.
|
734
|
+
#
|
735
|
+
# @!attribute [rw] phones
|
736
|
+
# List of phone numbers for the results contact.
|
737
|
+
# @return [Array<Types::ContactDetails>]
|
738
|
+
#
|
739
|
+
# @!attribute [rw] faxes
|
740
|
+
# List of fax addresses for the result contact.
|
741
|
+
# @return [Array<Types::ContactDetails>]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] websites
|
744
|
+
# List of website URLs that belong to the result.
|
745
|
+
# @return [Array<Types::ContactDetails>]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] emails
|
748
|
+
# List of emails for contacts of the result.
|
749
|
+
# @return [Array<Types::ContactDetails>]
|
750
|
+
#
|
751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Contacts AWS API Documentation
|
752
|
+
#
|
753
|
+
class Contacts < Struct.new(
|
754
|
+
:phones,
|
755
|
+
:faxes,
|
756
|
+
:websites,
|
757
|
+
:emails)
|
758
|
+
SENSITIVE = []
|
759
|
+
include Aws::Structure
|
760
|
+
end
|
761
|
+
|
762
|
+
# The alpha-2 or alpha-3 character code for the country that the results
|
763
|
+
# will be present in.
|
764
|
+
#
|
765
|
+
# @!attribute [rw] code_2
|
766
|
+
# Country, represented by its alpha 2-character code.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] code_3
|
770
|
+
# Country, represented by its alpha t-character code.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] name
|
774
|
+
# Name of the country.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Country AWS API Documentation
|
778
|
+
#
|
779
|
+
class Country < Struct.new(
|
780
|
+
:code_2,
|
781
|
+
:code_3,
|
782
|
+
:name)
|
783
|
+
SENSITIVE = []
|
784
|
+
include Aws::Structure
|
785
|
+
end
|
786
|
+
|
787
|
+
# Indicates the starting and ending index of the country in the text
|
788
|
+
# query that match the found title.
|
789
|
+
#
|
790
|
+
# @!attribute [rw] code
|
791
|
+
# Indicates the starting and ending index of the country code in the
|
792
|
+
# text query that match the found title.
|
793
|
+
# @return [Array<Types::Highlight>]
|
794
|
+
#
|
795
|
+
# @!attribute [rw] name
|
796
|
+
# Indicates the starting and ending index of the country code in the
|
797
|
+
# text query that match the found title.
|
798
|
+
# @return [Array<Types::Highlight>]
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/CountryHighlights AWS API Documentation
|
801
|
+
#
|
802
|
+
class CountryHighlights < Struct.new(
|
803
|
+
:code,
|
804
|
+
:name)
|
805
|
+
SENSITIVE = []
|
806
|
+
include Aws::Structure
|
807
|
+
end
|
808
|
+
|
809
|
+
# The `Circle` that all results must be in.
|
810
|
+
#
|
811
|
+
# @!attribute [rw] center
|
812
|
+
# The center position, in longitude and latitude, of the
|
813
|
+
# `FilterCircle`.
|
814
|
+
# @return [Array<Float>]
|
815
|
+
#
|
816
|
+
# @!attribute [rw] radius
|
817
|
+
# The radius, in meters, of the `FilterCircle`.
|
818
|
+
# @return [Integer]
|
819
|
+
#
|
820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/FilterCircle AWS API Documentation
|
821
|
+
#
|
822
|
+
class FilterCircle < Struct.new(
|
823
|
+
:center,
|
824
|
+
:radius)
|
825
|
+
SENSITIVE = [:center]
|
826
|
+
include Aws::Structure
|
827
|
+
end
|
828
|
+
|
829
|
+
# List of `Food` types offered by this result.
|
830
|
+
#
|
831
|
+
# @!attribute [rw] localized_name
|
832
|
+
# Localized name of the food type.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] id
|
836
|
+
# The Food Type Id.
|
837
|
+
# @return [String]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] primary
|
840
|
+
# Boolean which indicates if this food type is the primary offered by
|
841
|
+
# the place. For example, if a location serves fast food, but also
|
842
|
+
# dessert, he primary would likely be fast food.
|
843
|
+
# @return [Boolean]
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/FoodType AWS API Documentation
|
846
|
+
#
|
847
|
+
class FoodType < Struct.new(
|
848
|
+
:localized_name,
|
849
|
+
:id,
|
850
|
+
:primary)
|
851
|
+
SENSITIVE = []
|
852
|
+
include Aws::Structure
|
853
|
+
end
|
854
|
+
|
855
|
+
# Geocode structure which contains a set of inclusion/exclusion
|
856
|
+
# properties that results must posses in order to be returned as a
|
857
|
+
# result.
|
858
|
+
#
|
859
|
+
# @!attribute [rw] include_countries
|
860
|
+
# A list of countries that all results must be in. Countries are
|
861
|
+
# represented by either their alpha-2 or alpha-3 character codes.
|
862
|
+
# @return [Array<String>]
|
863
|
+
#
|
864
|
+
# @!attribute [rw] include_place_types
|
865
|
+
# The included place types.
|
866
|
+
# @return [Array<String>]
|
867
|
+
#
|
868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeFilter AWS API Documentation
|
869
|
+
#
|
870
|
+
class GeocodeFilter < Struct.new(
|
871
|
+
:include_countries,
|
872
|
+
:include_place_types)
|
873
|
+
SENSITIVE = []
|
874
|
+
include Aws::Structure
|
875
|
+
end
|
876
|
+
|
877
|
+
# A structured free text query allows you to search for places by the
|
878
|
+
# name or text representation of specific properties of the place.
|
879
|
+
#
|
880
|
+
# @!attribute [rw] country
|
881
|
+
# The alpha-2 or alpha-3 character code for the country that the
|
882
|
+
# results will be present in.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @!attribute [rw] region
|
886
|
+
# The region or state results should be to be present in.
|
887
|
+
#
|
888
|
+
# Example: `North Rhine-Westphalia`.
|
889
|
+
# @return [String]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] sub_region
|
892
|
+
# The sub-region or county for which results should be present in.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] locality
|
896
|
+
# City or locality results should be present in.
|
897
|
+
#
|
898
|
+
# Example: `Vancouver`.
|
899
|
+
# @return [String]
|
900
|
+
#
|
901
|
+
# @!attribute [rw] district
|
902
|
+
# The district or division of a city the results should be present in.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] street
|
906
|
+
# The name of the street results should be present in.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] address_number
|
910
|
+
# The house number or address results should have.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] postal_code
|
914
|
+
# An alphanumeric string included in a postal address to facilitate
|
915
|
+
# mail sorting, such as post code, postcode, or ZIP code for which the
|
916
|
+
# result should posses.
|
917
|
+
# @return [String]
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeQueryComponents AWS API Documentation
|
920
|
+
#
|
921
|
+
class GeocodeQueryComponents < Struct.new(
|
922
|
+
:country,
|
923
|
+
:region,
|
924
|
+
:sub_region,
|
925
|
+
:locality,
|
926
|
+
:district,
|
927
|
+
:street,
|
928
|
+
:address_number,
|
929
|
+
:postal_code)
|
930
|
+
SENSITIVE = [:country, :region, :sub_region, :locality, :district, :street, :address_number, :postal_code]
|
931
|
+
include Aws::Structure
|
932
|
+
end
|
933
|
+
|
934
|
+
# @!attribute [rw] query_text
|
935
|
+
# The free-form text query to match addresses against. This is usually
|
936
|
+
# a partially typed address from an end user in an address box or
|
937
|
+
# form.
|
938
|
+
# @return [String]
|
939
|
+
#
|
940
|
+
# @!attribute [rw] query_components
|
941
|
+
# A structured free text query allows you to search for places by the
|
942
|
+
# name or text representation of specific properties of the place.
|
943
|
+
# @return [Types::GeocodeQueryComponents]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] max_results
|
946
|
+
# An optional limit for the number of results returned in a single
|
947
|
+
# call.
|
948
|
+
# @return [Integer]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] bias_position
|
951
|
+
# The position, in longitude and latitude, that the results should be
|
952
|
+
# close to. Typically, place results returned are ranked higher the
|
953
|
+
# closer they are to this position. Stored in `[lng, lat]` and in the
|
954
|
+
# WSG84 format.
|
955
|
+
#
|
956
|
+
# <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
|
957
|
+
# are mutually exclusive.
|
958
|
+
#
|
959
|
+
# </note>
|
960
|
+
# @return [Array<Float>]
|
961
|
+
#
|
962
|
+
# @!attribute [rw] filter
|
963
|
+
# A structure which contains a set of inclusion/exclusion properties
|
964
|
+
# that results must posses in order to be returned as a result.
|
965
|
+
# @return [Types::GeocodeFilter]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] additional_features
|
968
|
+
# A list of optional additional parameters, such as time zone, that
|
969
|
+
# can be requested for each result.
|
970
|
+
# @return [Array<String>]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] language
|
973
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
974
|
+
# rendered in. If there is no data for the result in the requested
|
975
|
+
# language, data will be returned in the default language for the
|
976
|
+
# entry.
|
977
|
+
#
|
978
|
+
#
|
979
|
+
#
|
980
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] political_view
|
984
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
985
|
+
# country. The political view applies to the results of the request to
|
986
|
+
# represent unresolved territorial claims through the point of view of
|
987
|
+
# the specified country.
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] intended_use
|
991
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
992
|
+
# left empty.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] key
|
996
|
+
# Optional: The API key to be used for authorization. Either an API
|
997
|
+
# key or valid SigV4 signature must be provided when making a request.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeRequest AWS API Documentation
|
1001
|
+
#
|
1002
|
+
class GeocodeRequest < Struct.new(
|
1003
|
+
:query_text,
|
1004
|
+
:query_components,
|
1005
|
+
:max_results,
|
1006
|
+
:bias_position,
|
1007
|
+
:filter,
|
1008
|
+
:additional_features,
|
1009
|
+
:language,
|
1010
|
+
:political_view,
|
1011
|
+
:intended_use,
|
1012
|
+
:key)
|
1013
|
+
SENSITIVE = [:query_text, :bias_position, :key]
|
1014
|
+
include Aws::Structure
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
# @!attribute [rw] pricing_bucket
|
1018
|
+
# The pricing bucket for which the query is charged at.
|
1019
|
+
#
|
1020
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
1021
|
+
# Service Pricing][1].
|
1022
|
+
#
|
1023
|
+
#
|
1024
|
+
#
|
1025
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1026
|
+
# @return [String]
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] result_items
|
1029
|
+
# List of places or results returned for a query.
|
1030
|
+
# @return [Array<Types::GeocodeResultItem>]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeResponse AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class GeocodeResponse < Struct.new(
|
1035
|
+
:pricing_bucket,
|
1036
|
+
:result_items)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# The Geocoded result.
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] place_id
|
1044
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
1045
|
+
# @return [String]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] place_type
|
1048
|
+
# A `PlaceType` is a category that the result place must belong to.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] title
|
1052
|
+
# The localized display name of this result item based on request
|
1053
|
+
# parameter `language`.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] address
|
1057
|
+
# The place's address.
|
1058
|
+
# @return [Types::Address]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] address_number_corrected
|
1061
|
+
# Boolean indicating if the address provided has been corrected.
|
1062
|
+
# @return [Boolean]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] postal_code_details
|
1065
|
+
# Contains details about the postal code of the place/result.
|
1066
|
+
# @return [Array<Types::PostalCodeDetails>]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] position
|
1069
|
+
# The position in longitude and latitude.
|
1070
|
+
# @return [Array<Float>]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] distance
|
1073
|
+
# The distance in meters from the QueryPosition.
|
1074
|
+
# @return [Integer]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] map_view
|
1077
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1078
|
+
# an individual result covers.
|
1079
|
+
#
|
1080
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
1081
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
1082
|
+
# lat\}]`
|
1083
|
+
# @return [Array<Float>]
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] categories
|
1086
|
+
# Categories of results that results must belong to.
|
1087
|
+
# @return [Array<Types::Category>]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] food_types
|
1090
|
+
# List of food types offered by this result.
|
1091
|
+
# @return [Array<Types::FoodType>]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] access_points
|
1094
|
+
# Position of the access point represent by longitude and latitude.
|
1095
|
+
# @return [Array<Types::AccessPoint>]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] time_zone
|
1098
|
+
# The time zone in which the place is located.
|
1099
|
+
# @return [Types::TimeZone]
|
1100
|
+
#
|
1101
|
+
# @!attribute [rw] political_view
|
1102
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1103
|
+
# country. The political view applies to the results of the request to
|
1104
|
+
# represent unresolved territorial claims through the point of view of
|
1105
|
+
# the specified country.
|
1106
|
+
# @return [String]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] match_scores
|
1109
|
+
# Indicates how well the entire input matches the returned. It is
|
1110
|
+
# equal to 1 if all input tokens are recognized and matched.
|
1111
|
+
# @return [Types::MatchScoreDetails]
|
1112
|
+
#
|
1113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GeocodeResultItem AWS API Documentation
|
1114
|
+
#
|
1115
|
+
class GeocodeResultItem < Struct.new(
|
1116
|
+
:place_id,
|
1117
|
+
:place_type,
|
1118
|
+
:title,
|
1119
|
+
:address,
|
1120
|
+
:address_number_corrected,
|
1121
|
+
:postal_code_details,
|
1122
|
+
:position,
|
1123
|
+
:distance,
|
1124
|
+
:map_view,
|
1125
|
+
:categories,
|
1126
|
+
:food_types,
|
1127
|
+
:access_points,
|
1128
|
+
:time_zone,
|
1129
|
+
:political_view,
|
1130
|
+
:match_scores)
|
1131
|
+
SENSITIVE = [:position, :map_view]
|
1132
|
+
include Aws::Structure
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# @!attribute [rw] place_id
|
1136
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] additional_features
|
1140
|
+
# A list of optional additional parameters such as time zone that can
|
1141
|
+
# be requested for each result.
|
1142
|
+
# @return [Array<String>]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] language
|
1145
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
1146
|
+
# rendered in. If there is no data for the result in the requested
|
1147
|
+
# language, data will be returned in the default language for the
|
1148
|
+
# entry.
|
1149
|
+
#
|
1150
|
+
#
|
1151
|
+
#
|
1152
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
1153
|
+
# @return [String]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] political_view
|
1156
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1157
|
+
# country. The political view applies to the results of the request to
|
1158
|
+
# represent unresolved territorial claims through the point of view of
|
1159
|
+
# the specified country.
|
1160
|
+
# @return [String]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] intended_use
|
1163
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1164
|
+
# left empty.
|
1165
|
+
# @return [String]
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] key
|
1168
|
+
# Optional: The API key to be used for authorization. Either an API
|
1169
|
+
# key or valid SigV4 signature must be provided when making a request.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlaceRequest AWS API Documentation
|
1173
|
+
#
|
1174
|
+
class GetPlaceRequest < Struct.new(
|
1175
|
+
:place_id,
|
1176
|
+
:additional_features,
|
1177
|
+
:language,
|
1178
|
+
:political_view,
|
1179
|
+
:intended_use,
|
1180
|
+
:key)
|
1181
|
+
SENSITIVE = [:place_id, :key]
|
1182
|
+
include Aws::Structure
|
1183
|
+
end
|
1184
|
+
|
1185
|
+
# @!attribute [rw] place_id
|
1186
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
1187
|
+
# @return [String]
|
1188
|
+
#
|
1189
|
+
# @!attribute [rw] place_type
|
1190
|
+
# A `PlaceType` is a category that the result place must belong to.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] title
|
1194
|
+
# The localized display name of this result item based on request
|
1195
|
+
# parameter `language`.
|
1196
|
+
# @return [String]
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] pricing_bucket
|
1199
|
+
# The pricing bucket for which the query is charged at.
|
1200
|
+
#
|
1201
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
1202
|
+
# Service Pricing][1].
|
1203
|
+
#
|
1204
|
+
#
|
1205
|
+
#
|
1206
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1207
|
+
# @return [String]
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] address
|
1210
|
+
# The place's address.
|
1211
|
+
# @return [Types::Address]
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] address_number_corrected
|
1214
|
+
# Boolean indicating if the address provided has been corrected.
|
1215
|
+
# @return [Boolean]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] postal_code_details
|
1218
|
+
# Contains details about the postal code of the place/result.
|
1219
|
+
# @return [Array<Types::PostalCodeDetails>]
|
1220
|
+
#
|
1221
|
+
# @!attribute [rw] position
|
1222
|
+
# The position, in longitude and latitude.
|
1223
|
+
# @return [Array<Float>]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] map_view
|
1226
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1227
|
+
# an individual result covers.
|
1228
|
+
#
|
1229
|
+
# The bounding box formed is defined as a set of four coordinates:
|
1230
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
1231
|
+
# lat\}]`
|
1232
|
+
# @return [Array<Float>]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] categories
|
1235
|
+
# Categories of results that results must belong to.
|
1236
|
+
# @return [Array<Types::Category>]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] food_types
|
1239
|
+
# List of food types offered by this result.
|
1240
|
+
# @return [Array<Types::FoodType>]
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] business_chains
|
1243
|
+
# The Business Chains associated with the place.
|
1244
|
+
# @return [Array<Types::BusinessChain>]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] contacts
|
1247
|
+
# List of potential contact methods for the result/place.
|
1248
|
+
# @return [Types::Contacts]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] opening_hours
|
1251
|
+
# List of opening hours objects.
|
1252
|
+
# @return [Array<Types::OpeningHours>]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] access_points
|
1255
|
+
# Position of the access point in `(lng,lat)`.
|
1256
|
+
# @return [Array<Types::AccessPoint>]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] access_restrictions
|
1259
|
+
# Indicates known access restrictions on a vehicle access point. The
|
1260
|
+
# index correlates to an access point and indicates if access through
|
1261
|
+
# this point has some form of restriction.
|
1262
|
+
# @return [Array<Types::AccessRestriction>]
|
1263
|
+
#
|
1264
|
+
# @!attribute [rw] time_zone
|
1265
|
+
# The time zone in which the place is located.
|
1266
|
+
# @return [Types::TimeZone]
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] political_view
|
1269
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1270
|
+
# country. The political view applies to the results of the request to
|
1271
|
+
# represent unresolved territorial claims through the point of view of
|
1272
|
+
# the specified country.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] phonemes
|
1276
|
+
# How the various components of the result's address are pronounced
|
1277
|
+
# in various languages.
|
1278
|
+
# @return [Types::PhonemeDetails]
|
1279
|
+
#
|
1280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/GetPlaceResponse AWS API Documentation
|
1281
|
+
#
|
1282
|
+
class GetPlaceResponse < Struct.new(
|
1283
|
+
:place_id,
|
1284
|
+
:place_type,
|
1285
|
+
:title,
|
1286
|
+
:pricing_bucket,
|
1287
|
+
:address,
|
1288
|
+
:address_number_corrected,
|
1289
|
+
:postal_code_details,
|
1290
|
+
:position,
|
1291
|
+
:map_view,
|
1292
|
+
:categories,
|
1293
|
+
:food_types,
|
1294
|
+
:business_chains,
|
1295
|
+
:contacts,
|
1296
|
+
:opening_hours,
|
1297
|
+
:access_points,
|
1298
|
+
:access_restrictions,
|
1299
|
+
:time_zone,
|
1300
|
+
:political_view,
|
1301
|
+
:phonemes)
|
1302
|
+
SENSITIVE = [:position, :map_view]
|
1303
|
+
include Aws::Structure
|
1304
|
+
end
|
1305
|
+
|
1306
|
+
# Describes how parts of the result response match the input query.
|
1307
|
+
#
|
1308
|
+
# @!attribute [rw] start_index
|
1309
|
+
# Start index of the highlight.
|
1310
|
+
# @return [Integer]
|
1311
|
+
#
|
1312
|
+
# @!attribute [rw] end_index
|
1313
|
+
# End index of the highlight.
|
1314
|
+
# @return [Integer]
|
1315
|
+
#
|
1316
|
+
# @!attribute [rw] value
|
1317
|
+
# The highlight's value.
|
1318
|
+
# @return [String]
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Highlight AWS API Documentation
|
1321
|
+
#
|
1322
|
+
class Highlight < Struct.new(
|
1323
|
+
:start_index,
|
1324
|
+
:end_index,
|
1325
|
+
:value)
|
1326
|
+
SENSITIVE = []
|
1327
|
+
include Aws::Structure
|
1328
|
+
end
|
1329
|
+
|
1330
|
+
# The request processing has failed because of an unknown error,
|
1331
|
+
# exception or failure.
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] message
|
1334
|
+
# @return [String]
|
1335
|
+
#
|
1336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/InternalServerException AWS API Documentation
|
1337
|
+
#
|
1338
|
+
class InternalServerException < Struct.new(
|
1339
|
+
:message)
|
1340
|
+
SENSITIVE = []
|
1341
|
+
include Aws::Structure
|
1342
|
+
end
|
1343
|
+
|
1344
|
+
# Details related to the match score.
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] overall
|
1347
|
+
# Indicates how well the entire input matches the returned. It is
|
1348
|
+
# equal to 1 if all input tokens are recognized and matched.
|
1349
|
+
# @return [Float]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] components
|
1352
|
+
# Indicates how well the component input matches the returned. It is
|
1353
|
+
# equal to 1 if all input tokens are recognized and matched.
|
1354
|
+
# @return [Types::ComponentMatchScores]
|
1355
|
+
#
|
1356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/MatchScoreDetails AWS API Documentation
|
1357
|
+
#
|
1358
|
+
class MatchScoreDetails < Struct.new(
|
1359
|
+
:overall,
|
1360
|
+
:components)
|
1361
|
+
SENSITIVE = []
|
1362
|
+
include Aws::Structure
|
1363
|
+
end
|
1364
|
+
|
1365
|
+
# List of opening hours objects.
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] display
|
1368
|
+
# List of opening hours in the format they are displayed in. This can
|
1369
|
+
# vary by result and in most cases represents how the result uniquely
|
1370
|
+
# formats their opening hours.
|
1371
|
+
# @return [Array<String>]
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] open_now
|
1374
|
+
# Boolean which indicates if the result/place is currently open.
|
1375
|
+
# @return [Boolean]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] components
|
1378
|
+
# Components of the opening hours object.
|
1379
|
+
# @return [Array<Types::OpeningHoursComponents>]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] categories
|
1382
|
+
# Categories of results that results must belong too.
|
1383
|
+
# @return [Array<Types::Category>]
|
1384
|
+
#
|
1385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/OpeningHours AWS API Documentation
|
1386
|
+
#
|
1387
|
+
class OpeningHours < Struct.new(
|
1388
|
+
:display,
|
1389
|
+
:open_now,
|
1390
|
+
:components,
|
1391
|
+
:categories)
|
1392
|
+
SENSITIVE = []
|
1393
|
+
include Aws::Structure
|
1394
|
+
end
|
1395
|
+
|
1396
|
+
# Components of the opening hours object.
|
1397
|
+
#
|
1398
|
+
# @!attribute [rw] open_time
|
1399
|
+
# String which represents the opening hours, such as `"T070000"`.
|
1400
|
+
# @return [String]
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] open_duration
|
1403
|
+
# String which represents the duration of the opening period, such as
|
1404
|
+
# `"PT12H00M"`.
|
1405
|
+
# @return [String]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] recurrence
|
1408
|
+
# Days or periods when the provided opening hours are in affect.
|
1409
|
+
#
|
1410
|
+
# Example: `FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU`
|
1411
|
+
# @return [String]
|
1412
|
+
#
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/OpeningHoursComponents AWS API Documentation
|
1414
|
+
#
|
1415
|
+
class OpeningHoursComponents < Struct.new(
|
1416
|
+
:open_time,
|
1417
|
+
:open_duration,
|
1418
|
+
:recurrence)
|
1419
|
+
SENSITIVE = []
|
1420
|
+
include Aws::Structure
|
1421
|
+
end
|
1422
|
+
|
1423
|
+
# The phoneme details.
|
1424
|
+
#
|
1425
|
+
# @!attribute [rw] title
|
1426
|
+
# List of `PhonemeTranscription`. See `PhonemeTranscription` for
|
1427
|
+
# fields.
|
1428
|
+
# @return [Array<Types::PhonemeTranscription>]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] address
|
1431
|
+
# How to pronounce the address.
|
1432
|
+
# @return [Types::AddressComponentPhonemes]
|
1433
|
+
#
|
1434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/PhonemeDetails AWS API Documentation
|
1435
|
+
#
|
1436
|
+
class PhonemeDetails < Struct.new(
|
1437
|
+
:title,
|
1438
|
+
:address)
|
1439
|
+
SENSITIVE = []
|
1440
|
+
include Aws::Structure
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# How to pronounce the various components of the address or place.
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] value
|
1446
|
+
# Value which indicates how to pronounce the value.
|
1447
|
+
# @return [String]
|
1448
|
+
#
|
1449
|
+
# @!attribute [rw] language
|
1450
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
1451
|
+
# rendered in. If there is no data for the result in the requested
|
1452
|
+
# language, data will be returned in the default language for the
|
1453
|
+
# entry.
|
1454
|
+
#
|
1455
|
+
#
|
1456
|
+
#
|
1457
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] preferred
|
1461
|
+
# Boolean which indicates if it the preferred pronunciation.
|
1462
|
+
# @return [Boolean]
|
1463
|
+
#
|
1464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/PhonemeTranscription AWS API Documentation
|
1465
|
+
#
|
1466
|
+
class PhonemeTranscription < Struct.new(
|
1467
|
+
:value,
|
1468
|
+
:language,
|
1469
|
+
:preferred)
|
1470
|
+
SENSITIVE = []
|
1471
|
+
include Aws::Structure
|
1472
|
+
end
|
1473
|
+
|
1474
|
+
# Contains details about the postal code of the place or result.
|
1475
|
+
#
|
1476
|
+
# @!attribute [rw] postal_code
|
1477
|
+
# An alphanumeric string included in a postal address to facilitate
|
1478
|
+
# mail sorting, such as post code, postcode, or ZIP code for which the
|
1479
|
+
# result should posses.
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @!attribute [rw] postal_authority
|
1483
|
+
# The postal authority or entity. This could be a governmental
|
1484
|
+
# authority, a regulatory authority, or a designated postal operator.
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @!attribute [rw] postal_code_type
|
1488
|
+
# The postal code type.
|
1489
|
+
# @return [String]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] usps_zip
|
1492
|
+
# The ZIP Classification Code, or in other words what type of postal
|
1493
|
+
# code is it.
|
1494
|
+
# @return [Types::UspsZip]
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] usps_zip_plus_4
|
1497
|
+
# The USPS ZIP+4 Record Type Code.
|
1498
|
+
# @return [Types::UspsZipPlus4]
|
1499
|
+
#
|
1500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/PostalCodeDetails AWS API Documentation
|
1501
|
+
#
|
1502
|
+
class PostalCodeDetails < Struct.new(
|
1503
|
+
:postal_code,
|
1504
|
+
:postal_authority,
|
1505
|
+
:postal_code_type,
|
1506
|
+
:usps_zip,
|
1507
|
+
:usps_zip_plus_4)
|
1508
|
+
SENSITIVE = []
|
1509
|
+
include Aws::Structure
|
1510
|
+
end
|
1511
|
+
|
1512
|
+
# Suggestions for refining individual query terms. Suggestions are
|
1513
|
+
# returned as objects which note the term, suggested replacement, and
|
1514
|
+
# its index in the query.
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] refined_term
|
1517
|
+
# The term that will be suggested to the user.
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] original_term
|
1521
|
+
# The sub-string of the original query that is replaced by this query
|
1522
|
+
# term.
|
1523
|
+
# @return [String]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] start_index
|
1526
|
+
# Start index of the parsed component.
|
1527
|
+
# @return [Integer]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] end_index
|
1530
|
+
# End index of the parsed query.
|
1531
|
+
# @return [Integer]
|
1532
|
+
#
|
1533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/QueryRefinement AWS API Documentation
|
1534
|
+
#
|
1535
|
+
class QueryRefinement < Struct.new(
|
1536
|
+
:refined_term,
|
1537
|
+
:original_term,
|
1538
|
+
:start_index,
|
1539
|
+
:end_index)
|
1540
|
+
SENSITIVE = []
|
1541
|
+
include Aws::Structure
|
1542
|
+
end
|
1543
|
+
|
1544
|
+
# The region or state results should be to be present in.
|
1545
|
+
#
|
1546
|
+
# Example: `North Rhine-Westphalia`.
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] code
|
1549
|
+
# Abbreviated code for a the state, province or region of the country.
|
1550
|
+
#
|
1551
|
+
# Example: `BC`.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] name
|
1555
|
+
# Name for a the state, province, or region of the country.
|
1556
|
+
#
|
1557
|
+
# Example: `British Columbia`.
|
1558
|
+
# @return [String]
|
1559
|
+
#
|
1560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/Region AWS API Documentation
|
1561
|
+
#
|
1562
|
+
class Region < Struct.new(
|
1563
|
+
:code,
|
1564
|
+
:name)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# Indicates the starting and ending index of the region in the text
|
1570
|
+
# query that match the found title.
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] code
|
1573
|
+
# Indicates the starting and ending index of the region in the text
|
1574
|
+
# query that match the found title.
|
1575
|
+
# @return [Array<Types::Highlight>]
|
1576
|
+
#
|
1577
|
+
# @!attribute [rw] name
|
1578
|
+
# Indicates the starting and ending index of the region name in the
|
1579
|
+
# text query that match the found title.
|
1580
|
+
# @return [Array<Types::Highlight>]
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/RegionHighlights AWS API Documentation
|
1583
|
+
#
|
1584
|
+
class RegionHighlights < Struct.new(
|
1585
|
+
:code,
|
1586
|
+
:name)
|
1587
|
+
SENSITIVE = []
|
1588
|
+
include Aws::Structure
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# The included place types.
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] include_place_types
|
1594
|
+
# The included place types.
|
1595
|
+
# @return [Array<String>]
|
1596
|
+
#
|
1597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeFilter AWS API Documentation
|
1598
|
+
#
|
1599
|
+
class ReverseGeocodeFilter < Struct.new(
|
1600
|
+
:include_place_types)
|
1601
|
+
SENSITIVE = []
|
1602
|
+
include Aws::Structure
|
1603
|
+
end
|
1604
|
+
|
1605
|
+
# @!attribute [rw] query_position
|
1606
|
+
# The position, in `[lng, lat]` for which you are querying nearby
|
1607
|
+
# resultsfor. Results closer to the position will be ranked higher
|
1608
|
+
# then results further away from the position
|
1609
|
+
# @return [Array<Float>]
|
1610
|
+
#
|
1611
|
+
# @!attribute [rw] query_radius
|
1612
|
+
# The maximum distance in meters from the QueryPosition from which a
|
1613
|
+
# result will be returned.
|
1614
|
+
# @return [Integer]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] max_results
|
1617
|
+
# An optional limit for the number of results returned in a single
|
1618
|
+
# call.
|
1619
|
+
# @return [Integer]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] filter
|
1622
|
+
# A structure which contains a set of inclusion/exclusion properties
|
1623
|
+
# that results must posses in order to be returned as a result.
|
1624
|
+
# @return [Types::ReverseGeocodeFilter]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] additional_features
|
1627
|
+
# A list of optional additional parameters, such as time zone that can
|
1628
|
+
# be requested for each result.
|
1629
|
+
# @return [Array<String>]
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] language
|
1632
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
1633
|
+
# rendered in. If there is no data for the result in the requested
|
1634
|
+
# language, data will be returned in the default language for the
|
1635
|
+
# entry.
|
1636
|
+
#
|
1637
|
+
#
|
1638
|
+
#
|
1639
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
1640
|
+
# @return [String]
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] political_view
|
1643
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1644
|
+
# country. The political view applies to the results of the request to
|
1645
|
+
# represent unresolved territorial claims through the point of view of
|
1646
|
+
# the specified country.
|
1647
|
+
# @return [String]
|
1648
|
+
#
|
1649
|
+
# @!attribute [rw] intended_use
|
1650
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1651
|
+
# left empty.
|
1652
|
+
# @return [String]
|
1653
|
+
#
|
1654
|
+
# @!attribute [rw] key
|
1655
|
+
# Optional: The API key to be used for authorization. Either an API
|
1656
|
+
# key or valid SigV4 signature must be provided when making a request.
|
1657
|
+
# @return [String]
|
1658
|
+
#
|
1659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeRequest AWS API Documentation
|
1660
|
+
#
|
1661
|
+
class ReverseGeocodeRequest < Struct.new(
|
1662
|
+
:query_position,
|
1663
|
+
:query_radius,
|
1664
|
+
:max_results,
|
1665
|
+
:filter,
|
1666
|
+
:additional_features,
|
1667
|
+
:language,
|
1668
|
+
:political_view,
|
1669
|
+
:intended_use,
|
1670
|
+
:key)
|
1671
|
+
SENSITIVE = [:query_position, :key]
|
1672
|
+
include Aws::Structure
|
1673
|
+
end
|
1674
|
+
|
1675
|
+
# @!attribute [rw] pricing_bucket
|
1676
|
+
# The pricing bucket for which the query is charged at.
|
1677
|
+
#
|
1678
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
1679
|
+
# Service Pricing][1].
|
1680
|
+
#
|
1681
|
+
#
|
1682
|
+
#
|
1683
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1684
|
+
# @return [String]
|
1685
|
+
#
|
1686
|
+
# @!attribute [rw] result_items
|
1687
|
+
# List of places or results returned for a query.
|
1688
|
+
# @return [Array<Types::ReverseGeocodeResultItem>]
|
1689
|
+
#
|
1690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeResponse AWS API Documentation
|
1691
|
+
#
|
1692
|
+
class ReverseGeocodeResponse < Struct.new(
|
1693
|
+
:pricing_bucket,
|
1694
|
+
:result_items)
|
1695
|
+
SENSITIVE = []
|
1696
|
+
include Aws::Structure
|
1697
|
+
end
|
1698
|
+
|
1699
|
+
# The returned location from the `Reverse Geocode` action.
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] place_id
|
1702
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
1703
|
+
# @return [String]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] place_type
|
1706
|
+
# A `PlaceType` is a category that the result place must belong to.
|
1707
|
+
# @return [String]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] title
|
1710
|
+
# The localized display name of this result item based on request
|
1711
|
+
# parameter `language`.
|
1712
|
+
# @return [String]
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] address
|
1715
|
+
# The place's address.
|
1716
|
+
# @return [Types::Address]
|
1717
|
+
#
|
1718
|
+
# @!attribute [rw] address_number_corrected
|
1719
|
+
# Boolean indicating if the address provided has been corrected.
|
1720
|
+
# @return [Boolean]
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] postal_code_details
|
1723
|
+
# Contains details about the postal code of the place/result.
|
1724
|
+
# @return [Array<Types::PostalCodeDetails>]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] position
|
1727
|
+
# The position in longitude and latitude.
|
1728
|
+
# @return [Array<Float>]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] distance
|
1731
|
+
# The distance in meters from the QueryPosition.
|
1732
|
+
# @return [Integer]
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] map_view
|
1735
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1736
|
+
# an individual result covers.
|
1737
|
+
#
|
1738
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
1739
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
1740
|
+
# lat\}]`
|
1741
|
+
# @return [Array<Float>]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] categories
|
1744
|
+
# Categories of results that results must belong to.
|
1745
|
+
# @return [Array<Types::Category>]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] food_types
|
1748
|
+
# List of food types offered by this result.
|
1749
|
+
# @return [Array<Types::FoodType>]
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] access_points
|
1752
|
+
# Position of the access point represent by longitude and latitude.
|
1753
|
+
# @return [Array<Types::AccessPoint>]
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] time_zone
|
1756
|
+
# The time zone in which the place is located.
|
1757
|
+
# @return [Types::TimeZone]
|
1758
|
+
#
|
1759
|
+
# @!attribute [rw] political_view
|
1760
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1761
|
+
# country. The political view applies to the results of the request to
|
1762
|
+
# represent unresolved territorial claims through the point of view of
|
1763
|
+
# the specified country.
|
1764
|
+
# @return [String]
|
1765
|
+
#
|
1766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ReverseGeocodeResultItem AWS API Documentation
|
1767
|
+
#
|
1768
|
+
class ReverseGeocodeResultItem < Struct.new(
|
1769
|
+
:place_id,
|
1770
|
+
:place_type,
|
1771
|
+
:title,
|
1772
|
+
:address,
|
1773
|
+
:address_number_corrected,
|
1774
|
+
:postal_code_details,
|
1775
|
+
:position,
|
1776
|
+
:distance,
|
1777
|
+
:map_view,
|
1778
|
+
:categories,
|
1779
|
+
:food_types,
|
1780
|
+
:access_points,
|
1781
|
+
:time_zone,
|
1782
|
+
:political_view)
|
1783
|
+
SENSITIVE = [:position, :map_view]
|
1784
|
+
include Aws::Structure
|
1785
|
+
end
|
1786
|
+
|
1787
|
+
# SearchNearby structure which contains a set of inclusion/exclusion
|
1788
|
+
# properties that results must posses in order to be returned as a
|
1789
|
+
# result.
|
1790
|
+
#
|
1791
|
+
# @!attribute [rw] bounding_box
|
1792
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1793
|
+
# an individual result covers.
|
1794
|
+
#
|
1795
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
1796
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
1797
|
+
# lat\}]`
|
1798
|
+
# @return [Array<Float>]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] include_countries
|
1801
|
+
# A list of countries that all results must be in. Countries are
|
1802
|
+
# represented by either their alpha-2 or alpha-3 character codes.
|
1803
|
+
# @return [Array<String>]
|
1804
|
+
#
|
1805
|
+
# @!attribute [rw] include_categories
|
1806
|
+
# Categories of results that results must belong too.
|
1807
|
+
# @return [Array<String>]
|
1808
|
+
#
|
1809
|
+
# @!attribute [rw] exclude_categories
|
1810
|
+
# Categories of results that results are excluded from.
|
1811
|
+
# @return [Array<String>]
|
1812
|
+
#
|
1813
|
+
# @!attribute [rw] include_business_chains
|
1814
|
+
# The Business Chains associated with the place.
|
1815
|
+
# @return [Array<String>]
|
1816
|
+
#
|
1817
|
+
# @!attribute [rw] exclude_business_chains
|
1818
|
+
# The Business Chains associated with the place.
|
1819
|
+
# @return [Array<String>]
|
1820
|
+
#
|
1821
|
+
# @!attribute [rw] include_food_types
|
1822
|
+
# Food types that results are included from.
|
1823
|
+
# @return [Array<String>]
|
1824
|
+
#
|
1825
|
+
# @!attribute [rw] exclude_food_types
|
1826
|
+
# Food types that results are excluded from.
|
1827
|
+
# @return [Array<String>]
|
1828
|
+
#
|
1829
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchNearbyFilter AWS API Documentation
|
1830
|
+
#
|
1831
|
+
class SearchNearbyFilter < Struct.new(
|
1832
|
+
:bounding_box,
|
1833
|
+
:include_countries,
|
1834
|
+
:include_categories,
|
1835
|
+
:exclude_categories,
|
1836
|
+
:include_business_chains,
|
1837
|
+
:exclude_business_chains,
|
1838
|
+
:include_food_types,
|
1839
|
+
:exclude_food_types)
|
1840
|
+
SENSITIVE = [:bounding_box]
|
1841
|
+
include Aws::Structure
|
1842
|
+
end
|
1843
|
+
|
1844
|
+
# @!attribute [rw] query_position
|
1845
|
+
# The position, in `[lng, lat]` for which you are querying nearby
|
1846
|
+
# resultsfor. Results closer to the position will be ranked higher
|
1847
|
+
# then results further away from the position
|
1848
|
+
# @return [Array<Float>]
|
1849
|
+
#
|
1850
|
+
# @!attribute [rw] query_radius
|
1851
|
+
# The maximum distance in meters from the QueryPosition from which a
|
1852
|
+
# result will be returned.
|
1853
|
+
# @return [Integer]
|
1854
|
+
#
|
1855
|
+
# @!attribute [rw] max_results
|
1856
|
+
# An optional limit for the number of results returned in a single
|
1857
|
+
# call.
|
1858
|
+
# @return [Integer]
|
1859
|
+
#
|
1860
|
+
# @!attribute [rw] filter
|
1861
|
+
# A structure which contains a set of inclusion/exclusion properties
|
1862
|
+
# that results must posses in order to be returned as a result.
|
1863
|
+
# @return [Types::SearchNearbyFilter]
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] additional_features
|
1866
|
+
# A list of optional additional parameters, such as time zone, that
|
1867
|
+
# can be requested for each result.
|
1868
|
+
# @return [Array<String>]
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] language
|
1871
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
1872
|
+
# rendered in. If there is no data for the result in the requested
|
1873
|
+
# language, data will be returned in the default language for the
|
1874
|
+
# entry.
|
1875
|
+
#
|
1876
|
+
#
|
1877
|
+
#
|
1878
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] political_view
|
1882
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
1883
|
+
# country. The political view applies to the results of the request to
|
1884
|
+
# represent unresolved territorial claims through the point of view of
|
1885
|
+
# the specified country.
|
1886
|
+
# @return [String]
|
1887
|
+
#
|
1888
|
+
# @!attribute [rw] intended_use
|
1889
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
1890
|
+
# left empty.
|
1891
|
+
# @return [String]
|
1892
|
+
#
|
1893
|
+
# @!attribute [rw] next_token
|
1894
|
+
# If `nextToken` is returned, there are more results available. The
|
1895
|
+
# value of `nextToken` is a unique pagination token for each page.
|
1896
|
+
# @return [String]
|
1897
|
+
#
|
1898
|
+
# @!attribute [rw] key
|
1899
|
+
# Optional: The API key to be used for authorization. Either an API
|
1900
|
+
# key or valid SigV4 signature must be provided when making a request.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchNearbyRequest AWS API Documentation
|
1904
|
+
#
|
1905
|
+
class SearchNearbyRequest < Struct.new(
|
1906
|
+
:query_position,
|
1907
|
+
:query_radius,
|
1908
|
+
:max_results,
|
1909
|
+
:filter,
|
1910
|
+
:additional_features,
|
1911
|
+
:language,
|
1912
|
+
:political_view,
|
1913
|
+
:intended_use,
|
1914
|
+
:next_token,
|
1915
|
+
:key)
|
1916
|
+
SENSITIVE = [:query_position, :key]
|
1917
|
+
include Aws::Structure
|
1918
|
+
end
|
1919
|
+
|
1920
|
+
# @!attribute [rw] pricing_bucket
|
1921
|
+
# The pricing bucket for which the query is charged at.
|
1922
|
+
#
|
1923
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
1924
|
+
# Service Pricing][1].
|
1925
|
+
#
|
1926
|
+
#
|
1927
|
+
#
|
1928
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
1929
|
+
# @return [String]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] result_items
|
1932
|
+
# List of places or results returned for a query.
|
1933
|
+
# @return [Array<Types::SearchNearbyResultItem>]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] next_token
|
1936
|
+
# If `nextToken` is returned, there are more results available. The
|
1937
|
+
# value of `nextToken` is a unique pagination token for each page.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchNearbyResponse AWS API Documentation
|
1941
|
+
#
|
1942
|
+
class SearchNearbyResponse < Struct.new(
|
1943
|
+
:pricing_bucket,
|
1944
|
+
:result_items,
|
1945
|
+
:next_token)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# The search results of nearby places.
|
1951
|
+
#
|
1952
|
+
# @!attribute [rw] place_id
|
1953
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
1954
|
+
# @return [String]
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] place_type
|
1957
|
+
# A `PlaceType` is a category that the result place must belong to.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] title
|
1961
|
+
# The item's title.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] address
|
1965
|
+
# The place's address.
|
1966
|
+
# @return [Types::Address]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] address_number_corrected
|
1969
|
+
# Boolean indicating if the address provided has been corrected.
|
1970
|
+
# @return [Boolean]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] position
|
1973
|
+
# The position in longitude and latitude.
|
1974
|
+
# @return [Array<Float>]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] distance
|
1977
|
+
# The distance in meters from the QueryPosition.
|
1978
|
+
# @return [Integer]
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] map_view
|
1981
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
1982
|
+
# an individual result covers.
|
1983
|
+
#
|
1984
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
1985
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
1986
|
+
# lat\}]`
|
1987
|
+
# @return [Array<Float>]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] categories
|
1990
|
+
# Categories of results that results must belong to.
|
1991
|
+
# @return [Array<Types::Category>]
|
1992
|
+
#
|
1993
|
+
# @!attribute [rw] food_types
|
1994
|
+
# List of food types offered by this result.
|
1995
|
+
# @return [Array<Types::FoodType>]
|
1996
|
+
#
|
1997
|
+
# @!attribute [rw] business_chains
|
1998
|
+
# The Business Chains associated with the place.
|
1999
|
+
# @return [Array<Types::BusinessChain>]
|
2000
|
+
#
|
2001
|
+
# @!attribute [rw] contacts
|
2002
|
+
# List of potential contact methods for the result/place.
|
2003
|
+
# @return [Types::Contacts]
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] opening_hours
|
2006
|
+
# List of opening hours objects.
|
2007
|
+
# @return [Array<Types::OpeningHours>]
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] access_points
|
2010
|
+
# Position of the access point represent by longitude and latitude.
|
2011
|
+
# @return [Array<Types::AccessPoint>]
|
2012
|
+
#
|
2013
|
+
# @!attribute [rw] access_restrictions
|
2014
|
+
# Indicates known access restrictions on a vehicle access point. The
|
2015
|
+
# index correlates to an access point and indicates if access through
|
2016
|
+
# this point has some form of restriction.
|
2017
|
+
# @return [Array<Types::AccessRestriction>]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] time_zone
|
2020
|
+
# The time zone in which the place is located.
|
2021
|
+
# @return [Types::TimeZone]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] political_view
|
2024
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
2025
|
+
# country. The political view applies to the results of the request to
|
2026
|
+
# represent unresolved territorial claims through the point of view of
|
2027
|
+
# the specified country.
|
2028
|
+
# @return [String]
|
2029
|
+
#
|
2030
|
+
# @!attribute [rw] phonemes
|
2031
|
+
# How the various components of the result's address are pronounced
|
2032
|
+
# in various languages.
|
2033
|
+
# @return [Types::PhonemeDetails]
|
2034
|
+
#
|
2035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchNearbyResultItem AWS API Documentation
|
2036
|
+
#
|
2037
|
+
class SearchNearbyResultItem < Struct.new(
|
2038
|
+
:place_id,
|
2039
|
+
:place_type,
|
2040
|
+
:title,
|
2041
|
+
:address,
|
2042
|
+
:address_number_corrected,
|
2043
|
+
:position,
|
2044
|
+
:distance,
|
2045
|
+
:map_view,
|
2046
|
+
:categories,
|
2047
|
+
:food_types,
|
2048
|
+
:business_chains,
|
2049
|
+
:contacts,
|
2050
|
+
:opening_hours,
|
2051
|
+
:access_points,
|
2052
|
+
:access_restrictions,
|
2053
|
+
:time_zone,
|
2054
|
+
:political_view,
|
2055
|
+
:phonemes)
|
2056
|
+
SENSITIVE = [:position, :map_view]
|
2057
|
+
include Aws::Structure
|
2058
|
+
end
|
2059
|
+
|
2060
|
+
# SearchText structure which contains a set of inclusion/exclusion
|
2061
|
+
# properties that results must posses in order to be returned as a
|
2062
|
+
# result.
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] bounding_box
|
2065
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
2066
|
+
# an individual result covers.
|
2067
|
+
#
|
2068
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
2069
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
2070
|
+
# lat\}]`
|
2071
|
+
# @return [Array<Float>]
|
2072
|
+
#
|
2073
|
+
# @!attribute [rw] circle
|
2074
|
+
# The `Circle` that all results must be in.
|
2075
|
+
# @return [Types::FilterCircle]
|
2076
|
+
#
|
2077
|
+
# @!attribute [rw] include_countries
|
2078
|
+
# A list of countries that all results must be in. Countries are
|
2079
|
+
# represented by either their alpha-2 or alpha-3 character codes.
|
2080
|
+
# @return [Array<String>]
|
2081
|
+
#
|
2082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchTextFilter AWS API Documentation
|
2083
|
+
#
|
2084
|
+
class SearchTextFilter < Struct.new(
|
2085
|
+
:bounding_box,
|
2086
|
+
:circle,
|
2087
|
+
:include_countries)
|
2088
|
+
SENSITIVE = [:bounding_box, :circle]
|
2089
|
+
include Aws::Structure
|
2090
|
+
end
|
2091
|
+
|
2092
|
+
# @!attribute [rw] query_text
|
2093
|
+
# The free-form text query to match addresses against. This is usually
|
2094
|
+
# a partially typed address from an end user in an address box or
|
2095
|
+
# form.
|
2096
|
+
# @return [String]
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] query_id
|
2099
|
+
# The query Id.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] max_results
|
2103
|
+
# An optional limit for the number of results returned in a single
|
2104
|
+
# call.
|
2105
|
+
# @return [Integer]
|
2106
|
+
#
|
2107
|
+
# @!attribute [rw] bias_position
|
2108
|
+
# The position, in longitude and latitude, that the results should be
|
2109
|
+
# close to. Typically, place results returned are ranked higher the
|
2110
|
+
# closer they are to this position. Stored in `[lng, lat]` and in the
|
2111
|
+
# WSG84 format.
|
2112
|
+
#
|
2113
|
+
# <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
|
2114
|
+
# are mutually exclusive.
|
2115
|
+
#
|
2116
|
+
# </note>
|
2117
|
+
# @return [Array<Float>]
|
2118
|
+
#
|
2119
|
+
# @!attribute [rw] filter
|
2120
|
+
# A structure which contains a set of inclusion/exclusion properties
|
2121
|
+
# that results must posses in order to be returned as a result.
|
2122
|
+
# @return [Types::SearchTextFilter]
|
2123
|
+
#
|
2124
|
+
# @!attribute [rw] additional_features
|
2125
|
+
# A list of optional additional parameters, such as time zone, that
|
2126
|
+
# can be requested for each result.
|
2127
|
+
# @return [Array<String>]
|
2128
|
+
#
|
2129
|
+
# @!attribute [rw] language
|
2130
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
2131
|
+
# rendered in. If there is no data for the result in the requested
|
2132
|
+
# language, data will be returned in the default language for the
|
2133
|
+
# entry.
|
2134
|
+
#
|
2135
|
+
#
|
2136
|
+
#
|
2137
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
2138
|
+
# @return [String]
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] political_view
|
2141
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
2142
|
+
# country. The political view applies to the results of the request to
|
2143
|
+
# represent unresolved territorial claims through the point of view of
|
2144
|
+
# the specified country.
|
2145
|
+
# @return [String]
|
2146
|
+
#
|
2147
|
+
# @!attribute [rw] intended_use
|
2148
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
2149
|
+
# left empty.
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
2152
|
+
# @!attribute [rw] next_token
|
2153
|
+
# If `nextToken` is returned, there are more results available. The
|
2154
|
+
# value of `nextToken` is a unique pagination token for each page.
|
2155
|
+
# @return [String]
|
2156
|
+
#
|
2157
|
+
# @!attribute [rw] key
|
2158
|
+
# Optional: The API key to be used for authorization. Either an API
|
2159
|
+
# key or valid SigV4 signature must be provided when making a request.
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchTextRequest AWS API Documentation
|
2163
|
+
#
|
2164
|
+
class SearchTextRequest < Struct.new(
|
2165
|
+
:query_text,
|
2166
|
+
:query_id,
|
2167
|
+
:max_results,
|
2168
|
+
:bias_position,
|
2169
|
+
:filter,
|
2170
|
+
:additional_features,
|
2171
|
+
:language,
|
2172
|
+
:political_view,
|
2173
|
+
:intended_use,
|
2174
|
+
:next_token,
|
2175
|
+
:key)
|
2176
|
+
SENSITIVE = [:query_text, :query_id, :bias_position, :key]
|
2177
|
+
include Aws::Structure
|
2178
|
+
end
|
2179
|
+
|
2180
|
+
# @!attribute [rw] pricing_bucket
|
2181
|
+
# The pricing bucket for which the query is charged at.
|
2182
|
+
#
|
2183
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
2184
|
+
# Service Pricing][1].
|
2185
|
+
#
|
2186
|
+
#
|
2187
|
+
#
|
2188
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
2189
|
+
# @return [String]
|
2190
|
+
#
|
2191
|
+
# @!attribute [rw] result_items
|
2192
|
+
# List of places or results returned for a query.
|
2193
|
+
# @return [Array<Types::SearchTextResultItem>]
|
2194
|
+
#
|
2195
|
+
# @!attribute [rw] next_token
|
2196
|
+
# If `nextToken` is returned, there are more results available. The
|
2197
|
+
# value of `nextToken` is a unique pagination token for each page.
|
2198
|
+
# @return [String]
|
2199
|
+
#
|
2200
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchTextResponse AWS API Documentation
|
2201
|
+
#
|
2202
|
+
class SearchTextResponse < Struct.new(
|
2203
|
+
:pricing_bucket,
|
2204
|
+
:result_items,
|
2205
|
+
:next_token)
|
2206
|
+
SENSITIVE = []
|
2207
|
+
include Aws::Structure
|
2208
|
+
end
|
2209
|
+
|
2210
|
+
# The text search result.
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] place_id
|
2213
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] place_type
|
2217
|
+
# A `PlaceType` is a category that the result place must belong to.
|
2218
|
+
# @return [String]
|
2219
|
+
#
|
2220
|
+
# @!attribute [rw] title
|
2221
|
+
# The item's title.
|
2222
|
+
# @return [String]
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] address
|
2225
|
+
# The place's address.
|
2226
|
+
# @return [Types::Address]
|
2227
|
+
#
|
2228
|
+
# @!attribute [rw] address_number_corrected
|
2229
|
+
# Boolean indicating if the address provided has been corrected.
|
2230
|
+
# @return [Boolean]
|
2231
|
+
#
|
2232
|
+
# @!attribute [rw] position
|
2233
|
+
# The position, in longitude and latitude.
|
2234
|
+
# @return [Array<Float>]
|
2235
|
+
#
|
2236
|
+
# @!attribute [rw] distance
|
2237
|
+
# The distance in meters from the QueryPosition.
|
2238
|
+
# @return [Integer]
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] map_view
|
2241
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
2242
|
+
# an individual result covers.
|
2243
|
+
#
|
2244
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
2245
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
2246
|
+
# lat\}]`
|
2247
|
+
# @return [Array<Float>]
|
2248
|
+
#
|
2249
|
+
# @!attribute [rw] categories
|
2250
|
+
# Categories of results that results must belong to.
|
2251
|
+
# @return [Array<Types::Category>]
|
2252
|
+
#
|
2253
|
+
# @!attribute [rw] food_types
|
2254
|
+
# List of food types offered by this result.
|
2255
|
+
# @return [Array<Types::FoodType>]
|
2256
|
+
#
|
2257
|
+
# @!attribute [rw] business_chains
|
2258
|
+
# The Business Chains associated with the place.
|
2259
|
+
# @return [Array<Types::BusinessChain>]
|
2260
|
+
#
|
2261
|
+
# @!attribute [rw] contacts
|
2262
|
+
# List of potential contact methods for the result/place.
|
2263
|
+
# @return [Types::Contacts]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] opening_hours
|
2266
|
+
# List of opening hours objects.
|
2267
|
+
# @return [Array<Types::OpeningHours>]
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] access_points
|
2270
|
+
# Position of the access point represent by longitude and latitude.
|
2271
|
+
# @return [Array<Types::AccessPoint>]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] access_restrictions
|
2274
|
+
# Indicates known access restrictions on a vehicle access point. The
|
2275
|
+
# index correlates to an access point and indicates if access through
|
2276
|
+
# this point has some form of restriction.
|
2277
|
+
# @return [Array<Types::AccessRestriction>]
|
2278
|
+
#
|
2279
|
+
# @!attribute [rw] time_zone
|
2280
|
+
# The time zone in which the place is located.
|
2281
|
+
# @return [Types::TimeZone]
|
2282
|
+
#
|
2283
|
+
# @!attribute [rw] political_view
|
2284
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
2285
|
+
# country. The political view applies to the results of the request to
|
2286
|
+
# represent unresolved territorial claims through the point of view of
|
2287
|
+
# the specified country.
|
2288
|
+
# @return [String]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] phonemes
|
2291
|
+
# How the various components of the result's address are pronounced
|
2292
|
+
# in various languages.
|
2293
|
+
# @return [Types::PhonemeDetails]
|
2294
|
+
#
|
2295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SearchTextResultItem AWS API Documentation
|
2296
|
+
#
|
2297
|
+
class SearchTextResultItem < Struct.new(
|
2298
|
+
:place_id,
|
2299
|
+
:place_type,
|
2300
|
+
:title,
|
2301
|
+
:address,
|
2302
|
+
:address_number_corrected,
|
2303
|
+
:position,
|
2304
|
+
:distance,
|
2305
|
+
:map_view,
|
2306
|
+
:categories,
|
2307
|
+
:food_types,
|
2308
|
+
:business_chains,
|
2309
|
+
:contacts,
|
2310
|
+
:opening_hours,
|
2311
|
+
:access_points,
|
2312
|
+
:access_restrictions,
|
2313
|
+
:time_zone,
|
2314
|
+
:political_view,
|
2315
|
+
:phonemes)
|
2316
|
+
SENSITIVE = [:position, :map_view]
|
2317
|
+
include Aws::Structure
|
2318
|
+
end
|
2319
|
+
|
2320
|
+
# Components of a street.
|
2321
|
+
#
|
2322
|
+
# @!attribute [rw] base_name
|
2323
|
+
# Base name part of the street name.
|
2324
|
+
#
|
2325
|
+
# Example: Younge from the “Younge street".
|
2326
|
+
# @return [String]
|
2327
|
+
#
|
2328
|
+
# @!attribute [rw] type
|
2329
|
+
# Street type part of the street name.
|
2330
|
+
#
|
2331
|
+
# Example: `“avenue"`.
|
2332
|
+
# @return [String]
|
2333
|
+
#
|
2334
|
+
# @!attribute [rw] type_placement
|
2335
|
+
# Defines if the street type is before or after the base name.
|
2336
|
+
# @return [String]
|
2337
|
+
#
|
2338
|
+
# @!attribute [rw] type_separator
|
2339
|
+
# What character(s) separates the string from its type.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] prefix
|
2343
|
+
# A prefix is a directional identifier that precedes, but is not
|
2344
|
+
# included in, the base name of a road.
|
2345
|
+
#
|
2346
|
+
# Example: E for East.
|
2347
|
+
# @return [String]
|
2348
|
+
#
|
2349
|
+
# @!attribute [rw] suffix
|
2350
|
+
# A suffix is a directional identifier that follows, but is not
|
2351
|
+
# included in, the base name of a road.
|
2352
|
+
#
|
2353
|
+
# Example W for West.
|
2354
|
+
# @return [String]
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] direction
|
2357
|
+
# Indicates the official directional identifiers assigned to highways.
|
2358
|
+
# @return [String]
|
2359
|
+
#
|
2360
|
+
# @!attribute [rw] language
|
2361
|
+
# A [BCP 47][1] compliant language codes for the results to be
|
2362
|
+
# rendered in. If there is no data for the result in the requested
|
2363
|
+
# language, data will be returned in the default language for the
|
2364
|
+
# entry.
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
#
|
2368
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/StreetComponents AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class StreetComponents < Struct.new(
|
2374
|
+
:base_name,
|
2375
|
+
:type,
|
2376
|
+
:type_placement,
|
2377
|
+
:type_separator,
|
2378
|
+
:prefix,
|
2379
|
+
:suffix,
|
2380
|
+
:direction,
|
2381
|
+
:language)
|
2382
|
+
SENSITIVE = []
|
2383
|
+
include Aws::Structure
|
2384
|
+
end
|
2385
|
+
|
2386
|
+
# The sub-region.
|
2387
|
+
#
|
2388
|
+
# @!attribute [rw] code
|
2389
|
+
# Abbreviated code for the county or sub-region.
|
2390
|
+
# @return [String]
|
2391
|
+
#
|
2392
|
+
# @!attribute [rw] name
|
2393
|
+
# Name for the county or sub-region.
|
2394
|
+
# @return [String]
|
2395
|
+
#
|
2396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SubRegion AWS API Documentation
|
2397
|
+
#
|
2398
|
+
class SubRegion < Struct.new(
|
2399
|
+
:code,
|
2400
|
+
:name)
|
2401
|
+
SENSITIVE = []
|
2402
|
+
include Aws::Structure
|
2403
|
+
end
|
2404
|
+
|
2405
|
+
# Indicates the starting and ending index of the sub-region in the text
|
2406
|
+
# query that match the found title.
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] code
|
2409
|
+
# Indicates the starting and ending index of the sub-region in the
|
2410
|
+
# text query that match the found title.
|
2411
|
+
# @return [Array<Types::Highlight>]
|
2412
|
+
#
|
2413
|
+
# @!attribute [rw] name
|
2414
|
+
# Indicates the starting and ending index of the name in the text
|
2415
|
+
# query that match the found title.
|
2416
|
+
# @return [Array<Types::Highlight>]
|
2417
|
+
#
|
2418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SubRegionHighlights AWS API Documentation
|
2419
|
+
#
|
2420
|
+
class SubRegionHighlights < Struct.new(
|
2421
|
+
:code,
|
2422
|
+
:name)
|
2423
|
+
SENSITIVE = []
|
2424
|
+
include Aws::Structure
|
2425
|
+
end
|
2426
|
+
|
2427
|
+
# Describes how the parts of the textQuery matched the input query by
|
2428
|
+
# returning the sections of the response which matched to textQuery
|
2429
|
+
# terms.
|
2430
|
+
#
|
2431
|
+
# @!attribute [rw] label
|
2432
|
+
# Indicates the starting and ending indexes of the places in the
|
2433
|
+
# result which were identified to match the textQuery. This result is
|
2434
|
+
# useful for providing emphasis to results where the user query
|
2435
|
+
# directly matched to make selecting the correct result from a list
|
2436
|
+
# easier for an end user.
|
2437
|
+
# @return [Array<Types::Highlight>]
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestAddressHighlights AWS API Documentation
|
2440
|
+
#
|
2441
|
+
class SuggestAddressHighlights < Struct.new(
|
2442
|
+
:label)
|
2443
|
+
SENSITIVE = []
|
2444
|
+
include Aws::Structure
|
2445
|
+
end
|
2446
|
+
|
2447
|
+
# SuggestFilter structure which contains a set of inclusion/exclusion
|
2448
|
+
# properties that results must posses in order to be returned as a
|
2449
|
+
# result.
|
2450
|
+
#
|
2451
|
+
# @!attribute [rw] bounding_box
|
2452
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
2453
|
+
# an individual result covers.
|
2454
|
+
#
|
2455
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
2456
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
2457
|
+
# lat\}]`
|
2458
|
+
# @return [Array<Float>]
|
2459
|
+
#
|
2460
|
+
# @!attribute [rw] circle
|
2461
|
+
# The `Circle` that all results must be in.
|
2462
|
+
# @return [Types::FilterCircle]
|
2463
|
+
#
|
2464
|
+
# @!attribute [rw] include_countries
|
2465
|
+
# A list of countries that all results must be in. Countries are
|
2466
|
+
# represented by either their alpha-2 or alpha-3 character codes.
|
2467
|
+
# @return [Array<String>]
|
2468
|
+
#
|
2469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestFilter AWS API Documentation
|
2470
|
+
#
|
2471
|
+
class SuggestFilter < Struct.new(
|
2472
|
+
:bounding_box,
|
2473
|
+
:circle,
|
2474
|
+
:include_countries)
|
2475
|
+
SENSITIVE = [:bounding_box, :circle]
|
2476
|
+
include Aws::Structure
|
2477
|
+
end
|
2478
|
+
|
2479
|
+
# Describes how the parts of the textQuery matched the input query by
|
2480
|
+
# returning the sections of the response which matched to textQuery
|
2481
|
+
# terms.
|
2482
|
+
#
|
2483
|
+
# @!attribute [rw] title
|
2484
|
+
# Indicates the starting and ending index of the title in the text
|
2485
|
+
# query that match the found title.
|
2486
|
+
# @return [Array<Types::Highlight>]
|
2487
|
+
#
|
2488
|
+
# @!attribute [rw] address
|
2489
|
+
# The place's address.
|
2490
|
+
# @return [Types::SuggestAddressHighlights]
|
2491
|
+
#
|
2492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestHighlights AWS API Documentation
|
2493
|
+
#
|
2494
|
+
class SuggestHighlights < Struct.new(
|
2495
|
+
:title,
|
2496
|
+
:address)
|
2497
|
+
SENSITIVE = []
|
2498
|
+
include Aws::Structure
|
2499
|
+
end
|
2500
|
+
|
2501
|
+
# The suggested place results.
|
2502
|
+
#
|
2503
|
+
# @!attribute [rw] place_id
|
2504
|
+
# The `PlaceId` of the place you wish to receive the information for.
|
2505
|
+
# @return [String]
|
2506
|
+
#
|
2507
|
+
# @!attribute [rw] place_type
|
2508
|
+
# A `PlaceType` is a category that the result place must belong to.
|
2509
|
+
# @return [String]
|
2510
|
+
#
|
2511
|
+
# @!attribute [rw] address
|
2512
|
+
# The place's address.
|
2513
|
+
# @return [Types::Address]
|
2514
|
+
#
|
2515
|
+
# @!attribute [rw] position
|
2516
|
+
# The position, in longitude and latitude.
|
2517
|
+
# @return [Array<Float>]
|
2518
|
+
#
|
2519
|
+
# @!attribute [rw] distance
|
2520
|
+
# The distance in meters from the QueryPosition.
|
2521
|
+
# @return [Integer]
|
2522
|
+
#
|
2523
|
+
# @!attribute [rw] map_view
|
2524
|
+
# The bounding box enclosing the geometric shape (area or line) that
|
2525
|
+
# an individual result covers.
|
2526
|
+
#
|
2527
|
+
# The bounding box formed is defined as a set 4 coordinates:
|
2528
|
+
# `[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern
|
2529
|
+
# lat\}]`
|
2530
|
+
# @return [Array<Float>]
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] categories
|
2533
|
+
# Categories of results that results must belong to.
|
2534
|
+
# @return [Array<Types::Category>]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] food_types
|
2537
|
+
# List of food types offered by this result.
|
2538
|
+
# @return [Array<Types::FoodType>]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] business_chains
|
2541
|
+
# The Business Chains associated with the place.
|
2542
|
+
# @return [Array<Types::BusinessChain>]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] access_points
|
2545
|
+
# Position of the access point represent by longitude and latitude.
|
2546
|
+
# @return [Array<Types::AccessPoint>]
|
2547
|
+
#
|
2548
|
+
# @!attribute [rw] access_restrictions
|
2549
|
+
# Indicates known access restrictions on a vehicle access point. The
|
2550
|
+
# index correlates to an access point and indicates if access through
|
2551
|
+
# this point has some form of restriction.
|
2552
|
+
# @return [Array<Types::AccessRestriction>]
|
2553
|
+
#
|
2554
|
+
# @!attribute [rw] time_zone
|
2555
|
+
# The time zone in which the place is located.
|
2556
|
+
# @return [Types::TimeZone]
|
2557
|
+
#
|
2558
|
+
# @!attribute [rw] political_view
|
2559
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
2560
|
+
# country. The political view applies to the results of the request to
|
2561
|
+
# represent unresolved territorial claims through the point of view of
|
2562
|
+
# the specified country.
|
2563
|
+
# @return [String]
|
2564
|
+
#
|
2565
|
+
# @!attribute [rw] phonemes
|
2566
|
+
# How the various components of the result's address are pronounced
|
2567
|
+
# in various languages.
|
2568
|
+
# @return [Types::PhonemeDetails]
|
2569
|
+
#
|
2570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestPlaceResult AWS API Documentation
|
2571
|
+
#
|
2572
|
+
class SuggestPlaceResult < Struct.new(
|
2573
|
+
:place_id,
|
2574
|
+
:place_type,
|
2575
|
+
:address,
|
2576
|
+
:position,
|
2577
|
+
:distance,
|
2578
|
+
:map_view,
|
2579
|
+
:categories,
|
2580
|
+
:food_types,
|
2581
|
+
:business_chains,
|
2582
|
+
:access_points,
|
2583
|
+
:access_restrictions,
|
2584
|
+
:time_zone,
|
2585
|
+
:political_view,
|
2586
|
+
:phonemes)
|
2587
|
+
SENSITIVE = [:position, :map_view]
|
2588
|
+
include Aws::Structure
|
2589
|
+
end
|
2590
|
+
|
2591
|
+
# The suggested query results.
|
2592
|
+
#
|
2593
|
+
# @!attribute [rw] query_id
|
2594
|
+
# QueryId can be used to complete a follow up query through the
|
2595
|
+
# SearchText API. The QueryId retains context from the original
|
2596
|
+
# Suggest request such as filters, political view and language. See
|
2597
|
+
# the SearchText API documentation for more details [SearchText API
|
2598
|
+
# docs][1].
|
2599
|
+
#
|
2600
|
+
#
|
2601
|
+
#
|
2602
|
+
# [1]: https://docs.aws.amazon.com/latest/APIReference/API_geoplaces_SearchText.html
|
2603
|
+
# @return [String]
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] query_type
|
2606
|
+
# The query type. Category qeuries will search for places which have
|
2607
|
+
# an entry matching the given category, for example "doctor office".
|
2608
|
+
# BusinessChain queries will search for instances of a given business.
|
2609
|
+
# @return [String]
|
2610
|
+
#
|
2611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestQueryResult AWS API Documentation
|
2612
|
+
#
|
2613
|
+
class SuggestQueryResult < Struct.new(
|
2614
|
+
:query_id,
|
2615
|
+
:query_type)
|
2616
|
+
SENSITIVE = []
|
2617
|
+
include Aws::Structure
|
2618
|
+
end
|
2619
|
+
|
2620
|
+
# @!attribute [rw] query_text
|
2621
|
+
# The free-form text query to match addresses against. This is usually
|
2622
|
+
# a partially typed address from an end user in an address box or
|
2623
|
+
# form.
|
2624
|
+
# @return [String]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] max_results
|
2627
|
+
# An optional limit for the number of results returned in a single
|
2628
|
+
# call.
|
2629
|
+
# @return [Integer]
|
2630
|
+
#
|
2631
|
+
# @!attribute [rw] max_query_refinements
|
2632
|
+
# Maximum number of query terms to be returned for use with a search
|
2633
|
+
# text query.
|
2634
|
+
# @return [Integer]
|
2635
|
+
#
|
2636
|
+
# @!attribute [rw] bias_position
|
2637
|
+
# The position, in longitude and latitude, that the results should be
|
2638
|
+
# close to. Typically, place results returned are ranked higher the
|
2639
|
+
# closer they are to this position. Stored in `[lng, lat]` and in the
|
2640
|
+
# WSG84 format.
|
2641
|
+
#
|
2642
|
+
# <note markdown="1"> The fields `BiasPosition`, `FilterBoundingBox`, and `FilterCircle`
|
2643
|
+
# are mutually exclusive.
|
2644
|
+
#
|
2645
|
+
# </note>
|
2646
|
+
# @return [Array<Float>]
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] filter
|
2649
|
+
# A structure which contains a set of inclusion/exclusion properties
|
2650
|
+
# that results must posses in order to be returned as a result.
|
2651
|
+
# @return [Types::SuggestFilter]
|
2652
|
+
#
|
2653
|
+
# @!attribute [rw] additional_features
|
2654
|
+
# A list of optional additional parameters, such as time zone, that
|
2655
|
+
# can be requested for each result.
|
2656
|
+
# @return [Array<String>]
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] language
|
2659
|
+
# A list of [BCP 47][1] compliant language codes for the results to be
|
2660
|
+
# rendered in. If there is no data for the result in the requested
|
2661
|
+
# language, data will be returned in the default language for the
|
2662
|
+
# entry.
|
2663
|
+
#
|
2664
|
+
#
|
2665
|
+
#
|
2666
|
+
# [1]: https://en.wikipedia.org/wiki/IETF_language_tag
|
2667
|
+
# @return [String]
|
2668
|
+
#
|
2669
|
+
# @!attribute [rw] political_view
|
2670
|
+
# The alpha-2 or alpha-3 character code for the political view of a
|
2671
|
+
# country. The political view applies to the results of the request to
|
2672
|
+
# represent unresolved territorial claims through the point of view of
|
2673
|
+
# the specified country.
|
2674
|
+
# @return [String]
|
2675
|
+
#
|
2676
|
+
# @!attribute [rw] intended_use
|
2677
|
+
# Indicates if the results will be stored. Defaults to `SingleUse`, if
|
2678
|
+
# left empty.
|
2679
|
+
# @return [String]
|
2680
|
+
#
|
2681
|
+
# @!attribute [rw] key
|
2682
|
+
# Optional: The API key to be used for authorization. Either an API
|
2683
|
+
# key or valid SigV4 signature must be provided when making a request.
|
2684
|
+
# @return [String]
|
2685
|
+
#
|
2686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestRequest AWS API Documentation
|
2687
|
+
#
|
2688
|
+
class SuggestRequest < Struct.new(
|
2689
|
+
:query_text,
|
2690
|
+
:max_results,
|
2691
|
+
:max_query_refinements,
|
2692
|
+
:bias_position,
|
2693
|
+
:filter,
|
2694
|
+
:additional_features,
|
2695
|
+
:language,
|
2696
|
+
:political_view,
|
2697
|
+
:intended_use,
|
2698
|
+
:key)
|
2699
|
+
SENSITIVE = [:query_text, :bias_position, :key]
|
2700
|
+
include Aws::Structure
|
2701
|
+
end
|
2702
|
+
|
2703
|
+
# @!attribute [rw] pricing_bucket
|
2704
|
+
# The pricing bucket for which the query is charged at.
|
2705
|
+
#
|
2706
|
+
# For more inforamtion on pricing, please visit [Amazon Location
|
2707
|
+
# Service Pricing][1].
|
2708
|
+
#
|
2709
|
+
#
|
2710
|
+
#
|
2711
|
+
# [1]: https://aws.amazon.com/location/pricing/
|
2712
|
+
# @return [String]
|
2713
|
+
#
|
2714
|
+
# @!attribute [rw] result_items
|
2715
|
+
# List of places or results returned for a query.
|
2716
|
+
# @return [Array<Types::SuggestResultItem>]
|
2717
|
+
#
|
2718
|
+
# @!attribute [rw] query_refinements
|
2719
|
+
# Maximum number of query terms to be returned for use with a search
|
2720
|
+
# text query.
|
2721
|
+
# @return [Array<Types::QueryRefinement>]
|
2722
|
+
#
|
2723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestResponse AWS API Documentation
|
2724
|
+
#
|
2725
|
+
class SuggestResponse < Struct.new(
|
2726
|
+
:pricing_bucket,
|
2727
|
+
:result_items,
|
2728
|
+
:query_refinements)
|
2729
|
+
SENSITIVE = []
|
2730
|
+
include Aws::Structure
|
2731
|
+
end
|
2732
|
+
|
2733
|
+
# The resulting item from the suggested query.
|
2734
|
+
#
|
2735
|
+
# @!attribute [rw] title
|
2736
|
+
# The display title that should be used when presenting this option to
|
2737
|
+
# the end user.
|
2738
|
+
# @return [String]
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] suggest_result_item_type
|
2741
|
+
# The result type. Place results represent the final result for a
|
2742
|
+
# point of interest, Query results represent a follow up query which
|
2743
|
+
# can be completed through the SearchText operation.
|
2744
|
+
# @return [String]
|
2745
|
+
#
|
2746
|
+
# @!attribute [rw] place
|
2747
|
+
# The suggested place by its unique ID.
|
2748
|
+
# @return [Types::SuggestPlaceResult]
|
2749
|
+
#
|
2750
|
+
# @!attribute [rw] query
|
2751
|
+
# The suggested query results.
|
2752
|
+
# @return [Types::SuggestQueryResult]
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] highlights
|
2755
|
+
# Describes how the parts of the response element matched the input
|
2756
|
+
# query by returning the sections of the response which matched to
|
2757
|
+
# input query terms.
|
2758
|
+
# @return [Types::SuggestHighlights]
|
2759
|
+
#
|
2760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/SuggestResultItem AWS API Documentation
|
2761
|
+
#
|
2762
|
+
class SuggestResultItem < Struct.new(
|
2763
|
+
:title,
|
2764
|
+
:suggest_result_item_type,
|
2765
|
+
:place,
|
2766
|
+
:query,
|
2767
|
+
:highlights)
|
2768
|
+
SENSITIVE = []
|
2769
|
+
include Aws::Structure
|
2770
|
+
end
|
2771
|
+
|
2772
|
+
# The request was denied due to request throttling.
|
2773
|
+
#
|
2774
|
+
# @!attribute [rw] message
|
2775
|
+
# @return [String]
|
2776
|
+
#
|
2777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ThrottlingException AWS API Documentation
|
2778
|
+
#
|
2779
|
+
class ThrottlingException < Struct.new(
|
2780
|
+
:message)
|
2781
|
+
SENSITIVE = []
|
2782
|
+
include Aws::Structure
|
2783
|
+
end
|
2784
|
+
|
2785
|
+
# The time zone in which the place is located.
|
2786
|
+
#
|
2787
|
+
# @!attribute [rw] name
|
2788
|
+
# The time zone name.
|
2789
|
+
# @return [String]
|
2790
|
+
#
|
2791
|
+
# @!attribute [rw] offset
|
2792
|
+
# Time zone offset of the timezone from UTC.
|
2793
|
+
# @return [String]
|
2794
|
+
#
|
2795
|
+
# @!attribute [rw] offset_seconds
|
2796
|
+
# The offset of the time zone from UTC, in seconds.
|
2797
|
+
# @return [Integer]
|
2798
|
+
#
|
2799
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/TimeZone AWS API Documentation
|
2800
|
+
#
|
2801
|
+
class TimeZone < Struct.new(
|
2802
|
+
:name,
|
2803
|
+
:offset,
|
2804
|
+
:offset_seconds)
|
2805
|
+
SENSITIVE = []
|
2806
|
+
include Aws::Structure
|
2807
|
+
end
|
2808
|
+
|
2809
|
+
# The USPS zip code.
|
2810
|
+
#
|
2811
|
+
# @!attribute [rw] zip_classification_code
|
2812
|
+
# The ZIP Classification Code, or in other words what type of postal
|
2813
|
+
# code is it.
|
2814
|
+
# @return [String]
|
2815
|
+
#
|
2816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/UspsZip AWS API Documentation
|
2817
|
+
#
|
2818
|
+
class UspsZip < Struct.new(
|
2819
|
+
:zip_classification_code)
|
2820
|
+
SENSITIVE = []
|
2821
|
+
include Aws::Structure
|
2822
|
+
end
|
2823
|
+
|
2824
|
+
# The USPS zip+4 code.
|
2825
|
+
#
|
2826
|
+
# @!attribute [rw] record_type_code
|
2827
|
+
# The USPS ZIP+4 Record Type Code.
|
2828
|
+
# @return [String]
|
2829
|
+
#
|
2830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/UspsZipPlus4 AWS API Documentation
|
2831
|
+
#
|
2832
|
+
class UspsZipPlus4 < Struct.new(
|
2833
|
+
:record_type_code)
|
2834
|
+
SENSITIVE = []
|
2835
|
+
include Aws::Structure
|
2836
|
+
end
|
2837
|
+
|
2838
|
+
# The input fails to satisfy the constraints specified by an AWS
|
2839
|
+
# service.
|
2840
|
+
#
|
2841
|
+
# @!attribute [rw] message
|
2842
|
+
# @return [String]
|
2843
|
+
#
|
2844
|
+
# @!attribute [rw] reason
|
2845
|
+
# Test stub for reason
|
2846
|
+
# @return [String]
|
2847
|
+
#
|
2848
|
+
# @!attribute [rw] field_list
|
2849
|
+
# Test stub for FieldList.
|
2850
|
+
# @return [Array<Types::ValidationExceptionField>]
|
2851
|
+
#
|
2852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ValidationException AWS API Documentation
|
2853
|
+
#
|
2854
|
+
class ValidationException < Struct.new(
|
2855
|
+
:message,
|
2856
|
+
:reason,
|
2857
|
+
:field_list)
|
2858
|
+
SENSITIVE = []
|
2859
|
+
include Aws::Structure
|
2860
|
+
end
|
2861
|
+
|
2862
|
+
# The input fails to satisfy the constraints specified by the Amazon
|
2863
|
+
# Location service.
|
2864
|
+
#
|
2865
|
+
# @!attribute [rw] name
|
2866
|
+
# The name of the resource.
|
2867
|
+
# @return [String]
|
2868
|
+
#
|
2869
|
+
# @!attribute [rw] message
|
2870
|
+
# The error message.
|
2871
|
+
# @return [String]
|
2872
|
+
#
|
2873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/geo-places-2020-11-19/ValidationExceptionField AWS API Documentation
|
2874
|
+
#
|
2875
|
+
class ValidationExceptionField < Struct.new(
|
2876
|
+
:name,
|
2877
|
+
:message)
|
2878
|
+
SENSITIVE = []
|
2879
|
+
include Aws::Structure
|
2880
|
+
end
|
2881
|
+
|
2882
|
+
end
|
2883
|
+
end
|
2884
|
+
|