@aws-sdk/client-location 3.43.0 → 3.45.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/CHANGELOG.md +11 -0
- package/dist-cjs/Location.js +15 -0
- package/dist-cjs/commands/SearchPlaceIndexForSuggestionsCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +44 -3
- package/dist-cjs/protocols/Aws_restJson1.js +227 -2
- package/dist-es/Location.js +15 -0
- package/dist-es/commands/SearchPlaceIndexForSuggestionsCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +24 -4
- package/dist-es/protocols/Aws_restJson1.js +234 -2
- package/dist-types/Location.d.ts +33 -4
- package/dist-types/LocationClient.d.ts +3 -2
- package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +4 -0
- package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +11 -3
- package/dist-types/commands/CreatePlaceIndexCommand.d.ts +2 -1
- package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +44 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +267 -12
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/Location.d.ts +5 -0
- package/dist-types/ts3.4/LocationClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +98 -5
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
- package/package.json +5 -5
|
@@ -287,6 +287,22 @@ export declare namespace BatchDeleteGeofenceResponse {
|
|
|
287
287
|
*/
|
|
288
288
|
const filterSensitiveLog: (obj: BatchDeleteGeofenceResponse) => any;
|
|
289
289
|
}
|
|
290
|
+
/**
|
|
291
|
+
* <p>Defines the level of certainty of the position.</p>
|
|
292
|
+
*/
|
|
293
|
+
export interface PositionalAccuracy {
|
|
294
|
+
/**
|
|
295
|
+
* <p>Estimated maximum distance, in meters, between the measured position and the true
|
|
296
|
+
* position of a device, along the Earth's surface.</p>
|
|
297
|
+
*/
|
|
298
|
+
Horizontal: number | undefined;
|
|
299
|
+
}
|
|
300
|
+
export declare namespace PositionalAccuracy {
|
|
301
|
+
/**
|
|
302
|
+
* @internal
|
|
303
|
+
*/
|
|
304
|
+
const filterSensitiveLog: (obj: PositionalAccuracy) => any;
|
|
305
|
+
}
|
|
290
306
|
/**
|
|
291
307
|
* <p>Contains the position update details for a device.</p>
|
|
292
308
|
*/
|
|
@@ -306,6 +322,20 @@ export interface DevicePositionUpdate {
|
|
|
306
322
|
* <code>[X or longitude, Y or latitude]</code>.</p>
|
|
307
323
|
*/
|
|
308
324
|
Position: number[] | undefined;
|
|
325
|
+
/**
|
|
326
|
+
* <p>The accuracy of the device position.</p>
|
|
327
|
+
*/
|
|
328
|
+
Accuracy?: PositionalAccuracy;
|
|
329
|
+
/**
|
|
330
|
+
* <p>Associates one of more properties with the position update. A property is a key-value
|
|
331
|
+
* pair stored with the position update and added to any geofence event the update may
|
|
332
|
+
* trigger.</p>
|
|
333
|
+
* <p>Format: <code>"key" : "value"</code>
|
|
334
|
+
* </p>
|
|
335
|
+
*/
|
|
336
|
+
PositionProperties?: {
|
|
337
|
+
[key: string]: string;
|
|
338
|
+
};
|
|
309
339
|
}
|
|
310
340
|
export declare namespace DevicePositionUpdate {
|
|
311
341
|
/**
|
|
@@ -415,6 +445,16 @@ export interface DevicePosition {
|
|
|
415
445
|
* <p>The last known device position.</p>
|
|
416
446
|
*/
|
|
417
447
|
Position: number[] | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* <p>The accuracy of the device position.</p>
|
|
450
|
+
*/
|
|
451
|
+
Accuracy?: PositionalAccuracy;
|
|
452
|
+
/**
|
|
453
|
+
* <p>The properties associated with the position.</p>
|
|
454
|
+
*/
|
|
455
|
+
PositionProperties?: {
|
|
456
|
+
[key: string]: string;
|
|
457
|
+
};
|
|
418
458
|
}
|
|
419
459
|
export declare namespace DevicePosition {
|
|
420
460
|
/**
|
|
@@ -1216,11 +1256,12 @@ export interface CreateGeofenceCollectionRequest {
|
|
|
1216
1256
|
*/
|
|
1217
1257
|
CollectionName: string | undefined;
|
|
1218
1258
|
/**
|
|
1219
|
-
* <p>
|
|
1259
|
+
* <p>Optionally specifies the pricing plan for the geofence collection. Defaults to
|
|
1260
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1220
1261
|
* <p>For additional details and restrictions on each pricing plan option, see the <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing
|
|
1221
1262
|
* page</a>.</p>
|
|
1222
1263
|
*/
|
|
1223
|
-
PricingPlan
|
|
1264
|
+
PricingPlan?: PricingPlan | string;
|
|
1224
1265
|
/**
|
|
1225
1266
|
* <p>Specifies the data provider for the geofence collection.</p>
|
|
1226
1267
|
* <ul>
|
|
@@ -1410,10 +1451,11 @@ export interface CreateMapRequest {
|
|
|
1410
1451
|
*/
|
|
1411
1452
|
Configuration: MapConfiguration | undefined;
|
|
1412
1453
|
/**
|
|
1413
|
-
* <p>
|
|
1454
|
+
* <p>Optionally specifies the pricing plan for the map resource. Defaults to
|
|
1455
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1414
1456
|
* <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
|
|
1415
1457
|
*/
|
|
1416
|
-
PricingPlan
|
|
1458
|
+
PricingPlan?: PricingPlan | string;
|
|
1417
1459
|
/**
|
|
1418
1460
|
* <p>An optional description for the map resource.</p>
|
|
1419
1461
|
*/
|
|
@@ -1579,10 +1621,11 @@ export interface CreatePlaceIndexRequest {
|
|
|
1579
1621
|
*/
|
|
1580
1622
|
DataSource: string | undefined;
|
|
1581
1623
|
/**
|
|
1582
|
-
* <p>
|
|
1624
|
+
* <p>Optionally specifies the pricing plan for the place index resource. Defaults to
|
|
1625
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1583
1626
|
* <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
|
|
1584
1627
|
*/
|
|
1585
|
-
PricingPlan
|
|
1628
|
+
PricingPlan?: PricingPlan | string;
|
|
1586
1629
|
/**
|
|
1587
1630
|
* <p>The optional description for the place index resource.</p>
|
|
1588
1631
|
*/
|
|
@@ -1700,10 +1743,11 @@ export interface CreateRouteCalculatorRequest {
|
|
|
1700
1743
|
*/
|
|
1701
1744
|
DataSource: string | undefined;
|
|
1702
1745
|
/**
|
|
1703
|
-
* <p>
|
|
1746
|
+
* <p>Optionally specifies the pricing plan for the route calculator resource. Defaults to
|
|
1747
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1704
1748
|
* <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
|
|
1705
1749
|
*/
|
|
1706
|
-
PricingPlan
|
|
1750
|
+
PricingPlan?: PricingPlan | string;
|
|
1707
1751
|
/**
|
|
1708
1752
|
* <p>The optional description for the route calculator resource.</p>
|
|
1709
1753
|
*/
|
|
@@ -1811,10 +1855,11 @@ export interface CreateTrackerRequest {
|
|
|
1811
1855
|
*/
|
|
1812
1856
|
TrackerName: string | undefined;
|
|
1813
1857
|
/**
|
|
1814
|
-
* <p>
|
|
1858
|
+
* <p>Optionally specifies the pricing plan for the tracker resource. Defaults to
|
|
1859
|
+
* <code>RequestBasedUsage</code>.</p>
|
|
1815
1860
|
* <p>For additional details and restrictions on each pricing plan option, see <a href="https://aws.amazon.com/location/pricing/">Amazon Location Service pricing</a>.</p>
|
|
1816
1861
|
*/
|
|
1817
|
-
PricingPlan
|
|
1862
|
+
PricingPlan?: PricingPlan | string;
|
|
1818
1863
|
/**
|
|
1819
1864
|
* <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">AWS KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
|
|
1820
1865
|
*/
|
|
@@ -1891,6 +1936,17 @@ export interface CreateTrackerRequest {
|
|
|
1891
1936
|
* Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
|
|
1892
1937
|
* </p>
|
|
1893
1938
|
* </li>
|
|
1939
|
+
* <li>
|
|
1940
|
+
* <p>
|
|
1941
|
+
* <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
|
|
1942
|
+
* location updates are ignored. For example, if two consecutive updates from a device
|
|
1943
|
+
* have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
|
|
1944
|
+
* has moved less than 15 m. Ignored location updates are neither evaluated against
|
|
1945
|
+
* linked geofence collections, nor stored. This can reduce the effects of GPS noise
|
|
1946
|
+
* when displaying device trajectories on a map, and can help control your costs by reducing the
|
|
1947
|
+
* number of geofence evaluations.
|
|
1948
|
+
* </p>
|
|
1949
|
+
* </li>
|
|
1894
1950
|
* </ul>
|
|
1895
1951
|
* <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>
|
|
1896
1952
|
*/
|
|
@@ -2975,6 +3031,16 @@ export interface GetDevicePositionResponse {
|
|
|
2975
3031
|
* <p>The last known device position.</p>
|
|
2976
3032
|
*/
|
|
2977
3033
|
Position: number[] | undefined;
|
|
3034
|
+
/**
|
|
3035
|
+
* <p>The accuracy of the device position.</p>
|
|
3036
|
+
*/
|
|
3037
|
+
Accuracy?: PositionalAccuracy;
|
|
3038
|
+
/**
|
|
3039
|
+
* <p>The properties associated with the position.</p>
|
|
3040
|
+
*/
|
|
3041
|
+
PositionProperties?: {
|
|
3042
|
+
[key: string]: string;
|
|
3043
|
+
};
|
|
2978
3044
|
}
|
|
2979
3045
|
export declare namespace GetDevicePositionResponse {
|
|
2980
3046
|
/**
|
|
@@ -3294,6 +3360,16 @@ export interface ListDevicePositionsResponseEntry {
|
|
|
3294
3360
|
* <p>The last known device position. Empty if no positions currently stored.</p>
|
|
3295
3361
|
*/
|
|
3296
3362
|
Position: number[] | undefined;
|
|
3363
|
+
/**
|
|
3364
|
+
* <p>The accuracy of the device position.</p>
|
|
3365
|
+
*/
|
|
3366
|
+
Accuracy?: PositionalAccuracy;
|
|
3367
|
+
/**
|
|
3368
|
+
* <p>The properties associated with the position.</p>
|
|
3369
|
+
*/
|
|
3370
|
+
PositionProperties?: {
|
|
3371
|
+
[key: string]: string;
|
|
3372
|
+
};
|
|
3297
3373
|
}
|
|
3298
3374
|
export declare namespace ListDevicePositionsResponseEntry {
|
|
3299
3375
|
/**
|
|
@@ -3996,6 +4072,170 @@ export declare namespace SearchPlaceIndexForPositionResponse {
|
|
|
3996
4072
|
*/
|
|
3997
4073
|
const filterSensitiveLog: (obj: SearchPlaceIndexForPositionResponse) => any;
|
|
3998
4074
|
}
|
|
4075
|
+
export interface SearchPlaceIndexForSuggestionsRequest {
|
|
4076
|
+
/**
|
|
4077
|
+
* <p>The name of the place index resource you want to use for the search.</p>
|
|
4078
|
+
*/
|
|
4079
|
+
IndexName: string | undefined;
|
|
4080
|
+
/**
|
|
4081
|
+
* <p>The free-form partial text to use to generate place suggestions. For example,
|
|
4082
|
+
* <code>eiffel tow</code>.</p>
|
|
4083
|
+
*/
|
|
4084
|
+
Text: string | undefined;
|
|
4085
|
+
/**
|
|
4086
|
+
* <p>An optional parameter that indicates a preference for place suggestions that are closer to a specified position.</p>
|
|
4087
|
+
* <p>
|
|
4088
|
+
* If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude;
|
|
4089
|
+
* the second number represents the Y coordinate, or latitude.</p>
|
|
4090
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
|
|
4091
|
+
* longitude <code>-123.1174</code> and
|
|
4092
|
+
* latitude <code>49.2847</code>.</p>
|
|
4093
|
+
* <note>
|
|
4094
|
+
* <p>
|
|
4095
|
+
* <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.
|
|
4096
|
+
* </p>
|
|
4097
|
+
* </note>
|
|
4098
|
+
*/
|
|
4099
|
+
BiasPosition?: number[];
|
|
4100
|
+
/**
|
|
4101
|
+
* <p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p>
|
|
4102
|
+
* <p>
|
|
4103
|
+
* If provided, this parameter must contain a total of four consecutive numbers in two pairs.
|
|
4104
|
+
* The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
|
|
4105
|
+
* of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)
|
|
4106
|
+
* of the northeast corner of the bounding box.</p>
|
|
4107
|
+
* <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents
|
|
4108
|
+
* a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>,
|
|
4109
|
+
* and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>
|
|
4110
|
+
* <note>
|
|
4111
|
+
* <p>
|
|
4112
|
+
* <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.
|
|
4113
|
+
* </p>
|
|
4114
|
+
* </note>
|
|
4115
|
+
*/
|
|
4116
|
+
FilterBBox?: number[];
|
|
4117
|
+
/**
|
|
4118
|
+
* <p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p>
|
|
4119
|
+
* <ul>
|
|
4120
|
+
* <li>
|
|
4121
|
+
* <p>Use the <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit
|
|
4122
|
+
* country code. For example, Australia uses three upper-case characters:
|
|
4123
|
+
* <code>AUS</code>.</p>
|
|
4124
|
+
* </li>
|
|
4125
|
+
* </ul>
|
|
4126
|
+
*/
|
|
4127
|
+
FilterCountries?: string[];
|
|
4128
|
+
/**
|
|
4129
|
+
* <p>An optional parameter. The maximum number of results returned per request. </p>
|
|
4130
|
+
* <p>The default: <code>5</code>
|
|
4131
|
+
* </p>
|
|
4132
|
+
*/
|
|
4133
|
+
MaxResults?: number;
|
|
4134
|
+
/**
|
|
4135
|
+
* <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
4136
|
+
* <code>en</code> for English.</p>
|
|
4137
|
+
* <p>This setting affects the languages used in the results. It does not change which
|
|
4138
|
+
* results are returned. If the language is not specified, or not supported for a
|
|
4139
|
+
* particular result, the partner automatically chooses a language for the result.</p>
|
|
4140
|
+
* <p>Used only when the partner selected is Here.</p>
|
|
4141
|
+
*/
|
|
4142
|
+
Language?: string;
|
|
4143
|
+
}
|
|
4144
|
+
export declare namespace SearchPlaceIndexForSuggestionsRequest {
|
|
4145
|
+
/**
|
|
4146
|
+
* @internal
|
|
4147
|
+
*/
|
|
4148
|
+
const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsRequest) => any;
|
|
4149
|
+
}
|
|
4150
|
+
/**
|
|
4151
|
+
* <p>Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.</p>
|
|
4152
|
+
*/
|
|
4153
|
+
export interface SearchForSuggestionsResult {
|
|
4154
|
+
/**
|
|
4155
|
+
* <p>The text of the place suggestion, typically formatted as an address string.</p>
|
|
4156
|
+
*/
|
|
4157
|
+
Text: string | undefined;
|
|
4158
|
+
}
|
|
4159
|
+
export declare namespace SearchForSuggestionsResult {
|
|
4160
|
+
/**
|
|
4161
|
+
* @internal
|
|
4162
|
+
*/
|
|
4163
|
+
const filterSensitiveLog: (obj: SearchForSuggestionsResult) => any;
|
|
4164
|
+
}
|
|
4165
|
+
/**
|
|
4166
|
+
* <p>A summary of the request sent by using <code>SearchPlaceIndexForSuggestions</code>.</p>
|
|
4167
|
+
*/
|
|
4168
|
+
export interface SearchPlaceIndexForSuggestionsSummary {
|
|
4169
|
+
/**
|
|
4170
|
+
* <p>The free-form partial text input specified in the request.</p>
|
|
4171
|
+
*/
|
|
4172
|
+
Text: string | undefined;
|
|
4173
|
+
/**
|
|
4174
|
+
* <p>Contains the coordinates for the optional bias position specified in the request.</p>
|
|
4175
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
4176
|
+
* coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
|
|
4177
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
|
|
4178
|
+
* longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4179
|
+
*/
|
|
4180
|
+
BiasPosition?: number[];
|
|
4181
|
+
/**
|
|
4182
|
+
* <p>Contains the coordinates for the optional bounding box specified in the request.</p>
|
|
4183
|
+
*/
|
|
4184
|
+
FilterBBox?: number[];
|
|
4185
|
+
/**
|
|
4186
|
+
* <p>Contains the optional country filter specified in the request.</p>
|
|
4187
|
+
*/
|
|
4188
|
+
FilterCountries?: string[];
|
|
4189
|
+
/**
|
|
4190
|
+
* <p>Contains the optional result count limit specified in the request.</p>
|
|
4191
|
+
*/
|
|
4192
|
+
MaxResults?: number;
|
|
4193
|
+
/**
|
|
4194
|
+
* <p>The geospatial data provider attached to the place index resource specified in the request.
|
|
4195
|
+
* Values can be one of the following:</p>
|
|
4196
|
+
* <ul>
|
|
4197
|
+
* <li>
|
|
4198
|
+
* <p>Esri</p>
|
|
4199
|
+
* </li>
|
|
4200
|
+
* <li>
|
|
4201
|
+
* <p>Here</p>
|
|
4202
|
+
* </li>
|
|
4203
|
+
* </ul>
|
|
4204
|
+
* <p>For more information about data providers, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html">Amazon Location Service data providers</a>.</p>
|
|
4205
|
+
*/
|
|
4206
|
+
DataSource: string | undefined;
|
|
4207
|
+
/**
|
|
4208
|
+
* <p>The preferred language used to return results. Matches the language in the request.
|
|
4209
|
+
* The value is a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example,
|
|
4210
|
+
* <code>en</code> for English.</p>
|
|
4211
|
+
*/
|
|
4212
|
+
Language?: string;
|
|
4213
|
+
}
|
|
4214
|
+
export declare namespace SearchPlaceIndexForSuggestionsSummary {
|
|
4215
|
+
/**
|
|
4216
|
+
* @internal
|
|
4217
|
+
*/
|
|
4218
|
+
const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsSummary) => any;
|
|
4219
|
+
}
|
|
4220
|
+
export interface SearchPlaceIndexForSuggestionsResponse {
|
|
4221
|
+
/**
|
|
4222
|
+
* <p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,
|
|
4223
|
+
* <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,
|
|
4224
|
+
* and <code>Text</code>. Also includes the <code>DataSource</code> of the place index.
|
|
4225
|
+
* </p>
|
|
4226
|
+
*/
|
|
4227
|
+
Summary: SearchPlaceIndexForSuggestionsSummary | undefined;
|
|
4228
|
+
/**
|
|
4229
|
+
* <p>A list of place suggestions that best match the search text.</p>
|
|
4230
|
+
*/
|
|
4231
|
+
Results: SearchForSuggestionsResult[] | undefined;
|
|
4232
|
+
}
|
|
4233
|
+
export declare namespace SearchPlaceIndexForSuggestionsResponse {
|
|
4234
|
+
/**
|
|
4235
|
+
* @internal
|
|
4236
|
+
*/
|
|
4237
|
+
const filterSensitiveLog: (obj: SearchPlaceIndexForSuggestionsResponse) => any;
|
|
4238
|
+
}
|
|
3999
4239
|
export interface SearchPlaceIndexForTextRequest {
|
|
4000
4240
|
/**
|
|
4001
4241
|
* <p>The name of the place index resource you want to use for the search.</p>
|
|
@@ -4114,6 +4354,10 @@ export interface SearchPlaceIndexForTextSummary {
|
|
|
4114
4354
|
Text: string | undefined;
|
|
4115
4355
|
/**
|
|
4116
4356
|
* <p>Contains the coordinates for the optional bias position specified in the request.</p>
|
|
4357
|
+
* <p>This parameter contains a pair of numbers. The first number represents the X
|
|
4358
|
+
* coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
|
|
4359
|
+
* <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with
|
|
4360
|
+
* longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>
|
|
4117
4361
|
*/
|
|
4118
4362
|
BiasPosition?: number[];
|
|
4119
4363
|
/**
|
|
@@ -4334,8 +4578,19 @@ export interface UpdateTrackerRequest {
|
|
|
4334
4578
|
* <p>
|
|
4335
4579
|
* <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are
|
|
4336
4580
|
* ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.
|
|
4337
|
-
* This helps control costs by reducing the number of geofence evaluations and device positions to
|
|
4338
|
-
* Distance-based filtering can also reduce the
|
|
4581
|
+
* This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.
|
|
4582
|
+
* Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
|
|
4583
|
+
* </p>
|
|
4584
|
+
* </li>
|
|
4585
|
+
* <li>
|
|
4586
|
+
* <p>
|
|
4587
|
+
* <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,
|
|
4588
|
+
* location updates are ignored. For example, if two consecutive updates from a device
|
|
4589
|
+
* have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device
|
|
4590
|
+
* has moved less than 15 m. Ignored location updates are neither evaluated against
|
|
4591
|
+
* linked geofence collections, nor stored. This helps educe the effects of GPS noise
|
|
4592
|
+
* when displaying device trajectories on a map, and can help control costs by reducing the
|
|
4593
|
+
* number of geofence evaluations.
|
|
4339
4594
|
* </p>
|
|
4340
4595
|
* </li>
|
|
4341
4596
|
* </ul>
|
|
@@ -42,6 +42,7 @@ import { ListTrackerConsumersCommandInput, ListTrackerConsumersCommandOutput } f
|
|
|
42
42
|
import { ListTrackersCommandInput, ListTrackersCommandOutput } from "../commands/ListTrackersCommand";
|
|
43
43
|
import { PutGeofenceCommandInput, PutGeofenceCommandOutput } from "../commands/PutGeofenceCommand";
|
|
44
44
|
import { SearchPlaceIndexForPositionCommandInput, SearchPlaceIndexForPositionCommandOutput } from "../commands/SearchPlaceIndexForPositionCommand";
|
|
45
|
+
import { SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput } from "../commands/SearchPlaceIndexForSuggestionsCommand";
|
|
45
46
|
import { SearchPlaceIndexForTextCommandInput, SearchPlaceIndexForTextCommandOutput } from "../commands/SearchPlaceIndexForTextCommand";
|
|
46
47
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
47
48
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
@@ -92,6 +93,7 @@ export declare const serializeAws_restJson1ListTrackerConsumersCommand: (input:
|
|
|
92
93
|
export declare const serializeAws_restJson1ListTrackersCommand: (input: ListTrackersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
93
94
|
export declare const serializeAws_restJson1PutGeofenceCommand: (input: PutGeofenceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
94
95
|
export declare const serializeAws_restJson1SearchPlaceIndexForPositionCommand: (input: SearchPlaceIndexForPositionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
96
|
+
export declare const serializeAws_restJson1SearchPlaceIndexForSuggestionsCommand: (input: SearchPlaceIndexForSuggestionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
95
97
|
export declare const serializeAws_restJson1SearchPlaceIndexForTextCommand: (input: SearchPlaceIndexForTextCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
96
98
|
export declare const serializeAws_restJson1TagResourceCommand: (input: TagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
97
99
|
export declare const serializeAws_restJson1UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
@@ -142,6 +144,7 @@ export declare const deserializeAws_restJson1ListTrackerConsumersCommand: (outpu
|
|
|
142
144
|
export declare const deserializeAws_restJson1ListTrackersCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTrackersCommandOutput>;
|
|
143
145
|
export declare const deserializeAws_restJson1PutGeofenceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutGeofenceCommandOutput>;
|
|
144
146
|
export declare const deserializeAws_restJson1SearchPlaceIndexForPositionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchPlaceIndexForPositionCommandOutput>;
|
|
147
|
+
export declare const deserializeAws_restJson1SearchPlaceIndexForSuggestionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
145
148
|
export declare const deserializeAws_restJson1SearchPlaceIndexForTextCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchPlaceIndexForTextCommandOutput>;
|
|
146
149
|
export declare const deserializeAws_restJson1TagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TagResourceCommandOutput>;
|
|
147
150
|
export declare const deserializeAws_restJson1UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|
|
@@ -41,6 +41,7 @@ import { ListTrackerConsumersCommandInput, ListTrackerConsumersCommandOutput } f
|
|
|
41
41
|
import { ListTrackersCommandInput, ListTrackersCommandOutput } from "./commands/ListTrackersCommand";
|
|
42
42
|
import { PutGeofenceCommandInput, PutGeofenceCommandOutput } from "./commands/PutGeofenceCommand";
|
|
43
43
|
import { SearchPlaceIndexForPositionCommandInput, SearchPlaceIndexForPositionCommandOutput } from "./commands/SearchPlaceIndexForPositionCommand";
|
|
44
|
+
import { SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput } from "./commands/SearchPlaceIndexForSuggestionsCommand";
|
|
44
45
|
import { SearchPlaceIndexForTextCommandInput, SearchPlaceIndexForTextCommandOutput } from "./commands/SearchPlaceIndexForTextCommand";
|
|
45
46
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
46
47
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
@@ -221,6 +222,10 @@ export declare class Location extends LocationClient {
|
|
|
221
222
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
222
223
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
223
224
|
|
|
225
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
226
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
227
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
228
|
+
|
|
224
229
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForTextCommandOutput>;
|
|
225
230
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
226
231
|
searchPlaceIndexForText(args: SearchPlaceIndexForTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForTextCommandOutput) => void): void;
|
|
@@ -48,6 +48,7 @@ import { ListTrackerConsumersCommandInput, ListTrackerConsumersCommandOutput } f
|
|
|
48
48
|
import { ListTrackersCommandInput, ListTrackersCommandOutput } from "./commands/ListTrackersCommand";
|
|
49
49
|
import { PutGeofenceCommandInput, PutGeofenceCommandOutput } from "./commands/PutGeofenceCommand";
|
|
50
50
|
import { SearchPlaceIndexForPositionCommandInput, SearchPlaceIndexForPositionCommandOutput } from "./commands/SearchPlaceIndexForPositionCommand";
|
|
51
|
+
import { SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput } from "./commands/SearchPlaceIndexForSuggestionsCommand";
|
|
51
52
|
import { SearchPlaceIndexForTextCommandInput, SearchPlaceIndexForTextCommandOutput } from "./commands/SearchPlaceIndexForTextCommand";
|
|
52
53
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
53
54
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
@@ -56,8 +57,8 @@ import { UpdateMapCommandInput, UpdateMapCommandOutput } from "./commands/Update
|
|
|
56
57
|
import { UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput } from "./commands/UpdatePlaceIndexCommand";
|
|
57
58
|
import { UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput } from "./commands/UpdateRouteCalculatorCommand";
|
|
58
59
|
import { UpdateTrackerCommandInput, UpdateTrackerCommandOutput } from "./commands/UpdateTrackerCommand";
|
|
59
|
-
export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
|
|
60
|
-
export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
|
|
60
|
+
export declare type ServiceInputTypes = AssociateTrackerConsumerCommandInput | BatchDeleteDevicePositionHistoryCommandInput | BatchDeleteGeofenceCommandInput | BatchEvaluateGeofencesCommandInput | BatchGetDevicePositionCommandInput | BatchPutGeofenceCommandInput | BatchUpdateDevicePositionCommandInput | CalculateRouteCommandInput | CreateGeofenceCollectionCommandInput | CreateMapCommandInput | CreatePlaceIndexCommandInput | CreateRouteCalculatorCommandInput | CreateTrackerCommandInput | DeleteGeofenceCollectionCommandInput | DeleteMapCommandInput | DeletePlaceIndexCommandInput | DeleteRouteCalculatorCommandInput | DeleteTrackerCommandInput | DescribeGeofenceCollectionCommandInput | DescribeMapCommandInput | DescribePlaceIndexCommandInput | DescribeRouteCalculatorCommandInput | DescribeTrackerCommandInput | DisassociateTrackerConsumerCommandInput | GetDevicePositionCommandInput | GetDevicePositionHistoryCommandInput | GetGeofenceCommandInput | GetMapGlyphsCommandInput | GetMapSpritesCommandInput | GetMapStyleDescriptorCommandInput | GetMapTileCommandInput | ListDevicePositionsCommandInput | ListGeofenceCollectionsCommandInput | ListGeofencesCommandInput | ListMapsCommandInput | ListPlaceIndexesCommandInput | ListRouteCalculatorsCommandInput | ListTagsForResourceCommandInput | ListTrackerConsumersCommandInput | ListTrackersCommandInput | PutGeofenceCommandInput | SearchPlaceIndexForPositionCommandInput | SearchPlaceIndexForSuggestionsCommandInput | SearchPlaceIndexForTextCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateGeofenceCollectionCommandInput | UpdateMapCommandInput | UpdatePlaceIndexCommandInput | UpdateRouteCalculatorCommandInput | UpdateTrackerCommandInput;
|
|
61
|
+
export declare type ServiceOutputTypes = AssociateTrackerConsumerCommandOutput | BatchDeleteDevicePositionHistoryCommandOutput | BatchDeleteGeofenceCommandOutput | BatchEvaluateGeofencesCommandOutput | BatchGetDevicePositionCommandOutput | BatchPutGeofenceCommandOutput | BatchUpdateDevicePositionCommandOutput | CalculateRouteCommandOutput | CreateGeofenceCollectionCommandOutput | CreateMapCommandOutput | CreatePlaceIndexCommandOutput | CreateRouteCalculatorCommandOutput | CreateTrackerCommandOutput | DeleteGeofenceCollectionCommandOutput | DeleteMapCommandOutput | DeletePlaceIndexCommandOutput | DeleteRouteCalculatorCommandOutput | DeleteTrackerCommandOutput | DescribeGeofenceCollectionCommandOutput | DescribeMapCommandOutput | DescribePlaceIndexCommandOutput | DescribeRouteCalculatorCommandOutput | DescribeTrackerCommandOutput | DisassociateTrackerConsumerCommandOutput | GetDevicePositionCommandOutput | GetDevicePositionHistoryCommandOutput | GetGeofenceCommandOutput | GetMapGlyphsCommandOutput | GetMapSpritesCommandOutput | GetMapStyleDescriptorCommandOutput | GetMapTileCommandOutput | ListDevicePositionsCommandOutput | ListGeofenceCollectionsCommandOutput | ListGeofencesCommandOutput | ListMapsCommandOutput | ListPlaceIndexesCommandOutput | ListRouteCalculatorsCommandOutput | ListTagsForResourceCommandOutput | ListTrackerConsumersCommandOutput | ListTrackersCommandOutput | PutGeofenceCommandOutput | SearchPlaceIndexForPositionCommandOutput | SearchPlaceIndexForSuggestionsCommandOutput | SearchPlaceIndexForTextCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateGeofenceCollectionCommandOutput | UpdateMapCommandOutput | UpdatePlaceIndexCommandOutput | UpdateRouteCalculatorCommandOutput | UpdateTrackerCommandOutput;
|
|
61
62
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
62
63
|
|
|
63
64
|
requestHandler?: __HttpHandler;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
|
|
4
|
+
import { SearchPlaceIndexForSuggestionsRequest, SearchPlaceIndexForSuggestionsResponse } from "../models/models_0";
|
|
5
|
+
export interface SearchPlaceIndexForSuggestionsCommandInput extends SearchPlaceIndexForSuggestionsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface SearchPlaceIndexForSuggestionsCommandOutput extends SearchPlaceIndexForSuggestionsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export declare class SearchPlaceIndexForSuggestionsCommand extends $Command<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput, LocationClientResolvedConfig> {
|
|
11
|
+
readonly input: SearchPlaceIndexForSuggestionsCommandInput;
|
|
12
|
+
constructor(input: SearchPlaceIndexForSuggestionsCommandInput);
|
|
13
|
+
|
|
14
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
15
|
+
private serialize;
|
|
16
|
+
private deserialize;
|
|
17
|
+
}
|
|
@@ -40,6 +40,7 @@ export * from "./ListTrackerConsumersCommand";
|
|
|
40
40
|
export * from "./ListTrackersCommand";
|
|
41
41
|
export * from "./PutGeofenceCommand";
|
|
42
42
|
export * from "./SearchPlaceIndexForPositionCommand";
|
|
43
|
+
export * from "./SearchPlaceIndexForSuggestionsCommand";
|
|
43
44
|
export * from "./SearchPlaceIndexForTextCommand";
|
|
44
45
|
export * from "./TagResourceCommand";
|
|
45
46
|
export * from "./UntagResourceCommand";
|