@aws-sdk/client-location 3.315.0 → 3.319.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/dist-cjs/Location.js +62 -812
- package/dist-es/Location.js +62 -812
- package/dist-types/Location.d.ts +65 -389
- package/dist-types/ts3.4/Location.d.ts +2 -1
- package/package.json +8 -8
package/dist-types/Location.d.ts
CHANGED
|
@@ -58,683 +58,359 @@ import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./c
|
|
|
58
58
|
import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
|
|
59
59
|
import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
|
|
60
60
|
import { LocationClient } from "./LocationClient";
|
|
61
|
-
|
|
62
|
-
* @public
|
|
63
|
-
* <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
|
|
64
|
-
*/
|
|
65
|
-
export declare class Location extends LocationClient {
|
|
61
|
+
export interface Location {
|
|
66
62
|
/**
|
|
67
|
-
* @
|
|
68
|
-
* <p>Creates an association between a geofence collection and a tracker resource. This
|
|
69
|
-
* allows the tracker resource to communicate location data to the linked geofence
|
|
70
|
-
* collection. </p>
|
|
71
|
-
* <p>You can associate up to five geofence collections to each tracker resource.</p>
|
|
72
|
-
* <note>
|
|
73
|
-
* <p>Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.</p>
|
|
74
|
-
* </note>
|
|
63
|
+
* @see {@link AssociateTrackerConsumerCommand}
|
|
75
64
|
*/
|
|
76
65
|
associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions): Promise<AssociateTrackerConsumerCommandOutput>;
|
|
77
66
|
associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void): void;
|
|
78
67
|
associateTrackerConsumer(args: AssociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTrackerConsumerCommandOutput) => void): void;
|
|
79
68
|
/**
|
|
80
|
-
* @
|
|
81
|
-
* <p>Deletes the position history of one or more devices from a tracker resource.</p>
|
|
69
|
+
* @see {@link BatchDeleteDevicePositionHistoryCommand}
|
|
82
70
|
*/
|
|
83
71
|
batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteDevicePositionHistoryCommandOutput>;
|
|
84
72
|
batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void): void;
|
|
85
73
|
batchDeleteDevicePositionHistory(args: BatchDeleteDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDevicePositionHistoryCommandOutput) => void): void;
|
|
86
74
|
/**
|
|
87
|
-
* @
|
|
88
|
-
* <p>Deletes a batch of geofences from a geofence collection.</p>
|
|
89
|
-
* <note>
|
|
90
|
-
* <p>This operation deletes the resource permanently.</p>
|
|
91
|
-
* </note>
|
|
75
|
+
* @see {@link BatchDeleteGeofenceCommand}
|
|
92
76
|
*/
|
|
93
77
|
batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteGeofenceCommandOutput>;
|
|
94
78
|
batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void): void;
|
|
95
79
|
batchDeleteGeofence(args: BatchDeleteGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteGeofenceCommandOutput) => void): void;
|
|
96
80
|
/**
|
|
97
|
-
* @
|
|
98
|
-
* <p>Evaluates device positions against the geofence geometries from a given geofence
|
|
99
|
-
* collection.</p>
|
|
100
|
-
* <p>This operation always returns an empty response because geofences are asynchronously
|
|
101
|
-
* evaluated. The evaluation determines if the device has entered or exited a geofenced
|
|
102
|
-
* area, and then publishes one of the following events to Amazon EventBridge:</p>
|
|
103
|
-
* <ul>
|
|
104
|
-
* <li>
|
|
105
|
-
* <p>
|
|
106
|
-
* <code>ENTER</code> if Amazon Location determines that the tracked device has entered
|
|
107
|
-
* a geofenced area.</p>
|
|
108
|
-
* </li>
|
|
109
|
-
* <li>
|
|
110
|
-
* <p>
|
|
111
|
-
* <code>EXIT</code> if Amazon Location determines that the tracked device has exited a
|
|
112
|
-
* geofenced area.</p>
|
|
113
|
-
* </li>
|
|
114
|
-
* </ul>
|
|
115
|
-
* <note>
|
|
116
|
-
* <p>The last geofence that a device was observed within is tracked for 30 days after
|
|
117
|
-
* the most recent device position update.</p>
|
|
118
|
-
* </note>
|
|
119
|
-
* <note>
|
|
120
|
-
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
121
|
-
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
122
|
-
* </note>
|
|
123
|
-
* <note>
|
|
124
|
-
* <p>The <code>DeviceID</code> is used as a string to represent the device. You do not
|
|
125
|
-
* need to have a <code>Tracker</code> associated with the <code>DeviceID</code>.</p>
|
|
126
|
-
* </note>
|
|
81
|
+
* @see {@link BatchEvaluateGeofencesCommand}
|
|
127
82
|
*/
|
|
128
83
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<BatchEvaluateGeofencesCommandOutput>;
|
|
129
84
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
|
|
130
85
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
|
|
131
86
|
/**
|
|
132
|
-
* @
|
|
133
|
-
* <p>Lists the latest device positions for requested devices.</p>
|
|
87
|
+
* @see {@link BatchGetDevicePositionCommand}
|
|
134
88
|
*/
|
|
135
89
|
batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetDevicePositionCommandOutput>;
|
|
136
90
|
batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void): void;
|
|
137
91
|
batchGetDevicePosition(args: BatchGetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDevicePositionCommandOutput) => void): void;
|
|
138
92
|
/**
|
|
139
|
-
* @
|
|
140
|
-
* <p>A batch request for storing geofence geometries into a given geofence collection, or
|
|
141
|
-
* updates the geometry of an existing geofence if a geofence ID is included in the request.</p>
|
|
93
|
+
* @see {@link BatchPutGeofenceCommand}
|
|
142
94
|
*/
|
|
143
95
|
batchPutGeofence(args: BatchPutGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<BatchPutGeofenceCommandOutput>;
|
|
144
96
|
batchPutGeofence(args: BatchPutGeofenceCommandInput, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void): void;
|
|
145
97
|
batchPutGeofence(args: BatchPutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutGeofenceCommandOutput) => void): void;
|
|
146
98
|
/**
|
|
147
|
-
* @
|
|
148
|
-
* <p>Uploads position update data for one or more devices to a tracker resource. Amazon Location
|
|
149
|
-
* uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30
|
|
150
|
-
* days.</p>
|
|
151
|
-
* <note>
|
|
152
|
-
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
|
|
153
|
-
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
154
|
-
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
|
|
155
|
-
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
|
|
156
|
-
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
|
|
157
|
-
* collections only if the device has moved more than 30 m (98.4 ft).</p>
|
|
158
|
-
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,
|
|
159
|
-
* location data is stored and evaluated against linked geofence collections only if the
|
|
160
|
-
* device has moved more than the measured accuracy. For example, if two consecutive
|
|
161
|
-
* updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
|
|
162
|
-
* is neither stored or evaluated if the device has moved less than 15 m. If
|
|
163
|
-
* <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location
|
|
164
|
-
* uses the default value <code>\{ "Horizontal": 0\}</code> when accuracy is not provided on
|
|
165
|
-
* a <code>DevicePositionUpdate</code>.</p>
|
|
166
|
-
* </note>
|
|
99
|
+
* @see {@link BatchUpdateDevicePositionCommand}
|
|
167
100
|
*/
|
|
168
101
|
batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, options?: __HttpHandlerOptions): Promise<BatchUpdateDevicePositionCommandOutput>;
|
|
169
102
|
batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void): void;
|
|
170
103
|
batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateDevicePositionCommandOutput) => void): void;
|
|
171
104
|
/**
|
|
172
|
-
* @
|
|
173
|
-
* <p>
|
|
174
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
|
|
175
|
-
* <code>DeparturePosition</code> and <code>DestinationPosition</code>. Requires that
|
|
176
|
-
* you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
177
|
-
* route calculator resource</a>.</p>
|
|
178
|
-
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
179
|
-
* to travel with the best traffic conditions when calculating the route.</p>
|
|
180
|
-
* <p>Additional options include:</p>
|
|
181
|
-
* <ul>
|
|
182
|
-
* <li>
|
|
183
|
-
* <p>
|
|
184
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html">Specifying a
|
|
185
|
-
* departure time</a> using either <code>DepartureTime</code> or
|
|
186
|
-
* <code>DepartNow</code>. This calculates a route based on predictive traffic
|
|
187
|
-
* data at the given time. </p>
|
|
188
|
-
* <note>
|
|
189
|
-
* <p>You can't specify both <code>DepartureTime</code> and
|
|
190
|
-
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
191
|
-
* returns a validation error.</p>
|
|
192
|
-
* </note>
|
|
193
|
-
* </li>
|
|
194
|
-
* <li>
|
|
195
|
-
* <p>
|
|
196
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
197
|
-
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
198
|
-
* the routes. This also lets you specify additional route preferences in
|
|
199
|
-
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
200
|
-
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
201
|
-
* <note>
|
|
202
|
-
* <p>If you specify <code>walking</code> for the travel mode and your data
|
|
203
|
-
* provider is Esri, the start and destination must be within 40km.</p>
|
|
204
|
-
* </note>
|
|
205
|
-
* </li>
|
|
206
|
-
* </ul>
|
|
105
|
+
* @see {@link CalculateRouteCommand}
|
|
207
106
|
*/
|
|
208
107
|
calculateRoute(args: CalculateRouteCommandInput, options?: __HttpHandlerOptions): Promise<CalculateRouteCommandOutput>;
|
|
209
108
|
calculateRoute(args: CalculateRouteCommandInput, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
|
|
210
109
|
calculateRoute(args: CalculateRouteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteCommandOutput) => void): void;
|
|
211
110
|
/**
|
|
212
|
-
* @
|
|
213
|
-
* <p>
|
|
214
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html"> Calculates a route
|
|
215
|
-
* matrix</a> given the following required parameters:
|
|
216
|
-
* <code>DeparturePositions</code> and <code>DestinationPositions</code>.
|
|
217
|
-
* <code>CalculateRouteMatrix</code> calculates routes and returns the travel time and
|
|
218
|
-
* travel distance from each departure position to each destination position in the
|
|
219
|
-
* request. For example, given departure positions A and B, and destination positions X and
|
|
220
|
-
* Y, <code>CalculateRouteMatrix</code> will return time and distance for routes from A to
|
|
221
|
-
* X, A to Y, B to X, and B to Y (in that order). The number of results returned (and
|
|
222
|
-
* routes calculated) will be the number of <code>DeparturePositions</code> times the
|
|
223
|
-
* number of <code>DestinationPositions</code>.</p>
|
|
224
|
-
* <note>
|
|
225
|
-
* <p>Your account is charged for each route calculated, not the number of
|
|
226
|
-
* requests.</p>
|
|
227
|
-
* </note>
|
|
228
|
-
* <p>Requires that you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
|
|
229
|
-
* route calculator resource</a>.</p>
|
|
230
|
-
* <p>By default, a request that doesn't specify a departure time uses the best time of day
|
|
231
|
-
* to travel with the best traffic conditions when calculating routes.</p>
|
|
232
|
-
* <p>Additional options include:</p>
|
|
233
|
-
* <ul>
|
|
234
|
-
* <li>
|
|
235
|
-
* <p>
|
|
236
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/departure-time.html"> Specifying a
|
|
237
|
-
* departure time</a> using either <code>DepartureTime</code> or
|
|
238
|
-
* <code>DepartNow</code>. This calculates routes based on predictive traffic
|
|
239
|
-
* data at the given time. </p>
|
|
240
|
-
* <note>
|
|
241
|
-
* <p>You can't specify both <code>DepartureTime</code> and
|
|
242
|
-
* <code>DepartNow</code> in a single request. Specifying both parameters
|
|
243
|
-
* returns a validation error.</p>
|
|
244
|
-
* </note>
|
|
245
|
-
* </li>
|
|
246
|
-
* <li>
|
|
247
|
-
* <p>
|
|
248
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html">Specifying a travel
|
|
249
|
-
* mode</a> using TravelMode sets the transportation mode used to calculate
|
|
250
|
-
* the routes. This also lets you specify additional route preferences in
|
|
251
|
-
* <code>CarModeOptions</code> if traveling by <code>Car</code>, or
|
|
252
|
-
* <code>TruckModeOptions</code> if traveling by <code>Truck</code>.</p>
|
|
253
|
-
* </li>
|
|
254
|
-
* </ul>
|
|
111
|
+
* @see {@link CalculateRouteMatrixCommand}
|
|
255
112
|
*/
|
|
256
113
|
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, options?: __HttpHandlerOptions): Promise<CalculateRouteMatrixCommandOutput>;
|
|
257
114
|
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
|
|
258
115
|
calculateRouteMatrix(args: CalculateRouteMatrixCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CalculateRouteMatrixCommandOutput) => void): void;
|
|
259
116
|
/**
|
|
260
|
-
* @
|
|
261
|
-
* <p>Creates a geofence collection, which manages and stores geofences.</p>
|
|
117
|
+
* @see {@link CreateGeofenceCollectionCommand}
|
|
262
118
|
*/
|
|
263
119
|
createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateGeofenceCollectionCommandOutput>;
|
|
264
120
|
createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void): void;
|
|
265
121
|
createGeofenceCollection(args: CreateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGeofenceCollectionCommandOutput) => void): void;
|
|
266
122
|
/**
|
|
267
|
-
* @
|
|
268
|
-
* <p>Creates an API key resource in your Amazon Web Services account, which lets you grant
|
|
269
|
-
* <code>geo:GetMap*</code> actions for Amazon Location Map resources to the API key
|
|
270
|
-
* bearer.</p>
|
|
271
|
-
* <important>
|
|
272
|
-
* <p>The API keys feature is in preview. We may add, change, or remove
|
|
273
|
-
* features before announcing general availability. For more information, see
|
|
274
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
|
|
275
|
-
* </important>
|
|
123
|
+
* @see {@link CreateKeyCommand}
|
|
276
124
|
*/
|
|
277
125
|
createKey(args: CreateKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateKeyCommandOutput>;
|
|
278
126
|
createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
279
127
|
createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
280
128
|
/**
|
|
281
|
-
* @
|
|
282
|
-
* <p>Creates a map resource in your Amazon Web Services account, which provides map tiles of different
|
|
283
|
-
* styles sourced from global location data providers.</p>
|
|
284
|
-
* <note>
|
|
285
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
286
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
287
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
288
|
-
* service terms</a> for more details.</p>
|
|
289
|
-
* </note>
|
|
129
|
+
* @see {@link CreateMapCommand}
|
|
290
130
|
*/
|
|
291
131
|
createMap(args: CreateMapCommandInput, options?: __HttpHandlerOptions): Promise<CreateMapCommandOutput>;
|
|
292
132
|
createMap(args: CreateMapCommandInput, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
|
|
293
133
|
createMap(args: CreateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMapCommandOutput) => void): void;
|
|
294
134
|
/**
|
|
295
|
-
* @
|
|
296
|
-
* <p>Creates a place index resource in your Amazon Web Services account. Use a place index resource to
|
|
297
|
-
* geocode addresses and other text queries by using the
|
|
298
|
-
* <code>SearchPlaceIndexForText</code> operation, and reverse geocode coordinates by
|
|
299
|
-
* using the <code>SearchPlaceIndexForPosition</code> operation, and enable autosuggestions
|
|
300
|
-
* by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
301
|
-
* <note>
|
|
302
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
303
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
304
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
305
|
-
* service terms</a> for more details.</p>
|
|
306
|
-
* </note>
|
|
135
|
+
* @see {@link CreatePlaceIndexCommand}
|
|
307
136
|
*/
|
|
308
137
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlaceIndexCommandOutput>;
|
|
309
138
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
310
139
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
311
140
|
/**
|
|
312
|
-
* @
|
|
313
|
-
* <p>Creates a route calculator resource in your Amazon Web Services account.</p>
|
|
314
|
-
* <p>You can send requests to a route calculator resource to estimate travel time,
|
|
315
|
-
* distance, and get directions. A route calculator sources traffic and road network data
|
|
316
|
-
* from your chosen data provider.</p>
|
|
317
|
-
* <note>
|
|
318
|
-
* <p>If your application is tracking or routing assets you use in your business, such
|
|
319
|
-
* as delivery vehicles or employees, you must not use Esri as your geolocation
|
|
320
|
-
* provider. See section 82 of the <a href="http://aws.amazon.com/service-terms">Amazon Web Services
|
|
321
|
-
* service terms</a> for more details.</p>
|
|
322
|
-
* </note>
|
|
141
|
+
* @see {@link CreateRouteCalculatorCommand}
|
|
323
142
|
*/
|
|
324
143
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCalculatorCommandOutput>;
|
|
325
144
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
|
|
326
145
|
createRouteCalculator(args: CreateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRouteCalculatorCommandOutput) => void): void;
|
|
327
146
|
/**
|
|
328
|
-
* @
|
|
329
|
-
* <p>Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and
|
|
330
|
-
* historical location of devices.</p>
|
|
147
|
+
* @see {@link CreateTrackerCommand}
|
|
331
148
|
*/
|
|
332
149
|
createTracker(args: CreateTrackerCommandInput, options?: __HttpHandlerOptions): Promise<CreateTrackerCommandOutput>;
|
|
333
150
|
createTracker(args: CreateTrackerCommandInput, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void;
|
|
334
151
|
createTracker(args: CreateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTrackerCommandOutput) => void): void;
|
|
335
152
|
/**
|
|
336
|
-
* @
|
|
337
|
-
* <p>Deletes a geofence collection from your Amazon Web Services account.</p>
|
|
338
|
-
* <note>
|
|
339
|
-
* <p>This operation deletes the resource permanently. If the geofence collection is the
|
|
340
|
-
* target of a tracker resource, the devices will no longer be monitored.</p>
|
|
341
|
-
* </note>
|
|
153
|
+
* @see {@link DeleteGeofenceCollectionCommand}
|
|
342
154
|
*/
|
|
343
155
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGeofenceCollectionCommandOutput>;
|
|
344
156
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
|
|
345
157
|
deleteGeofenceCollection(args: DeleteGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGeofenceCollectionCommandOutput) => void): void;
|
|
346
158
|
/**
|
|
347
|
-
* @
|
|
348
|
-
* <p>Deletes the specified API key. The API key must have been deactivated more than
|
|
349
|
-
* 90 days previously.</p>
|
|
159
|
+
* @see {@link DeleteKeyCommand}
|
|
350
160
|
*/
|
|
351
161
|
deleteKey(args: DeleteKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteKeyCommandOutput>;
|
|
352
162
|
deleteKey(args: DeleteKeyCommandInput, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void;
|
|
353
163
|
deleteKey(args: DeleteKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKeyCommandOutput) => void): void;
|
|
354
164
|
/**
|
|
355
|
-
* @
|
|
356
|
-
* <p>Deletes a map resource from your Amazon Web Services account.</p>
|
|
357
|
-
* <note>
|
|
358
|
-
* <p>This operation deletes the resource permanently. If the map is being used in an application,
|
|
359
|
-
* the map may not render.</p>
|
|
360
|
-
* </note>
|
|
165
|
+
* @see {@link DeleteMapCommand}
|
|
361
166
|
*/
|
|
362
167
|
deleteMap(args: DeleteMapCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMapCommandOutput>;
|
|
363
168
|
deleteMap(args: DeleteMapCommandInput, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
|
|
364
169
|
deleteMap(args: DeleteMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMapCommandOutput) => void): void;
|
|
365
170
|
/**
|
|
366
|
-
* @
|
|
367
|
-
* <p>Deletes a place index resource from your Amazon Web Services account.</p>
|
|
368
|
-
* <note>
|
|
369
|
-
* <p>This operation deletes the resource permanently.</p>
|
|
370
|
-
* </note>
|
|
171
|
+
* @see {@link DeletePlaceIndexCommand}
|
|
371
172
|
*/
|
|
372
173
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeletePlaceIndexCommandOutput>;
|
|
373
174
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
|
|
374
175
|
deletePlaceIndex(args: DeletePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaceIndexCommandOutput) => void): void;
|
|
375
176
|
/**
|
|
376
|
-
* @
|
|
377
|
-
* <p>Deletes a route calculator resource from your Amazon Web Services account.</p>
|
|
378
|
-
* <note>
|
|
379
|
-
* <p>This operation deletes the resource permanently.</p>
|
|
380
|
-
* </note>
|
|
177
|
+
* @see {@link DeleteRouteCalculatorCommand}
|
|
381
178
|
*/
|
|
382
179
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRouteCalculatorCommandOutput>;
|
|
383
180
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
|
|
384
181
|
deleteRouteCalculator(args: DeleteRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRouteCalculatorCommandOutput) => void): void;
|
|
385
182
|
/**
|
|
386
|
-
* @
|
|
387
|
-
* <p>Deletes a tracker resource from your Amazon Web Services account.</p>
|
|
388
|
-
* <note>
|
|
389
|
-
* <p>This operation deletes the resource permanently. If the tracker resource is in use, you may
|
|
390
|
-
* encounter an error. Make sure that the target resource isn't a dependency for your
|
|
391
|
-
* applications.</p>
|
|
392
|
-
* </note>
|
|
183
|
+
* @see {@link DeleteTrackerCommand}
|
|
393
184
|
*/
|
|
394
185
|
deleteTracker(args: DeleteTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTrackerCommandOutput>;
|
|
395
186
|
deleteTracker(args: DeleteTrackerCommandInput, cb: (err: any, data?: DeleteTrackerCommandOutput) => void): void;
|
|
396
187
|
deleteTracker(args: DeleteTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTrackerCommandOutput) => void): void;
|
|
397
188
|
/**
|
|
398
|
-
* @
|
|
399
|
-
* <p>Retrieves the geofence collection details.</p>
|
|
189
|
+
* @see {@link DescribeGeofenceCollectionCommand}
|
|
400
190
|
*/
|
|
401
191
|
describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGeofenceCollectionCommandOutput>;
|
|
402
192
|
describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void): void;
|
|
403
193
|
describeGeofenceCollection(args: DescribeGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGeofenceCollectionCommandOutput) => void): void;
|
|
404
194
|
/**
|
|
405
|
-
* @
|
|
406
|
-
* <p>Retrieves the API key resource details.</p>
|
|
407
|
-
* <important>
|
|
408
|
-
* <p>The API keys feature is in preview. We may add, change, or remove
|
|
409
|
-
* features before announcing general availability. For more information, see
|
|
410
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
|
|
411
|
-
* </important>
|
|
195
|
+
* @see {@link DescribeKeyCommand}
|
|
412
196
|
*/
|
|
413
197
|
describeKey(args: DescribeKeyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeKeyCommandOutput>;
|
|
414
198
|
describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
415
199
|
describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
416
200
|
/**
|
|
417
|
-
* @
|
|
418
|
-
* <p>Retrieves the map resource details.</p>
|
|
201
|
+
* @see {@link DescribeMapCommand}
|
|
419
202
|
*/
|
|
420
203
|
describeMap(args: DescribeMapCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMapCommandOutput>;
|
|
421
204
|
describeMap(args: DescribeMapCommandInput, cb: (err: any, data?: DescribeMapCommandOutput) => void): void;
|
|
422
205
|
describeMap(args: DescribeMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMapCommandOutput) => void): void;
|
|
423
206
|
/**
|
|
424
|
-
* @
|
|
425
|
-
* <p>Retrieves the place index resource details.</p>
|
|
207
|
+
* @see {@link DescribePlaceIndexCommand}
|
|
426
208
|
*/
|
|
427
209
|
describePlaceIndex(args: DescribePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<DescribePlaceIndexCommandOutput>;
|
|
428
210
|
describePlaceIndex(args: DescribePlaceIndexCommandInput, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void): void;
|
|
429
211
|
describePlaceIndex(args: DescribePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlaceIndexCommandOutput) => void): void;
|
|
430
212
|
/**
|
|
431
|
-
* @
|
|
432
|
-
* <p>Retrieves the route calculator resource details.</p>
|
|
213
|
+
* @see {@link DescribeRouteCalculatorCommand}
|
|
433
214
|
*/
|
|
434
215
|
describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRouteCalculatorCommandOutput>;
|
|
435
216
|
describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void): void;
|
|
436
217
|
describeRouteCalculator(args: DescribeRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRouteCalculatorCommandOutput) => void): void;
|
|
437
218
|
/**
|
|
438
|
-
* @
|
|
439
|
-
* <p>Retrieves the tracker resource details.</p>
|
|
219
|
+
* @see {@link DescribeTrackerCommand}
|
|
440
220
|
*/
|
|
441
221
|
describeTracker(args: DescribeTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrackerCommandOutput>;
|
|
442
222
|
describeTracker(args: DescribeTrackerCommandInput, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void;
|
|
443
223
|
describeTracker(args: DescribeTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrackerCommandOutput) => void): void;
|
|
444
224
|
/**
|
|
445
|
-
* @
|
|
446
|
-
* <p>Removes the association between a tracker resource and a geofence collection.</p>
|
|
447
|
-
* <note>
|
|
448
|
-
* <p>Once you unlink a tracker resource from a geofence collection, the tracker
|
|
449
|
-
* positions will no longer be automatically evaluated against geofences.</p>
|
|
450
|
-
* </note>
|
|
225
|
+
* @see {@link DisassociateTrackerConsumerCommand}
|
|
451
226
|
*/
|
|
452
227
|
disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateTrackerConsumerCommandOutput>;
|
|
453
228
|
disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void): void;
|
|
454
229
|
disassociateTrackerConsumer(args: DisassociateTrackerConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTrackerConsumerCommandOutput) => void): void;
|
|
455
230
|
/**
|
|
456
|
-
* @
|
|
457
|
-
* <p>Retrieves a device's most recent position according to its sample time.</p>
|
|
458
|
-
* <note>
|
|
459
|
-
* <p>Device positions are deleted after 30 days.</p>
|
|
460
|
-
* </note>
|
|
231
|
+
* @see {@link GetDevicePositionCommand}
|
|
461
232
|
*/
|
|
462
233
|
getDevicePosition(args: GetDevicePositionCommandInput, options?: __HttpHandlerOptions): Promise<GetDevicePositionCommandOutput>;
|
|
463
234
|
getDevicePosition(args: GetDevicePositionCommandInput, cb: (err: any, data?: GetDevicePositionCommandOutput) => void): void;
|
|
464
235
|
getDevicePosition(args: GetDevicePositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionCommandOutput) => void): void;
|
|
465
236
|
/**
|
|
466
|
-
* @
|
|
467
|
-
* <p>Retrieves the device position history from a tracker resource within a specified range
|
|
468
|
-
* of time.</p>
|
|
469
|
-
* <note>
|
|
470
|
-
* <p>Device positions are deleted after 30 days.</p>
|
|
471
|
-
* </note>
|
|
237
|
+
* @see {@link GetDevicePositionHistoryCommand}
|
|
472
238
|
*/
|
|
473
239
|
getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetDevicePositionHistoryCommandOutput>;
|
|
474
240
|
getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void): void;
|
|
475
241
|
getDevicePositionHistory(args: GetDevicePositionHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDevicePositionHistoryCommandOutput) => void): void;
|
|
476
242
|
/**
|
|
477
|
-
* @
|
|
478
|
-
* <p>Retrieves the geofence details from a geofence collection.</p>
|
|
243
|
+
* @see {@link GetGeofenceCommand}
|
|
479
244
|
*/
|
|
480
245
|
getGeofence(args: GetGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<GetGeofenceCommandOutput>;
|
|
481
246
|
getGeofence(args: GetGeofenceCommandInput, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void;
|
|
482
247
|
getGeofence(args: GetGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGeofenceCommandOutput) => void): void;
|
|
483
248
|
/**
|
|
484
|
-
* @
|
|
485
|
-
* <p>Retrieves glyphs used to display labels on a map.</p>
|
|
249
|
+
* @see {@link GetMapGlyphsCommand}
|
|
486
250
|
*/
|
|
487
251
|
getMapGlyphs(args: GetMapGlyphsCommandInput, options?: __HttpHandlerOptions): Promise<GetMapGlyphsCommandOutput>;
|
|
488
252
|
getMapGlyphs(args: GetMapGlyphsCommandInput, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void;
|
|
489
253
|
getMapGlyphs(args: GetMapGlyphsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapGlyphsCommandOutput) => void): void;
|
|
490
254
|
/**
|
|
491
|
-
* @
|
|
492
|
-
* <p>Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG
|
|
493
|
-
* image paired with a JSON document describing the offsets of individual icons that will
|
|
494
|
-
* be displayed on a rendered map.</p>
|
|
255
|
+
* @see {@link GetMapSpritesCommand}
|
|
495
256
|
*/
|
|
496
257
|
getMapSprites(args: GetMapSpritesCommandInput, options?: __HttpHandlerOptions): Promise<GetMapSpritesCommandOutput>;
|
|
497
258
|
getMapSprites(args: GetMapSpritesCommandInput, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void;
|
|
498
259
|
getMapSprites(args: GetMapSpritesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapSpritesCommandOutput) => void): void;
|
|
499
260
|
/**
|
|
500
|
-
* @
|
|
501
|
-
* <p>Retrieves the map style descriptor from a map resource. </p>
|
|
502
|
-
* <p>The style descriptor contains specifications on how features render on a map. For
|
|
503
|
-
* example, what data to display, what order to display the data in, and the style for the
|
|
504
|
-
* data. Style descriptors follow the Mapbox Style Specification.</p>
|
|
261
|
+
* @see {@link GetMapStyleDescriptorCommand}
|
|
505
262
|
*/
|
|
506
263
|
getMapStyleDescriptor(args: GetMapStyleDescriptorCommandInput, options?: __HttpHandlerOptions): Promise<GetMapStyleDescriptorCommandOutput>;
|
|
507
264
|
getMapStyleDescriptor(args: GetMapStyleDescriptorCommandInput, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void): void;
|
|
508
265
|
getMapStyleDescriptor(args: GetMapStyleDescriptorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapStyleDescriptorCommandOutput) => void): void;
|
|
509
266
|
/**
|
|
510
|
-
* @
|
|
511
|
-
* <p>Retrieves a vector data tile from the map resource. Map tiles are used by clients to
|
|
512
|
-
* render a map. they're addressed using a grid arrangement with an X coordinate, Y
|
|
513
|
-
* coordinate, and Z (zoom) level. </p>
|
|
514
|
-
* <p>The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles
|
|
515
|
-
* both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0)
|
|
516
|
-
* will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).</p>
|
|
267
|
+
* @see {@link GetMapTileCommand}
|
|
517
268
|
*/
|
|
518
269
|
getMapTile(args: GetMapTileCommandInput, options?: __HttpHandlerOptions): Promise<GetMapTileCommandOutput>;
|
|
519
270
|
getMapTile(args: GetMapTileCommandInput, cb: (err: any, data?: GetMapTileCommandOutput) => void): void;
|
|
520
271
|
getMapTile(args: GetMapTileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMapTileCommandOutput) => void): void;
|
|
521
272
|
/**
|
|
522
|
-
* @
|
|
523
|
-
* <p>Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search
|
|
524
|
-
* operations.</p>
|
|
525
|
-
* <note>
|
|
526
|
-
* <p>A PlaceId is valid only if all of the following are the same in the original
|
|
527
|
-
* search request and the call to <code>GetPlace</code>.</p>
|
|
528
|
-
* <ul>
|
|
529
|
-
* <li>
|
|
530
|
-
* <p>Customer Amazon Web Services account</p>
|
|
531
|
-
* </li>
|
|
532
|
-
* <li>
|
|
533
|
-
* <p>Amazon Web Services Region</p>
|
|
534
|
-
* </li>
|
|
535
|
-
* <li>
|
|
536
|
-
* <p>Data provider specified in the place index resource</p>
|
|
537
|
-
* </li>
|
|
538
|
-
* </ul>
|
|
539
|
-
* </note>
|
|
273
|
+
* @see {@link GetPlaceCommand}
|
|
540
274
|
*/
|
|
541
275
|
getPlace(args: GetPlaceCommandInput, options?: __HttpHandlerOptions): Promise<GetPlaceCommandOutput>;
|
|
542
276
|
getPlace(args: GetPlaceCommandInput, cb: (err: any, data?: GetPlaceCommandOutput) => void): void;
|
|
543
277
|
getPlace(args: GetPlaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaceCommandOutput) => void): void;
|
|
544
278
|
/**
|
|
545
|
-
* @
|
|
546
|
-
* <p>A batch request to retrieve all device positions.</p>
|
|
279
|
+
* @see {@link ListDevicePositionsCommand}
|
|
547
280
|
*/
|
|
548
281
|
listDevicePositions(args: ListDevicePositionsCommandInput, options?: __HttpHandlerOptions): Promise<ListDevicePositionsCommandOutput>;
|
|
549
282
|
listDevicePositions(args: ListDevicePositionsCommandInput, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void): void;
|
|
550
283
|
listDevicePositions(args: ListDevicePositionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDevicePositionsCommandOutput) => void): void;
|
|
551
284
|
/**
|
|
552
|
-
* @
|
|
553
|
-
* <p>Lists geofence collections in your Amazon Web Services account.</p>
|
|
285
|
+
* @see {@link ListGeofenceCollectionsCommand}
|
|
554
286
|
*/
|
|
555
287
|
listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListGeofenceCollectionsCommandOutput>;
|
|
556
288
|
listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void): void;
|
|
557
289
|
listGeofenceCollections(args: ListGeofenceCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofenceCollectionsCommandOutput) => void): void;
|
|
558
290
|
/**
|
|
559
|
-
* @
|
|
560
|
-
* <p>Lists geofences stored in a given geofence collection.</p>
|
|
291
|
+
* @see {@link ListGeofencesCommand}
|
|
561
292
|
*/
|
|
562
293
|
listGeofences(args: ListGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<ListGeofencesCommandOutput>;
|
|
563
294
|
listGeofences(args: ListGeofencesCommandInput, cb: (err: any, data?: ListGeofencesCommandOutput) => void): void;
|
|
564
295
|
listGeofences(args: ListGeofencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGeofencesCommandOutput) => void): void;
|
|
565
296
|
/**
|
|
566
|
-
* @
|
|
567
|
-
* <p>Lists API key resources in your Amazon Web Services account.</p>
|
|
568
|
-
* <important>
|
|
569
|
-
* <p>The API keys feature is in preview. We may add, change, or remove
|
|
570
|
-
* features before announcing general availability. For more information, see
|
|
571
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
|
|
572
|
-
* </important>
|
|
297
|
+
* @see {@link ListKeysCommand}
|
|
573
298
|
*/
|
|
574
299
|
listKeys(args: ListKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListKeysCommandOutput>;
|
|
575
300
|
listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
576
301
|
listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
577
302
|
/**
|
|
578
|
-
* @
|
|
579
|
-
* <p>Lists map resources in your Amazon Web Services account.</p>
|
|
303
|
+
* @see {@link ListMapsCommand}
|
|
580
304
|
*/
|
|
581
305
|
listMaps(args: ListMapsCommandInput, options?: __HttpHandlerOptions): Promise<ListMapsCommandOutput>;
|
|
582
306
|
listMaps(args: ListMapsCommandInput, cb: (err: any, data?: ListMapsCommandOutput) => void): void;
|
|
583
307
|
listMaps(args: ListMapsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapsCommandOutput) => void): void;
|
|
584
308
|
/**
|
|
585
|
-
* @
|
|
586
|
-
* <p>Lists place index resources in your Amazon Web Services account.</p>
|
|
309
|
+
* @see {@link ListPlaceIndexesCommand}
|
|
587
310
|
*/
|
|
588
311
|
listPlaceIndexes(args: ListPlaceIndexesCommandInput, options?: __HttpHandlerOptions): Promise<ListPlaceIndexesCommandOutput>;
|
|
589
312
|
listPlaceIndexes(args: ListPlaceIndexesCommandInput, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void): void;
|
|
590
313
|
listPlaceIndexes(args: ListPlaceIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaceIndexesCommandOutput) => void): void;
|
|
591
314
|
/**
|
|
592
|
-
* @
|
|
593
|
-
* <p>Lists route calculator resources in your Amazon Web Services account.</p>
|
|
315
|
+
* @see {@link ListRouteCalculatorsCommand}
|
|
594
316
|
*/
|
|
595
317
|
listRouteCalculators(args: ListRouteCalculatorsCommandInput, options?: __HttpHandlerOptions): Promise<ListRouteCalculatorsCommandOutput>;
|
|
596
318
|
listRouteCalculators(args: ListRouteCalculatorsCommandInput, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void): void;
|
|
597
319
|
listRouteCalculators(args: ListRouteCalculatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRouteCalculatorsCommandOutput) => void): void;
|
|
598
320
|
/**
|
|
599
|
-
* @
|
|
600
|
-
* <p>Returns a list of tags that are applied to the specified Amazon Location resource.</p>
|
|
321
|
+
* @see {@link ListTagsForResourceCommand}
|
|
601
322
|
*/
|
|
602
323
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
603
324
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
604
325
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
605
326
|
/**
|
|
606
|
-
* @
|
|
607
|
-
* <p>Lists geofence collections currently associated to the given tracker resource.</p>
|
|
327
|
+
* @see {@link ListTrackerConsumersCommand}
|
|
608
328
|
*/
|
|
609
329
|
listTrackerConsumers(args: ListTrackerConsumersCommandInput, options?: __HttpHandlerOptions): Promise<ListTrackerConsumersCommandOutput>;
|
|
610
330
|
listTrackerConsumers(args: ListTrackerConsumersCommandInput, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void): void;
|
|
611
331
|
listTrackerConsumers(args: ListTrackerConsumersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackerConsumersCommandOutput) => void): void;
|
|
612
332
|
/**
|
|
613
|
-
* @
|
|
614
|
-
* <p>Lists tracker resources in your Amazon Web Services account.</p>
|
|
333
|
+
* @see {@link ListTrackersCommand}
|
|
615
334
|
*/
|
|
616
335
|
listTrackers(args: ListTrackersCommandInput, options?: __HttpHandlerOptions): Promise<ListTrackersCommandOutput>;
|
|
617
336
|
listTrackers(args: ListTrackersCommandInput, cb: (err: any, data?: ListTrackersCommandOutput) => void): void;
|
|
618
337
|
listTrackers(args: ListTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTrackersCommandOutput) => void): void;
|
|
619
338
|
/**
|
|
620
|
-
* @
|
|
621
|
-
* <p>Stores a geofence geometry in a given geofence collection, or updates the geometry of
|
|
622
|
-
* an existing geofence if a geofence ID is included in the request. </p>
|
|
339
|
+
* @see {@link PutGeofenceCommand}
|
|
623
340
|
*/
|
|
624
341
|
putGeofence(args: PutGeofenceCommandInput, options?: __HttpHandlerOptions): Promise<PutGeofenceCommandOutput>;
|
|
625
342
|
putGeofence(args: PutGeofenceCommandInput, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
|
|
626
343
|
putGeofence(args: PutGeofenceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGeofenceCommandOutput) => void): void;
|
|
627
344
|
/**
|
|
628
|
-
* @
|
|
629
|
-
* <p>Reverse geocodes a given coordinate and returns a legible address. Allows you to
|
|
630
|
-
* search for Places or points of interest near a given position.</p>
|
|
345
|
+
* @see {@link SearchPlaceIndexForPositionCommand}
|
|
631
346
|
*/
|
|
632
347
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForPositionCommandOutput>;
|
|
633
348
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
634
349
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
635
350
|
/**
|
|
636
|
-
* @
|
|
637
|
-
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
638
|
-
* misspelled free-form text. This operation is also known as autocomplete, autosuggest, or
|
|
639
|
-
* fuzzy matching.</p>
|
|
640
|
-
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
641
|
-
* bias your search toward a specific position on the globe.</p>
|
|
642
|
-
* <note>
|
|
643
|
-
* <p>You can search for suggested place names near a specified position by using
|
|
644
|
-
* <code>BiasPosition</code>, or filter results within a bounding box by using
|
|
645
|
-
* <code>FilterBBox</code>. These parameters are mutually exclusive; using both
|
|
646
|
-
* <code>BiasPosition</code> and <code>FilterBBox</code> in the same command
|
|
647
|
-
* returns an error.</p>
|
|
648
|
-
* </note>
|
|
351
|
+
* @see {@link SearchPlaceIndexForSuggestionsCommand}
|
|
649
352
|
*/
|
|
650
353
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
651
354
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
652
355
|
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
653
356
|
/**
|
|
654
|
-
* @
|
|
655
|
-
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
656
|
-
* search for Places or points of interest. </p>
|
|
657
|
-
* <p>Optional parameters let you narrow your search results by bounding box or country, or
|
|
658
|
-
* bias your search toward a specific position on the globe.</p>
|
|
659
|
-
* <note>
|
|
660
|
-
* <p>You can search for places near a given position using <code>BiasPosition</code>,
|
|
661
|
-
* or filter results within a bounding box using <code>FilterBBox</code>. Providing
|
|
662
|
-
* both parameters simultaneously returns an error.</p>
|
|
663
|
-
* </note>
|
|
664
|
-
* <p>Search results are returned in order of highest to lowest relevance.</p>
|
|
357
|
+
* @see {@link SearchPlaceIndexForTextCommand}
|
|
665
358
|
*/
|
|
666
359
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForTextCommandOutput>;
|
|
667
360
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
668
361
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
669
362
|
/**
|
|
670
|
-
* @
|
|
671
|
-
* <p>Assigns one or more tags (key-value pairs) to the specified Amazon Location Service
|
|
672
|
-
* resource.</p>
|
|
673
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to
|
|
674
|
-
* scope user permissions, by granting a user permission to access or change only resources
|
|
675
|
-
* with certain tag values.</p>
|
|
676
|
-
* <p>You can use the <code>TagResource</code> operation with an Amazon Location Service
|
|
677
|
-
* resource that already has tags. If you specify a new tag key for the resource, this tag
|
|
678
|
-
* is appended to the tags already associated with the resource. If you specify a tag key
|
|
679
|
-
* that's already associated with the resource, the new tag value that you specify replaces
|
|
680
|
-
* the previous value for that tag. </p>
|
|
681
|
-
* <p>You can associate up to 50 tags with a resource.</p>
|
|
363
|
+
* @see {@link TagResourceCommand}
|
|
682
364
|
*/
|
|
683
365
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
684
366
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
685
367
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
686
368
|
/**
|
|
687
|
-
* @
|
|
688
|
-
* <p>Removes one or more tags from the specified Amazon Location resource.</p>
|
|
369
|
+
* @see {@link UntagResourceCommand}
|
|
689
370
|
*/
|
|
690
371
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
691
372
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
692
373
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
693
374
|
/**
|
|
694
|
-
* @
|
|
695
|
-
* <p>Updates the specified properties of a given geofence collection.</p>
|
|
375
|
+
* @see {@link UpdateGeofenceCollectionCommand}
|
|
696
376
|
*/
|
|
697
377
|
updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGeofenceCollectionCommandOutput>;
|
|
698
378
|
updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void): void;
|
|
699
379
|
updateGeofenceCollection(args: UpdateGeofenceCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGeofenceCollectionCommandOutput) => void): void;
|
|
700
380
|
/**
|
|
701
|
-
* @
|
|
702
|
-
* <p>Updates the specified properties of a given API key resource.</p>
|
|
703
|
-
* <important>
|
|
704
|
-
* <p>The API keys feature is in preview. We may add, change, or remove
|
|
705
|
-
* features before announcing general availability. For more information, see
|
|
706
|
-
* <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">Using API keys</a>.</p>
|
|
707
|
-
* </important>
|
|
381
|
+
* @see {@link UpdateKeyCommand}
|
|
708
382
|
*/
|
|
709
383
|
updateKey(args: UpdateKeyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateKeyCommandOutput>;
|
|
710
384
|
updateKey(args: UpdateKeyCommandInput, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void;
|
|
711
385
|
updateKey(args: UpdateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyCommandOutput) => void): void;
|
|
712
386
|
/**
|
|
713
|
-
* @
|
|
714
|
-
* <p>Updates the specified properties of a given map resource.</p>
|
|
387
|
+
* @see {@link UpdateMapCommand}
|
|
715
388
|
*/
|
|
716
389
|
updateMap(args: UpdateMapCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMapCommandOutput>;
|
|
717
390
|
updateMap(args: UpdateMapCommandInput, cb: (err: any, data?: UpdateMapCommandOutput) => void): void;
|
|
718
391
|
updateMap(args: UpdateMapCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMapCommandOutput) => void): void;
|
|
719
392
|
/**
|
|
720
|
-
* @
|
|
721
|
-
* <p>Updates the specified properties of a given place index resource.</p>
|
|
393
|
+
* @see {@link UpdatePlaceIndexCommand}
|
|
722
394
|
*/
|
|
723
395
|
updatePlaceIndex(args: UpdatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePlaceIndexCommandOutput>;
|
|
724
396
|
updatePlaceIndex(args: UpdatePlaceIndexCommandInput, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void): void;
|
|
725
397
|
updatePlaceIndex(args: UpdatePlaceIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePlaceIndexCommandOutput) => void): void;
|
|
726
398
|
/**
|
|
727
|
-
* @
|
|
728
|
-
* <p>Updates the specified properties for a given route calculator resource.</p>
|
|
399
|
+
* @see {@link UpdateRouteCalculatorCommand}
|
|
729
400
|
*/
|
|
730
401
|
updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRouteCalculatorCommandOutput>;
|
|
731
402
|
updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void): void;
|
|
732
403
|
updateRouteCalculator(args: UpdateRouteCalculatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRouteCalculatorCommandOutput) => void): void;
|
|
733
404
|
/**
|
|
734
|
-
* @
|
|
735
|
-
* <p>Updates the specified properties of a given tracker resource.</p>
|
|
405
|
+
* @see {@link UpdateTrackerCommand}
|
|
736
406
|
*/
|
|
737
407
|
updateTracker(args: UpdateTrackerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTrackerCommandOutput>;
|
|
738
408
|
updateTracker(args: UpdateTrackerCommandInput, cb: (err: any, data?: UpdateTrackerCommandOutput) => void): void;
|
|
739
409
|
updateTracker(args: UpdateTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTrackerCommandOutput) => void): void;
|
|
740
410
|
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
* <p>"Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing"</p>
|
|
414
|
+
*/
|
|
415
|
+
export declare class Location extends LocationClient implements Location {
|
|
416
|
+
}
|