@aws-sdk/client-geo-places 3.830.0 → 3.835.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.
@@ -51,8 +51,7 @@ export interface Category {
51
51
  Primary?: boolean | undefined;
52
52
  }
53
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>
54
+ * <p>Indicates if the access location is restricted. Index correlates to that of an access point and indicates if access through this point has some form of restriction. </p>
56
55
  * @public
57
56
  */
58
57
  export interface AccessRestriction {
@@ -89,24 +88,32 @@ export interface Country {
89
88
  Name?: string | undefined;
90
89
  }
91
90
  /**
92
- * <p>The region or state results should be to be present in. </p>
93
- * <p>Example: <code>North Rhine-Westphalia</code>. </p>
91
+ * <p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>. </p>
94
92
  * @public
95
93
  */
96
94
  export interface Region {
97
95
  /**
98
- * <p>Abbreviated code for a the state, province or region of the country. </p>
99
- * <p>Example: <code>BC</code>.</p>
96
+ * <p>Abbreviated code for a the state, province or region of the country. </p> <p>Example: <code>BC</code>.</p>
100
97
  * @public
101
98
  */
102
99
  Code?: string | undefined;
103
100
  /**
104
- * <p>Name for a the state, province, or region of the country. </p>
105
- * <p>Example: <code>British Columbia</code>. </p>
101
+ * <p>Name for a the state, province, or region of the country. </p> <p>Example: <code>British Columbia</code>. </p>
106
102
  * @public
107
103
  */
108
104
  Name?: string | undefined;
109
105
  }
106
+ /**
107
+ * <p>Components that correspond to secondary identifiers on an address. The only component type supported currently is Unit.</p>
108
+ * @public
109
+ */
110
+ export interface SecondaryAddressComponent {
111
+ /**
112
+ * <p>Number that uniquely identifies a secondary address.</p>
113
+ * @public
114
+ */
115
+ Number: string | undefined;
116
+ }
110
117
  /**
111
118
  * @public
112
119
  * @enum
@@ -125,14 +132,12 @@ export type TypePlacement = (typeof TypePlacement)[keyof typeof TypePlacement];
125
132
  */
126
133
  export interface StreetComponents {
127
134
  /**
128
- * <p>Base name part of the street name. </p>
129
- * <p>Example: Younge from the “Younge street".</p>
135
+ * <p>Base name part of the street name. </p> <p>Example: Younge from the "Younge street".</p>
130
136
  * @public
131
137
  */
132
138
  BaseName?: string | undefined;
133
139
  /**
134
- * <p>Street type part of the street name. </p>
135
- * <p>Example: <code>“avenue"</code>.</p>
140
+ * <p>Street type part of the street name. </p> <p>Example: <code>"avenue"</code>.</p>
136
141
  * @public
137
142
  */
138
143
  Type?: string | undefined;
@@ -142,21 +147,17 @@ export interface StreetComponents {
142
147
  */
143
148
  TypePlacement?: TypePlacement | undefined;
144
149
  /**
145
- * <p>What character(s) separates the string from its type. </p>
150
+ * <p>Defines a separator character such as <code>""</code> or <code>" "</code> between the base name and type.</p>
146
151
  * @public
147
152
  */
148
153
  TypeSeparator?: string | undefined;
149
154
  /**
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>
155
+ * <p>A prefix is a directional identifier that precedes, but is not included in, the base name of a road. </p> <p>Example: E for East.</p>
153
156
  * @public
154
157
  */
155
158
  Prefix?: string | undefined;
156
159
  /**
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
+ * <p>A suffix is a directional identifier that follows, but is not included in, the base name of a road. </p> <p>Example W for West.</p>
160
161
  * @public
161
162
  */
162
163
  Suffix?: string | undefined;
@@ -193,8 +194,7 @@ export interface SubRegion {
193
194
  */
194
195
  export interface Address {
195
196
  /**
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>
197
+ * <p>Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.</p>
198
198
  * @public
199
199
  */
200
200
  Label?: string | undefined;
@@ -204,8 +204,7 @@ export interface Address {
204
204
  */
205
205
  Country?: Country | undefined;
206
206
  /**
207
- * <p>The region or state results should be present in. </p>
208
- * <p>Example: <code>North Rhine-Westphalia</code>.</p>
207
+ * <p>The region or state results should be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>
209
208
  * @public
210
209
  */
211
210
  Region?: Region | undefined;
@@ -215,8 +214,7 @@ export interface Address {
215
214
  */
216
215
  SubRegion?: SubRegion | undefined;
217
216
  /**
218
- * <p>The locality or city of the address.</p>
219
- * <p>Example: <code>Vancouver</code>.</p>
217
+ * <p>The city or locality of the address.</p> <p>Example: <code>Vancouver</code>.</p>
220
218
  * @public
221
219
  */
222
220
  Locality?: string | undefined;
@@ -226,35 +224,27 @@ export interface Address {
226
224
  */
227
225
  District?: string | undefined;
228
226
  /**
229
- * <p>A subdivision of a district. </p>
230
- * <p>Example: <code>Minden-Lübbecke</code>.</p>
227
+ * <p>A subdivision of a district. </p> <p>Example: <code>Minden-Lübbecke</code>.</p>
231
228
  * @public
232
229
  */
233
230
  SubDistrict?: string | undefined;
234
231
  /**
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>
232
+ * <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 possess. </p>
237
233
  * @public
238
234
  */
239
235
  PostalCode?: string | undefined;
240
236
  /**
241
- * <p>Name of the block. </p>
242
- * <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code>
243
- * </p>
237
+ * <p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
244
238
  * @public
245
239
  */
246
240
  Block?: string | undefined;
247
241
  /**
248
- * <p>Name of sub-block. </p>
249
- * <p>Example: <code>Sunny Mansion 203 sub-block: 4</code>
250
- * </p>
242
+ * <p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
251
243
  * @public
252
244
  */
253
245
  SubBlock?: string | undefined;
254
246
  /**
255
- * <p>Name of the streets in the intersection. </p>
256
- * <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code>
257
- * </p>
247
+ * <p>Name of the streets in the intersection. </p> <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code> </p>
258
248
  * @public
259
249
  */
260
250
  Intersection?: string[] | undefined;
@@ -264,8 +254,7 @@ export interface Address {
264
254
  */
265
255
  Street?: string | undefined;
266
256
  /**
267
- * <p>Components of the street. </p>
268
- * <p>Example: Younge from the "Younge street".</p>
257
+ * <p>Components of the street. </p> <p>Example: Younge from the "Younge street".</p>
269
258
  * @public
270
259
  */
271
260
  StreetComponents?: StreetComponents[] | undefined;
@@ -279,10 +268,25 @@ export interface Address {
279
268
  * @public
280
269
  */
281
270
  Building?: string | undefined;
271
+ /**
272
+ * <p>Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.</p>
273
+ * @public
274
+ */
275
+ SecondaryAddressComponents?: SecondaryAddressComponent[] | undefined;
276
+ }
277
+ /**
278
+ * <p>Match score for a secondary address component in the result.</p>
279
+ * @public
280
+ */
281
+ export interface SecondaryAddressComponentMatchScore {
282
+ /**
283
+ * <p>Match score for the secondary address number.</p>
284
+ * @public
285
+ */
286
+ Number?: number | undefined;
282
287
  }
283
288
  /**
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>
289
+ * <p>Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.</p>
286
290
  * @public
287
291
  */
288
292
  export interface AddressComponentMatchScores {
@@ -292,8 +296,7 @@ export interface AddressComponentMatchScores {
292
296
  */
293
297
  Country?: number | undefined;
294
298
  /**
295
- * <p>The region or state results should be to be present in. </p>
296
- * <p>Example: <code>North Rhine-Westphalia</code>.</p>
299
+ * <p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>
297
300
  * @public
298
301
  */
299
302
  Region?: number | undefined;
@@ -303,8 +306,7 @@ export interface AddressComponentMatchScores {
303
306
  */
304
307
  SubRegion?: number | undefined;
305
308
  /**
306
- * <p>The city or locality results should be present in. </p>
307
- * <p>Example: <code>Vancouver</code>.</p>
309
+ * <p>The city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>
308
310
  * @public
309
311
  */
310
312
  Locality?: number | undefined;
@@ -314,36 +316,27 @@ export interface AddressComponentMatchScores {
314
316
  */
315
317
  District?: number | undefined;
316
318
  /**
317
- * <p>A subdivision of a district. </p>
318
- * <p>Example: <code>Minden-Lübbecke</code>
319
- * </p>
319
+ * <p>A subdivision of a district. </p> <p>Example: <code>Minden-Lübbecke</code> </p>
320
320
  * @public
321
321
  */
322
322
  SubDistrict?: number | undefined;
323
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>
324
+ * <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 possess. </p>
326
325
  * @public
327
326
  */
328
327
  PostalCode?: number | undefined;
329
328
  /**
330
- * <p>Name of the block. </p>
331
- * <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code>
332
- * </p>
329
+ * <p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
333
330
  * @public
334
331
  */
335
332
  Block?: number | undefined;
336
333
  /**
337
- * <p>Name of sub-block. </p>
338
- * <p>Example: <code>Sunny Mansion 203 sub-block: 4</code>
339
- * </p>
334
+ * <p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
340
335
  * @public
341
336
  */
342
337
  SubBlock?: number | undefined;
343
338
  /**
344
- * <p>Name of the streets in the intersection. </p>
345
- * <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code>
346
- * </p>
339
+ * <p>Name of the streets in the intersection. </p> <p>Example: <code>["Friedrichstraße","Unter den Linden"]</code> </p>
347
340
  * @public
348
341
  */
349
342
  Intersection?: number[] | undefined;
@@ -357,6 +350,11 @@ export interface AddressComponentMatchScores {
357
350
  * @public
358
351
  */
359
352
  Building?: number | undefined;
353
+ /**
354
+ * <p>Match scores for the secondary address components in the result.</p>
355
+ * @public
356
+ */
357
+ SecondaryAddressComponents?: SecondaryAddressComponentMatchScore[] | undefined;
360
358
  }
361
359
  /**
362
360
  * <p>How to pronounce the various components of the address or place.</p>
@@ -400,8 +398,7 @@ export interface AddressComponentPhonemes {
400
398
  */
401
399
  SubRegion?: PhonemeTranscription[] | undefined;
402
400
  /**
403
- * <p>How to pronounce the city or locality results should be present in. </p>
404
- * <p>Example: <code>Vancouver</code>.</p>
401
+ * <p>How to pronounce the city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>
405
402
  * @public
406
403
  */
407
404
  Locality?: PhonemeTranscription[] | undefined;
@@ -411,8 +408,7 @@ export interface AddressComponentPhonemes {
411
408
  */
412
409
  District?: PhonemeTranscription[] | undefined;
413
410
  /**
414
- * <p>How to pronounce the sub-district or division of a city results should be present
415
- * in.</p>
411
+ * <p>How to pronounce the sub-district or division of a city results should be present in.</p>
416
412
  * @public
417
413
  */
418
414
  SubDistrict?: PhonemeTranscription[] | undefined;
@@ -472,15 +468,12 @@ export declare const AutocompleteFilterPlaceType: {
472
468
  */
473
469
  export type AutocompleteFilterPlaceType = (typeof AutocompleteFilterPlaceType)[keyof typeof AutocompleteFilterPlaceType];
474
470
  /**
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>
471
+ * <p>Autocomplete structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
476
472
  * @public
477
473
  */
478
474
  export interface AutocompleteFilter {
479
475
  /**
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>
476
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
484
477
  * @public
485
478
  */
486
479
  BoundingBox?: number[] | undefined;
@@ -531,7 +524,7 @@ export type PostalCodeMode = (typeof PostalCodeMode)[keyof typeof PostalCodeMode
531
524
  */
532
525
  export interface AutocompleteRequest {
533
526
  /**
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>
527
+ * <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> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
535
528
  * @public
536
529
  */
537
530
  QueryText: string | undefined;
@@ -541,32 +534,22 @@ export interface AutocompleteRequest {
541
534
  */
542
535
  MaxResults?: number | undefined;
543
536
  /**
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>
537
+ * <p>The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in <code>[lng, lat]</code> and in the WSG84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
551
538
  * @public
552
539
  */
553
540
  BiasPosition?: number[] | undefined;
554
541
  /**
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>
542
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
556
543
  * @public
557
544
  */
558
545
  Filter?: AutocompleteFilter | undefined;
559
546
  /**
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>
547
+ * <p>The <code>PostalCodeMode</code> affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value <code>EnumerateSpannedLocalities</code>, all cities in that postal code are returned.</p>
564
548
  * @public
565
549
  */
566
550
  PostalCodeMode?: PostalCodeMode | undefined;
567
551
  /**
568
- * <p>A list of optional additional parameters that can be requested for
569
- * each result.</p>
552
+ * <p>A list of optional additional parameters that can be requested for each result.</p>
570
553
  * @public
571
554
  */
572
555
  AdditionalFeatures?: AutocompleteAdditionalFeature[] | undefined;
@@ -576,25 +559,23 @@ export interface AutocompleteRequest {
576
559
  */
577
560
  Language?: string | undefined;
578
561
  /**
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>
562
+ * <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> <p>The following political views are currently supported:</p> <ul> <li> <p> <code>ARG</code>: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands</p> </li> <li> <p> <code>EGY</code>: Egypt's view on Bir Tawil</p> </li> <li> <p> <code>IND</code>: India's view on Gilgit-Baltistan</p> </li> <li> <p> <code>KEN</code>: Kenya's view on the Ilemi Triangle</p> </li> <li> <p> <code>MAR</code>: Morocco's view on Western Sahara</p> </li> <li> <p> <code>RUS</code>: Russia's view on Crimea</p> </li> <li> <p> <code>SDN</code>: Sudan's view on the Halaib Triangle</p> </li> <li> <p> <code>SRB</code>: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands</p> </li> <li> <p> <code>SUR</code>: Suriname's view on the Courantyne Headwaters and Lawa Headwaters</p> </li> <li> <p> <code>SYR</code>: Syria's view on the Golan Heights</p> </li> <li> <p> <code>TUR</code>: Turkey's view on Cyprus and Northern Cyprus</p> </li> <li> <p> <code>TZA</code>: Tanzania's view on Lake Malawi</p> </li> <li> <p> <code>URY</code>: Uruguay's view on Rincon de Artigas</p> </li> <li> <p> <code>VNM</code>: Vietnam's view on the Paracel Islands and Spratly Islands</p> </li> </ul>
580
563
  * @public
581
564
  */
582
565
  PoliticalView?: string | undefined;
583
566
  /**
584
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left
585
- * empty.</p>
567
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p>
586
568
  * @public
587
569
  */
588
570
  IntendedUse?: AutocompleteIntendedUse | undefined;
589
571
  /**
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>
572
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
592
573
  * @public
593
574
  */
594
575
  Key?: string | undefined;
595
576
  }
596
577
  /**
597
- * <p>Describes how parts of the result response match the input query.</p>
578
+ * <p>Indicates the starting and ending index of the text query that match the found title.</p>
598
579
  * @public
599
580
  */
600
581
  export interface Highlight {
@@ -647,14 +628,12 @@ export interface RegionHighlights {
647
628
  Name?: Highlight[] | undefined;
648
629
  }
649
630
  /**
650
- * <p>Indicates the starting and ending index of the sub-region in the text query that match
651
- * the found title. </p>
631
+ * <p>Indicates the starting and ending index of the sub-region in the text query that match the found title. </p>
652
632
  * @public
653
633
  */
654
634
  export interface SubRegionHighlights {
655
635
  /**
656
- * <p>Indicates the starting and ending index of the sub-region in the text query that match
657
- * the found title. </p>
636
+ * <p>Indicates the starting and ending index of the sub-region in the text query that match the found title. </p>
658
637
  * @public
659
638
  */
660
639
  Code?: Highlight[] | undefined;
@@ -670,8 +649,7 @@ export interface SubRegionHighlights {
670
649
  */
671
650
  export interface AutocompleteAddressHighlights {
672
651
  /**
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>
652
+ * <p>Indicates the starting and ending indexes for result items where they are identified to match the input query. 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
653
  * @public
676
654
  */
677
655
  Label?: Highlight[] | undefined;
@@ -681,8 +659,7 @@ export interface AutocompleteAddressHighlights {
681
659
  */
682
660
  Country?: CountryHighlights | undefined;
683
661
  /**
684
- * <p>The region or state results should be to be present in. </p>
685
- * <p>Example: <code>North Rhine-Westphalia</code>.</p>
662
+ * <p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>
686
663
  * @public
687
664
  */
688
665
  Region?: RegionHighlights | undefined;
@@ -692,8 +669,7 @@ export interface AutocompleteAddressHighlights {
692
669
  */
693
670
  SubRegion?: SubRegionHighlights | undefined;
694
671
  /**
695
- * <p>The city or locality results should be present in. </p>
696
- * <p>Example: <code>Vancouver</code>.</p>
672
+ * <p>The city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>
697
673
  * @public
698
674
  */
699
675
  Locality?: Highlight[] | undefined;
@@ -713,13 +689,12 @@ export interface AutocompleteAddressHighlights {
713
689
  */
714
690
  Street?: Highlight[] | undefined;
715
691
  /**
716
- * <p>Name of the block. Example: Sunny Mansion 203
717
- * block: 2 Chome</p>
692
+ * <p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
718
693
  * @public
719
694
  */
720
695
  Block?: Highlight[] | undefined;
721
696
  /**
722
- * <p>Name of sub-block. Example Sunny Mansion 203 sub-block: 4</p>
697
+ * <p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
723
698
  * @public
724
699
  */
725
700
  SubBlock?: Highlight[] | undefined;
@@ -729,7 +704,7 @@ export interface AutocompleteAddressHighlights {
729
704
  */
730
705
  Intersection?: Highlight[][] | undefined;
731
706
  /**
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>
707
+ * <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 possess. </p>
733
708
  * @public
734
709
  */
735
710
  PostalCode?: Highlight[] | undefined;
@@ -775,6 +750,7 @@ export declare const PlaceType: {
775
750
  readonly POINT_OF_INTEREST: "PointOfInterest";
776
751
  readonly POSTAL_CODE: "PostalCode";
777
752
  readonly REGION: "Region";
753
+ readonly SECONDARY_ADDRESS: "SecondaryAddress";
778
754
  readonly STREET: "Street";
779
755
  readonly SUB_BLOCK: "SubBlock";
780
756
  readonly SUB_DISTRICT: "SubDistrict";
@@ -835,8 +811,7 @@ export interface AutocompleteResultItem {
835
811
  */
836
812
  export interface AutocompleteResponse {
837
813
  /**
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>
814
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
840
815
  * @public
841
816
  */
842
817
  PricingBucket: string | undefined;
@@ -968,13 +943,12 @@ export interface BusinessChain {
968
943
  Id?: string | undefined;
969
944
  }
970
945
  /**
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>
946
+ * <p>Indicates how well the returned title and address components matches the input TextQuery. For each component a score is provied with 1 indicating all tokens were matched and 0 indicating no tokens were matched.</p>
973
947
  * @public
974
948
  */
975
949
  export interface ComponentMatchScores {
976
950
  /**
977
- * <p>Indicates the starting and ending index of the title in the text query that match the found title. </p>
951
+ * <p>Indicates the match score of the title in the text query that match the found title. </p>
978
952
  * @public
979
953
  */
980
954
  Title?: number | undefined;
@@ -1047,9 +1021,7 @@ export interface FoodType {
1047
1021
  */
1048
1022
  Id?: string | undefined;
1049
1023
  /**
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>
1024
+ * <p>Boolean which indicates if this food type is the primary offered by the place. For example, if a location serves fast food, but also dessert, he primary would likely be fast food.</p>
1053
1025
  * @public
1054
1026
  */
1055
1027
  Primary?: boolean | undefined;
@@ -1060,6 +1032,8 @@ export interface FoodType {
1060
1032
  */
1061
1033
  export declare const GeocodeAdditionalFeature: {
1062
1034
  readonly ACCESS: "Access";
1035
+ readonly INTERSECTIONS: "Intersections";
1036
+ readonly SECONDARY_ADDRESSES: "SecondaryAddresses";
1063
1037
  readonly TIME_ZONE: "TimeZone";
1064
1038
  };
1065
1039
  /**
@@ -1083,7 +1057,7 @@ export declare const GeocodeFilterPlaceType: {
1083
1057
  */
1084
1058
  export type GeocodeFilterPlaceType = (typeof GeocodeFilterPlaceType)[keyof typeof GeocodeFilterPlaceType];
1085
1059
  /**
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>
1060
+ * <p>Geocode structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
1087
1061
  * @public
1088
1062
  */
1089
1063
  export interface GeocodeFilter {
@@ -1127,8 +1101,7 @@ export interface GeocodeQueryComponents {
1127
1101
  */
1128
1102
  Country?: string | undefined;
1129
1103
  /**
1130
- * <p>The region or state results should be to be present in. </p>
1131
- * <p>Example: <code>North Rhine-Westphalia</code>.</p>
1104
+ * <p>The region or state results should be to be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>
1132
1105
  * @public
1133
1106
  */
1134
1107
  Region?: string | undefined;
@@ -1138,8 +1111,7 @@ export interface GeocodeQueryComponents {
1138
1111
  */
1139
1112
  SubRegion?: string | undefined;
1140
1113
  /**
1141
- * <p>City or locality results should be present in. </p>
1142
- * <p>Example: <code>Vancouver</code>.</p>
1114
+ * <p>The city or locality results should be present in. </p> <p>Example: <code>Vancouver</code>.</p>
1143
1115
  * @public
1144
1116
  */
1145
1117
  Locality?: string | undefined;
@@ -1159,7 +1131,7 @@ export interface GeocodeQueryComponents {
1159
1131
  */
1160
1132
  AddressNumber?: string | undefined;
1161
1133
  /**
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>
1134
+ * <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 possess. </p>
1163
1135
  * @public
1164
1136
  */
1165
1137
  PostalCode?: string | undefined;
@@ -1169,7 +1141,7 @@ export interface GeocodeQueryComponents {
1169
1141
  */
1170
1142
  export interface GeocodeRequest {
1171
1143
  /**
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>
1144
+ * <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> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
1173
1145
  * @public
1174
1146
  */
1175
1147
  QueryText?: string | undefined;
@@ -1184,24 +1156,17 @@ export interface GeocodeRequest {
1184
1156
  */
1185
1157
  MaxResults?: number | undefined;
1186
1158
  /**
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>
1159
+ * <p>The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in <code>[lng, lat]</code> and in the WSG84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
1194
1160
  * @public
1195
1161
  */
1196
1162
  BiasPosition?: number[] | undefined;
1197
1163
  /**
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>
1164
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
1199
1165
  * @public
1200
1166
  */
1201
1167
  Filter?: GeocodeFilter | undefined;
1202
1168
  /**
1203
- * <p>A list of optional additional parameters, such as time zone, that can be requested for
1204
- * each result.</p>
1169
+ * <p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p>
1205
1170
  * @public
1206
1171
  */
1207
1172
  AdditionalFeatures?: GeocodeAdditionalFeature[] | undefined;
@@ -1211,24 +1176,103 @@ export interface GeocodeRequest {
1211
1176
  */
1212
1177
  Language?: string | undefined;
1213
1178
  /**
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>
1179
+ * <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>
1216
1180
  * @public
1217
1181
  */
1218
1182
  PoliticalView?: string | undefined;
1219
1183
  /**
1220
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left
1221
- * empty.</p>
1184
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p> <note> <p>Storing the response of an Geocode query is required to comply with service terms, but charged at a higher cost per request. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
1222
1185
  * @public
1223
1186
  */
1224
1187
  IntendedUse?: GeocodeIntendedUse | undefined;
1225
1188
  /**
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>
1189
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
1228
1190
  * @public
1229
1191
  */
1230
1192
  Key?: string | undefined;
1231
1193
  }
1194
+ /**
1195
+ * <p>All Intersections that are near the provided address.</p>
1196
+ * @public
1197
+ */
1198
+ export interface Intersection {
1199
+ /**
1200
+ * <p>The <code>PlaceId</code> of the place result.</p>
1201
+ * @public
1202
+ */
1203
+ PlaceId: string | undefined;
1204
+ /**
1205
+ * <p>The localized display name of this result item based on request parameter <code>language</code>.</p>
1206
+ * @public
1207
+ */
1208
+ Title: string | undefined;
1209
+ /**
1210
+ * <p>The place address.</p>
1211
+ * @public
1212
+ */
1213
+ Address?: Address | undefined;
1214
+ /**
1215
+ * <p>The position, in longitude and latitude.</p>
1216
+ * @public
1217
+ */
1218
+ Position?: number[] | undefined;
1219
+ /**
1220
+ * <p>The distance in meters from the QueryPosition.</p>
1221
+ * @public
1222
+ */
1223
+ Distance?: number | undefined;
1224
+ /**
1225
+ * <p>The distance from the routing position of the nearby address to the street result.</p>
1226
+ * @public
1227
+ */
1228
+ RouteDistance?: number | undefined;
1229
+ /**
1230
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set of four coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
1231
+ * @public
1232
+ */
1233
+ MapView?: number[] | undefined;
1234
+ /**
1235
+ * <p>Position of the access point represented by longitude and latitude.</p>
1236
+ * @public
1237
+ */
1238
+ AccessPoints?: AccessPoint[] | undefined;
1239
+ }
1240
+ /**
1241
+ * <p>Place that is related to the result item.</p>
1242
+ * @public
1243
+ */
1244
+ export interface RelatedPlace {
1245
+ /**
1246
+ * <p>The <code>PlaceId</code> of the place result.</p>
1247
+ * @public
1248
+ */
1249
+ PlaceId: string | undefined;
1250
+ /**
1251
+ * <p>A <code>PlaceType</code> is a category that the result place must belong to.</p>
1252
+ * @public
1253
+ */
1254
+ PlaceType: PlaceType | undefined;
1255
+ /**
1256
+ * <p>The localized display name of this result item based on request parameter <code>language</code>.</p>
1257
+ * @public
1258
+ */
1259
+ Title: string | undefined;
1260
+ /**
1261
+ * <p>The place address.</p>
1262
+ * @public
1263
+ */
1264
+ Address?: Address | undefined;
1265
+ /**
1266
+ * <p>The position, in longitude and latitude.</p>
1267
+ * @public
1268
+ */
1269
+ Position?: number[] | undefined;
1270
+ /**
1271
+ * <p>Position of the access point represented by longitude and latitude.</p>
1272
+ * @public
1273
+ */
1274
+ AccessPoints?: AccessPoint[] | undefined;
1275
+ }
1232
1276
  /**
1233
1277
  * <p>Details related to the match score.</p>
1234
1278
  * @public
@@ -1240,12 +1284,155 @@ export interface MatchScoreDetails {
1240
1284
  */
1241
1285
  Overall?: number | undefined;
1242
1286
  /**
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>
1287
+ * <p>Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.</p>
1245
1288
  * @public
1246
1289
  */
1247
1290
  Components?: ComponentMatchScores | undefined;
1248
1291
  }
1292
+ /**
1293
+ * <p>Parsed components in the provided QueryText.</p>
1294
+ * @public
1295
+ */
1296
+ export interface ParsedQueryComponent {
1297
+ /**
1298
+ * <p>Start index of the parsed query component.</p>
1299
+ * @public
1300
+ */
1301
+ StartIndex?: number | undefined;
1302
+ /**
1303
+ * <p>End index of the parsed query component.</p>
1304
+ * @public
1305
+ */
1306
+ EndIndex?: number | undefined;
1307
+ /**
1308
+ * <p>Value of the parsed query component.</p>
1309
+ * @public
1310
+ */
1311
+ Value?: string | undefined;
1312
+ /**
1313
+ * <p>The address component that the parsed query component corresponds to.</p>
1314
+ * @public
1315
+ */
1316
+ QueryComponent?: string | undefined;
1317
+ }
1318
+ /**
1319
+ * <p>Information about a secondary address component parsed from the query text.</p>
1320
+ * @public
1321
+ */
1322
+ export interface ParsedQuerySecondaryAddressComponent {
1323
+ /**
1324
+ * <p>Start index of the parsed secondary address component in the query text.</p>
1325
+ * @public
1326
+ */
1327
+ StartIndex: number | undefined;
1328
+ /**
1329
+ * <p>End index of the parsed secondary address component in the query text.</p>
1330
+ * @public
1331
+ */
1332
+ EndIndex: number | undefined;
1333
+ /**
1334
+ * <p>Value of the parsed secondary address component.</p>
1335
+ * @public
1336
+ */
1337
+ Value: string | undefined;
1338
+ /**
1339
+ * <p>Secondary address number provided in the query.</p>
1340
+ * @public
1341
+ */
1342
+ Number: string | undefined;
1343
+ /**
1344
+ * <p>Secondary address designator provided in the query.</p>
1345
+ * @public
1346
+ */
1347
+ Designator: string | undefined;
1348
+ }
1349
+ /**
1350
+ * <p>Parsed address components in the provided QueryText.</p>
1351
+ * @public
1352
+ */
1353
+ export interface GeocodeParsedQueryAddressComponents {
1354
+ /**
1355
+ * <p>The alpha-2 or alpha-3 character code for the country that the results will be present in.</p>
1356
+ * @public
1357
+ */
1358
+ Country?: ParsedQueryComponent[] | undefined;
1359
+ /**
1360
+ * <p>The region or state results should be present in. </p> <p>Example: <code>North Rhine-Westphalia</code>.</p>
1361
+ * @public
1362
+ */
1363
+ Region?: ParsedQueryComponent[] | undefined;
1364
+ /**
1365
+ * <p>The sub-region or county for which results should be present in. </p>
1366
+ * @public
1367
+ */
1368
+ SubRegion?: ParsedQueryComponent[] | undefined;
1369
+ /**
1370
+ * <p>The city or locality of the address.</p> <p>Example: <code>Vancouver</code>.</p>
1371
+ * @public
1372
+ */
1373
+ Locality?: ParsedQueryComponent[] | undefined;
1374
+ /**
1375
+ * <p>The district or division of a city the results should be present in.</p>
1376
+ * @public
1377
+ */
1378
+ District?: ParsedQueryComponent[] | undefined;
1379
+ /**
1380
+ * <p>A subdivision of a district. </p> <p>Example: <code>Minden-Lübbecke</code>.</p>
1381
+ * @public
1382
+ */
1383
+ SubDistrict?: ParsedQueryComponent[] | undefined;
1384
+ /**
1385
+ * <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 possess. </p>
1386
+ * @public
1387
+ */
1388
+ PostalCode?: ParsedQueryComponent[] | undefined;
1389
+ /**
1390
+ * <p>Name of the block. </p> <p>Example: <code>Sunny Mansion 203 block: 2 Chome</code> </p>
1391
+ * @public
1392
+ */
1393
+ Block?: ParsedQueryComponent[] | undefined;
1394
+ /**
1395
+ * <p>Name of sub-block. </p> <p>Example: <code>Sunny Mansion 203 sub-block: 4</code> </p>
1396
+ * @public
1397
+ */
1398
+ SubBlock?: ParsedQueryComponent[] | undefined;
1399
+ /**
1400
+ * <p>The name of the street results should be present in.</p>
1401
+ * @public
1402
+ */
1403
+ Street?: ParsedQueryComponent[] | undefined;
1404
+ /**
1405
+ * <p>The number that identifies an address within a street.</p>
1406
+ * @public
1407
+ */
1408
+ AddressNumber?: ParsedQueryComponent[] | undefined;
1409
+ /**
1410
+ * <p>The name of the building at the address.</p>
1411
+ * @public
1412
+ */
1413
+ Building?: ParsedQueryComponent[] | undefined;
1414
+ /**
1415
+ * <p>Parsed secondary address components from the provided query text.</p>
1416
+ * @public
1417
+ */
1418
+ SecondaryAddressComponents?: ParsedQuerySecondaryAddressComponent[] | undefined;
1419
+ }
1420
+ /**
1421
+ * <p>Parsed components in the provided QueryText.</p>
1422
+ * @public
1423
+ */
1424
+ export interface GeocodeParsedQuery {
1425
+ /**
1426
+ * <p>The localized display name of this result item based on request parameter <code>language</code>.</p>
1427
+ * @public
1428
+ */
1429
+ Title?: ParsedQueryComponent[] | undefined;
1430
+ /**
1431
+ * <p>The place address.</p>
1432
+ * @public
1433
+ */
1434
+ Address?: GeocodeParsedQueryAddressComponents | undefined;
1435
+ }
1249
1436
  /**
1250
1437
  * @public
1251
1438
  * @enum
@@ -1326,7 +1513,7 @@ export interface UspsZipPlus4 {
1326
1513
  */
1327
1514
  export interface PostalCodeDetails {
1328
1515
  /**
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>
1516
+ * <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 possess. </p>
1330
1517
  * @public
1331
1518
  */
1332
1519
  PostalCode?: string | undefined;
@@ -1378,7 +1565,7 @@ export interface TimeZone {
1378
1565
  */
1379
1566
  export interface GeocodeResultItem {
1380
1567
  /**
1381
- * <p>The <code>PlaceId</code> of the place you wish to receive the information for.</p>
1568
+ * <p>The <code>PlaceId</code> of the place result.</p>
1382
1569
  * @public
1383
1570
  */
1384
1571
  PlaceId: string | undefined;
@@ -1418,10 +1605,7 @@ export interface GeocodeResultItem {
1418
1605
  */
1419
1606
  Distance?: number | undefined;
1420
1607
  /**
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>
1608
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
1425
1609
  * @public
1426
1610
  */
1427
1611
  MapView?: number[] | undefined;
@@ -1436,7 +1620,7 @@ export interface GeocodeResultItem {
1436
1620
  */
1437
1621
  FoodTypes?: FoodType[] | undefined;
1438
1622
  /**
1439
- * <p>Position of the access point represent by longitude and latitude.</p>
1623
+ * <p>Position of the access point represented by longitude and latitude.</p>
1440
1624
  * @public
1441
1625
  */
1442
1626
  AccessPoints?: AccessPoint[] | undefined;
@@ -1451,19 +1635,37 @@ export interface GeocodeResultItem {
1451
1635
  */
1452
1636
  PoliticalView?: string | undefined;
1453
1637
  /**
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>
1638
+ * <p>Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.</p>
1456
1639
  * @public
1457
1640
  */
1458
1641
  MatchScores?: MatchScoreDetails | undefined;
1642
+ /**
1643
+ * <p>Free-form text query.</p>
1644
+ * @public
1645
+ */
1646
+ ParsedQuery?: GeocodeParsedQuery | undefined;
1647
+ /**
1648
+ * <p>All Intersections that are near the provided address.</p>
1649
+ * @public
1650
+ */
1651
+ Intersections?: Intersection[] | undefined;
1652
+ /**
1653
+ * <p>The main address corresponding to a place of type Secondary Address.</p>
1654
+ * @public
1655
+ */
1656
+ MainAddress?: RelatedPlace | undefined;
1657
+ /**
1658
+ * <p>All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.</p>
1659
+ * @public
1660
+ */
1661
+ SecondaryAddresses?: RelatedPlace[] | undefined;
1459
1662
  }
1460
1663
  /**
1461
1664
  * @public
1462
1665
  */
1463
1666
  export interface GeocodeResponse {
1464
1667
  /**
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>
1668
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
1467
1669
  * @public
1468
1670
  */
1469
1671
  PricingBucket: string | undefined;
@@ -1481,6 +1683,7 @@ export declare const GetPlaceAdditionalFeature: {
1481
1683
  readonly ACCESS: "Access";
1482
1684
  readonly CONTACT: "Contact";
1483
1685
  readonly PHONEMES: "Phonemes";
1686
+ readonly SECONDARY_ADDRESSES: "SecondaryAddresses";
1484
1687
  readonly TIME_ZONE: "TimeZone";
1485
1688
  };
1486
1689
  /**
@@ -1515,8 +1718,7 @@ export interface GetPlaceRequest {
1515
1718
  */
1516
1719
  PlaceId: string | undefined;
1517
1720
  /**
1518
- * <p>A list of optional additional parameters such as time zone that can be requested for
1519
- * each result.</p>
1721
+ * <p>A list of optional additional parameters such as time zone that can be requested for each result.</p>
1520
1722
  * @public
1521
1723
  */
1522
1724
  AdditionalFeatures?: GetPlaceAdditionalFeature[] | undefined;
@@ -1531,13 +1733,12 @@ export interface GetPlaceRequest {
1531
1733
  */
1532
1734
  PoliticalView?: string | undefined;
1533
1735
  /**
1534
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p>
1736
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p> <note> <p>Storing the response of an GetPlace query is required to comply with service terms, but charged at a higher cost per request. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
1535
1737
  * @public
1536
1738
  */
1537
1739
  IntendedUse?: GetPlaceIntendedUse | undefined;
1538
1740
  /**
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>
1741
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
1541
1742
  * @public
1542
1743
  */
1543
1744
  Key?: string | undefined;
@@ -1553,15 +1754,12 @@ export interface OpeningHoursComponents {
1553
1754
  */
1554
1755
  OpenTime?: string | undefined;
1555
1756
  /**
1556
- * <p>String which represents the duration of the opening period, such as
1557
- * <code>"PT12H00M"</code>.</p>
1757
+ * <p>String which represents the duration of the opening period, such as <code>"PT12H00M"</code>.</p>
1558
1758
  * @public
1559
1759
  */
1560
1760
  OpenDuration?: string | undefined;
1561
1761
  /**
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>
1762
+ * <p>Days or periods when the provided opening hours are in affect. </p> <p>Example: <code>FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU</code> </p>
1565
1763
  * @public
1566
1764
  */
1567
1765
  Recurrence?: string | undefined;
@@ -1572,8 +1770,7 @@ export interface OpeningHoursComponents {
1572
1770
  */
1573
1771
  export interface OpeningHours {
1574
1772
  /**
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>
1773
+ * <p>List of opening hours in the format they are displayed in. This can vary by result and in most cases represents how the result uniquely formats their opening hours. </p>
1577
1774
  * @public
1578
1775
  */
1579
1776
  Display?: string[] | undefined;
@@ -1599,8 +1796,7 @@ export interface OpeningHours {
1599
1796
  */
1600
1797
  export interface PhonemeDetails {
1601
1798
  /**
1602
- * <p>List of <code>PhonemeTranscription</code>. See <code>PhonemeTranscription</code> for
1603
- * fields.</p>
1799
+ * <p>List of <code>PhonemeTranscription</code>. See <code>PhonemeTranscription</code> for fields.</p>
1604
1800
  * @public
1605
1801
  */
1606
1802
  Title?: PhonemeTranscription[] | undefined;
@@ -1625,13 +1821,12 @@ export interface GetPlaceResponse {
1625
1821
  */
1626
1822
  PlaceType: PlaceType | undefined;
1627
1823
  /**
1628
- * <p>The localized display name of this result item based on request parameter <code>language</code>. </p>
1824
+ * <p>The localized display name of this result item based on request parameter <code>language</code>.</p>
1629
1825
  * @public
1630
1826
  */
1631
1827
  Title: string | undefined;
1632
1828
  /**
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>
1829
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
1635
1830
  * @public
1636
1831
  */
1637
1832
  PricingBucket: string | undefined;
@@ -1656,10 +1851,7 @@ export interface GetPlaceResponse {
1656
1851
  */
1657
1852
  Position?: number[] | undefined;
1658
1853
  /**
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>
1854
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set of four coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
1663
1855
  * @public
1664
1856
  */
1665
1857
  MapView?: number[] | undefined;
@@ -1709,11 +1901,20 @@ export interface GetPlaceResponse {
1709
1901
  */
1710
1902
  PoliticalView?: string | undefined;
1711
1903
  /**
1712
- * <p>How the various components of the result's address are pronounced in various
1713
- * languages.</p>
1904
+ * <p>How the various components of the result's address are pronounced in various languages.</p>
1714
1905
  * @public
1715
1906
  */
1716
1907
  Phonemes?: PhonemeDetails | undefined;
1908
+ /**
1909
+ * <p>The main address corresponding to a place of type Secondary Address.</p>
1910
+ * @public
1911
+ */
1912
+ MainAddress?: RelatedPlace | undefined;
1913
+ /**
1914
+ * <p>All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.</p>
1915
+ * @public
1916
+ */
1917
+ SecondaryAddresses?: RelatedPlace[] | undefined;
1717
1918
  }
1718
1919
  /**
1719
1920
  * @public
@@ -1721,6 +1922,7 @@ export interface GetPlaceResponse {
1721
1922
  */
1722
1923
  export declare const ReverseGeocodeAdditionalFeature: {
1723
1924
  readonly ACCESS: "Access";
1925
+ readonly INTERSECTIONS: "Intersections";
1724
1926
  readonly TIME_ZONE: "TimeZone";
1725
1927
  };
1726
1928
  /**
@@ -1776,7 +1978,7 @@ export type ReverseGeocodeIntendedUse = (typeof ReverseGeocodeIntendedUse)[keyof
1776
1978
  */
1777
1979
  export interface ReverseGeocodeRequest {
1778
1980
  /**
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>
1981
+ * <p>The position, in <code>[lng, lat]</code> for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position</p>
1780
1982
  * @public
1781
1983
  */
1782
1984
  QueryPosition: number[] | undefined;
@@ -1791,13 +1993,12 @@ export interface ReverseGeocodeRequest {
1791
1993
  */
1792
1994
  MaxResults?: number | undefined;
1793
1995
  /**
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>
1996
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
1795
1997
  * @public
1796
1998
  */
1797
1999
  Filter?: ReverseGeocodeFilter | undefined;
1798
2000
  /**
1799
- * <p>A list of optional additional parameters, such as time zone that can be requested for
1800
- * each result.</p>
2001
+ * <p>A list of optional additional parameters, such as time zone that can be requested for each result.</p>
1801
2002
  * @public
1802
2003
  */
1803
2004
  AdditionalFeatures?: ReverseGeocodeAdditionalFeature[] | undefined;
@@ -1812,13 +2013,12 @@ export interface ReverseGeocodeRequest {
1812
2013
  */
1813
2014
  PoliticalView?: string | undefined;
1814
2015
  /**
1815
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p>
2016
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p> <note> <p>Storing the response of an ReverseGeocode query is required to comply with service terms, but charged at a higher cost per request. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
1816
2017
  * @public
1817
2018
  */
1818
2019
  IntendedUse?: ReverseGeocodeIntendedUse | undefined;
1819
2020
  /**
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>
2021
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
1822
2022
  * @public
1823
2023
  */
1824
2024
  Key?: string | undefined;
@@ -1869,10 +2069,7 @@ export interface ReverseGeocodeResultItem {
1869
2069
  */
1870
2070
  Distance?: number | undefined;
1871
2071
  /**
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>
2072
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
1876
2073
  * @public
1877
2074
  */
1878
2075
  MapView?: number[] | undefined;
@@ -1887,7 +2084,7 @@ export interface ReverseGeocodeResultItem {
1887
2084
  */
1888
2085
  FoodTypes?: FoodType[] | undefined;
1889
2086
  /**
1890
- * <p>Position of the access point represent by longitude and latitude.</p>
2087
+ * <p>Position of the access point represented by longitude and latitude.</p>
1891
2088
  * @public
1892
2089
  */
1893
2090
  AccessPoints?: AccessPoint[] | undefined;
@@ -1901,14 +2098,18 @@ export interface ReverseGeocodeResultItem {
1901
2098
  * @public
1902
2099
  */
1903
2100
  PoliticalView?: string | undefined;
2101
+ /**
2102
+ * <p>All Intersections that are near the provided address.</p>
2103
+ * @public
2104
+ */
2105
+ Intersections?: Intersection[] | undefined;
1904
2106
  }
1905
2107
  /**
1906
2108
  * @public
1907
2109
  */
1908
2110
  export interface ReverseGeocodeResponse {
1909
2111
  /**
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>
2112
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
1912
2113
  * @public
1913
2114
  */
1914
2115
  PricingBucket: string | undefined;
@@ -1933,15 +2134,12 @@ export declare const SearchNearbyAdditionalFeature: {
1933
2134
  */
1934
2135
  export type SearchNearbyAdditionalFeature = (typeof SearchNearbyAdditionalFeature)[keyof typeof SearchNearbyAdditionalFeature];
1935
2136
  /**
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>
2137
+ * <p>SearchNearby structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
1937
2138
  * @public
1938
2139
  */
1939
2140
  export interface SearchNearbyFilter {
1940
2141
  /**
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>
2142
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
1945
2143
  * @public
1946
2144
  */
1947
2145
  BoundingBox?: number[] | undefined;
@@ -2004,12 +2202,12 @@ export type SearchNearbyIntendedUse = (typeof SearchNearbyIntendedUse)[keyof typ
2004
2202
  */
2005
2203
  export interface SearchNearbyRequest {
2006
2204
  /**
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>
2205
+ * <p>The position, in <code>[lng, lat]</code> for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position</p>
2008
2206
  * @public
2009
2207
  */
2010
2208
  QueryPosition: number[] | undefined;
2011
2209
  /**
2012
- * <p>The maximum distance in meters from the QueryPosition from which a result will be returned.</p>
2210
+ * <p>The maximum distance in meters from the QueryPosition from which a result will be returned.</p> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
2013
2211
  * @public
2014
2212
  */
2015
2213
  QueryRadius?: number | undefined;
@@ -2019,13 +2217,12 @@ export interface SearchNearbyRequest {
2019
2217
  */
2020
2218
  MaxResults?: number | undefined;
2021
2219
  /**
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>
2220
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
2023
2221
  * @public
2024
2222
  */
2025
2223
  Filter?: SearchNearbyFilter | undefined;
2026
2224
  /**
2027
- * <p>A list of optional additional parameters, such as time zone, that can be requested for
2028
- * each result.</p>
2225
+ * <p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p>
2029
2226
  * @public
2030
2227
  */
2031
2228
  AdditionalFeatures?: SearchNearbyAdditionalFeature[] | undefined;
@@ -2040,19 +2237,17 @@ export interface SearchNearbyRequest {
2040
2237
  */
2041
2238
  PoliticalView?: string | undefined;
2042
2239
  /**
2043
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p>
2240
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p> <note> <p>Storing the response of an SearchNearby query is required to comply with service terms, but charged at a higher cost per request. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
2044
2241
  * @public
2045
2242
  */
2046
2243
  IntendedUse?: SearchNearbyIntendedUse | undefined;
2047
2244
  /**
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>
2245
+ * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. </p>
2050
2246
  * @public
2051
2247
  */
2052
2248
  NextToken?: string | undefined;
2053
2249
  /**
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>
2250
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
2056
2251
  * @public
2057
2252
  */
2058
2253
  Key?: string | undefined;
@@ -2098,10 +2293,7 @@ export interface SearchNearbyResultItem {
2098
2293
  */
2099
2294
  Distance?: number | undefined;
2100
2295
  /**
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>
2296
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
2105
2297
  * @public
2106
2298
  */
2107
2299
  MapView?: number[] | undefined;
@@ -2151,8 +2343,7 @@ export interface SearchNearbyResultItem {
2151
2343
  */
2152
2344
  PoliticalView?: string | undefined;
2153
2345
  /**
2154
- * <p>How the various components of the result's address are pronounced in various
2155
- * languages.</p>
2346
+ * <p>How the various components of the result's address are pronounced in various languages.</p>
2156
2347
  * @public
2157
2348
  */
2158
2349
  Phonemes?: PhonemeDetails | undefined;
@@ -2162,8 +2353,7 @@ export interface SearchNearbyResultItem {
2162
2353
  */
2163
2354
  export interface SearchNearbyResponse {
2164
2355
  /**
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>
2356
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
2167
2357
  * @public
2168
2358
  */
2169
2359
  PricingBucket: string | undefined;
@@ -2173,8 +2363,7 @@ export interface SearchNearbyResponse {
2173
2363
  */
2174
2364
  ResultItems?: SearchNearbyResultItem[] | undefined;
2175
2365
  /**
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>
2366
+ * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. </p>
2178
2367
  * @public
2179
2368
  */
2180
2369
  NextToken?: string | undefined;
@@ -2194,15 +2383,12 @@ export declare const SearchTextAdditionalFeature: {
2194
2383
  */
2195
2384
  export type SearchTextAdditionalFeature = (typeof SearchTextAdditionalFeature)[keyof typeof SearchTextAdditionalFeature];
2196
2385
  /**
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>
2386
+ * <p>SearchText structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
2198
2387
  * @public
2199
2388
  */
2200
2389
  export interface SearchTextFilter {
2201
2390
  /**
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>
2391
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
2206
2392
  * @public
2207
2393
  */
2208
2394
  BoundingBox?: number[] | undefined;
@@ -2240,12 +2426,12 @@ export type SearchTextIntendedUse = (typeof SearchTextIntendedUse)[keyof typeof
2240
2426
  */
2241
2427
  export interface SearchTextRequest {
2242
2428
  /**
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>
2429
+ * <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> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
2244
2430
  * @public
2245
2431
  */
2246
2432
  QueryText?: string | undefined;
2247
2433
  /**
2248
- * <p>The query Id.</p>
2434
+ * <p>The query Id returned by the suggest API. If passed in the request, the SearchText API will preform a SearchText query with the improved query terms for the original query made to the suggest API.</p> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
2249
2435
  * @public
2250
2436
  */
2251
2437
  QueryId?: string | undefined;
@@ -2255,23 +2441,17 @@ export interface SearchTextRequest {
2255
2441
  */
2256
2442
  MaxResults?: number | undefined;
2257
2443
  /**
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>
2444
+ * <p>The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in <code>[lng, lat]</code> and in the WSG84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
2264
2445
  * @public
2265
2446
  */
2266
2447
  BiasPosition?: number[] | undefined;
2267
2448
  /**
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>
2449
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
2269
2450
  * @public
2270
2451
  */
2271
2452
  Filter?: SearchTextFilter | undefined;
2272
2453
  /**
2273
- * <p>A list of optional additional parameters, such as time zone, that can be requested for
2274
- * each result.</p>
2454
+ * <p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p>
2275
2455
  * @public
2276
2456
  */
2277
2457
  AdditionalFeatures?: SearchTextAdditionalFeature[] | undefined;
@@ -2286,19 +2466,17 @@ export interface SearchTextRequest {
2286
2466
  */
2287
2467
  PoliticalView?: string | undefined;
2288
2468
  /**
2289
- * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p>
2469
+ * <p>Indicates if the results will be stored. Defaults to <code>SingleUse</code>, if left empty.</p> <note> <p>Storing the response of an SearchText query is required to comply with service terms, but charged at a higher cost per request. Please review the <a href="https://aws.amazon.com/location/sla/">user agreement</a> and <a href="https://aws.amazon.com/location/pricing/">service pricing structure</a> to determine the correct setting for your use case.</p> </note>
2290
2470
  * @public
2291
2471
  */
2292
2472
  IntendedUse?: SearchTextIntendedUse | undefined;
2293
2473
  /**
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>
2474
+ * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. </p>
2296
2475
  * @public
2297
2476
  */
2298
2477
  NextToken?: string | undefined;
2299
2478
  /**
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>
2479
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
2302
2480
  * @public
2303
2481
  */
2304
2482
  Key?: string | undefined;
@@ -2344,10 +2522,7 @@ export interface SearchTextResultItem {
2344
2522
  */
2345
2523
  Distance?: number | undefined;
2346
2524
  /**
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>
2525
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
2351
2526
  * @public
2352
2527
  */
2353
2528
  MapView?: number[] | undefined;
@@ -2397,8 +2572,7 @@ export interface SearchTextResultItem {
2397
2572
  */
2398
2573
  PoliticalView?: string | undefined;
2399
2574
  /**
2400
- * <p>How the various components of the result's address are pronounced in various
2401
- * languages.</p>
2575
+ * <p>How the various components of the result's address are pronounced in various languages.</p>
2402
2576
  * @public
2403
2577
  */
2404
2578
  Phonemes?: PhonemeDetails | undefined;
@@ -2408,8 +2582,7 @@ export interface SearchTextResultItem {
2408
2582
  */
2409
2583
  export interface SearchTextResponse {
2410
2584
  /**
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>
2585
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
2413
2586
  * @public
2414
2587
  */
2415
2588
  PricingBucket: string | undefined;
@@ -2419,8 +2592,7 @@ export interface SearchTextResponse {
2419
2592
  */
2420
2593
  ResultItems?: SearchTextResultItem[] | undefined;
2421
2594
  /**
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>
2595
+ * <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. </p>
2424
2596
  * @public
2425
2597
  */
2426
2598
  NextToken?: string | undefined;
@@ -2440,15 +2612,12 @@ export declare const SuggestAdditionalFeature: {
2440
2612
  */
2441
2613
  export type SuggestAdditionalFeature = (typeof SuggestAdditionalFeature)[keyof typeof SuggestAdditionalFeature];
2442
2614
  /**
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>
2615
+ * <p>SuggestFilter structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
2444
2616
  * @public
2445
2617
  */
2446
2618
  export interface SuggestFilter {
2447
2619
  /**
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>
2620
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
2452
2621
  * @public
2453
2622
  */
2454
2623
  BoundingBox?: number[] | undefined;
@@ -2482,7 +2651,7 @@ export type SuggestIntendedUse = (typeof SuggestIntendedUse)[keyof typeof Sugges
2482
2651
  */
2483
2652
  export interface SuggestRequest {
2484
2653
  /**
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>
2654
+ * <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> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
2486
2655
  * @public
2487
2656
  */
2488
2657
  QueryText: string | undefined;
@@ -2497,23 +2666,17 @@ export interface SuggestRequest {
2497
2666
  */
2498
2667
  MaxQueryRefinements?: number | undefined;
2499
2668
  /**
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>
2669
+ * <p>The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in <code>[lng, lat]</code> and in the WSG84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
2506
2670
  * @public
2507
2671
  */
2508
2672
  BiasPosition?: number[] | undefined;
2509
2673
  /**
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>
2674
+ * <p>A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.</p>
2511
2675
  * @public
2512
2676
  */
2513
2677
  Filter?: SuggestFilter | undefined;
2514
2678
  /**
2515
- * <p>A list of optional additional parameters, such as time zone, that can be requested for
2516
- * each result.</p>
2679
+ * <p>A list of optional additional parameters, such as time zone, that can be requested for each result.</p>
2517
2680
  * @public
2518
2681
  */
2519
2682
  AdditionalFeatures?: SuggestAdditionalFeature[] | undefined;
@@ -2533,15 +2696,13 @@ export interface SuggestRequest {
2533
2696
  */
2534
2697
  IntendedUse?: SuggestIntendedUse | undefined;
2535
2698
  /**
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>
2699
+ * <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
2538
2700
  * @public
2539
2701
  */
2540
2702
  Key?: string | undefined;
2541
2703
  }
2542
2704
  /**
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>
2705
+ * <p>Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query. </p>
2545
2706
  * @public
2546
2707
  */
2547
2708
  export interface QueryRefinement {
@@ -2624,10 +2785,7 @@ export interface SuggestPlaceResult {
2624
2785
  */
2625
2786
  Distance?: number | undefined;
2626
2787
  /**
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>
2788
+ * <p>The bounding box enclosing the geometric shape (area or line) that an individual result covers.</p> <p>The bounding box formed is defined as a set 4 coordinates: <code>[\{westward lng\}, \{southern lat\}, \{eastward lng\}, \{northern lat\}]</code> </p>
2631
2789
  * @public
2632
2790
  */
2633
2791
  MapView?: number[] | undefined;
@@ -2667,8 +2825,7 @@ export interface SuggestPlaceResult {
2667
2825
  */
2668
2826
  PoliticalView?: string | undefined;
2669
2827
  /**
2670
- * <p>How the various components of the result's address are pronounced in various
2671
- * languages.</p>
2828
+ * <p>How the various components of the result's address are pronounced in various languages.</p>
2672
2829
  * @public
2673
2830
  */
2674
2831
  Phonemes?: PhonemeDetails | undefined;
@@ -2691,12 +2848,12 @@ export type QueryType = (typeof QueryType)[keyof typeof QueryType];
2691
2848
  */
2692
2849
  export interface SuggestQueryResult {
2693
2850
  /**
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>
2851
+ * <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> <note> <p>The fields <code>QueryText</code>, and <code>QueryID</code> are mutually exclusive.</p> </note>
2695
2852
  * @public
2696
2853
  */
2697
2854
  QueryId?: string | undefined;
2698
2855
  /**
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>
2856
+ * <p>The query type. Category queries 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
2857
  * @public
2701
2858
  */
2702
2859
  QueryType?: QueryType | undefined;
@@ -2749,8 +2906,7 @@ export interface SuggestResultItem {
2749
2906
  */
2750
2907
  export interface SuggestResponse {
2751
2908
  /**
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>
2909
+ * <p>The pricing bucket for which the query is charged at.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
2754
2910
  * @public
2755
2911
  */
2756
2912
  PricingBucket: string | undefined;
@@ -2769,6 +2925,46 @@ export interface SuggestResponse {
2769
2925
  * @internal
2770
2926
  */
2771
2927
  export declare const AccessPointFilterSensitiveLog: (obj: AccessPoint) => any;
2928
+ /**
2929
+ * @internal
2930
+ */
2931
+ export declare const CategoryFilterSensitiveLog: (obj: Category) => any;
2932
+ /**
2933
+ * @internal
2934
+ */
2935
+ export declare const AccessRestrictionFilterSensitiveLog: (obj: AccessRestriction) => any;
2936
+ /**
2937
+ * @internal
2938
+ */
2939
+ export declare const CountryFilterSensitiveLog: (obj: Country) => any;
2940
+ /**
2941
+ * @internal
2942
+ */
2943
+ export declare const RegionFilterSensitiveLog: (obj: Region) => any;
2944
+ /**
2945
+ * @internal
2946
+ */
2947
+ export declare const SecondaryAddressComponentFilterSensitiveLog: (obj: SecondaryAddressComponent) => any;
2948
+ /**
2949
+ * @internal
2950
+ */
2951
+ export declare const StreetComponentsFilterSensitiveLog: (obj: StreetComponents) => any;
2952
+ /**
2953
+ * @internal
2954
+ */
2955
+ export declare const SubRegionFilterSensitiveLog: (obj: SubRegion) => any;
2956
+ /**
2957
+ * @internal
2958
+ */
2959
+ export declare const AddressFilterSensitiveLog: (obj: Address) => any;
2960
+ /**
2961
+ * @internal
2962
+ */
2963
+ export declare const PhonemeTranscriptionFilterSensitiveLog: (obj: PhonemeTranscription) => any;
2964
+ /**
2965
+ * @internal
2966
+ */
2967
+ export declare const AddressComponentPhonemesFilterSensitiveLog: (obj: AddressComponentPhonemes) => any;
2772
2968
  /**
2773
2969
  * @internal
2774
2970
  */
@@ -2781,6 +2977,58 @@ export declare const AutocompleteFilterFilterSensitiveLog: (obj: AutocompleteFil
2781
2977
  * @internal
2782
2978
  */
2783
2979
  export declare const AutocompleteRequestFilterSensitiveLog: (obj: AutocompleteRequest) => any;
2980
+ /**
2981
+ * @internal
2982
+ */
2983
+ export declare const HighlightFilterSensitiveLog: (obj: Highlight) => any;
2984
+ /**
2985
+ * @internal
2986
+ */
2987
+ export declare const CountryHighlightsFilterSensitiveLog: (obj: CountryHighlights) => any;
2988
+ /**
2989
+ * @internal
2990
+ */
2991
+ export declare const RegionHighlightsFilterSensitiveLog: (obj: RegionHighlights) => any;
2992
+ /**
2993
+ * @internal
2994
+ */
2995
+ export declare const SubRegionHighlightsFilterSensitiveLog: (obj: SubRegionHighlights) => any;
2996
+ /**
2997
+ * @internal
2998
+ */
2999
+ export declare const AutocompleteAddressHighlightsFilterSensitiveLog: (obj: AutocompleteAddressHighlights) => any;
3000
+ /**
3001
+ * @internal
3002
+ */
3003
+ export declare const AutocompleteHighlightsFilterSensitiveLog: (obj: AutocompleteHighlights) => any;
3004
+ /**
3005
+ * @internal
3006
+ */
3007
+ export declare const AutocompleteResultItemFilterSensitiveLog: (obj: AutocompleteResultItem) => any;
3008
+ /**
3009
+ * @internal
3010
+ */
3011
+ export declare const AutocompleteResponseFilterSensitiveLog: (obj: AutocompleteResponse) => any;
3012
+ /**
3013
+ * @internal
3014
+ */
3015
+ export declare const BusinessChainFilterSensitiveLog: (obj: BusinessChain) => any;
3016
+ /**
3017
+ * @internal
3018
+ */
3019
+ export declare const ContactDetailsFilterSensitiveLog: (obj: ContactDetails) => any;
3020
+ /**
3021
+ * @internal
3022
+ */
3023
+ export declare const ContactsFilterSensitiveLog: (obj: Contacts) => any;
3024
+ /**
3025
+ * @internal
3026
+ */
3027
+ export declare const FoodTypeFilterSensitiveLog: (obj: FoodType) => any;
3028
+ /**
3029
+ * @internal
3030
+ */
3031
+ export declare const GeocodeFilterFilterSensitiveLog: (obj: GeocodeFilter) => any;
2784
3032
  /**
2785
3033
  * @internal
2786
3034
  */
@@ -2789,6 +3037,46 @@ export declare const GeocodeQueryComponentsFilterSensitiveLog: (obj: GeocodeQuer
2789
3037
  * @internal
2790
3038
  */
2791
3039
  export declare const GeocodeRequestFilterSensitiveLog: (obj: GeocodeRequest) => any;
3040
+ /**
3041
+ * @internal
3042
+ */
3043
+ export declare const IntersectionFilterSensitiveLog: (obj: Intersection) => any;
3044
+ /**
3045
+ * @internal
3046
+ */
3047
+ export declare const RelatedPlaceFilterSensitiveLog: (obj: RelatedPlace) => any;
3048
+ /**
3049
+ * @internal
3050
+ */
3051
+ export declare const ParsedQueryComponentFilterSensitiveLog: (obj: ParsedQueryComponent) => any;
3052
+ /**
3053
+ * @internal
3054
+ */
3055
+ export declare const ParsedQuerySecondaryAddressComponentFilterSensitiveLog: (obj: ParsedQuerySecondaryAddressComponent) => any;
3056
+ /**
3057
+ * @internal
3058
+ */
3059
+ export declare const GeocodeParsedQueryAddressComponentsFilterSensitiveLog: (obj: GeocodeParsedQueryAddressComponents) => any;
3060
+ /**
3061
+ * @internal
3062
+ */
3063
+ export declare const GeocodeParsedQueryFilterSensitiveLog: (obj: GeocodeParsedQuery) => any;
3064
+ /**
3065
+ * @internal
3066
+ */
3067
+ export declare const UspsZipFilterSensitiveLog: (obj: UspsZip) => any;
3068
+ /**
3069
+ * @internal
3070
+ */
3071
+ export declare const UspsZipPlus4FilterSensitiveLog: (obj: UspsZipPlus4) => any;
3072
+ /**
3073
+ * @internal
3074
+ */
3075
+ export declare const PostalCodeDetailsFilterSensitiveLog: (obj: PostalCodeDetails) => any;
3076
+ /**
3077
+ * @internal
3078
+ */
3079
+ export declare const TimeZoneFilterSensitiveLog: (obj: TimeZone) => any;
2792
3080
  /**
2793
3081
  * @internal
2794
3082
  */
@@ -2801,6 +3089,18 @@ export declare const GeocodeResponseFilterSensitiveLog: (obj: GeocodeResponse) =
2801
3089
  * @internal
2802
3090
  */
2803
3091
  export declare const GetPlaceRequestFilterSensitiveLog: (obj: GetPlaceRequest) => any;
3092
+ /**
3093
+ * @internal
3094
+ */
3095
+ export declare const OpeningHoursComponentsFilterSensitiveLog: (obj: OpeningHoursComponents) => any;
3096
+ /**
3097
+ * @internal
3098
+ */
3099
+ export declare const OpeningHoursFilterSensitiveLog: (obj: OpeningHours) => any;
3100
+ /**
3101
+ * @internal
3102
+ */
3103
+ export declare const PhonemeDetailsFilterSensitiveLog: (obj: PhonemeDetails) => any;
2804
3104
  /**
2805
3105
  * @internal
2806
3106
  */
@@ -2857,10 +3157,26 @@ export declare const SuggestFilterFilterSensitiveLog: (obj: SuggestFilter) => an
2857
3157
  * @internal
2858
3158
  */
2859
3159
  export declare const SuggestRequestFilterSensitiveLog: (obj: SuggestRequest) => any;
3160
+ /**
3161
+ * @internal
3162
+ */
3163
+ export declare const QueryRefinementFilterSensitiveLog: (obj: QueryRefinement) => any;
3164
+ /**
3165
+ * @internal
3166
+ */
3167
+ export declare const SuggestAddressHighlightsFilterSensitiveLog: (obj: SuggestAddressHighlights) => any;
3168
+ /**
3169
+ * @internal
3170
+ */
3171
+ export declare const SuggestHighlightsFilterSensitiveLog: (obj: SuggestHighlights) => any;
2860
3172
  /**
2861
3173
  * @internal
2862
3174
  */
2863
3175
  export declare const SuggestPlaceResultFilterSensitiveLog: (obj: SuggestPlaceResult) => any;
3176
+ /**
3177
+ * @internal
3178
+ */
3179
+ export declare const SuggestQueryResultFilterSensitiveLog: (obj: SuggestQueryResult) => any;
2864
3180
  /**
2865
3181
  * @internal
2866
3182
  */