@aws-sdk/client-geo-places 3.683.0

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