@aws-sdk/client-geo-places 3.683.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +297 -0
- package/dist-cjs/GeoPlaces.js +25 -0
- package/dist-cjs/GeoPlacesClient.js +50 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/AutocompleteCommand.js +27 -0
- package/dist-cjs/commands/GeocodeCommand.js +27 -0
- package/dist-cjs/commands/GetPlaceCommand.js +27 -0
- package/dist-cjs/commands/ReverseGeocodeCommand.js +27 -0
- package/dist-cjs/commands/SearchNearbyCommand.js +27 -0
- package/dist-cjs/commands/SearchTextCommand.js +27 -0
- package/dist-cjs/commands/SuggestCommand.js +27 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/endpoint/EndpointParameters.js +18 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/GeoPlacesServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +379 -0
- package/dist-cjs/protocols/Aws_restJson1.js +690 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/GeoPlaces.js +21 -0
- package/dist-es/GeoPlacesClient.js +46 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/AutocompleteCommand.js +23 -0
- package/dist-es/commands/GeocodeCommand.js +23 -0
- package/dist-es/commands/GetPlaceCommand.js +23 -0
- package/dist-es/commands/ReverseGeocodeCommand.js +23 -0
- package/dist-es/commands/SearchNearbyCommand.js +23 -0
- package/dist-es/commands/SearchTextCommand.js +23 -0
- package/dist-es/commands/SuggestCommand.js +23 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/endpoint/EndpointParameters.js +14 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/GeoPlacesServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +345 -0
- package/dist-es/protocols/Aws_restJson1.js +673 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/GeoPlaces.d.ts +97 -0
- package/dist-types/GeoPlacesClient.d.ts +212 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/AutocompleteCommand.d.ts +204 -0
- package/dist-types/commands/GeocodeCommand.d.ts +231 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +312 -0
- package/dist-types/commands/ReverseGeocodeCommand.d.ts +196 -0
- package/dist-types/commands/SearchNearbyCommand.d.ts +335 -0
- package/dist-types/commands/SearchTextCommand.d.ts +326 -0
- package/dist-types/commands/SuggestCommand.d.ts +289 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +49 -0
- package/dist-types/models/GeoPlacesServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2871 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +65 -0
- package/dist-types/runtimeConfig.browser.d.ts +48 -0
- package/dist-types/runtimeConfig.d.ts +48 -0
- package/dist-types/runtimeConfig.native.d.ts +47 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/GeoPlaces.d.ts +126 -0
- package/dist-types/ts3.4/GeoPlacesClient.d.ts +160 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/AutocompleteCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GeocodeCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/GetPlaceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ReverseGeocodeCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/SearchNearbyCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/SearchTextCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/SuggestCommand.d.ts +43 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +8 -0
- package/dist-types/ts3.4/models/GeoPlacesServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +786 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +94 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +101 -0
|
@@ -0,0 +1,335 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
|
|
4
|
+
import { SearchNearbyRequest, SearchNearbyResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SearchNearbyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchNearbyCommandInput extends SearchNearbyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchNearbyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchNearbyCommandOutput extends SearchNearbyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchNearbyCommand_base: {
|
|
25
|
+
new (input: SearchNearbyCommandInput): import("@smithy/smithy-client").CommandImpl<SearchNearbyCommandInput, SearchNearbyCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SearchNearbyCommandInput): import("@smithy/smithy-client").CommandImpl<SearchNearbyCommandInput, SearchNearbyCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Search nearby a specified location.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { GeoPlacesClient, SearchNearbyCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
|
|
35
|
+
* // const { GeoPlacesClient, SearchNearbyCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
|
|
36
|
+
* const client = new GeoPlacesClient(config);
|
|
37
|
+
* const input = { // SearchNearbyRequest
|
|
38
|
+
* QueryPosition: [ // Position // required
|
|
39
|
+
* Number("double"),
|
|
40
|
+
* ],
|
|
41
|
+
* QueryRadius: Number("long"),
|
|
42
|
+
* MaxResults: Number("int"),
|
|
43
|
+
* Filter: { // SearchNearbyFilter
|
|
44
|
+
* BoundingBox: [ // BoundingBox
|
|
45
|
+
* Number("double"),
|
|
46
|
+
* ],
|
|
47
|
+
* IncludeCountries: [ // CountryCodeList
|
|
48
|
+
* "STRING_VALUE",
|
|
49
|
+
* ],
|
|
50
|
+
* IncludeCategories: [ // FilterCategoryList
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* ExcludeCategories: [
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* IncludeBusinessChains: [ // FilterBusinessChainList
|
|
57
|
+
* "STRING_VALUE",
|
|
58
|
+
* ],
|
|
59
|
+
* ExcludeBusinessChains: [
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* IncludeFoodTypes: [ // FilterFoodTypeList
|
|
63
|
+
* "STRING_VALUE",
|
|
64
|
+
* ],
|
|
65
|
+
* ExcludeFoodTypes: [
|
|
66
|
+
* "STRING_VALUE",
|
|
67
|
+
* ],
|
|
68
|
+
* },
|
|
69
|
+
* AdditionalFeatures: [ // SearchNearbyAdditionalFeatureList
|
|
70
|
+
* "STRING_VALUE",
|
|
71
|
+
* ],
|
|
72
|
+
* Language: "STRING_VALUE",
|
|
73
|
+
* PoliticalView: "STRING_VALUE",
|
|
74
|
+
* IntendedUse: "STRING_VALUE",
|
|
75
|
+
* NextToken: "STRING_VALUE",
|
|
76
|
+
* Key: "STRING_VALUE",
|
|
77
|
+
* };
|
|
78
|
+
* const command = new SearchNearbyCommand(input);
|
|
79
|
+
* const response = await client.send(command);
|
|
80
|
+
* // { // SearchNearbyResponse
|
|
81
|
+
* // PricingBucket: "STRING_VALUE", // required
|
|
82
|
+
* // ResultItems: [ // SearchNearbyResultItemList
|
|
83
|
+
* // { // SearchNearbyResultItem
|
|
84
|
+
* // PlaceId: "STRING_VALUE", // required
|
|
85
|
+
* // PlaceType: "STRING_VALUE", // required
|
|
86
|
+
* // Title: "STRING_VALUE", // required
|
|
87
|
+
* // Address: { // Address
|
|
88
|
+
* // Label: "STRING_VALUE",
|
|
89
|
+
* // Country: { // Country
|
|
90
|
+
* // Code2: "STRING_VALUE",
|
|
91
|
+
* // Code3: "STRING_VALUE",
|
|
92
|
+
* // Name: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // Region: { // Region
|
|
95
|
+
* // Code: "STRING_VALUE",
|
|
96
|
+
* // Name: "STRING_VALUE",
|
|
97
|
+
* // },
|
|
98
|
+
* // SubRegion: { // SubRegion
|
|
99
|
+
* // Code: "STRING_VALUE",
|
|
100
|
+
* // Name: "STRING_VALUE",
|
|
101
|
+
* // },
|
|
102
|
+
* // Locality: "STRING_VALUE",
|
|
103
|
+
* // District: "STRING_VALUE",
|
|
104
|
+
* // SubDistrict: "STRING_VALUE",
|
|
105
|
+
* // PostalCode: "STRING_VALUE",
|
|
106
|
+
* // Block: "STRING_VALUE",
|
|
107
|
+
* // SubBlock: "STRING_VALUE",
|
|
108
|
+
* // Intersection: [ // IntersectionList
|
|
109
|
+
* // "STRING_VALUE",
|
|
110
|
+
* // ],
|
|
111
|
+
* // Street: "STRING_VALUE",
|
|
112
|
+
* // StreetComponents: [ // StreetComponentsList
|
|
113
|
+
* // { // StreetComponents
|
|
114
|
+
* // BaseName: "STRING_VALUE",
|
|
115
|
+
* // Type: "STRING_VALUE",
|
|
116
|
+
* // TypePlacement: "STRING_VALUE",
|
|
117
|
+
* // TypeSeparator: "STRING_VALUE",
|
|
118
|
+
* // Prefix: "STRING_VALUE",
|
|
119
|
+
* // Suffix: "STRING_VALUE",
|
|
120
|
+
* // Direction: "STRING_VALUE",
|
|
121
|
+
* // Language: "STRING_VALUE",
|
|
122
|
+
* // },
|
|
123
|
+
* // ],
|
|
124
|
+
* // AddressNumber: "STRING_VALUE",
|
|
125
|
+
* // Building: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
127
|
+
* // AddressNumberCorrected: true || false,
|
|
128
|
+
* // Position: [ // Position
|
|
129
|
+
* // Number("double"),
|
|
130
|
+
* // ],
|
|
131
|
+
* // Distance: Number("long"),
|
|
132
|
+
* // MapView: [ // BoundingBox
|
|
133
|
+
* // Number("double"),
|
|
134
|
+
* // ],
|
|
135
|
+
* // Categories: [ // CategoryList
|
|
136
|
+
* // { // Category
|
|
137
|
+
* // Id: "STRING_VALUE", // required
|
|
138
|
+
* // Name: "STRING_VALUE", // required
|
|
139
|
+
* // LocalizedName: "STRING_VALUE",
|
|
140
|
+
* // Primary: true || false,
|
|
141
|
+
* // },
|
|
142
|
+
* // ],
|
|
143
|
+
* // FoodTypes: [ // FoodTypeList
|
|
144
|
+
* // { // FoodType
|
|
145
|
+
* // LocalizedName: "STRING_VALUE", // required
|
|
146
|
+
* // Id: "STRING_VALUE",
|
|
147
|
+
* // Primary: true || false,
|
|
148
|
+
* // },
|
|
149
|
+
* // ],
|
|
150
|
+
* // BusinessChains: [ // BusinessChainList
|
|
151
|
+
* // { // BusinessChain
|
|
152
|
+
* // Name: "STRING_VALUE",
|
|
153
|
+
* // Id: "STRING_VALUE",
|
|
154
|
+
* // },
|
|
155
|
+
* // ],
|
|
156
|
+
* // Contacts: { // Contacts
|
|
157
|
+
* // Phones: [ // ContactDetailsList
|
|
158
|
+
* // { // ContactDetails
|
|
159
|
+
* // Label: "STRING_VALUE",
|
|
160
|
+
* // Value: "STRING_VALUE",
|
|
161
|
+
* // Categories: [
|
|
162
|
+
* // {
|
|
163
|
+
* // Id: "STRING_VALUE", // required
|
|
164
|
+
* // Name: "STRING_VALUE", // required
|
|
165
|
+
* // LocalizedName: "STRING_VALUE",
|
|
166
|
+
* // Primary: true || false,
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
169
|
+
* // },
|
|
170
|
+
* // ],
|
|
171
|
+
* // Faxes: [
|
|
172
|
+
* // {
|
|
173
|
+
* // Label: "STRING_VALUE",
|
|
174
|
+
* // Value: "STRING_VALUE",
|
|
175
|
+
* // Categories: [
|
|
176
|
+
* // {
|
|
177
|
+
* // Id: "STRING_VALUE", // required
|
|
178
|
+
* // Name: "STRING_VALUE", // required
|
|
179
|
+
* // LocalizedName: "STRING_VALUE",
|
|
180
|
+
* // Primary: true || false,
|
|
181
|
+
* // },
|
|
182
|
+
* // ],
|
|
183
|
+
* // },
|
|
184
|
+
* // ],
|
|
185
|
+
* // Websites: [
|
|
186
|
+
* // {
|
|
187
|
+
* // Label: "STRING_VALUE",
|
|
188
|
+
* // Value: "STRING_VALUE",
|
|
189
|
+
* // Categories: [
|
|
190
|
+
* // {
|
|
191
|
+
* // Id: "STRING_VALUE", // required
|
|
192
|
+
* // Name: "STRING_VALUE", // required
|
|
193
|
+
* // LocalizedName: "STRING_VALUE",
|
|
194
|
+
* // Primary: true || false,
|
|
195
|
+
* // },
|
|
196
|
+
* // ],
|
|
197
|
+
* // },
|
|
198
|
+
* // ],
|
|
199
|
+
* // Emails: [
|
|
200
|
+
* // {
|
|
201
|
+
* // Label: "STRING_VALUE",
|
|
202
|
+
* // Value: "STRING_VALUE",
|
|
203
|
+
* // Categories: [
|
|
204
|
+
* // {
|
|
205
|
+
* // Id: "STRING_VALUE", // required
|
|
206
|
+
* // Name: "STRING_VALUE", // required
|
|
207
|
+
* // LocalizedName: "STRING_VALUE",
|
|
208
|
+
* // Primary: true || false,
|
|
209
|
+
* // },
|
|
210
|
+
* // ],
|
|
211
|
+
* // },
|
|
212
|
+
* // ],
|
|
213
|
+
* // },
|
|
214
|
+
* // OpeningHours: [ // OpeningHoursList
|
|
215
|
+
* // { // OpeningHours
|
|
216
|
+
* // Display: [ // OpeningHoursDisplayList
|
|
217
|
+
* // "STRING_VALUE",
|
|
218
|
+
* // ],
|
|
219
|
+
* // OpenNow: true || false,
|
|
220
|
+
* // Components: [ // OpeningHoursComponentsList
|
|
221
|
+
* // { // OpeningHoursComponents
|
|
222
|
+
* // OpenTime: "STRING_VALUE",
|
|
223
|
+
* // OpenDuration: "STRING_VALUE",
|
|
224
|
+
* // Recurrence: "STRING_VALUE",
|
|
225
|
+
* // },
|
|
226
|
+
* // ],
|
|
227
|
+
* // Categories: "<CategoryList>",
|
|
228
|
+
* // },
|
|
229
|
+
* // ],
|
|
230
|
+
* // AccessPoints: [ // AccessPointList
|
|
231
|
+
* // { // AccessPoint
|
|
232
|
+
* // Position: [
|
|
233
|
+
* // Number("double"),
|
|
234
|
+
* // ],
|
|
235
|
+
* // },
|
|
236
|
+
* // ],
|
|
237
|
+
* // AccessRestrictions: [ // AccessRestrictionList
|
|
238
|
+
* // { // AccessRestriction
|
|
239
|
+
* // Restricted: true || false,
|
|
240
|
+
* // Categories: "<CategoryList>",
|
|
241
|
+
* // },
|
|
242
|
+
* // ],
|
|
243
|
+
* // TimeZone: { // TimeZone
|
|
244
|
+
* // Name: "STRING_VALUE", // required
|
|
245
|
+
* // Offset: "STRING_VALUE",
|
|
246
|
+
* // OffsetSeconds: Number("long"),
|
|
247
|
+
* // },
|
|
248
|
+
* // PoliticalView: "STRING_VALUE",
|
|
249
|
+
* // Phonemes: { // PhonemeDetails
|
|
250
|
+
* // Title: [ // PhonemeTranscriptionList
|
|
251
|
+
* // { // PhonemeTranscription
|
|
252
|
+
* // Value: "STRING_VALUE",
|
|
253
|
+
* // Language: "STRING_VALUE",
|
|
254
|
+
* // Preferred: true || false,
|
|
255
|
+
* // },
|
|
256
|
+
* // ],
|
|
257
|
+
* // Address: { // AddressComponentPhonemes
|
|
258
|
+
* // Country: [
|
|
259
|
+
* // {
|
|
260
|
+
* // Value: "STRING_VALUE",
|
|
261
|
+
* // Language: "STRING_VALUE",
|
|
262
|
+
* // Preferred: true || false,
|
|
263
|
+
* // },
|
|
264
|
+
* // ],
|
|
265
|
+
* // Region: [
|
|
266
|
+
* // {
|
|
267
|
+
* // Value: "STRING_VALUE",
|
|
268
|
+
* // Language: "STRING_VALUE",
|
|
269
|
+
* // Preferred: true || false,
|
|
270
|
+
* // },
|
|
271
|
+
* // ],
|
|
272
|
+
* // SubRegion: [
|
|
273
|
+
* // {
|
|
274
|
+
* // Value: "STRING_VALUE",
|
|
275
|
+
* // Language: "STRING_VALUE",
|
|
276
|
+
* // Preferred: true || false,
|
|
277
|
+
* // },
|
|
278
|
+
* // ],
|
|
279
|
+
* // Locality: [
|
|
280
|
+
* // {
|
|
281
|
+
* // Value: "STRING_VALUE",
|
|
282
|
+
* // Language: "STRING_VALUE",
|
|
283
|
+
* // Preferred: true || false,
|
|
284
|
+
* // },
|
|
285
|
+
* // ],
|
|
286
|
+
* // District: "<PhonemeTranscriptionList>",
|
|
287
|
+
* // SubDistrict: "<PhonemeTranscriptionList>",
|
|
288
|
+
* // Block: "<PhonemeTranscriptionList>",
|
|
289
|
+
* // SubBlock: "<PhonemeTranscriptionList>",
|
|
290
|
+
* // Street: "<PhonemeTranscriptionList>",
|
|
291
|
+
* // },
|
|
292
|
+
* // },
|
|
293
|
+
* // },
|
|
294
|
+
* // ],
|
|
295
|
+
* // NextToken: "STRING_VALUE",
|
|
296
|
+
* // };
|
|
297
|
+
*
|
|
298
|
+
* ```
|
|
299
|
+
*
|
|
300
|
+
* @param SearchNearbyCommandInput - {@link SearchNearbyCommandInput}
|
|
301
|
+
* @returns {@link SearchNearbyCommandOutput}
|
|
302
|
+
* @see {@link SearchNearbyCommandInput} for command's `input` shape.
|
|
303
|
+
* @see {@link SearchNearbyCommandOutput} for command's `response` shape.
|
|
304
|
+
* @see {@link GeoPlacesClientResolvedConfig | config} for GeoPlacesClient's `config` shape.
|
|
305
|
+
*
|
|
306
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
307
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
308
|
+
*
|
|
309
|
+
* @throws {@link InternalServerException} (server fault)
|
|
310
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
311
|
+
*
|
|
312
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
313
|
+
* <p>The request was denied due to request throttling.</p>
|
|
314
|
+
*
|
|
315
|
+
* @throws {@link ValidationException} (client fault)
|
|
316
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
317
|
+
*
|
|
318
|
+
* @throws {@link GeoPlacesServiceException}
|
|
319
|
+
* <p>Base exception class for all service exceptions from GeoPlaces service.</p>
|
|
320
|
+
*
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
export declare class SearchNearbyCommand extends SearchNearbyCommand_base {
|
|
324
|
+
/** @internal type navigation helper, not in runtime. */
|
|
325
|
+
protected static __types: {
|
|
326
|
+
api: {
|
|
327
|
+
input: SearchNearbyRequest;
|
|
328
|
+
output: SearchNearbyResponse;
|
|
329
|
+
};
|
|
330
|
+
sdk: {
|
|
331
|
+
input: SearchNearbyCommandInput;
|
|
332
|
+
output: SearchNearbyCommandOutput;
|
|
333
|
+
};
|
|
334
|
+
};
|
|
335
|
+
}
|
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GeoPlacesClient";
|
|
4
|
+
import { SearchTextRequest, SearchTextResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SearchTextCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchTextCommandInput extends SearchTextRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchTextCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchTextCommandOutput extends SearchTextResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchTextCommand_base: {
|
|
25
|
+
new (input: SearchTextCommandInput): import("@smithy/smithy-client").CommandImpl<SearchTextCommandInput, SearchTextCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [SearchTextCommandInput]): import("@smithy/smithy-client").CommandImpl<SearchTextCommandInput, SearchTextCommandOutput, GeoPlacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Use the <code>SearchText</code> operation to search for geocode and place information.
|
|
31
|
+
* You can then complete a follow-up query suggested from the <code>Suggest</code> API via a
|
|
32
|
+
* query id.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { GeoPlacesClient, SearchTextCommand } from "@aws-sdk/client-geo-places"; // ES Modules import
|
|
37
|
+
* // const { GeoPlacesClient, SearchTextCommand } = require("@aws-sdk/client-geo-places"); // CommonJS import
|
|
38
|
+
* const client = new GeoPlacesClient(config);
|
|
39
|
+
* const input = { // SearchTextRequest
|
|
40
|
+
* QueryText: "STRING_VALUE",
|
|
41
|
+
* QueryId: "STRING_VALUE",
|
|
42
|
+
* MaxResults: Number("int"),
|
|
43
|
+
* BiasPosition: [ // Position
|
|
44
|
+
* Number("double"),
|
|
45
|
+
* ],
|
|
46
|
+
* Filter: { // SearchTextFilter
|
|
47
|
+
* BoundingBox: [ // BoundingBox
|
|
48
|
+
* Number("double"),
|
|
49
|
+
* ],
|
|
50
|
+
* Circle: { // FilterCircle
|
|
51
|
+
* Center: [ // required
|
|
52
|
+
* Number("double"),
|
|
53
|
+
* ],
|
|
54
|
+
* Radius: Number("long"), // required
|
|
55
|
+
* },
|
|
56
|
+
* IncludeCountries: [ // CountryCodeList
|
|
57
|
+
* "STRING_VALUE",
|
|
58
|
+
* ],
|
|
59
|
+
* },
|
|
60
|
+
* AdditionalFeatures: [ // SearchTextAdditionalFeatureList
|
|
61
|
+
* "STRING_VALUE",
|
|
62
|
+
* ],
|
|
63
|
+
* Language: "STRING_VALUE",
|
|
64
|
+
* PoliticalView: "STRING_VALUE",
|
|
65
|
+
* IntendedUse: "STRING_VALUE",
|
|
66
|
+
* NextToken: "STRING_VALUE",
|
|
67
|
+
* Key: "STRING_VALUE",
|
|
68
|
+
* };
|
|
69
|
+
* const command = new SearchTextCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // { // SearchTextResponse
|
|
72
|
+
* // PricingBucket: "STRING_VALUE", // required
|
|
73
|
+
* // ResultItems: [ // SearchTextResultItemList
|
|
74
|
+
* // { // SearchTextResultItem
|
|
75
|
+
* // PlaceId: "STRING_VALUE", // required
|
|
76
|
+
* // PlaceType: "STRING_VALUE", // required
|
|
77
|
+
* // Title: "STRING_VALUE", // required
|
|
78
|
+
* // Address: { // Address
|
|
79
|
+
* // Label: "STRING_VALUE",
|
|
80
|
+
* // Country: { // Country
|
|
81
|
+
* // Code2: "STRING_VALUE",
|
|
82
|
+
* // Code3: "STRING_VALUE",
|
|
83
|
+
* // Name: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // Region: { // Region
|
|
86
|
+
* // Code: "STRING_VALUE",
|
|
87
|
+
* // Name: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // SubRegion: { // SubRegion
|
|
90
|
+
* // Code: "STRING_VALUE",
|
|
91
|
+
* // Name: "STRING_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // Locality: "STRING_VALUE",
|
|
94
|
+
* // District: "STRING_VALUE",
|
|
95
|
+
* // SubDistrict: "STRING_VALUE",
|
|
96
|
+
* // PostalCode: "STRING_VALUE",
|
|
97
|
+
* // Block: "STRING_VALUE",
|
|
98
|
+
* // SubBlock: "STRING_VALUE",
|
|
99
|
+
* // Intersection: [ // IntersectionList
|
|
100
|
+
* // "STRING_VALUE",
|
|
101
|
+
* // ],
|
|
102
|
+
* // Street: "STRING_VALUE",
|
|
103
|
+
* // StreetComponents: [ // StreetComponentsList
|
|
104
|
+
* // { // StreetComponents
|
|
105
|
+
* // BaseName: "STRING_VALUE",
|
|
106
|
+
* // Type: "STRING_VALUE",
|
|
107
|
+
* // TypePlacement: "STRING_VALUE",
|
|
108
|
+
* // TypeSeparator: "STRING_VALUE",
|
|
109
|
+
* // Prefix: "STRING_VALUE",
|
|
110
|
+
* // Suffix: "STRING_VALUE",
|
|
111
|
+
* // Direction: "STRING_VALUE",
|
|
112
|
+
* // Language: "STRING_VALUE",
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // AddressNumber: "STRING_VALUE",
|
|
116
|
+
* // Building: "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // AddressNumberCorrected: true || false,
|
|
119
|
+
* // Position: [ // Position
|
|
120
|
+
* // Number("double"),
|
|
121
|
+
* // ],
|
|
122
|
+
* // Distance: Number("long"),
|
|
123
|
+
* // MapView: [ // BoundingBox
|
|
124
|
+
* // Number("double"),
|
|
125
|
+
* // ],
|
|
126
|
+
* // Categories: [ // CategoryList
|
|
127
|
+
* // { // Category
|
|
128
|
+
* // Id: "STRING_VALUE", // required
|
|
129
|
+
* // Name: "STRING_VALUE", // required
|
|
130
|
+
* // LocalizedName: "STRING_VALUE",
|
|
131
|
+
* // Primary: true || false,
|
|
132
|
+
* // },
|
|
133
|
+
* // ],
|
|
134
|
+
* // FoodTypes: [ // FoodTypeList
|
|
135
|
+
* // { // FoodType
|
|
136
|
+
* // LocalizedName: "STRING_VALUE", // required
|
|
137
|
+
* // Id: "STRING_VALUE",
|
|
138
|
+
* // Primary: true || false,
|
|
139
|
+
* // },
|
|
140
|
+
* // ],
|
|
141
|
+
* // BusinessChains: [ // BusinessChainList
|
|
142
|
+
* // { // BusinessChain
|
|
143
|
+
* // Name: "STRING_VALUE",
|
|
144
|
+
* // Id: "STRING_VALUE",
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // Contacts: { // Contacts
|
|
148
|
+
* // Phones: [ // ContactDetailsList
|
|
149
|
+
* // { // ContactDetails
|
|
150
|
+
* // Label: "STRING_VALUE",
|
|
151
|
+
* // Value: "STRING_VALUE",
|
|
152
|
+
* // Categories: [
|
|
153
|
+
* // {
|
|
154
|
+
* // Id: "STRING_VALUE", // required
|
|
155
|
+
* // Name: "STRING_VALUE", // required
|
|
156
|
+
* // LocalizedName: "STRING_VALUE",
|
|
157
|
+
* // Primary: true || false,
|
|
158
|
+
* // },
|
|
159
|
+
* // ],
|
|
160
|
+
* // },
|
|
161
|
+
* // ],
|
|
162
|
+
* // Faxes: [
|
|
163
|
+
* // {
|
|
164
|
+
* // Label: "STRING_VALUE",
|
|
165
|
+
* // Value: "STRING_VALUE",
|
|
166
|
+
* // Categories: [
|
|
167
|
+
* // {
|
|
168
|
+
* // Id: "STRING_VALUE", // required
|
|
169
|
+
* // Name: "STRING_VALUE", // required
|
|
170
|
+
* // LocalizedName: "STRING_VALUE",
|
|
171
|
+
* // Primary: true || false,
|
|
172
|
+
* // },
|
|
173
|
+
* // ],
|
|
174
|
+
* // },
|
|
175
|
+
* // ],
|
|
176
|
+
* // Websites: [
|
|
177
|
+
* // {
|
|
178
|
+
* // Label: "STRING_VALUE",
|
|
179
|
+
* // Value: "STRING_VALUE",
|
|
180
|
+
* // Categories: [
|
|
181
|
+
* // {
|
|
182
|
+
* // Id: "STRING_VALUE", // required
|
|
183
|
+
* // Name: "STRING_VALUE", // required
|
|
184
|
+
* // LocalizedName: "STRING_VALUE",
|
|
185
|
+
* // Primary: true || false,
|
|
186
|
+
* // },
|
|
187
|
+
* // ],
|
|
188
|
+
* // },
|
|
189
|
+
* // ],
|
|
190
|
+
* // Emails: [
|
|
191
|
+
* // {
|
|
192
|
+
* // Label: "STRING_VALUE",
|
|
193
|
+
* // Value: "STRING_VALUE",
|
|
194
|
+
* // Categories: [
|
|
195
|
+
* // {
|
|
196
|
+
* // Id: "STRING_VALUE", // required
|
|
197
|
+
* // Name: "STRING_VALUE", // required
|
|
198
|
+
* // LocalizedName: "STRING_VALUE",
|
|
199
|
+
* // Primary: true || false,
|
|
200
|
+
* // },
|
|
201
|
+
* // ],
|
|
202
|
+
* // },
|
|
203
|
+
* // ],
|
|
204
|
+
* // },
|
|
205
|
+
* // OpeningHours: [ // OpeningHoursList
|
|
206
|
+
* // { // OpeningHours
|
|
207
|
+
* // Display: [ // OpeningHoursDisplayList
|
|
208
|
+
* // "STRING_VALUE",
|
|
209
|
+
* // ],
|
|
210
|
+
* // OpenNow: true || false,
|
|
211
|
+
* // Components: [ // OpeningHoursComponentsList
|
|
212
|
+
* // { // OpeningHoursComponents
|
|
213
|
+
* // OpenTime: "STRING_VALUE",
|
|
214
|
+
* // OpenDuration: "STRING_VALUE",
|
|
215
|
+
* // Recurrence: "STRING_VALUE",
|
|
216
|
+
* // },
|
|
217
|
+
* // ],
|
|
218
|
+
* // Categories: "<CategoryList>",
|
|
219
|
+
* // },
|
|
220
|
+
* // ],
|
|
221
|
+
* // AccessPoints: [ // AccessPointList
|
|
222
|
+
* // { // AccessPoint
|
|
223
|
+
* // Position: [
|
|
224
|
+
* // Number("double"),
|
|
225
|
+
* // ],
|
|
226
|
+
* // },
|
|
227
|
+
* // ],
|
|
228
|
+
* // AccessRestrictions: [ // AccessRestrictionList
|
|
229
|
+
* // { // AccessRestriction
|
|
230
|
+
* // Restricted: true || false,
|
|
231
|
+
* // Categories: "<CategoryList>",
|
|
232
|
+
* // },
|
|
233
|
+
* // ],
|
|
234
|
+
* // TimeZone: { // TimeZone
|
|
235
|
+
* // Name: "STRING_VALUE", // required
|
|
236
|
+
* // Offset: "STRING_VALUE",
|
|
237
|
+
* // OffsetSeconds: Number("long"),
|
|
238
|
+
* // },
|
|
239
|
+
* // PoliticalView: "STRING_VALUE",
|
|
240
|
+
* // Phonemes: { // PhonemeDetails
|
|
241
|
+
* // Title: [ // PhonemeTranscriptionList
|
|
242
|
+
* // { // PhonemeTranscription
|
|
243
|
+
* // Value: "STRING_VALUE",
|
|
244
|
+
* // Language: "STRING_VALUE",
|
|
245
|
+
* // Preferred: true || false,
|
|
246
|
+
* // },
|
|
247
|
+
* // ],
|
|
248
|
+
* // Address: { // AddressComponentPhonemes
|
|
249
|
+
* // Country: [
|
|
250
|
+
* // {
|
|
251
|
+
* // Value: "STRING_VALUE",
|
|
252
|
+
* // Language: "STRING_VALUE",
|
|
253
|
+
* // Preferred: true || false,
|
|
254
|
+
* // },
|
|
255
|
+
* // ],
|
|
256
|
+
* // Region: [
|
|
257
|
+
* // {
|
|
258
|
+
* // Value: "STRING_VALUE",
|
|
259
|
+
* // Language: "STRING_VALUE",
|
|
260
|
+
* // Preferred: true || false,
|
|
261
|
+
* // },
|
|
262
|
+
* // ],
|
|
263
|
+
* // SubRegion: [
|
|
264
|
+
* // {
|
|
265
|
+
* // Value: "STRING_VALUE",
|
|
266
|
+
* // Language: "STRING_VALUE",
|
|
267
|
+
* // Preferred: true || false,
|
|
268
|
+
* // },
|
|
269
|
+
* // ],
|
|
270
|
+
* // Locality: [
|
|
271
|
+
* // {
|
|
272
|
+
* // Value: "STRING_VALUE",
|
|
273
|
+
* // Language: "STRING_VALUE",
|
|
274
|
+
* // Preferred: true || false,
|
|
275
|
+
* // },
|
|
276
|
+
* // ],
|
|
277
|
+
* // District: "<PhonemeTranscriptionList>",
|
|
278
|
+
* // SubDistrict: "<PhonemeTranscriptionList>",
|
|
279
|
+
* // Block: "<PhonemeTranscriptionList>",
|
|
280
|
+
* // SubBlock: "<PhonemeTranscriptionList>",
|
|
281
|
+
* // Street: "<PhonemeTranscriptionList>",
|
|
282
|
+
* // },
|
|
283
|
+
* // },
|
|
284
|
+
* // },
|
|
285
|
+
* // ],
|
|
286
|
+
* // NextToken: "STRING_VALUE",
|
|
287
|
+
* // };
|
|
288
|
+
*
|
|
289
|
+
* ```
|
|
290
|
+
*
|
|
291
|
+
* @param SearchTextCommandInput - {@link SearchTextCommandInput}
|
|
292
|
+
* @returns {@link SearchTextCommandOutput}
|
|
293
|
+
* @see {@link SearchTextCommandInput} for command's `input` shape.
|
|
294
|
+
* @see {@link SearchTextCommandOutput} for command's `response` shape.
|
|
295
|
+
* @see {@link GeoPlacesClientResolvedConfig | config} for GeoPlacesClient's `config` shape.
|
|
296
|
+
*
|
|
297
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
298
|
+
* <p>You don't have sufficient access to perform this action.</p>
|
|
299
|
+
*
|
|
300
|
+
* @throws {@link InternalServerException} (server fault)
|
|
301
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
302
|
+
*
|
|
303
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
304
|
+
* <p>The request was denied due to request throttling.</p>
|
|
305
|
+
*
|
|
306
|
+
* @throws {@link ValidationException} (client fault)
|
|
307
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
308
|
+
*
|
|
309
|
+
* @throws {@link GeoPlacesServiceException}
|
|
310
|
+
* <p>Base exception class for all service exceptions from GeoPlaces service.</p>
|
|
311
|
+
*
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
export declare class SearchTextCommand extends SearchTextCommand_base {
|
|
315
|
+
/** @internal type navigation helper, not in runtime. */
|
|
316
|
+
protected static __types: {
|
|
317
|
+
api: {
|
|
318
|
+
input: SearchTextRequest;
|
|
319
|
+
output: SearchTextResponse;
|
|
320
|
+
};
|
|
321
|
+
sdk: {
|
|
322
|
+
input: SearchTextCommandInput;
|
|
323
|
+
output: SearchTextCommandOutput;
|
|
324
|
+
};
|
|
325
|
+
};
|
|
326
|
+
}
|