@aws-sdk/client-location 3.43.0 → 3.47.1
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 +47 -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 -45
- package/dist-cjs/protocols/Aws_restJson1.js +227 -2
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- 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 -32
- package/dist-es/protocols/Aws_restJson1.js +234 -2
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/Location.d.ts +33 -4
- package/dist-types/LocationClient.d.ts +8 -3
- 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 -54
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/Location.d.ts +5 -0
- package/dist-types/ts3.4/LocationClient.d.ts +6 -3
- 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 -33
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +39 -46
package/dist-es/runtimeConfig.js
CHANGED
|
@@ -1,21 +1,28 @@
|
|
|
1
|
-
import { __assign } from "tslib";
|
|
1
|
+
import { __assign, __awaiter, __generator } from "tslib";
|
|
2
2
|
import packageInfo from "../package.json";
|
|
3
3
|
import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
|
|
4
4
|
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@aws-sdk/config-resolver";
|
|
5
5
|
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
|
|
6
6
|
import { Hash } from "@aws-sdk/hash-node";
|
|
7
|
-
import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
|
|
7
|
+
import { DEFAULT_RETRY_MODE, NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS, } from "@aws-sdk/middleware-retry";
|
|
8
8
|
import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
|
|
9
|
-
import { NodeHttpHandler, streamCollector } from "@aws-sdk/node-http-handler";
|
|
9
|
+
import { NodeHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/node-http-handler";
|
|
10
10
|
import { fromBase64, toBase64 } from "@aws-sdk/util-base64-node";
|
|
11
11
|
import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
|
|
12
12
|
import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
|
|
13
13
|
import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
|
|
14
14
|
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
|
|
15
|
-
import {
|
|
15
|
+
import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
|
|
16
|
+
import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-node";
|
|
16
17
|
export var getRuntimeConfig = function (config) {
|
|
17
18
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
|
|
18
|
-
|
|
19
|
+
var defaultsMode = resolveDefaultsModeConfig(config);
|
|
20
|
+
var defaultConfigProvider = function () { return defaultsMode().then(loadConfigsForDefaultMode); };
|
|
19
21
|
var clientSharedValues = getSharedRuntimeConfig(config);
|
|
20
|
-
return __assign(__assign(__assign({}, clientSharedValues), config), { runtime: "node", base64Decoder: (_a = config === null || config === void 0 ? void 0 : config.base64Decoder) !== null && _a !== void 0 ? _a : fromBase64, base64Encoder: (_b = config === null || config === void 0 ? void 0 : config.base64Encoder) !== null && _b !== void 0 ? _b : toBase64, bodyLengthChecker: (_c = config === null || config === void 0 ? void 0 : config.bodyLengthChecker) !== null && _c !== void 0 ? _c : calculateBodyLength, credentialDefaultProvider: (_d = config === null || config === void 0 ? void 0 : config.credentialDefaultProvider) !== null && _d !== void 0 ? _d : decorateDefaultCredentialProvider(credentialDefaultProvider), defaultUserAgentProvider: (_e = config === null || config === void 0 ? void 0 : config.defaultUserAgentProvider) !== null && _e !== void 0 ? _e : defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }), maxAttempts: (_f = config === null || config === void 0 ? void 0 : config.maxAttempts) !== null && _f !== void 0 ? _f : loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS), region: (_g = config === null || config === void 0 ? void 0 : config.region) !== null && _g !== void 0 ? _g : loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS), requestHandler: (_h = config === null || config === void 0 ? void 0 : config.requestHandler) !== null && _h !== void 0 ? _h : new
|
|
22
|
+
return __assign(__assign(__assign({}, clientSharedValues), config), { runtime: "node", defaultsMode: defaultsMode, base64Decoder: (_a = config === null || config === void 0 ? void 0 : config.base64Decoder) !== null && _a !== void 0 ? _a : fromBase64, base64Encoder: (_b = config === null || config === void 0 ? void 0 : config.base64Encoder) !== null && _b !== void 0 ? _b : toBase64, bodyLengthChecker: (_c = config === null || config === void 0 ? void 0 : config.bodyLengthChecker) !== null && _c !== void 0 ? _c : calculateBodyLength, credentialDefaultProvider: (_d = config === null || config === void 0 ? void 0 : config.credentialDefaultProvider) !== null && _d !== void 0 ? _d : decorateDefaultCredentialProvider(credentialDefaultProvider), defaultUserAgentProvider: (_e = config === null || config === void 0 ? void 0 : config.defaultUserAgentProvider) !== null && _e !== void 0 ? _e : defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }), maxAttempts: (_f = config === null || config === void 0 ? void 0 : config.maxAttempts) !== null && _f !== void 0 ? _f : loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS), region: (_g = config === null || config === void 0 ? void 0 : config.region) !== null && _g !== void 0 ? _g : loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS), requestHandler: (_h = config === null || config === void 0 ? void 0 : config.requestHandler) !== null && _h !== void 0 ? _h : new RequestHandler(defaultConfigProvider), retryMode: (_j = config === null || config === void 0 ? void 0 : config.retryMode) !== null && _j !== void 0 ? _j : loadNodeConfig(__assign(__assign({}, NODE_RETRY_MODE_CONFIG_OPTIONS), { default: function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
|
|
23
|
+
switch (_a.label) {
|
|
24
|
+
case 0: return [4, defaultConfigProvider()];
|
|
25
|
+
case 1: return [2, (_a.sent()).retryMode || DEFAULT_RETRY_MODE];
|
|
26
|
+
}
|
|
27
|
+
}); }); } })), sha256: (_k = config === null || config === void 0 ? void 0 : config.sha256) !== null && _k !== void 0 ? _k : Hash.bind(null, "sha256"), streamCollector: (_l = config === null || config === void 0 ? void 0 : config.streamCollector) !== null && _l !== void 0 ? _l : streamCollector, useDualstackEndpoint: (_m = config === null || config === void 0 ? void 0 : config.useDualstackEndpoint) !== null && _m !== void 0 ? _m : loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS), useFipsEndpoint: (_o = config === null || config === void 0 ? void 0 : config.useFipsEndpoint) !== null && _o !== void 0 ? _o : loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS), utf8Decoder: (_p = config === null || config === void 0 ? void 0 : config.utf8Decoder) !== null && _p !== void 0 ? _p : fromUtf8, utf8Encoder: (_q = config === null || config === void 0 ? void 0 : config.utf8Encoder) !== null && _q !== void 0 ? _q : toUtf8 });
|
|
21
28
|
};
|
package/dist-types/Location.d.ts
CHANGED
|
@@ -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";
|
|
@@ -103,6 +104,10 @@ export declare class Location extends LocationClient {
|
|
|
103
104
|
* <p>The last geofence that a device was observed within is tracked for 30 days after
|
|
104
105
|
* the most recent device position update.</p>
|
|
105
106
|
* </note>
|
|
107
|
+
* <note>
|
|
108
|
+
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
109
|
+
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
110
|
+
* </note>
|
|
106
111
|
*/
|
|
107
112
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, options?: __HttpHandlerOptions): Promise<BatchEvaluateGeofencesCommandOutput>;
|
|
108
113
|
batchEvaluateGeofences(args: BatchEvaluateGeofencesCommandInput, cb: (err: any, data?: BatchEvaluateGeofencesCommandOutput) => void): void;
|
|
@@ -128,9 +133,17 @@ export declare class Location extends LocationClient {
|
|
|
128
133
|
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
|
|
129
134
|
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
130
135
|
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
|
|
131
|
-
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID
|
|
132
|
-
*
|
|
133
|
-
*
|
|
136
|
+
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
|
|
137
|
+
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
|
|
138
|
+
* collections only if the device has moved more than 30 m (98.4 ft).</p>
|
|
139
|
+
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,
|
|
140
|
+
* location data is stored and evaluated against linked geofence collections only if the
|
|
141
|
+
* device has moved more than the measured accuracy. For example, if two consecutive
|
|
142
|
+
* updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
|
|
143
|
+
* is neither stored or evaluated if the device has moved less than 15 m. If
|
|
144
|
+
* <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location
|
|
145
|
+
* uses the default value <code>{ "Horizontal": 0}</code> when accuracy is not provided on
|
|
146
|
+
* a <code>DevicePositionUpdate</code>.</p>
|
|
134
147
|
* </note>
|
|
135
148
|
*/
|
|
136
149
|
batchUpdateDevicePosition(args: BatchUpdateDevicePositionCommandInput, options?: __HttpHandlerOptions): Promise<BatchUpdateDevicePositionCommandOutput>;
|
|
@@ -187,7 +200,8 @@ export declare class Location extends LocationClient {
|
|
|
187
200
|
/**
|
|
188
201
|
* <p>Creates a place index resource in your AWS account. Use a place index resource to
|
|
189
202
|
* geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
|
|
190
|
-
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation
|
|
203
|
+
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
|
|
204
|
+
* enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
191
205
|
*/
|
|
192
206
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlaceIndexCommandOutput>;
|
|
193
207
|
createPlaceIndex(args: CreatePlaceIndexCommandInput, cb: (err: any, data?: CreatePlaceIndexCommandOutput) => void): void;
|
|
@@ -424,6 +438,21 @@ export declare class Location extends LocationClient {
|
|
|
424
438
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForPositionCommandOutput>;
|
|
425
439
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
426
440
|
searchPlaceIndexForPosition(args: SearchPlaceIndexForPositionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForPositionCommandOutput) => void): void;
|
|
441
|
+
/**
|
|
442
|
+
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
443
|
+
* misspelled free-form text. This operation is also known as autocomplete, autosuggest,
|
|
444
|
+
* or fuzzy matching.</p>
|
|
445
|
+
* <p>Optional parameters let you narrow your search results by bounding box or
|
|
446
|
+
* country, or bias your search toward a specific position on the globe.</p>
|
|
447
|
+
* <note>
|
|
448
|
+
* <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or
|
|
449
|
+
* filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive;
|
|
450
|
+
* using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p>
|
|
451
|
+
* </note>
|
|
452
|
+
*/
|
|
453
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
454
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
455
|
+
searchPlaceIndexForSuggestions(args: SearchPlaceIndexForSuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchPlaceIndexForSuggestionsCommandOutput) => void): void;
|
|
427
456
|
/**
|
|
428
457
|
* <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
|
|
429
458
|
* search for Places or points of interest. </p>
|
|
@@ -4,7 +4,7 @@ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry
|
|
|
4
4
|
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
|
-
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
7
|
+
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { AssociateTrackerConsumerCommandInput, AssociateTrackerConsumerCommandOutput } from "./commands/AssociateTrackerConsumerCommand";
|
|
10
10
|
import { BatchDeleteDevicePositionHistoryCommandInput, BatchDeleteDevicePositionHistoryCommandOutput } from "./commands/BatchDeleteDevicePositionHistoryCommand";
|
|
@@ -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
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -158,6 +159,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
158
159
|
* @internal
|
|
159
160
|
*/
|
|
160
161
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
162
|
+
/**
|
|
163
|
+
* The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
164
|
+
*/
|
|
165
|
+
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
161
166
|
}
|
|
162
167
|
declare type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
163
168
|
/**
|
|
@@ -28,6 +28,10 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen
|
|
|
28
28
|
* <p>The last geofence that a device was observed within is tracked for 30 days after
|
|
29
29
|
* the most recent device position update.</p>
|
|
30
30
|
* </note>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Geofence evaluation uses the given device position. It does not account for the
|
|
33
|
+
* optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>
|
|
34
|
+
* </note>
|
|
31
35
|
* @example
|
|
32
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
37
|
* ```javascript
|
|
@@ -14,9 +14,17 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
|
|
|
14
14
|
* <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker.
|
|
15
15
|
* When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections,
|
|
16
16
|
* and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than
|
|
17
|
-
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
|
|
18
|
+
* <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence
|
|
19
|
+
* collections only if the device has moved more than 30 m (98.4 ft).</p>
|
|
20
|
+
* <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,
|
|
21
|
+
* location data is stored and evaluated against linked geofence collections only if the
|
|
22
|
+
* device has moved more than the measured accuracy. For example, if two consecutive
|
|
23
|
+
* updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
|
|
24
|
+
* is neither stored or evaluated if the device has moved less than 15 m. If
|
|
25
|
+
* <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location
|
|
26
|
+
* uses the default value <code>{ "Horizontal": 0}</code> when accuracy is not provided on
|
|
27
|
+
* a <code>DevicePositionUpdate</code>.</p>
|
|
20
28
|
* </note>
|
|
21
29
|
* @example
|
|
22
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,8 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a place index resource in your AWS account. Use a place index resource to
|
|
11
11
|
* geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
|
|
12
|
-
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation
|
|
12
|
+
* and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
|
|
13
|
+
* enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
16
|
* ```javascript
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
* <p>Generates suggestions for addresses and points of interest based on partial or
|
|
11
|
+
* misspelled free-form text. This operation is also known as autocomplete, autosuggest,
|
|
12
|
+
* or fuzzy matching.</p>
|
|
13
|
+
* <p>Optional parameters let you narrow your search results by bounding box or
|
|
14
|
+
* country, or bias your search toward a specific position on the globe.</p>
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or
|
|
17
|
+
* filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive;
|
|
18
|
+
* using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p>
|
|
19
|
+
* </note>
|
|
20
|
+
* @example
|
|
21
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
22
|
+
* ```javascript
|
|
23
|
+
* import { LocationClient, SearchPlaceIndexForSuggestionsCommand } from "@aws-sdk/client-location"; // ES Modules import
|
|
24
|
+
* // const { LocationClient, SearchPlaceIndexForSuggestionsCommand } = require("@aws-sdk/client-location"); // CommonJS import
|
|
25
|
+
* const client = new LocationClient(config);
|
|
26
|
+
* const command = new SearchPlaceIndexForSuggestionsCommand(input);
|
|
27
|
+
* const response = await client.send(command);
|
|
28
|
+
* ```
|
|
29
|
+
*
|
|
30
|
+
* @see {@link SearchPlaceIndexForSuggestionsCommandInput} for command's `input` shape.
|
|
31
|
+
* @see {@link SearchPlaceIndexForSuggestionsCommandOutput} for command's `response` shape.
|
|
32
|
+
* @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
export declare class SearchPlaceIndexForSuggestionsCommand extends $Command<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput, LocationClientResolvedConfig> {
|
|
36
|
+
readonly input: SearchPlaceIndexForSuggestionsCommandInput;
|
|
37
|
+
constructor(input: SearchPlaceIndexForSuggestionsCommandInput);
|
|
38
|
+
/**
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput>;
|
|
42
|
+
private serialize;
|
|
43
|
+
private deserialize;
|
|
44
|
+
}
|
|
@@ -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";
|