@aws-sdk/client-geo-places 3.1081.0 → 3.1083.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.
- package/README.md +1 -1
- package/dist-cjs/index.js +199 -57
- package/dist-es/models/enums.js +67 -0
- package/dist-es/schemas/schemas_0.js +118 -56
- package/dist-types/GeoPlaces.d.ts +1 -1
- package/dist-types/GeoPlacesClient.d.ts +1 -1
- package/dist-types/commands/AutocompleteCommand.d.ts +8 -7
- package/dist-types/commands/GeocodeCommand.d.ts +84 -13
- package/dist-types/commands/GetPlaceCommand.d.ts +29 -11
- package/dist-types/commands/ReverseGeocodeCommand.d.ts +26 -10
- package/dist-types/commands/SearchNearbyCommand.d.ts +18 -5
- package/dist-types/commands/SearchTextCommand.d.ts +18 -4
- package/dist-types/commands/SuggestCommand.d.ts +27 -6
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/enums.d.ts +147 -10
- package/dist-types/models/models_0.d.ts +232 -13
- package/dist-types/schemas/schemas_0.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +87 -0
- package/dist-types/ts3.4/models/models_0.d.ts +57 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +4 -0
- package/package.json +8 -8
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AutocompleteAdditionalFeature, AutocompleteFilterPlaceType, AutocompleteIntendedUse, GeocodeAdditionalFeature, GeocodeFilterPlaceType, GeocodeIntendedUse, GetPlaceAdditionalFeature, GetPlaceIntendedUse, PlaceType, PostalAuthority, PostalCodeMode, PostalCodeType, QueryType, RecordTypeCode, ReverseGeocodeAdditionalFeature, ReverseGeocodeFilterPlaceType, ReverseGeocodeIntendedUse, SearchNearbyAdditionalFeature, SearchNearbyIntendedUse, SearchTextAdditionalFeature, SearchTextIntendedUse, SuggestAdditionalFeature, SuggestIntendedUse, SuggestResultItemType, TypePlacement, ZipClassificationCode } from "./enums";
|
|
1
|
+
import type { AccessPointType, AddressTranslationComponent, AdminNamesPreference, AutocompleteAdditionalFeature, AutocompleteFilterPlaceType, AutocompleteIntendedUse, GeocodeAdditionalFeature, GeocodeAddressNamesMode, GeocodeFilterPlaceType, GeocodeIntendedUse, GetPlaceAdditionalFeature, GetPlaceAddressNamesMode, GetPlaceIntendedUse, PlaceAttribute, PlaceType, PostalAuthority, PostalCodeMode, PostalCodeType, QueryType, RecordTypeCode, ReverseGeocodeAdditionalFeature, ReverseGeocodeAddressNamesMode, ReverseGeocodeFilterPlaceType, ReverseGeocodeIntendedUse, SearchNearbyAdditionalFeature, SearchNearbyIntendedUse, SearchTextAdditionalFeature, SearchTextIntendedUse, SearchTextTravelMode, SuggestAdditionalFeature, SuggestIntendedUse, SuggestResultItemType, SuggestTravelMode, TranslationNameType, TypePlacement, ZipClassificationCode } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Position of the access point represented by longitude and latitude for a vehicle.</p>
|
|
4
4
|
* @public
|
|
@@ -9,6 +9,21 @@ export interface AccessPoint {
|
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
11
|
Position?: number[] | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The type of access point, indicating its intended use. Only applies to results of type place.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
Type?: AccessPointType | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>Set to <code>true</code> for the primary access position when the place has more than one access point.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
Primary?: boolean | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* <p>A short textual description of the access point, such as <code>"North Entrance"</code>.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
Label?: string | undefined;
|
|
12
27
|
}
|
|
13
28
|
/**
|
|
14
29
|
* <p>Category of the <code>Place</code> returned. </p>
|
|
@@ -146,7 +161,7 @@ export interface StreetComponents {
|
|
|
146
161
|
*/
|
|
147
162
|
Direction?: string | undefined;
|
|
148
163
|
/**
|
|
149
|
-
* <p>A <a href="https://
|
|
164
|
+
* <p>A <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
150
165
|
* @public
|
|
151
166
|
*/
|
|
152
167
|
Language?: string | undefined;
|
|
@@ -346,7 +361,7 @@ export interface PhonemeTranscription {
|
|
|
346
361
|
*/
|
|
347
362
|
Value?: string | undefined;
|
|
348
363
|
/**
|
|
349
|
-
* <p>A list of <a href="https://
|
|
364
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
350
365
|
* @public
|
|
351
366
|
*/
|
|
352
367
|
Language?: string | undefined;
|
|
@@ -407,6 +422,53 @@ export interface AddressComponentPhonemes {
|
|
|
407
422
|
*/
|
|
408
423
|
Street?: PhonemeTranscription[] | undefined;
|
|
409
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* <p>A translation or alternative name for an address component.</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
export interface TranslationName {
|
|
430
|
+
/**
|
|
431
|
+
* <p>The translated or alternative name value.</p>
|
|
432
|
+
* @public
|
|
433
|
+
*/
|
|
434
|
+
Value: string | undefined;
|
|
435
|
+
/**
|
|
436
|
+
* <p>A <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">BCP 47</a> compliant language code for the translation name.</p>
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
Language?: string | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* <p>The type of translation name. Valid values are <code>Abbreviation</code>, <code>AreaCode</code>, <code>BaseName</code>, <code>Exonym</code>, <code>Shortened</code>, and <code>Synonym</code>.</p>
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
Type: TranslationNameType | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>If <code>true</code>, indicates this is the primary name variant for the given language.</p>
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
Primary?: boolean | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>If <code>true</code>, indicates this name is a transliterated version rather than a native script translation.</p>
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
Transliterated?: boolean | undefined;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* <p>The official administrative names for an address component, returned when <code>AddressNamesMode</code> is set to <code>Administrative</code>.</p>
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
export interface AdminNames {
|
|
461
|
+
/**
|
|
462
|
+
* <p>A list of translation names for the administrative address component, including name variants and translations in available languages.</p>
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
Names: TranslationName[] | undefined;
|
|
466
|
+
/**
|
|
467
|
+
* <p>Indicates the preference level of the administrative name. Valid values are <code>Primary</code> and <code>Alternative</code>.</p>
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
Preference?: AdminNamesPreference | undefined;
|
|
471
|
+
}
|
|
410
472
|
/**
|
|
411
473
|
* <p>The <code>Circle</code> that all results must be in. </p>
|
|
412
474
|
* @public
|
|
@@ -474,7 +536,7 @@ export interface AutocompleteRequest {
|
|
|
474
536
|
*/
|
|
475
537
|
Filter?: AutocompleteFilter | undefined;
|
|
476
538
|
/**
|
|
477
|
-
* <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>
|
|
539
|
+
* <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. If it's populated with the value <code>EnumerateSpannedDistricts</code>, all combinations of the postal code with the corresponding district and city names are returned.</p>
|
|
478
540
|
* @public
|
|
479
541
|
*/
|
|
480
542
|
PostalCodeMode?: PostalCodeMode | undefined;
|
|
@@ -484,7 +546,7 @@ export interface AutocompleteRequest {
|
|
|
484
546
|
*/
|
|
485
547
|
AdditionalFeatures?: AutocompleteAdditionalFeature[] | undefined;
|
|
486
548
|
/**
|
|
487
|
-
* <p>A list of <a href="https://
|
|
549
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
488
550
|
* @public
|
|
489
551
|
*/
|
|
490
552
|
Language?: string | undefined;
|
|
@@ -696,7 +758,7 @@ export interface AutocompleteResultItem {
|
|
|
696
758
|
*/
|
|
697
759
|
Distance?: number | undefined;
|
|
698
760
|
/**
|
|
699
|
-
* <p>A list of <a href="https://
|
|
761
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
700
762
|
* @public
|
|
701
763
|
*/
|
|
702
764
|
Language?: string | undefined;
|
|
@@ -710,6 +772,11 @@ export interface AutocompleteResultItem {
|
|
|
710
772
|
* @public
|
|
711
773
|
*/
|
|
712
774
|
Highlights?: AutocompleteHighlights | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
EstimatedPointAddress?: boolean | undefined;
|
|
713
780
|
}
|
|
714
781
|
/**
|
|
715
782
|
* @public
|
|
@@ -821,6 +888,27 @@ export interface Contacts {
|
|
|
821
888
|
*/
|
|
822
889
|
Emails?: ContactDetails[] | undefined;
|
|
823
890
|
}
|
|
891
|
+
/**
|
|
892
|
+
* <p>A reference to a third-party supplier's identifier for a place, enabling correlation of places across external systems.</p>
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
export interface CrossReference {
|
|
896
|
+
/**
|
|
897
|
+
* <p>The name of the third-party data supplier (for example, <code>Yelp</code> or <code>TripAdvisor</code>).</p>
|
|
898
|
+
* @public
|
|
899
|
+
*/
|
|
900
|
+
Source: string | undefined;
|
|
901
|
+
/**
|
|
902
|
+
* <p>The place identifier assigned by the third-party supplier.</p>
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
905
|
+
SourcePlaceId: string | undefined;
|
|
906
|
+
/**
|
|
907
|
+
* <p>The list of place category identifiers this supplier reference relates to.</p>
|
|
908
|
+
* @public
|
|
909
|
+
*/
|
|
910
|
+
SourceCategories?: Category[] | undefined;
|
|
911
|
+
}
|
|
824
912
|
/**
|
|
825
913
|
* <p>List of <code>Food</code> types offered by this result.</p>
|
|
826
914
|
* @public
|
|
@@ -939,7 +1027,7 @@ export interface GeocodeRequest {
|
|
|
939
1027
|
*/
|
|
940
1028
|
AdditionalFeatures?: GeocodeAdditionalFeature[] | undefined;
|
|
941
1029
|
/**
|
|
942
|
-
* <p>A list of <a href="https://
|
|
1030
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
943
1031
|
* @public
|
|
944
1032
|
*/
|
|
945
1033
|
Language?: string | undefined;
|
|
@@ -958,6 +1046,21 @@ export interface GeocodeRequest {
|
|
|
958
1046
|
* @public
|
|
959
1047
|
*/
|
|
960
1048
|
Key?: string | undefined;
|
|
1049
|
+
/**
|
|
1050
|
+
* <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. If it's populated with the value <code>EnumerateSpannedDistricts</code>, all combinations of the postal code with the corresponding district and city names are returned.</p>
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
1053
|
+
PostalCodeMode?: PostalCodeMode | undefined;
|
|
1054
|
+
/**
|
|
1055
|
+
* <p>Specifies which address components to include translations for. Translations include all name variants and alternative names for the requested fields in all available languages. Valid values are <code>District</code>, <code>Locality</code>, <code>Region</code>, and <code>SubRegion</code>.</p>
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
AddressTranslations?: AddressTranslationComponent[] | undefined;
|
|
1059
|
+
/**
|
|
1060
|
+
* <p>Specifies how address names are returned. If not set, the service returns normalized (official) names by default. When set to <code>Matched</code>, address names in the response are based on the input query rather than official names. When set to <code>Administrative</code>, the service returns the official administrative names for address components. <code>Administrative</code> currently applies only to addresses in the United States.</p>
|
|
1061
|
+
* @public
|
|
1062
|
+
*/
|
|
1063
|
+
AddressNamesMode?: GeocodeAddressNamesMode | undefined;
|
|
961
1064
|
}
|
|
962
1065
|
/**
|
|
963
1066
|
* <p>All Intersections that are near the provided address.</p>
|
|
@@ -1184,6 +1287,11 @@ export interface GeocodeParsedQueryAddressComponents {
|
|
|
1184
1287
|
* @public
|
|
1185
1288
|
*/
|
|
1186
1289
|
SecondaryAddressComponents?: ParsedQuerySecondaryAddressComponent[] | undefined;
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>Additional information extracted from the query that does not correspond to standard address components.</p>
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
OtherComponents?: ParsedQueryComponent[] | undefined;
|
|
1187
1295
|
}
|
|
1188
1296
|
/**
|
|
1189
1297
|
* <p>Parsed components in the provided QueryText.</p>
|
|
@@ -1275,6 +1383,32 @@ export interface TimeZone {
|
|
|
1275
1383
|
*/
|
|
1276
1384
|
OffsetSeconds?: number | undefined;
|
|
1277
1385
|
}
|
|
1386
|
+
/**
|
|
1387
|
+
* <p>Translation details for the address, including alternative names and translations in available languages.</p>
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
export interface TranslationDetails {
|
|
1391
|
+
/**
|
|
1392
|
+
* <p>A list of administrative names and translations for the locality address component.</p>
|
|
1393
|
+
* @public
|
|
1394
|
+
*/
|
|
1395
|
+
Locality?: AdminNames[] | undefined;
|
|
1396
|
+
/**
|
|
1397
|
+
* <p>A list of administrative names and translations for the region address component.</p>
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
Region?: AdminNames[] | undefined;
|
|
1401
|
+
/**
|
|
1402
|
+
* <p>A list of administrative names and translations for the district address component.</p>
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
District?: AdminNames[] | undefined;
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>A list of administrative names and translations for the sub-region address component.</p>
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
SubRegion?: AdminNames[] | undefined;
|
|
1411
|
+
}
|
|
1278
1412
|
/**
|
|
1279
1413
|
* <p>The Geocoded result.</p>
|
|
1280
1414
|
* @public
|
|
@@ -1375,6 +1509,16 @@ export interface GeocodeResultItem {
|
|
|
1375
1509
|
* @public
|
|
1376
1510
|
*/
|
|
1377
1511
|
SecondaryAddresses?: RelatedPlace[] | undefined;
|
|
1512
|
+
/**
|
|
1513
|
+
* <p>All name translations and alternative names for the requested address fields in all available languages.</p>
|
|
1514
|
+
* @public
|
|
1515
|
+
*/
|
|
1516
|
+
Translations?: TranslationDetails | undefined;
|
|
1517
|
+
/**
|
|
1518
|
+
* <p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>
|
|
1519
|
+
* @public
|
|
1520
|
+
*/
|
|
1521
|
+
EstimatedPointAddress?: boolean | undefined;
|
|
1378
1522
|
}
|
|
1379
1523
|
/**
|
|
1380
1524
|
* @public
|
|
@@ -1406,7 +1550,7 @@ export interface GetPlaceRequest {
|
|
|
1406
1550
|
*/
|
|
1407
1551
|
AdditionalFeatures?: GetPlaceAdditionalFeature[] | undefined;
|
|
1408
1552
|
/**
|
|
1409
|
-
* <p> A list of <a href="https://
|
|
1553
|
+
* <p> A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
1410
1554
|
* @public
|
|
1411
1555
|
*/
|
|
1412
1556
|
Language?: string | undefined;
|
|
@@ -1425,6 +1569,11 @@ export interface GetPlaceRequest {
|
|
|
1425
1569
|
* @public
|
|
1426
1570
|
*/
|
|
1427
1571
|
Key?: string | undefined;
|
|
1572
|
+
/**
|
|
1573
|
+
* <p>Specifies how address names are returned. When set to <code>Administrative</code>, the service returns the official administrative names for address components. <code>Administrative</code> currently applies only to addresses in the United States.</p>
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
AddressNamesMode?: GetPlaceAddressNamesMode | undefined;
|
|
1428
1577
|
}
|
|
1429
1578
|
/**
|
|
1430
1579
|
* <p>Components of the opening hours object.</p>
|
|
@@ -1598,6 +1747,21 @@ export interface GetPlaceResponse {
|
|
|
1598
1747
|
* @public
|
|
1599
1748
|
*/
|
|
1600
1749
|
SecondaryAddresses?: RelatedPlace[] | undefined;
|
|
1750
|
+
/**
|
|
1751
|
+
* <p>A list of place attributes for the result, such as whether the business offers drive-through service.</p>
|
|
1752
|
+
* @public
|
|
1753
|
+
*/
|
|
1754
|
+
PlaceAttributes?: PlaceAttribute[] | undefined;
|
|
1755
|
+
/**
|
|
1756
|
+
* <p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
EstimatedPointAddress?: boolean | undefined;
|
|
1760
|
+
/**
|
|
1761
|
+
* <p>The list of supplier references available for this place. Requires the <code>CrossReferences</code> additional feature to be enabled.</p>
|
|
1762
|
+
* @public
|
|
1763
|
+
*/
|
|
1764
|
+
CrossReferences?: CrossReference[] | undefined;
|
|
1601
1765
|
}
|
|
1602
1766
|
/**
|
|
1603
1767
|
* <p>The included place types.</p>
|
|
@@ -1640,7 +1804,7 @@ export interface ReverseGeocodeRequest {
|
|
|
1640
1804
|
*/
|
|
1641
1805
|
AdditionalFeatures?: ReverseGeocodeAdditionalFeature[] | undefined;
|
|
1642
1806
|
/**
|
|
1643
|
-
* <p> A list of <a href="https://
|
|
1807
|
+
* <p> A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
1644
1808
|
* @public
|
|
1645
1809
|
*/
|
|
1646
1810
|
Language?: string | undefined;
|
|
@@ -1664,6 +1828,11 @@ export interface ReverseGeocodeRequest {
|
|
|
1664
1828
|
* @public
|
|
1665
1829
|
*/
|
|
1666
1830
|
Heading?: number | undefined;
|
|
1831
|
+
/**
|
|
1832
|
+
* <p>Specifies how address names are returned. When set to <code>Administrative</code>, the service returns the official administrative names for address components. <code>Administrative</code> currently applies only to addresses in the United States.</p>
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
AddressNamesMode?: ReverseGeocodeAddressNamesMode | undefined;
|
|
1667
1836
|
}
|
|
1668
1837
|
/**
|
|
1669
1838
|
* <p>The returned location from the <code>Reverse Geocode</code> action.</p>
|
|
@@ -1745,6 +1914,16 @@ export interface ReverseGeocodeResultItem {
|
|
|
1745
1914
|
* @public
|
|
1746
1915
|
*/
|
|
1747
1916
|
Intersections?: Intersection[] | undefined;
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>The main address corresponding to a place of type Secondary Address.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
MainAddress?: RelatedPlace | undefined;
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>If <code>true</code>, indicates that the coordinates of the position and access points of the point address are estimated.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
EstimatedPointAddress?: boolean | undefined;
|
|
1748
1927
|
}
|
|
1749
1928
|
/**
|
|
1750
1929
|
* @public
|
|
@@ -1837,7 +2016,7 @@ export interface SearchNearbyRequest {
|
|
|
1837
2016
|
*/
|
|
1838
2017
|
AdditionalFeatures?: SearchNearbyAdditionalFeature[] | undefined;
|
|
1839
2018
|
/**
|
|
1840
|
-
* <p>A list of <a href="https://
|
|
2019
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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>
|
|
1841
2020
|
* @public
|
|
1842
2021
|
*/
|
|
1843
2022
|
Language?: string | undefined;
|
|
@@ -1957,6 +2136,16 @@ export interface SearchNearbyResultItem {
|
|
|
1957
2136
|
* @public
|
|
1958
2137
|
*/
|
|
1959
2138
|
Phonemes?: PhonemeDetails | undefined;
|
|
2139
|
+
/**
|
|
2140
|
+
* <p>A list of place attributes for the result, such as whether the business offers drive-through service.</p>
|
|
2141
|
+
* @public
|
|
2142
|
+
*/
|
|
2143
|
+
PlaceAttributes?: PlaceAttribute[] | undefined;
|
|
2144
|
+
/**
|
|
2145
|
+
* <p>The list of supplier references available for this place. Requires the <code>CrossReferences</code> additional feature to be enabled.</p>
|
|
2146
|
+
* @public
|
|
2147
|
+
*/
|
|
2148
|
+
CrossReferences?: CrossReference[] | undefined;
|
|
1960
2149
|
}
|
|
1961
2150
|
/**
|
|
1962
2151
|
* @public
|
|
@@ -2034,7 +2223,7 @@ export interface SearchTextRequest {
|
|
|
2034
2223
|
*/
|
|
2035
2224
|
AdditionalFeatures?: SearchTextAdditionalFeature[] | undefined;
|
|
2036
2225
|
/**
|
|
2037
|
-
* <p>A list of <a href="https://
|
|
2226
|
+
* <p>A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
2038
2227
|
* @public
|
|
2039
2228
|
*/
|
|
2040
2229
|
Language?: string | undefined;
|
|
@@ -2053,6 +2242,11 @@ export interface SearchTextRequest {
|
|
|
2053
2242
|
* @public
|
|
2054
2243
|
*/
|
|
2055
2244
|
NextToken?: string | undefined;
|
|
2245
|
+
/**
|
|
2246
|
+
* <p>Indicates the mode of mobility used by the end user. This is used to improve the relevance of search results. Valid values are <code>Car</code>, <code>Scooter</code>, and <code>Truck</code>.</p>
|
|
2247
|
+
* @public
|
|
2248
|
+
*/
|
|
2249
|
+
TravelMode?: SearchTextTravelMode | undefined;
|
|
2056
2250
|
/**
|
|
2057
2251
|
* <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>
|
|
2058
2252
|
* @public
|
|
@@ -2125,7 +2319,7 @@ export interface SearchTextResultItem {
|
|
|
2125
2319
|
*/
|
|
2126
2320
|
Contacts?: Contacts | undefined;
|
|
2127
2321
|
/**
|
|
2128
|
-
* <p>List of opening hours objects
|
|
2322
|
+
* <p> List of opening hours objects. Not available in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers. </p>
|
|
2129
2323
|
* @public
|
|
2130
2324
|
*/
|
|
2131
2325
|
OpeningHours?: OpeningHours[] | undefined;
|
|
@@ -2154,6 +2348,16 @@ export interface SearchTextResultItem {
|
|
|
2154
2348
|
* @public
|
|
2155
2349
|
*/
|
|
2156
2350
|
Phonemes?: PhonemeDetails | undefined;
|
|
2351
|
+
/**
|
|
2352
|
+
* <p>A list of place attributes for the result, such as whether the business offers drive-through service.</p>
|
|
2353
|
+
* @public
|
|
2354
|
+
*/
|
|
2355
|
+
PlaceAttributes?: PlaceAttribute[] | undefined;
|
|
2356
|
+
/**
|
|
2357
|
+
* <p>The list of supplier references available for this place. Requires the <code>CrossReferences</code> additional feature to be enabled.</p>
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
CrossReferences?: CrossReference[] | undefined;
|
|
2157
2361
|
}
|
|
2158
2362
|
/**
|
|
2159
2363
|
* @public
|
|
@@ -2231,7 +2435,7 @@ export interface SuggestRequest {
|
|
|
2231
2435
|
*/
|
|
2232
2436
|
AdditionalFeatures?: SuggestAdditionalFeature[] | undefined;
|
|
2233
2437
|
/**
|
|
2234
|
-
* <p> A list of <a href="https://
|
|
2438
|
+
* <p> A list of <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">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. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the following codes: <code>en, id, km, lo, ms, my, pt, th, tl, vi, zh</code> </p>
|
|
2235
2439
|
* @public
|
|
2236
2440
|
*/
|
|
2237
2441
|
Language?: string | undefined;
|
|
@@ -2245,6 +2449,11 @@ export interface SuggestRequest {
|
|
|
2245
2449
|
* @public
|
|
2246
2450
|
*/
|
|
2247
2451
|
IntendedUse?: SuggestIntendedUse | undefined;
|
|
2452
|
+
/**
|
|
2453
|
+
* <p>Indicates the mode of mobility used by the end user. This is used to improve the relevance of search results. Valid values are <code>Car</code>, <code>Scooter</code>, and <code>Truck</code>.</p>
|
|
2454
|
+
* @public
|
|
2455
|
+
*/
|
|
2456
|
+
TravelMode?: SuggestTravelMode | undefined;
|
|
2248
2457
|
/**
|
|
2249
2458
|
* <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>
|
|
2250
2459
|
* @public
|
|
@@ -2379,6 +2588,16 @@ export interface SuggestPlaceResult {
|
|
|
2379
2588
|
* @public
|
|
2380
2589
|
*/
|
|
2381
2590
|
Phonemes?: PhonemeDetails | undefined;
|
|
2591
|
+
/**
|
|
2592
|
+
* <p>A list of place attributes for the result, such as whether the business offers drive-through service.</p>
|
|
2593
|
+
* @public
|
|
2594
|
+
*/
|
|
2595
|
+
PlaceAttributes?: PlaceAttribute[] | undefined;
|
|
2596
|
+
/**
|
|
2597
|
+
* <p>The list of supplier references available for this place. Requires the <code>CrossReferences</code> additional feature to be enabled.</p>
|
|
2598
|
+
* @public
|
|
2599
|
+
*/
|
|
2600
|
+
CrossReferences?: CrossReference[] | undefined;
|
|
2382
2601
|
}
|
|
2383
2602
|
/**
|
|
2384
2603
|
* <p>The suggested query results.</p>
|
|
@@ -16,6 +16,7 @@ export declare var AccessRestriction$: StaticStructureSchema;
|
|
|
16
16
|
export declare var Address$: StaticStructureSchema;
|
|
17
17
|
export declare var AddressComponentMatchScores$: StaticStructureSchema;
|
|
18
18
|
export declare var AddressComponentPhonemes$: StaticStructureSchema;
|
|
19
|
+
export declare var AdminNames$: StaticStructureSchema;
|
|
19
20
|
export declare var AutocompleteAddressHighlights$: StaticStructureSchema;
|
|
20
21
|
export declare var AutocompleteFilter$: StaticStructureSchema;
|
|
21
22
|
export declare var AutocompleteHighlights$: StaticStructureSchema;
|
|
@@ -29,6 +30,7 @@ export declare var ContactDetails$: StaticStructureSchema;
|
|
|
29
30
|
export declare var Contacts$: StaticStructureSchema;
|
|
30
31
|
export declare var Country$: StaticStructureSchema;
|
|
31
32
|
export declare var CountryHighlights$: StaticStructureSchema;
|
|
33
|
+
export declare var CrossReference$: StaticStructureSchema;
|
|
32
34
|
export declare var FilterCircle$: StaticStructureSchema;
|
|
33
35
|
export declare var FoodType$: StaticStructureSchema;
|
|
34
36
|
export declare var GeocodeFilter$: StaticStructureSchema;
|
|
@@ -80,6 +82,8 @@ export declare var SuggestRequest$: StaticStructureSchema;
|
|
|
80
82
|
export declare var SuggestResponse$: StaticStructureSchema;
|
|
81
83
|
export declare var SuggestResultItem$: StaticStructureSchema;
|
|
82
84
|
export declare var TimeZone$: StaticStructureSchema;
|
|
85
|
+
export declare var TranslationDetails$: StaticStructureSchema;
|
|
86
|
+
export declare var TranslationName$: StaticStructureSchema;
|
|
83
87
|
export declare var UspsZip$: StaticStructureSchema;
|
|
84
88
|
export declare var UspsZipPlus4$: StaticStructureSchema;
|
|
85
89
|
export declare var ValidationExceptionField$: StaticStructureSchema;
|
|
@@ -1,16 +1,57 @@
|
|
|
1
|
+
export declare const AccessPointType: {
|
|
2
|
+
readonly DELIVERY: "Delivery";
|
|
3
|
+
readonly EMERGENCY: "Emergency";
|
|
4
|
+
readonly ENTRANCE: "Entrance";
|
|
5
|
+
readonly LOADING: "Loading";
|
|
6
|
+
readonly OTHER: "Other";
|
|
7
|
+
readonly PARKING: "Parking";
|
|
8
|
+
readonly TAXI: "Taxi";
|
|
9
|
+
};
|
|
10
|
+
export type AccessPointType =
|
|
11
|
+
(typeof AccessPointType)[keyof typeof AccessPointType];
|
|
1
12
|
export declare const TypePlacement: {
|
|
2
13
|
readonly AFTER_BASE_NAME: "AfterBaseName";
|
|
3
14
|
readonly BEFORE_BASE_NAME: "BeforeBaseName";
|
|
4
15
|
};
|
|
5
16
|
export type TypePlacement = (typeof TypePlacement)[keyof typeof TypePlacement];
|
|
17
|
+
export declare const AddressTranslationComponent: {
|
|
18
|
+
readonly DISTRICT: "District";
|
|
19
|
+
readonly LOCALITY: "Locality";
|
|
20
|
+
readonly REGION: "Region";
|
|
21
|
+
readonly SUB_REGION: "SubRegion";
|
|
22
|
+
};
|
|
23
|
+
export type AddressTranslationComponent =
|
|
24
|
+
(typeof AddressTranslationComponent)[keyof typeof AddressTranslationComponent];
|
|
25
|
+
export declare const TranslationNameType: {
|
|
26
|
+
readonly ABBREVIATION: "Abbreviation";
|
|
27
|
+
readonly AREA_CODE: "AreaCode";
|
|
28
|
+
readonly BASE_NAME: "BaseName";
|
|
29
|
+
readonly EXONYM: "Exonym";
|
|
30
|
+
readonly SHORTENED: "Shortened";
|
|
31
|
+
readonly SYNONYM: "Synonym";
|
|
32
|
+
};
|
|
33
|
+
export type TranslationNameType =
|
|
34
|
+
(typeof TranslationNameType)[keyof typeof TranslationNameType];
|
|
35
|
+
export declare const AdminNamesPreference: {
|
|
36
|
+
readonly ALTERNATIVE: "Alternative";
|
|
37
|
+
readonly PRIMARY: "Primary";
|
|
38
|
+
};
|
|
39
|
+
export type AdminNamesPreference =
|
|
40
|
+
(typeof AdminNamesPreference)[keyof typeof AdminNamesPreference];
|
|
6
41
|
export declare const AutocompleteAdditionalFeature: {
|
|
7
42
|
readonly CORE: "Core";
|
|
8
43
|
};
|
|
9
44
|
export type AutocompleteAdditionalFeature =
|
|
10
45
|
(typeof AutocompleteAdditionalFeature)[keyof typeof AutocompleteAdditionalFeature];
|
|
11
46
|
export declare const AutocompleteFilterPlaceType: {
|
|
47
|
+
readonly COUNTRY: "Country";
|
|
48
|
+
readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
|
|
49
|
+
readonly INTERSECTION: "Intersection";
|
|
12
50
|
readonly LOCALITY: "Locality";
|
|
51
|
+
readonly POINT_ADDRESS: "PointAddress";
|
|
13
52
|
readonly POSTAL_CODE: "PostalCode";
|
|
53
|
+
readonly REGION: "Region";
|
|
54
|
+
readonly STREET: "Street";
|
|
14
55
|
};
|
|
15
56
|
export type AutocompleteFilterPlaceType =
|
|
16
57
|
(typeof AutocompleteFilterPlaceType)[keyof typeof AutocompleteFilterPlaceType];
|
|
@@ -20,6 +61,7 @@ export declare const AutocompleteIntendedUse: {
|
|
|
20
61
|
export type AutocompleteIntendedUse =
|
|
21
62
|
(typeof AutocompleteIntendedUse)[keyof typeof AutocompleteIntendedUse];
|
|
22
63
|
export declare const PostalCodeMode: {
|
|
64
|
+
readonly ENUMERATE_SPANNED_DISTRICTS: "EnumerateSpannedDistricts";
|
|
23
65
|
readonly ENUMERATE_SPANNED_LOCALITIES: "EnumerateSpannedLocalities";
|
|
24
66
|
readonly MERGE_ALL_SPANNED_LOCALITIES: "MergeAllSpannedLocalities";
|
|
25
67
|
};
|
|
@@ -62,12 +104,22 @@ export declare const GeocodeAdditionalFeature: {
|
|
|
62
104
|
};
|
|
63
105
|
export type GeocodeAdditionalFeature =
|
|
64
106
|
(typeof GeocodeAdditionalFeature)[keyof typeof GeocodeAdditionalFeature];
|
|
107
|
+
export declare const GeocodeAddressNamesMode: {
|
|
108
|
+
readonly ADMINISTRATIVE: "Administrative";
|
|
109
|
+
readonly MATCHED: "Matched";
|
|
110
|
+
};
|
|
111
|
+
export type GeocodeAddressNamesMode =
|
|
112
|
+
(typeof GeocodeAddressNamesMode)[keyof typeof GeocodeAddressNamesMode];
|
|
65
113
|
export declare const GeocodeFilterPlaceType: {
|
|
114
|
+
readonly COUNTRY: "Country";
|
|
66
115
|
readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
|
|
67
116
|
readonly INTERSECTION: "Intersection";
|
|
68
117
|
readonly LOCALITY: "Locality";
|
|
69
118
|
readonly POINT_ADDRESS: "PointAddress";
|
|
119
|
+
readonly POINT_OF_INTEREST: "PointOfInterest";
|
|
70
120
|
readonly POSTAL_CODE: "PostalCode";
|
|
121
|
+
readonly REGION: "Region";
|
|
122
|
+
readonly SECONDARY_ADDRESS: "SecondaryAddress";
|
|
71
123
|
readonly STREET: "Street";
|
|
72
124
|
};
|
|
73
125
|
export type GeocodeFilterPlaceType =
|
|
@@ -109,18 +161,29 @@ export type RecordTypeCode =
|
|
|
109
161
|
export declare const GetPlaceAdditionalFeature: {
|
|
110
162
|
readonly ACCESS: "Access";
|
|
111
163
|
readonly CONTACT: "Contact";
|
|
164
|
+
readonly CROSS_REFERENCES: "CrossReferences";
|
|
112
165
|
readonly PHONEMES: "Phonemes";
|
|
113
166
|
readonly SECONDARY_ADDRESSES: "SecondaryAddresses";
|
|
114
167
|
readonly TIME_ZONE: "TimeZone";
|
|
115
168
|
};
|
|
116
169
|
export type GetPlaceAdditionalFeature =
|
|
117
170
|
(typeof GetPlaceAdditionalFeature)[keyof typeof GetPlaceAdditionalFeature];
|
|
171
|
+
export declare const GetPlaceAddressNamesMode: {
|
|
172
|
+
readonly ADMINISTRATIVE: "Administrative";
|
|
173
|
+
};
|
|
174
|
+
export type GetPlaceAddressNamesMode =
|
|
175
|
+
(typeof GetPlaceAddressNamesMode)[keyof typeof GetPlaceAddressNamesMode];
|
|
118
176
|
export declare const GetPlaceIntendedUse: {
|
|
119
177
|
readonly SINGLE_USE: "SingleUse";
|
|
120
178
|
readonly STORAGE: "Storage";
|
|
121
179
|
};
|
|
122
180
|
export type GetPlaceIntendedUse =
|
|
123
181
|
(typeof GetPlaceIntendedUse)[keyof typeof GetPlaceIntendedUse];
|
|
182
|
+
export declare const PlaceAttribute: {
|
|
183
|
+
readonly DRIVE_THROUGH: "DriveThrough";
|
|
184
|
+
};
|
|
185
|
+
export type PlaceAttribute =
|
|
186
|
+
(typeof PlaceAttribute)[keyof typeof PlaceAttribute];
|
|
124
187
|
export declare const ReverseGeocodeAdditionalFeature: {
|
|
125
188
|
readonly ACCESS: "Access";
|
|
126
189
|
readonly INTERSECTIONS: "Intersections";
|
|
@@ -128,11 +191,18 @@ export declare const ReverseGeocodeAdditionalFeature: {
|
|
|
128
191
|
};
|
|
129
192
|
export type ReverseGeocodeAdditionalFeature =
|
|
130
193
|
(typeof ReverseGeocodeAdditionalFeature)[keyof typeof ReverseGeocodeAdditionalFeature];
|
|
194
|
+
export declare const ReverseGeocodeAddressNamesMode: {
|
|
195
|
+
readonly ADMINISTRATIVE: "Administrative";
|
|
196
|
+
};
|
|
197
|
+
export type ReverseGeocodeAddressNamesMode =
|
|
198
|
+
(typeof ReverseGeocodeAddressNamesMode)[keyof typeof ReverseGeocodeAddressNamesMode];
|
|
131
199
|
export declare const ReverseGeocodeFilterPlaceType: {
|
|
132
200
|
readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
|
|
133
201
|
readonly INTERSECTION: "Intersection";
|
|
134
202
|
readonly LOCALITY: "Locality";
|
|
135
203
|
readonly POINT_ADDRESS: "PointAddress";
|
|
204
|
+
readonly POINT_OF_INTEREST: "PointOfInterest";
|
|
205
|
+
readonly SECONDARY_ADDRESS: "SecondaryAddress";
|
|
136
206
|
readonly STREET: "Street";
|
|
137
207
|
};
|
|
138
208
|
export type ReverseGeocodeFilterPlaceType =
|
|
@@ -146,6 +216,7 @@ export type ReverseGeocodeIntendedUse =
|
|
|
146
216
|
export declare const SearchNearbyAdditionalFeature: {
|
|
147
217
|
readonly ACCESS: "Access";
|
|
148
218
|
readonly CONTACT: "Contact";
|
|
219
|
+
readonly CROSS_REFERENCES: "CrossReferences";
|
|
149
220
|
readonly PHONEMES: "Phonemes";
|
|
150
221
|
readonly TIME_ZONE: "TimeZone";
|
|
151
222
|
};
|
|
@@ -160,6 +231,7 @@ export type SearchNearbyIntendedUse =
|
|
|
160
231
|
export declare const SearchTextAdditionalFeature: {
|
|
161
232
|
readonly ACCESS: "Access";
|
|
162
233
|
readonly CONTACT: "Contact";
|
|
234
|
+
readonly CROSS_REFERENCES: "CrossReferences";
|
|
163
235
|
readonly PHONEMES: "Phonemes";
|
|
164
236
|
readonly TIME_ZONE: "TimeZone";
|
|
165
237
|
};
|
|
@@ -171,9 +243,17 @@ export declare const SearchTextIntendedUse: {
|
|
|
171
243
|
};
|
|
172
244
|
export type SearchTextIntendedUse =
|
|
173
245
|
(typeof SearchTextIntendedUse)[keyof typeof SearchTextIntendedUse];
|
|
246
|
+
export declare const SearchTextTravelMode: {
|
|
247
|
+
readonly CAR: "Car";
|
|
248
|
+
readonly SCOOTER: "Scooter";
|
|
249
|
+
readonly TRUCK: "Truck";
|
|
250
|
+
};
|
|
251
|
+
export type SearchTextTravelMode =
|
|
252
|
+
(typeof SearchTextTravelMode)[keyof typeof SearchTextTravelMode];
|
|
174
253
|
export declare const SuggestAdditionalFeature: {
|
|
175
254
|
readonly ACCESS: "Access";
|
|
176
255
|
readonly CORE: "Core";
|
|
256
|
+
readonly CROSS_REFERENCES: "CrossReferences";
|
|
177
257
|
readonly PHONEMES: "Phonemes";
|
|
178
258
|
readonly TIME_ZONE: "TimeZone";
|
|
179
259
|
};
|
|
@@ -184,6 +264,13 @@ export declare const SuggestIntendedUse: {
|
|
|
184
264
|
};
|
|
185
265
|
export type SuggestIntendedUse =
|
|
186
266
|
(typeof SuggestIntendedUse)[keyof typeof SuggestIntendedUse];
|
|
267
|
+
export declare const SuggestTravelMode: {
|
|
268
|
+
readonly CAR: "Car";
|
|
269
|
+
readonly SCOOTER: "Scooter";
|
|
270
|
+
readonly TRUCK: "Truck";
|
|
271
|
+
};
|
|
272
|
+
export type SuggestTravelMode =
|
|
273
|
+
(typeof SuggestTravelMode)[keyof typeof SuggestTravelMode];
|
|
187
274
|
export declare const QueryType: {
|
|
188
275
|
readonly BUSINESS_CHAIN: "BusinessChain";
|
|
189
276
|
readonly CATEGORY: "Category";
|