@aws-sdk/client-geo-places 3.956.0 → 3.958.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.
@@ -27,7 +27,7 @@ declare const AutocompleteCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>Autocomplete</code> completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views.</p>
30
+ * <p> <code>Autocomplete</code> completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/autocomplete.html">Autocomplete</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -119,6 +119,7 @@ declare const AutocompleteCommand_base: {
119
119
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
120
120
  * // { // SecondaryAddressComponent
121
121
  * // Number: "STRING_VALUE", // required
122
+ * // Designator: "STRING_VALUE",
122
123
  * // },
123
124
  * // ],
124
125
  * // },
@@ -27,7 +27,7 @@ declare const GeocodeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>Geocode</code> converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views.</p>
30
+ * <p> <code>Geocode</code> converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/geocode.html">Geocode</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -119,6 +119,7 @@ declare const GeocodeCommand_base: {
119
119
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
120
120
  * // { // SecondaryAddressComponent
121
121
  * // Number: "STRING_VALUE", // required
122
+ * // Designator: "STRING_VALUE",
122
123
  * // },
123
124
  * // ],
124
125
  * // },
@@ -305,6 +306,7 @@ declare const GeocodeCommand_base: {
305
306
  * // SecondaryAddressComponents: [
306
307
  * // {
307
308
  * // Number: "STRING_VALUE", // required
309
+ * // Designator: "STRING_VALUE",
308
310
  * // },
309
311
  * // ],
310
312
  * // },
@@ -27,7 +27,7 @@ declare const GetPlaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>GetPlace</code> finds a place by its unique ID. A <code>PlaceId</code> is returned by other place operations.</p>
30
+ * <p> <code>GetPlace</code> finds a place by its unique ID. A <code>PlaceId</code> is returned by other place operations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/get-place.html">GetPlace</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -95,6 +95,7 @@ declare const GetPlaceCommand_base: {
95
95
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
96
96
  * // { // SecondaryAddressComponent
97
97
  * // Number: "STRING_VALUE", // required
98
+ * // Designator: "STRING_VALUE",
98
99
  * // },
99
100
  * // ],
100
101
  * // },
@@ -322,6 +323,7 @@ declare const GetPlaceCommand_base: {
322
323
  * // SecondaryAddressComponents: [
323
324
  * // {
324
325
  * // Number: "STRING_VALUE", // required
326
+ * // Designator: "STRING_VALUE",
325
327
  * // },
326
328
  * // ],
327
329
  * // },
@@ -27,7 +27,7 @@ declare const ReverseGeocodeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>ReverseGeocode</code> converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views.</p>
30
+ * <p> <code>ReverseGeocode</code> converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/reverse-geocode.html">Reverse Geocode</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -54,6 +54,7 @@ declare const ReverseGeocodeCommand_base: {
54
54
  * PoliticalView: "STRING_VALUE",
55
55
  * IntendedUse: "STRING_VALUE",
56
56
  * Key: "STRING_VALUE",
57
+ * Heading: Number("double"),
57
58
  * };
58
59
  * const command = new ReverseGeocodeCommand(input);
59
60
  * const response = await client.send(command);
@@ -106,6 +107,7 @@ declare const ReverseGeocodeCommand_base: {
106
107
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
107
108
  * // { // SecondaryAddressComponent
108
109
  * // Number: "STRING_VALUE", // required
110
+ * // Designator: "STRING_VALUE",
109
111
  * // },
110
112
  * // ],
111
113
  * // },
@@ -204,6 +206,7 @@ declare const ReverseGeocodeCommand_base: {
204
206
  * // SecondaryAddressComponents: [
205
207
  * // {
206
208
  * // Number: "STRING_VALUE", // required
209
+ * // Designator: "STRING_VALUE",
207
210
  * // },
208
211
  * // ],
209
212
  * // },
@@ -27,7 +27,7 @@ declare const SearchNearbyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>SearchNearby</code> queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters.</p>
30
+ * <p> <code>SearchNearby</code> queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/search-nearby.html">Search Nearby</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -128,6 +128,7 @@ declare const SearchNearbyCommand_base: {
128
128
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
129
129
  * // { // SecondaryAddressComponent
130
130
  * // Number: "STRING_VALUE", // required
131
+ * // Designator: "STRING_VALUE",
131
132
  * // },
132
133
  * // ],
133
134
  * // },
@@ -27,7 +27,7 @@ declare const SearchTextCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>SearchText</code> searches for geocode and place information. You can then complete a follow-up query suggested from the <code>Suggest</code> API via a query id.</p>
30
+ * <p> <code>SearchText</code> searches for geocode and place information. You can then complete a follow-up query suggested from the <code>Suggest</code> API via a query id.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/search-text.html">Search Text</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -117,6 +117,7 @@ declare const SearchTextCommand_base: {
117
117
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
118
118
  * // { // SecondaryAddressComponent
119
119
  * // Number: "STRING_VALUE", // required
120
+ * // Designator: "STRING_VALUE",
120
121
  * // },
121
122
  * // ],
122
123
  * // },
@@ -27,7 +27,7 @@ declare const SuggestCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p> <code>Suggest</code> provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.</p>
30
+ * <p> <code>Suggest</code> provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for further searching. The API provides options for filtering results by location and other attributes, and allows for additional features like phonemes and timezones. The response includes refined query terms and detailed place information.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/suggest.html">Suggest</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -118,6 +118,7 @@ declare const SuggestCommand_base: {
118
118
  * // SecondaryAddressComponents: [ // SecondaryAddressComponentList
119
119
  * // { // SecondaryAddressComponent
120
120
  * // Number: "STRING_VALUE", // required
121
+ * // Designator: "STRING_VALUE",
121
122
  * // },
122
123
  * // ],
123
124
  * // },
@@ -67,6 +67,7 @@ export declare const PlaceType: {
67
67
  readonly BLOCK: "Block";
68
68
  readonly COUNTRY: "Country";
69
69
  readonly DISTRICT: "District";
70
+ readonly INFERRED_SECONDARY_ADDRESS: "InferredSecondaryAddress";
70
71
  readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
71
72
  readonly INTERSECTION: "Intersection";
72
73
  readonly LOCALITY: "Locality";
@@ -5,7 +5,7 @@ import { AutocompleteAdditionalFeature, AutocompleteFilterPlaceType, Autocomplet
5
5
  */
6
6
  export interface AccessPoint {
7
7
  /**
8
- * <p>The position, in longitude and latitude.</p>
8
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
9
9
  * @public
10
10
  */
11
11
  Position?: number[] | undefined;
@@ -99,6 +99,11 @@ export interface SecondaryAddressComponent {
99
99
  * @public
100
100
  */
101
101
  Number: string | undefined;
102
+ /**
103
+ * <p>The designator of the secondary address component.</p> <p>Example: <code>Apt</code>.</p>
104
+ * @public
105
+ */
106
+ Designator?: string | undefined;
102
107
  }
103
108
  /**
104
109
  * <p>Components of a street.</p>
@@ -243,7 +248,7 @@ export interface Address {
243
248
  */
244
249
  Building?: string | undefined;
245
250
  /**
246
- * <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>
251
+ * <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> <note> <p>Coverage for <code>Address.SecondaryAddressComponents</code> is available in the following countries:</p> <p>AUS, CAN, NZL, USA, PRI</p> </note>
247
252
  * @public
248
253
  */
249
254
  SecondaryAddressComponents?: SecondaryAddressComponent[] | undefined;
@@ -325,7 +330,7 @@ export interface AddressComponentMatchScores {
325
330
  */
326
331
  Building?: number | undefined;
327
332
  /**
328
- * <p>Match scores for the secondary address components in the result.</p>
333
+ * <p>Match scores for the secondary address components in the result.</p> <note> <p>Coverage for this functionality is available in the following countries: AUS, AUT, BRA, CAN, ESP, FRA, GBR, IDN, IND, NZL, TUR, TWN, USA.</p> </note>
329
334
  * @public
330
335
  */
331
336
  SecondaryAddressComponents?: SecondaryAddressComponentMatchScore[] | undefined;
@@ -408,7 +413,7 @@ export interface AddressComponentPhonemes {
408
413
  */
409
414
  export interface FilterCircle {
410
415
  /**
411
- * <p>The center position, in longitude and latitude, of the <code>FilterCircle</code>.</p>
416
+ * <p>The center position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
412
417
  * @public
413
418
  */
414
419
  Center: number[] | undefined;
@@ -454,12 +459,12 @@ export interface AutocompleteRequest {
454
459
  */
455
460
  QueryText: string | undefined;
456
461
  /**
457
- * <p>An optional limit for the number of results returned in a single call. </p>
462
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 5</p>
458
463
  * @public
459
464
  */
460
465
  MaxResults?: number | undefined;
461
466
  /**
462
- * <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>
467
+ * <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 WGS 84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
463
468
  * @public
464
469
  */
465
470
  BiasPosition?: number[] | undefined;
@@ -904,7 +909,7 @@ export interface GeocodeQueryComponents {
904
909
  */
905
910
  export interface GeocodeRequest {
906
911
  /**
907
- * <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>
912
+ * <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>
908
913
  * @public
909
914
  */
910
915
  QueryText?: string | undefined;
@@ -914,12 +919,12 @@ export interface GeocodeRequest {
914
919
  */
915
920
  QueryComponents?: GeocodeQueryComponents | undefined;
916
921
  /**
917
- * <p>An optional limit for the number of results returned in a single call.</p>
922
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 20</p>
918
923
  * @public
919
924
  */
920
925
  MaxResults?: number | undefined;
921
926
  /**
922
- * <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>
927
+ * <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 WGS 84 format.</p>
923
928
  * @public
924
929
  */
925
930
  BiasPosition?: number[] | undefined;
@@ -975,7 +980,7 @@ export interface Intersection {
975
980
  */
976
981
  Address?: Address | undefined;
977
982
  /**
978
- * <p>The position, in longitude and latitude.</p>
983
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
979
984
  * @public
980
985
  */
981
986
  Position?: number[] | undefined;
@@ -995,7 +1000,7 @@ export interface Intersection {
995
1000
  */
996
1001
  MapView?: number[] | undefined;
997
1002
  /**
998
- * <p>Position of the access point represented by longitude and latitude.</p>
1003
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
999
1004
  * @public
1000
1005
  */
1001
1006
  AccessPoints?: AccessPoint[] | undefined;
@@ -1026,12 +1031,12 @@ export interface RelatedPlace {
1026
1031
  */
1027
1032
  Address?: Address | undefined;
1028
1033
  /**
1029
- * <p>The position, in longitude and latitude.</p>
1034
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1030
1035
  * @public
1031
1036
  */
1032
1037
  Position?: number[] | undefined;
1033
1038
  /**
1034
- * <p>Position of the access point represented by longitude and latitude.</p>
1039
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1035
1040
  * @public
1036
1041
  */
1037
1042
  AccessPoints?: AccessPoint[] | undefined;
@@ -1175,7 +1180,7 @@ export interface GeocodeParsedQueryAddressComponents {
1175
1180
  */
1176
1181
  Building?: ParsedQueryComponent[] | undefined;
1177
1182
  /**
1178
- * <p>Parsed secondary address components from the provided query text.</p>
1183
+ * <p>Parsed secondary address components from the provided query text.</p> <note> <p>Coverage for <code>ParsedQuery.Address.SecondaryAddressComponents</code> is available in the following countries:</p> <p>AUS, AUT, BRA, CAN, ESP, FRA, GBR, HKG, IDN, IND, NZL, TUR, TWN, USA</p> </note>
1179
1184
  * @public
1180
1185
  */
1181
1186
  SecondaryAddressComponents?: ParsedQuerySecondaryAddressComponent[] | undefined;
@@ -1306,7 +1311,7 @@ export interface GeocodeResultItem {
1306
1311
  */
1307
1312
  PostalCodeDetails?: PostalCodeDetails[] | undefined;
1308
1313
  /**
1309
- * <p>The position in longitude and latitude.</p>
1314
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1310
1315
  * @public
1311
1316
  */
1312
1317
  Position?: number[] | undefined;
@@ -1331,7 +1336,7 @@ export interface GeocodeResultItem {
1331
1336
  */
1332
1337
  FoodTypes?: FoodType[] | undefined;
1333
1338
  /**
1334
- * <p>Position of the access point represented by longitude and latitude.</p>
1339
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1335
1340
  * @public
1336
1341
  */
1337
1342
  AccessPoints?: AccessPoint[] | undefined;
@@ -1366,7 +1371,7 @@ export interface GeocodeResultItem {
1366
1371
  */
1367
1372
  MainAddress?: RelatedPlace | undefined;
1368
1373
  /**
1369
- * <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>
1374
+ * <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> <note> <p>Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.</p> </note>
1370
1375
  * @public
1371
1376
  */
1372
1377
  SecondaryAddresses?: RelatedPlace[] | undefined;
@@ -1376,7 +1381,7 @@ export interface GeocodeResultItem {
1376
1381
  */
1377
1382
  export interface GeocodeResponse {
1378
1383
  /**
1379
- * <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>
1384
+ * <p>The pricing bucket for which the query is charged at, or the maximum pricing bucket when the query is charged per item within the query.</p> <p>For more information on pricing, please visit <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service Pricing</a>.</p>
1380
1385
  * @public
1381
1386
  */
1382
1387
  PricingBucket: string | undefined;
@@ -1524,7 +1529,7 @@ export interface GetPlaceResponse {
1524
1529
  */
1525
1530
  PostalCodeDetails?: PostalCodeDetails[] | undefined;
1526
1531
  /**
1527
- * <p>The position, in longitude and latitude.</p>
1532
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1528
1533
  * @public
1529
1534
  */
1530
1535
  Position?: number[] | undefined;
@@ -1559,7 +1564,7 @@ export interface GetPlaceResponse {
1559
1564
  */
1560
1565
  OpeningHours?: OpeningHours[] | undefined;
1561
1566
  /**
1562
- * <p>Position of the access point in <code>(lng,lat)</code>.</p>
1567
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1563
1568
  * @public
1564
1569
  */
1565
1570
  AccessPoints?: AccessPoint[] | undefined;
@@ -1589,7 +1594,7 @@ export interface GetPlaceResponse {
1589
1594
  */
1590
1595
  MainAddress?: RelatedPlace | undefined;
1591
1596
  /**
1592
- * <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>
1597
+ * <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> <note> <p>Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.</p> </note>
1593
1598
  * @public
1594
1599
  */
1595
1600
  SecondaryAddresses?: RelatedPlace[] | undefined;
@@ -1610,7 +1615,7 @@ export interface ReverseGeocodeFilter {
1610
1615
  */
1611
1616
  export interface ReverseGeocodeRequest {
1612
1617
  /**
1613
- * <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>
1618
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude] 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>
1614
1619
  * @public
1615
1620
  */
1616
1621
  QueryPosition: number[] | undefined;
@@ -1620,7 +1625,7 @@ export interface ReverseGeocodeRequest {
1620
1625
  */
1621
1626
  QueryRadius?: number | undefined;
1622
1627
  /**
1623
- * <p>An optional limit for the number of results returned in a single call.</p>
1628
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 1</p>
1624
1629
  * @public
1625
1630
  */
1626
1631
  MaxResults?: number | undefined;
@@ -1654,6 +1659,11 @@ export interface ReverseGeocodeRequest {
1654
1659
  * @public
1655
1660
  */
1656
1661
  Key?: string | undefined;
1662
+ /**
1663
+ * <p>The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction.</p> <p>Example: North is <code>0</code> degrees, East is <code>90</code> degrees, South is <code>180</code> degrees, and West is <code>270</code> degrees.</p>
1664
+ * @public
1665
+ */
1666
+ Heading?: number | undefined;
1657
1667
  }
1658
1668
  /**
1659
1669
  * <p>The returned location from the <code>Reverse Geocode</code> action.</p>
@@ -1691,7 +1701,7 @@ export interface ReverseGeocodeResultItem {
1691
1701
  */
1692
1702
  PostalCodeDetails?: PostalCodeDetails[] | undefined;
1693
1703
  /**
1694
- * <p>The position in longitude and latitude.</p>
1704
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1695
1705
  * @public
1696
1706
  */
1697
1707
  Position?: number[] | undefined;
@@ -1716,7 +1726,7 @@ export interface ReverseGeocodeResultItem {
1716
1726
  */
1717
1727
  FoodTypes?: FoodType[] | undefined;
1718
1728
  /**
1719
- * <p>Position of the access point represented by longitude and latitude.</p>
1729
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1720
1730
  * @public
1721
1731
  */
1722
1732
  AccessPoints?: AccessPoint[] | undefined;
@@ -1802,7 +1812,7 @@ export interface SearchNearbyFilter {
1802
1812
  */
1803
1813
  export interface SearchNearbyRequest {
1804
1814
  /**
1805
- * <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>
1815
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude] 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>
1806
1816
  * @public
1807
1817
  */
1808
1818
  QueryPosition: number[] | undefined;
@@ -1812,7 +1822,7 @@ export interface SearchNearbyRequest {
1812
1822
  */
1813
1823
  QueryRadius?: number | undefined;
1814
1824
  /**
1815
- * <p>An optional limit for the number of results returned in a single call.</p>
1825
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 20</p>
1816
1826
  * @public
1817
1827
  */
1818
1828
  MaxResults?: number | undefined;
@@ -1883,7 +1893,7 @@ export interface SearchNearbyResultItem {
1883
1893
  */
1884
1894
  AddressNumberCorrected?: boolean | undefined;
1885
1895
  /**
1886
- * <p>The position in longitude and latitude.</p>
1896
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1887
1897
  * @public
1888
1898
  */
1889
1899
  Position?: number[] | undefined;
@@ -1923,7 +1933,7 @@ export interface SearchNearbyResultItem {
1923
1933
  */
1924
1934
  OpeningHours?: OpeningHours[] | undefined;
1925
1935
  /**
1926
- * <p>Position of the access point represent by longitude and latitude.</p>
1936
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
1927
1937
  * @public
1928
1938
  */
1929
1939
  AccessPoints?: AccessPoint[] | undefined;
@@ -1994,22 +2004,22 @@ export interface SearchTextFilter {
1994
2004
  */
1995
2005
  export interface SearchTextRequest {
1996
2006
  /**
1997
- * <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>
2007
+ * <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>Exactly one of the following fields must be set: <code>QueryText</code> or <code>QueryId</code>.</p> </note>
1998
2008
  * @public
1999
2009
  */
2000
2010
  QueryText?: string | undefined;
2001
2011
  /**
2002
- * <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>
2012
+ * <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>Exactly one of the following fields must be set: <code>QueryText</code> or <code>QueryId</code>.</p> </note>
2003
2013
  * @public
2004
2014
  */
2005
2015
  QueryId?: string | undefined;
2006
2016
  /**
2007
- * <p>An optional limit for the number of results returned in a single call.</p>
2017
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 20</p>
2008
2018
  * @public
2009
2019
  */
2010
2020
  MaxResults?: number | undefined;
2011
2021
  /**
2012
- * <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>
2022
+ * <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 WGS 84 format.</p> <note> <p>Exactly one of the following fields must be set: <code>BiasPosition</code>, <code>Filter.BoundingBox</code>, or <code>Filter.Circle</code>.</p> </note>
2013
2023
  * @public
2014
2024
  */
2015
2025
  BiasPosition?: number[] | undefined;
@@ -2080,7 +2090,7 @@ export interface SearchTextResultItem {
2080
2090
  */
2081
2091
  AddressNumberCorrected?: boolean | undefined;
2082
2092
  /**
2083
- * <p>The position, in longitude and latitude.</p>
2093
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
2084
2094
  * @public
2085
2095
  */
2086
2096
  Position?: number[] | undefined;
@@ -2120,7 +2130,7 @@ export interface SearchTextResultItem {
2120
2130
  */
2121
2131
  OpeningHours?: OpeningHours[] | undefined;
2122
2132
  /**
2123
- * <p>Position of the access point represent by longitude and latitude.</p>
2133
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
2124
2134
  * @public
2125
2135
  */
2126
2136
  AccessPoints?: AccessPoint[] | undefined;
@@ -2191,12 +2201,12 @@ export interface SuggestFilter {
2191
2201
  */
2192
2202
  export interface SuggestRequest {
2193
2203
  /**
2194
- * <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>
2204
+ * <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>
2195
2205
  * @public
2196
2206
  */
2197
2207
  QueryText: string | undefined;
2198
2208
  /**
2199
- * <p>An optional limit for the number of results returned in a single call.</p>
2209
+ * <p>An optional limit for the number of results returned in a single call.</p> <p>Default value: 20</p>
2200
2210
  * @public
2201
2211
  */
2202
2212
  MaxResults?: number | undefined;
@@ -2206,7 +2216,7 @@ export interface SuggestRequest {
2206
2216
  */
2207
2217
  MaxQueryRefinements?: number | undefined;
2208
2218
  /**
2209
- * <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>
2219
+ * <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 WGS 84 format.</p> <note> <p>The fields <code>BiasPosition</code>, <code>FilterBoundingBox</code>, and <code>FilterCircle</code> are mutually exclusive.</p> </note>
2210
2220
  * @public
2211
2221
  */
2212
2222
  BiasPosition?: number[] | undefined;
@@ -2315,7 +2325,7 @@ export interface SuggestPlaceResult {
2315
2325
  */
2316
2326
  Address?: Address | undefined;
2317
2327
  /**
2318
- * <p>The position, in longitude and latitude.</p>
2328
+ * <p>The position in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
2319
2329
  * @public
2320
2330
  */
2321
2331
  Position?: number[] | undefined;
@@ -2345,7 +2355,7 @@ export interface SuggestPlaceResult {
2345
2355
  */
2346
2356
  BusinessChains?: BusinessChain[] | undefined;
2347
2357
  /**
2348
- * <p>Position of the access point represent by longitude and latitude.</p>
2358
+ * <p>Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].</p>
2349
2359
  * @public
2350
2360
  */
2351
2361
  AccessPoints?: AccessPoint[] | undefined;
@@ -2376,7 +2386,7 @@ export interface SuggestPlaceResult {
2376
2386
  */
2377
2387
  export interface SuggestQueryResult {
2378
2388
  /**
2379
- * <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>
2389
+ * <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/location/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>
2380
2390
  * @public
2381
2391
  */
2382
2392
  QueryId?: string | undefined;
@@ -29,6 +29,7 @@ export declare const PlaceType: {
29
29
  readonly BLOCK: "Block";
30
30
  readonly COUNTRY: "Country";
31
31
  readonly DISTRICT: "District";
32
+ readonly INFERRED_SECONDARY_ADDRESS: "InferredSecondaryAddress";
32
33
  readonly INTERPOLATED_ADDRESS: "InterpolatedAddress";
33
34
  readonly INTERSECTION: "Intersection";
34
35
  readonly LOCALITY: "Locality";
@@ -50,6 +50,7 @@ export interface Region {
50
50
  }
51
51
  export interface SecondaryAddressComponent {
52
52
  Number: string | undefined;
53
+ Designator?: string | undefined;
53
54
  }
54
55
  export interface StreetComponents {
55
56
  BaseName?: string | undefined;
@@ -404,6 +405,7 @@ export interface ReverseGeocodeRequest {
404
405
  PoliticalView?: string | undefined;
405
406
  IntendedUse?: ReverseGeocodeIntendedUse | undefined;
406
407
  Key?: string | undefined;
408
+ Heading?: number | undefined;
407
409
  }
408
410
  export interface ReverseGeocodeResultItem {
409
411
  PlaceId: string | undefined;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-geo-places",
3
3
  "description": "AWS SDK for JavaScript Geo Places Client for Node.js, Browser and React Native",
4
- "version": "3.956.0",
4
+ "version": "3.958.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-geo-places",
8
8
  "build:es": "tsc -p tsconfig.es.json",
9
- "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
9
+ "build:include:deps": "yarn g:turbo run build -F=\"$npm_package_name\"",
10
10
  "build:types": "tsc -p tsconfig.types.json",
11
11
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
12
12
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo || exit 0",
@@ -21,17 +21,17 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "3.956.0",
25
- "@aws-sdk/credential-provider-node": "3.956.0",
26
- "@aws-sdk/middleware-host-header": "3.956.0",
27
- "@aws-sdk/middleware-logger": "3.956.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.956.0",
29
- "@aws-sdk/middleware-user-agent": "3.956.0",
30
- "@aws-sdk/region-config-resolver": "3.956.0",
31
- "@aws-sdk/types": "3.956.0",
32
- "@aws-sdk/util-endpoints": "3.956.0",
33
- "@aws-sdk/util-user-agent-browser": "3.956.0",
34
- "@aws-sdk/util-user-agent-node": "3.956.0",
24
+ "@aws-sdk/core": "3.957.0",
25
+ "@aws-sdk/credential-provider-node": "3.958.0",
26
+ "@aws-sdk/middleware-host-header": "3.957.0",
27
+ "@aws-sdk/middleware-logger": "3.957.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.957.0",
29
+ "@aws-sdk/middleware-user-agent": "3.957.0",
30
+ "@aws-sdk/region-config-resolver": "3.957.0",
31
+ "@aws-sdk/types": "3.957.0",
32
+ "@aws-sdk/util-endpoints": "3.957.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.957.0",
34
+ "@aws-sdk/util-user-agent-node": "3.957.0",
35
35
  "@smithy/config-resolver": "^4.4.5",
36
36
  "@smithy/core": "^3.20.0",
37
37
  "@smithy/fetch-http-handler": "^5.3.8",