@aws-sdk/client-geo-places 3.1080.0 → 3.1082.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
|
@@ -175,7 +175,7 @@ export type GeoPlacesClientResolvedConfigType = __SmithyResolvedConfiguration<__
|
|
|
175
175
|
export interface GeoPlacesClientResolvedConfig extends GeoPlacesClientResolvedConfigType {
|
|
176
176
|
}
|
|
177
177
|
/**
|
|
178
|
-
* <p> The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include: </p> <ul> <li> <p>Forward and reverse geocoding for addresses and coordinates</p> </li> <li> <p>Comprehensive place searches with detailed information
|
|
178
|
+
* <p> The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include: </p> <ul> <li> <p>Forward and reverse geocoding for addresses and coordinates. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Geocode.html">Geocode</a> and <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_ReverseGeocode.html">ReverseGeocode</a>.</p> </li> <li> <p>Comprehensive place searches with detailed information. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchText.html">SearchText</a>, <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_SearchNearby.html">SearchNearby</a>, and <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_GetPlace.html">GetPlace</a>. Place information you can find include:</p> <ul> <li> <p>Business names and addresses</p> </li> <li> <p>Contact information</p> </li> <li> <p>Hours of operation</p> </li> <li> <p>Points of Interest (POI) categories</p> </li> <li> <p>Food types for restaurants</p> </li> <li> <p>Chain affiliation for relevant businesses</p> </li> </ul> </li> <li> <p>Address and place completion as users type, enhancing input efficiency by completing partial queries with valid addresses. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Autocomplete.html">Autocomplete</a>.</p> </li> <li> <p>Intelligent place and query recommendation based on user's input or context, returning relevant places, points of interest, query terms, or search categories. See <a href="https://docs.aws.amazon.com/location/latest/APIReference/API_geoplaces_Suggest.html">Suggest</a>.</p> </li> <li> <p>Global data coverage with a wide range of POI categories.</p> </li> <li> <p>Regular data updates to ensure accuracy and relevance.</p> </li> <li> <p>Bulk address validation for verifying and standardizing large volumes of addresses in a single operation using <a href="https://docs.aws.amazon.com/location/latest/APIReference/Welcome.html#Welcome_Amazon_Location_Service_Jobs">Amazon Location Service Jobs</a>.</p> </li> </ul>
|
|
179
179
|
* @public
|
|
180
180
|
*/
|
|
181
181
|
export declare class GeoPlacesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GeoPlacesClientResolvedConfig> {
|
|
@@ -24,7 +24,7 @@ declare const AutocompleteCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <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>
|
|
27
|
+
* <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. Not supported 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> <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>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -53,16 +53,16 @@ declare const AutocompleteCommand_base: {
|
|
|
53
53
|
* "STRING_VALUE",
|
|
54
54
|
* ],
|
|
55
55
|
* IncludePlaceTypes: [ // AutocompleteFilterPlaceTypeList
|
|
56
|
-
* "
|
|
56
|
+
* "Locality" || "PostalCode" || "Street" || "Intersection" || "PointAddress" || "InterpolatedAddress" || "Country" || "Region",
|
|
57
57
|
* ],
|
|
58
58
|
* },
|
|
59
|
-
* PostalCodeMode: "
|
|
59
|
+
* PostalCodeMode: "MergeAllSpannedLocalities" || "EnumerateSpannedLocalities" || "EnumerateSpannedDistricts",
|
|
60
60
|
* AdditionalFeatures: [ // AutocompleteAdditionalFeatureList
|
|
61
|
-
* "
|
|
61
|
+
* "Core",
|
|
62
62
|
* ],
|
|
63
63
|
* Language: "STRING_VALUE",
|
|
64
64
|
* PoliticalView: "STRING_VALUE",
|
|
65
|
-
* IntendedUse: "
|
|
65
|
+
* IntendedUse: "SingleUse",
|
|
66
66
|
* Key: "STRING_VALUE",
|
|
67
67
|
* };
|
|
68
68
|
* const command = new AutocompleteCommand(input);
|
|
@@ -72,7 +72,7 @@ declare const AutocompleteCommand_base: {
|
|
|
72
72
|
* // ResultItems: [ // AutocompleteResultItemList
|
|
73
73
|
* // { // AutocompleteResultItem
|
|
74
74
|
* // PlaceId: "STRING_VALUE", // required
|
|
75
|
-
* // PlaceType: "
|
|
75
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
76
76
|
* // Title: "STRING_VALUE", // required
|
|
77
77
|
* // Address: { // Address
|
|
78
78
|
* // Label: "STRING_VALUE",
|
|
@@ -103,7 +103,7 @@ declare const AutocompleteCommand_base: {
|
|
|
103
103
|
* // { // StreetComponents
|
|
104
104
|
* // BaseName: "STRING_VALUE",
|
|
105
105
|
* // Type: "STRING_VALUE",
|
|
106
|
-
* // TypePlacement: "
|
|
106
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
107
107
|
* // TypeSeparator: "STRING_VALUE",
|
|
108
108
|
* // Prefix: "STRING_VALUE",
|
|
109
109
|
* // Suffix: "STRING_VALUE",
|
|
@@ -165,6 +165,7 @@ declare const AutocompleteCommand_base: {
|
|
|
165
165
|
* // Building: "<HighlightList>",
|
|
166
166
|
* // },
|
|
167
167
|
* // },
|
|
168
|
+
* // EstimatedPointAddress: true || false,
|
|
168
169
|
* // },
|
|
169
170
|
* // ],
|
|
170
171
|
* // };
|
|
@@ -24,7 +24,7 @@ declare const GeocodeCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <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>
|
|
27
|
+
* <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. Not supported 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> <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>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -54,16 +54,21 @@ declare const GeocodeCommand_base: {
|
|
|
54
54
|
* "STRING_VALUE",
|
|
55
55
|
* ],
|
|
56
56
|
* IncludePlaceTypes: [ // GeocodeFilterPlaceTypeList
|
|
57
|
-
* "
|
|
57
|
+
* "Locality" || "PostalCode" || "Intersection" || "Street" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "PointOfInterest" || "Country" || "Region",
|
|
58
58
|
* ],
|
|
59
59
|
* },
|
|
60
60
|
* AdditionalFeatures: [ // GeocodeAdditionalFeatureList
|
|
61
|
-
* "
|
|
61
|
+
* "TimeZone" || "Access" || "SecondaryAddresses" || "Intersections",
|
|
62
62
|
* ],
|
|
63
63
|
* Language: "STRING_VALUE",
|
|
64
64
|
* PoliticalView: "STRING_VALUE",
|
|
65
|
-
* IntendedUse: "
|
|
65
|
+
* IntendedUse: "SingleUse" || "Storage",
|
|
66
66
|
* Key: "STRING_VALUE",
|
|
67
|
+
* PostalCodeMode: "MergeAllSpannedLocalities" || "EnumerateSpannedLocalities" || "EnumerateSpannedDistricts",
|
|
68
|
+
* AddressTranslations: [ // AddressTranslationComponentList
|
|
69
|
+
* "District" || "Locality" || "Region" || "SubRegion",
|
|
70
|
+
* ],
|
|
71
|
+
* AddressNamesMode: "Matched" || "Administrative",
|
|
67
72
|
* };
|
|
68
73
|
* const command = new GeocodeCommand(input);
|
|
69
74
|
* const response = await client.send(command);
|
|
@@ -72,7 +77,7 @@ declare const GeocodeCommand_base: {
|
|
|
72
77
|
* // ResultItems: [ // GeocodeResultItemList
|
|
73
78
|
* // { // GeocodeResultItem
|
|
74
79
|
* // PlaceId: "STRING_VALUE", // required
|
|
75
|
-
* // PlaceType: "
|
|
80
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
76
81
|
* // Title: "STRING_VALUE", // required
|
|
77
82
|
* // Address: { // Address
|
|
78
83
|
* // Label: "STRING_VALUE",
|
|
@@ -103,7 +108,7 @@ declare const GeocodeCommand_base: {
|
|
|
103
108
|
* // { // StreetComponents
|
|
104
109
|
* // BaseName: "STRING_VALUE",
|
|
105
110
|
* // Type: "STRING_VALUE",
|
|
106
|
-
* // TypePlacement: "
|
|
111
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
107
112
|
* // TypeSeparator: "STRING_VALUE",
|
|
108
113
|
* // Prefix: "STRING_VALUE",
|
|
109
114
|
* // Suffix: "STRING_VALUE",
|
|
@@ -124,13 +129,13 @@ declare const GeocodeCommand_base: {
|
|
|
124
129
|
* // PostalCodeDetails: [ // PostalCodeDetailsList
|
|
125
130
|
* // { // PostalCodeDetails
|
|
126
131
|
* // PostalCode: "STRING_VALUE",
|
|
127
|
-
* // PostalAuthority: "
|
|
128
|
-
* // PostalCodeType: "
|
|
132
|
+
* // PostalAuthority: "Usps",
|
|
133
|
+
* // PostalCodeType: "UspsZip" || "UspsZipPlus4",
|
|
129
134
|
* // UspsZip: { // UspsZip
|
|
130
|
-
* // ZipClassificationCode: "
|
|
135
|
+
* // ZipClassificationCode: "Military" || "PostOfficeBoxes" || "Unique",
|
|
131
136
|
* // },
|
|
132
137
|
* // UspsZipPlus4: { // UspsZipPlus4
|
|
133
|
-
* // RecordTypeCode: "
|
|
138
|
+
* // RecordTypeCode: "Firm" || "General" || "HighRise" || "PostOfficeBox" || "Rural" || "Street",
|
|
134
139
|
* // },
|
|
135
140
|
* // },
|
|
136
141
|
* // ],
|
|
@@ -161,6 +166,9 @@ declare const GeocodeCommand_base: {
|
|
|
161
166
|
* // Position: [
|
|
162
167
|
* // Number("double"),
|
|
163
168
|
* // ],
|
|
169
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
170
|
+
* // Primary: true || false,
|
|
171
|
+
* // Label: "STRING_VALUE",
|
|
164
172
|
* // },
|
|
165
173
|
* // ],
|
|
166
174
|
* // TimeZone: { // TimeZone
|
|
@@ -255,6 +263,7 @@ declare const GeocodeCommand_base: {
|
|
|
255
263
|
* // Designator: "STRING_VALUE", // required
|
|
256
264
|
* // },
|
|
257
265
|
* // ],
|
|
266
|
+
* // OtherComponents: "<ParsedQueryComponentList>",
|
|
258
267
|
* // },
|
|
259
268
|
* // },
|
|
260
269
|
* // Intersections: [ // IntersectionList
|
|
@@ -290,7 +299,7 @@ declare const GeocodeCommand_base: {
|
|
|
290
299
|
* // {
|
|
291
300
|
* // BaseName: "STRING_VALUE",
|
|
292
301
|
* // Type: "STRING_VALUE",
|
|
293
|
-
* // TypePlacement: "
|
|
302
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
294
303
|
* // TypeSeparator: "STRING_VALUE",
|
|
295
304
|
* // Prefix: "STRING_VALUE",
|
|
296
305
|
* // Suffix: "STRING_VALUE",
|
|
@@ -318,13 +327,16 @@ declare const GeocodeCommand_base: {
|
|
|
318
327
|
* // AccessPoints: [
|
|
319
328
|
* // {
|
|
320
329
|
* // Position: "<Position>",
|
|
330
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
331
|
+
* // Primary: true || false,
|
|
332
|
+
* // Label: "STRING_VALUE",
|
|
321
333
|
* // },
|
|
322
334
|
* // ],
|
|
323
335
|
* // },
|
|
324
336
|
* // ],
|
|
325
337
|
* // MainAddress: { // RelatedPlace
|
|
326
338
|
* // PlaceId: "STRING_VALUE", // required
|
|
327
|
-
* // PlaceType: "
|
|
339
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
328
340
|
* // Title: "STRING_VALUE", // required
|
|
329
341
|
* // Address: "<Address>",
|
|
330
342
|
* // Position: "<Position>",
|
|
@@ -333,13 +345,72 @@ declare const GeocodeCommand_base: {
|
|
|
333
345
|
* // SecondaryAddresses: [ // RelatedPlaceList
|
|
334
346
|
* // {
|
|
335
347
|
* // PlaceId: "STRING_VALUE", // required
|
|
336
|
-
* // PlaceType: "
|
|
348
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
337
349
|
* // Title: "STRING_VALUE", // required
|
|
338
350
|
* // Address: "<Address>",
|
|
339
351
|
* // Position: "<Position>",
|
|
340
352
|
* // AccessPoints: "<AccessPointList>",
|
|
341
353
|
* // },
|
|
342
354
|
* // ],
|
|
355
|
+
* // Translations: { // TranslationDetails
|
|
356
|
+
* // Locality: [ // AdminNamesList
|
|
357
|
+
* // { // AdminNames
|
|
358
|
+
* // Names: [ // TranslationNameList // required
|
|
359
|
+
* // { // TranslationName
|
|
360
|
+
* // Value: "STRING_VALUE", // required
|
|
361
|
+
* // Language: "STRING_VALUE",
|
|
362
|
+
* // Type: "Abbreviation" || "AreaCode" || "BaseName" || "Exonym" || "Shortened" || "Synonym", // required
|
|
363
|
+
* // Primary: true || false,
|
|
364
|
+
* // Transliterated: true || false,
|
|
365
|
+
* // },
|
|
366
|
+
* // ],
|
|
367
|
+
* // Preference: "Alternative" || "Primary",
|
|
368
|
+
* // },
|
|
369
|
+
* // ],
|
|
370
|
+
* // Region: [
|
|
371
|
+
* // {
|
|
372
|
+
* // Names: [ // required
|
|
373
|
+
* // {
|
|
374
|
+
* // Value: "STRING_VALUE", // required
|
|
375
|
+
* // Language: "STRING_VALUE",
|
|
376
|
+
* // Type: "Abbreviation" || "AreaCode" || "BaseName" || "Exonym" || "Shortened" || "Synonym", // required
|
|
377
|
+
* // Primary: true || false,
|
|
378
|
+
* // Transliterated: true || false,
|
|
379
|
+
* // },
|
|
380
|
+
* // ],
|
|
381
|
+
* // Preference: "Alternative" || "Primary",
|
|
382
|
+
* // },
|
|
383
|
+
* // ],
|
|
384
|
+
* // District: [
|
|
385
|
+
* // {
|
|
386
|
+
* // Names: [ // required
|
|
387
|
+
* // {
|
|
388
|
+
* // Value: "STRING_VALUE", // required
|
|
389
|
+
* // Language: "STRING_VALUE",
|
|
390
|
+
* // Type: "Abbreviation" || "AreaCode" || "BaseName" || "Exonym" || "Shortened" || "Synonym", // required
|
|
391
|
+
* // Primary: true || false,
|
|
392
|
+
* // Transliterated: true || false,
|
|
393
|
+
* // },
|
|
394
|
+
* // ],
|
|
395
|
+
* // Preference: "Alternative" || "Primary",
|
|
396
|
+
* // },
|
|
397
|
+
* // ],
|
|
398
|
+
* // SubRegion: [
|
|
399
|
+
* // {
|
|
400
|
+
* // Names: [ // required
|
|
401
|
+
* // {
|
|
402
|
+
* // Value: "STRING_VALUE", // required
|
|
403
|
+
* // Language: "STRING_VALUE",
|
|
404
|
+
* // Type: "Abbreviation" || "AreaCode" || "BaseName" || "Exonym" || "Shortened" || "Synonym", // required
|
|
405
|
+
* // Primary: true || false,
|
|
406
|
+
* // Transliterated: true || false,
|
|
407
|
+
* // },
|
|
408
|
+
* // ],
|
|
409
|
+
* // Preference: "Alternative" || "Primary",
|
|
410
|
+
* // },
|
|
411
|
+
* // ],
|
|
412
|
+
* // },
|
|
413
|
+
* // EstimatedPointAddress: true || false,
|
|
343
414
|
* // },
|
|
344
415
|
* // ],
|
|
345
416
|
* // };
|
|
@@ -36,18 +36,19 @@ declare const GetPlaceCommand_base: {
|
|
|
36
36
|
* const input = { // GetPlaceRequest
|
|
37
37
|
* PlaceId: "STRING_VALUE", // required
|
|
38
38
|
* AdditionalFeatures: [ // GetPlaceAdditionalFeatureList
|
|
39
|
-
* "
|
|
39
|
+
* "TimeZone" || "Phonemes" || "Access" || "Contact" || "SecondaryAddresses" || "CrossReferences",
|
|
40
40
|
* ],
|
|
41
41
|
* Language: "STRING_VALUE",
|
|
42
42
|
* PoliticalView: "STRING_VALUE",
|
|
43
|
-
* IntendedUse: "
|
|
43
|
+
* IntendedUse: "SingleUse" || "Storage",
|
|
44
44
|
* Key: "STRING_VALUE",
|
|
45
|
+
* AddressNamesMode: "Administrative",
|
|
45
46
|
* };
|
|
46
47
|
* const command = new GetPlaceCommand(input);
|
|
47
48
|
* const response = await client.send(command);
|
|
48
49
|
* // { // GetPlaceResponse
|
|
49
50
|
* // PlaceId: "STRING_VALUE", // required
|
|
50
|
-
* // PlaceType: "
|
|
51
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
51
52
|
* // Title: "STRING_VALUE", // required
|
|
52
53
|
* // PricingBucket: "STRING_VALUE", // required
|
|
53
54
|
* // Address: { // Address
|
|
@@ -79,7 +80,7 @@ declare const GetPlaceCommand_base: {
|
|
|
79
80
|
* // { // StreetComponents
|
|
80
81
|
* // BaseName: "STRING_VALUE",
|
|
81
82
|
* // Type: "STRING_VALUE",
|
|
82
|
-
* // TypePlacement: "
|
|
83
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
83
84
|
* // TypeSeparator: "STRING_VALUE",
|
|
84
85
|
* // Prefix: "STRING_VALUE",
|
|
85
86
|
* // Suffix: "STRING_VALUE",
|
|
@@ -100,13 +101,13 @@ declare const GetPlaceCommand_base: {
|
|
|
100
101
|
* // PostalCodeDetails: [ // PostalCodeDetailsList
|
|
101
102
|
* // { // PostalCodeDetails
|
|
102
103
|
* // PostalCode: "STRING_VALUE",
|
|
103
|
-
* // PostalAuthority: "
|
|
104
|
-
* // PostalCodeType: "
|
|
104
|
+
* // PostalAuthority: "Usps",
|
|
105
|
+
* // PostalCodeType: "UspsZip" || "UspsZipPlus4",
|
|
105
106
|
* // UspsZip: { // UspsZip
|
|
106
|
-
* // ZipClassificationCode: "
|
|
107
|
+
* // ZipClassificationCode: "Military" || "PostOfficeBoxes" || "Unique",
|
|
107
108
|
* // },
|
|
108
109
|
* // UspsZipPlus4: { // UspsZipPlus4
|
|
109
|
-
* // RecordTypeCode: "
|
|
110
|
+
* // RecordTypeCode: "Firm" || "General" || "HighRise" || "PostOfficeBox" || "Rural" || "Street",
|
|
110
111
|
* // },
|
|
111
112
|
* // },
|
|
112
113
|
* // ],
|
|
@@ -216,6 +217,9 @@ declare const GetPlaceCommand_base: {
|
|
|
216
217
|
* // Position: [
|
|
217
218
|
* // Number("double"),
|
|
218
219
|
* // ],
|
|
220
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
221
|
+
* // Primary: true || false,
|
|
222
|
+
* // Label: "STRING_VALUE",
|
|
219
223
|
* // },
|
|
220
224
|
* // ],
|
|
221
225
|
* // AccessRestrictions: [ // AccessRestrictionList
|
|
@@ -276,7 +280,7 @@ declare const GetPlaceCommand_base: {
|
|
|
276
280
|
* // },
|
|
277
281
|
* // MainAddress: { // RelatedPlace
|
|
278
282
|
* // PlaceId: "STRING_VALUE", // required
|
|
279
|
-
* // PlaceType: "
|
|
283
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
280
284
|
* // Title: "STRING_VALUE", // required
|
|
281
285
|
* // Address: {
|
|
282
286
|
* // Label: "STRING_VALUE",
|
|
@@ -307,7 +311,7 @@ declare const GetPlaceCommand_base: {
|
|
|
307
311
|
* // {
|
|
308
312
|
* // BaseName: "STRING_VALUE",
|
|
309
313
|
* // Type: "STRING_VALUE",
|
|
310
|
-
* // TypePlacement: "
|
|
314
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
311
315
|
* // TypeSeparator: "STRING_VALUE",
|
|
312
316
|
* // Prefix: "STRING_VALUE",
|
|
313
317
|
* // Suffix: "STRING_VALUE",
|
|
@@ -328,19 +332,33 @@ declare const GetPlaceCommand_base: {
|
|
|
328
332
|
* // AccessPoints: [
|
|
329
333
|
* // {
|
|
330
334
|
* // Position: "<Position>",
|
|
335
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
336
|
+
* // Primary: true || false,
|
|
337
|
+
* // Label: "STRING_VALUE",
|
|
331
338
|
* // },
|
|
332
339
|
* // ],
|
|
333
340
|
* // },
|
|
334
341
|
* // SecondaryAddresses: [ // RelatedPlaceList
|
|
335
342
|
* // {
|
|
336
343
|
* // PlaceId: "STRING_VALUE", // required
|
|
337
|
-
* // PlaceType: "
|
|
344
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
338
345
|
* // Title: "STRING_VALUE", // required
|
|
339
346
|
* // Address: "<Address>",
|
|
340
347
|
* // Position: "<Position>",
|
|
341
348
|
* // AccessPoints: "<AccessPointList>",
|
|
342
349
|
* // },
|
|
343
350
|
* // ],
|
|
351
|
+
* // PlaceAttributes: [ // PlaceAttributeList
|
|
352
|
+
* // "DriveThrough",
|
|
353
|
+
* // ],
|
|
354
|
+
* // EstimatedPointAddress: true || false,
|
|
355
|
+
* // CrossReferences: [ // CrossReferenceList
|
|
356
|
+
* // { // CrossReference
|
|
357
|
+
* // Source: "STRING_VALUE", // required
|
|
358
|
+
* // SourcePlaceId: "STRING_VALUE", // required
|
|
359
|
+
* // SourceCategories: "<CategoryList>",
|
|
360
|
+
* // },
|
|
361
|
+
* // ],
|
|
344
362
|
* // };
|
|
345
363
|
*
|
|
346
364
|
* ```
|
|
@@ -41,17 +41,18 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
41
41
|
* MaxResults: Number("int"),
|
|
42
42
|
* Filter: { // ReverseGeocodeFilter
|
|
43
43
|
* IncludePlaceTypes: [ // ReverseGeocodeFilterPlaceTypeList
|
|
44
|
-
* "
|
|
44
|
+
* "Locality" || "Intersection" || "Street" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "PointOfInterest",
|
|
45
45
|
* ],
|
|
46
46
|
* },
|
|
47
47
|
* AdditionalFeatures: [ // ReverseGeocodeAdditionalFeatureList
|
|
48
|
-
* "
|
|
48
|
+
* "TimeZone" || "Access" || "Intersections",
|
|
49
49
|
* ],
|
|
50
50
|
* Language: "STRING_VALUE",
|
|
51
51
|
* PoliticalView: "STRING_VALUE",
|
|
52
|
-
* IntendedUse: "
|
|
52
|
+
* IntendedUse: "SingleUse" || "Storage",
|
|
53
53
|
* Key: "STRING_VALUE",
|
|
54
54
|
* Heading: Number("double"),
|
|
55
|
+
* AddressNamesMode: "Administrative",
|
|
55
56
|
* };
|
|
56
57
|
* const command = new ReverseGeocodeCommand(input);
|
|
57
58
|
* const response = await client.send(command);
|
|
@@ -60,7 +61,7 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
60
61
|
* // ResultItems: [ // ReverseGeocodeResultItemList
|
|
61
62
|
* // { // ReverseGeocodeResultItem
|
|
62
63
|
* // PlaceId: "STRING_VALUE", // required
|
|
63
|
-
* // PlaceType: "
|
|
64
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
64
65
|
* // Title: "STRING_VALUE", // required
|
|
65
66
|
* // Address: { // Address
|
|
66
67
|
* // Label: "STRING_VALUE",
|
|
@@ -91,7 +92,7 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
91
92
|
* // { // StreetComponents
|
|
92
93
|
* // BaseName: "STRING_VALUE",
|
|
93
94
|
* // Type: "STRING_VALUE",
|
|
94
|
-
* // TypePlacement: "
|
|
95
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
95
96
|
* // TypeSeparator: "STRING_VALUE",
|
|
96
97
|
* // Prefix: "STRING_VALUE",
|
|
97
98
|
* // Suffix: "STRING_VALUE",
|
|
@@ -112,13 +113,13 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
112
113
|
* // PostalCodeDetails: [ // PostalCodeDetailsList
|
|
113
114
|
* // { // PostalCodeDetails
|
|
114
115
|
* // PostalCode: "STRING_VALUE",
|
|
115
|
-
* // PostalAuthority: "
|
|
116
|
-
* // PostalCodeType: "
|
|
116
|
+
* // PostalAuthority: "Usps",
|
|
117
|
+
* // PostalCodeType: "UspsZip" || "UspsZipPlus4",
|
|
117
118
|
* // UspsZip: { // UspsZip
|
|
118
|
-
* // ZipClassificationCode: "
|
|
119
|
+
* // ZipClassificationCode: "Military" || "PostOfficeBoxes" || "Unique",
|
|
119
120
|
* // },
|
|
120
121
|
* // UspsZipPlus4: { // UspsZipPlus4
|
|
121
|
-
* // RecordTypeCode: "
|
|
122
|
+
* // RecordTypeCode: "Firm" || "General" || "HighRise" || "PostOfficeBox" || "Rural" || "Street",
|
|
122
123
|
* // },
|
|
123
124
|
* // },
|
|
124
125
|
* // ],
|
|
@@ -149,6 +150,9 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
149
150
|
* // Position: [
|
|
150
151
|
* // Number("double"),
|
|
151
152
|
* // ],
|
|
153
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
154
|
+
* // Primary: true || false,
|
|
155
|
+
* // Label: "STRING_VALUE",
|
|
152
156
|
* // },
|
|
153
157
|
* // ],
|
|
154
158
|
* // TimeZone: { // TimeZone
|
|
@@ -190,7 +194,7 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
190
194
|
* // {
|
|
191
195
|
* // BaseName: "STRING_VALUE",
|
|
192
196
|
* // Type: "STRING_VALUE",
|
|
193
|
-
* // TypePlacement: "
|
|
197
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
194
198
|
* // TypeSeparator: "STRING_VALUE",
|
|
195
199
|
* // Prefix: "STRING_VALUE",
|
|
196
200
|
* // Suffix: "STRING_VALUE",
|
|
@@ -218,10 +222,22 @@ declare const ReverseGeocodeCommand_base: {
|
|
|
218
222
|
* // AccessPoints: [
|
|
219
223
|
* // {
|
|
220
224
|
* // Position: "<Position>",
|
|
225
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
226
|
+
* // Primary: true || false,
|
|
227
|
+
* // Label: "STRING_VALUE",
|
|
221
228
|
* // },
|
|
222
229
|
* // ],
|
|
223
230
|
* // },
|
|
224
231
|
* // ],
|
|
232
|
+
* // MainAddress: { // RelatedPlace
|
|
233
|
+
* // PlaceId: "STRING_VALUE", // required
|
|
234
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
235
|
+
* // Title: "STRING_VALUE", // required
|
|
236
|
+
* // Address: "<Address>",
|
|
237
|
+
* // Position: "<Position>",
|
|
238
|
+
* // AccessPoints: "<AccessPointList>",
|
|
239
|
+
* // },
|
|
240
|
+
* // EstimatedPointAddress: true || false,
|
|
225
241
|
* // },
|
|
226
242
|
* // ],
|
|
227
243
|
* // };
|
|
@@ -24,7 +24,7 @@ declare const SearchNearbyCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <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>
|
|
27
|
+
* <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. Not supported 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> <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>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -66,11 +66,11 @@ declare const SearchNearbyCommand_base: {
|
|
|
66
66
|
* ],
|
|
67
67
|
* },
|
|
68
68
|
* AdditionalFeatures: [ // SearchNearbyAdditionalFeatureList
|
|
69
|
-
* "
|
|
69
|
+
* "TimeZone" || "Phonemes" || "Access" || "Contact" || "CrossReferences",
|
|
70
70
|
* ],
|
|
71
71
|
* Language: "STRING_VALUE",
|
|
72
72
|
* PoliticalView: "STRING_VALUE",
|
|
73
|
-
* IntendedUse: "
|
|
73
|
+
* IntendedUse: "SingleUse" || "Storage",
|
|
74
74
|
* NextToken: "STRING_VALUE",
|
|
75
75
|
* Key: "STRING_VALUE",
|
|
76
76
|
* };
|
|
@@ -81,7 +81,7 @@ declare const SearchNearbyCommand_base: {
|
|
|
81
81
|
* // ResultItems: [ // SearchNearbyResultItemList
|
|
82
82
|
* // { // SearchNearbyResultItem
|
|
83
83
|
* // PlaceId: "STRING_VALUE", // required
|
|
84
|
-
* // PlaceType: "
|
|
84
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
85
85
|
* // Title: "STRING_VALUE", // required
|
|
86
86
|
* // Address: { // Address
|
|
87
87
|
* // Label: "STRING_VALUE",
|
|
@@ -112,7 +112,7 @@ declare const SearchNearbyCommand_base: {
|
|
|
112
112
|
* // { // StreetComponents
|
|
113
113
|
* // BaseName: "STRING_VALUE",
|
|
114
114
|
* // Type: "STRING_VALUE",
|
|
115
|
-
* // TypePlacement: "
|
|
115
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
116
116
|
* // TypeSeparator: "STRING_VALUE",
|
|
117
117
|
* // Prefix: "STRING_VALUE",
|
|
118
118
|
* // Suffix: "STRING_VALUE",
|
|
@@ -237,6 +237,9 @@ declare const SearchNearbyCommand_base: {
|
|
|
237
237
|
* // Position: [
|
|
238
238
|
* // Number("double"),
|
|
239
239
|
* // ],
|
|
240
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
241
|
+
* // Primary: true || false,
|
|
242
|
+
* // Label: "STRING_VALUE",
|
|
240
243
|
* // },
|
|
241
244
|
* // ],
|
|
242
245
|
* // AccessRestrictions: [ // AccessRestrictionList
|
|
@@ -295,6 +298,16 @@ declare const SearchNearbyCommand_base: {
|
|
|
295
298
|
* // Street: "<PhonemeTranscriptionList>",
|
|
296
299
|
* // },
|
|
297
300
|
* // },
|
|
301
|
+
* // PlaceAttributes: [ // PlaceAttributeList
|
|
302
|
+
* // "DriveThrough",
|
|
303
|
+
* // ],
|
|
304
|
+
* // CrossReferences: [ // CrossReferenceList
|
|
305
|
+
* // { // CrossReference
|
|
306
|
+
* // Source: "STRING_VALUE", // required
|
|
307
|
+
* // SourcePlaceId: "STRING_VALUE", // required
|
|
308
|
+
* // SourceCategories: "<CategoryList>",
|
|
309
|
+
* // },
|
|
310
|
+
* // ],
|
|
298
311
|
* // },
|
|
299
312
|
* // ],
|
|
300
313
|
* // NextToken: "STRING_VALUE",
|
|
@@ -55,12 +55,13 @@ declare const SearchTextCommand_base: {
|
|
|
55
55
|
* ],
|
|
56
56
|
* },
|
|
57
57
|
* AdditionalFeatures: [ // SearchTextAdditionalFeatureList
|
|
58
|
-
* "
|
|
58
|
+
* "TimeZone" || "Phonemes" || "Access" || "Contact" || "CrossReferences",
|
|
59
59
|
* ],
|
|
60
60
|
* Language: "STRING_VALUE",
|
|
61
61
|
* PoliticalView: "STRING_VALUE",
|
|
62
|
-
* IntendedUse: "
|
|
62
|
+
* IntendedUse: "SingleUse" || "Storage",
|
|
63
63
|
* NextToken: "STRING_VALUE",
|
|
64
|
+
* TravelMode: "Car" || "Scooter" || "Truck",
|
|
64
65
|
* Key: "STRING_VALUE",
|
|
65
66
|
* };
|
|
66
67
|
* const command = new SearchTextCommand(input);
|
|
@@ -70,7 +71,7 @@ declare const SearchTextCommand_base: {
|
|
|
70
71
|
* // ResultItems: [ // SearchTextResultItemList
|
|
71
72
|
* // { // SearchTextResultItem
|
|
72
73
|
* // PlaceId: "STRING_VALUE", // required
|
|
73
|
-
* // PlaceType: "
|
|
74
|
+
* // PlaceType: "Country" || "Region" || "SubRegion" || "Locality" || "District" || "SubDistrict" || "PostalCode" || "Block" || "SubBlock" || "Intersection" || "Street" || "PointOfInterest" || "PointAddress" || "InterpolatedAddress" || "SecondaryAddress" || "InferredSecondaryAddress", // required
|
|
74
75
|
* // Title: "STRING_VALUE", // required
|
|
75
76
|
* // Address: { // Address
|
|
76
77
|
* // Label: "STRING_VALUE",
|
|
@@ -101,7 +102,7 @@ declare const SearchTextCommand_base: {
|
|
|
101
102
|
* // { // StreetComponents
|
|
102
103
|
* // BaseName: "STRING_VALUE",
|
|
103
104
|
* // Type: "STRING_VALUE",
|
|
104
|
-
* // TypePlacement: "
|
|
105
|
+
* // TypePlacement: "BeforeBaseName" || "AfterBaseName",
|
|
105
106
|
* // TypeSeparator: "STRING_VALUE",
|
|
106
107
|
* // Prefix: "STRING_VALUE",
|
|
107
108
|
* // Suffix: "STRING_VALUE",
|
|
@@ -226,6 +227,9 @@ declare const SearchTextCommand_base: {
|
|
|
226
227
|
* // Position: [
|
|
227
228
|
* // Number("double"),
|
|
228
229
|
* // ],
|
|
230
|
+
* // Type: "Delivery" || "Emergency" || "Entrance" || "Loading" || "Other" || "Parking" || "Taxi",
|
|
231
|
+
* // Primary: true || false,
|
|
232
|
+
* // Label: "STRING_VALUE",
|
|
229
233
|
* // },
|
|
230
234
|
* // ],
|
|
231
235
|
* // AccessRestrictions: [ // AccessRestrictionList
|
|
@@ -284,6 +288,16 @@ declare const SearchTextCommand_base: {
|
|
|
284
288
|
* // Street: "<PhonemeTranscriptionList>",
|
|
285
289
|
* // },
|
|
286
290
|
* // },
|
|
291
|
+
* // PlaceAttributes: [ // PlaceAttributeList
|
|
292
|
+
* // "DriveThrough",
|
|
293
|
+
* // ],
|
|
294
|
+
* // CrossReferences: [ // CrossReferenceList
|
|
295
|
+
* // { // CrossReference
|
|
296
|
+
* // Source: "STRING_VALUE", // required
|
|
297
|
+
* // SourcePlaceId: "STRING_VALUE", // required
|
|
298
|
+
* // SourceCategories: "<CategoryList>",
|
|
299
|
+
* // },
|
|
300
|
+
* // ],
|
|
287
301
|
* // },
|
|
288
302
|
* // ],
|
|
289
303
|
* // NextToken: "STRING_VALUE",
|