@aws-sdk/client-location 3.40.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.
Files changed (76) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/dist-cjs/Location.js +15 -0
  3. package/dist-cjs/commands/SearchPlaceIndexForSuggestionsCommand.js +36 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoints.js +9 -0
  6. package/dist-cjs/models/models_0.js +50 -3
  7. package/dist-cjs/protocols/Aws_restJson1.js +244 -2
  8. package/dist-es/Location.js +15 -0
  9. package/dist-es/commands/SearchPlaceIndexForSuggestionsCommand.js +39 -0
  10. package/dist-es/commands/index.js +1 -0
  11. package/dist-es/endpoints.js +9 -0
  12. package/dist-es/models/models_0.js +28 -4
  13. package/dist-es/protocols/Aws_restJson1.js +253 -6
  14. package/dist-types/Location.d.ts +40 -10
  15. package/dist-types/LocationClient.d.ts +3 -2
  16. package/dist-types/commands/AssociateTrackerConsumerCommand.d.ts +1 -1
  17. package/dist-types/commands/BatchDeleteDevicePositionHistoryCommand.d.ts +1 -1
  18. package/dist-types/commands/BatchDeleteGeofenceCommand.d.ts +1 -1
  19. package/dist-types/commands/BatchEvaluateGeofencesCommand.d.ts +5 -1
  20. package/dist-types/commands/BatchGetDevicePositionCommand.d.ts +1 -1
  21. package/dist-types/commands/BatchPutGeofenceCommand.d.ts +1 -1
  22. package/dist-types/commands/BatchUpdateDevicePositionCommand.d.ts +12 -4
  23. package/dist-types/commands/CalculateRouteCommand.d.ts +3 -4
  24. package/dist-types/commands/CreateGeofenceCollectionCommand.d.ts +1 -1
  25. package/dist-types/commands/CreateMapCommand.d.ts +1 -1
  26. package/dist-types/commands/CreatePlaceIndexCommand.d.ts +5 -3
  27. package/dist-types/commands/CreateRouteCalculatorCommand.d.ts +1 -1
  28. package/dist-types/commands/CreateTrackerCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteGeofenceCollectionCommand.d.ts +1 -1
  30. package/dist-types/commands/DeleteMapCommand.d.ts +1 -1
  31. package/dist-types/commands/DeletePlaceIndexCommand.d.ts +1 -1
  32. package/dist-types/commands/DeleteRouteCalculatorCommand.d.ts +1 -1
  33. package/dist-types/commands/DeleteTrackerCommand.d.ts +1 -1
  34. package/dist-types/commands/DescribeGeofenceCollectionCommand.d.ts +1 -1
  35. package/dist-types/commands/DescribeMapCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribePlaceIndexCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeRouteCalculatorCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeTrackerCommand.d.ts +1 -1
  39. package/dist-types/commands/DisassociateTrackerConsumerCommand.d.ts +1 -1
  40. package/dist-types/commands/GetDevicePositionCommand.d.ts +1 -1
  41. package/dist-types/commands/GetDevicePositionHistoryCommand.d.ts +1 -1
  42. package/dist-types/commands/GetGeofenceCommand.d.ts +1 -1
  43. package/dist-types/commands/GetMapGlyphsCommand.d.ts +1 -1
  44. package/dist-types/commands/GetMapSpritesCommand.d.ts +1 -1
  45. package/dist-types/commands/GetMapStyleDescriptorCommand.d.ts +1 -1
  46. package/dist-types/commands/GetMapTileCommand.d.ts +1 -1
  47. package/dist-types/commands/ListDevicePositionsCommand.d.ts +1 -1
  48. package/dist-types/commands/ListGeofenceCollectionsCommand.d.ts +1 -1
  49. package/dist-types/commands/ListGeofencesCommand.d.ts +1 -1
  50. package/dist-types/commands/ListMapsCommand.d.ts +1 -1
  51. package/dist-types/commands/ListPlaceIndexesCommand.d.ts +1 -1
  52. package/dist-types/commands/ListRouteCalculatorsCommand.d.ts +1 -1
  53. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  54. package/dist-types/commands/ListTrackerConsumersCommand.d.ts +1 -1
  55. package/dist-types/commands/ListTrackersCommand.d.ts +1 -1
  56. package/dist-types/commands/PutGeofenceCommand.d.ts +1 -1
  57. package/dist-types/commands/SearchPlaceIndexForPositionCommand.d.ts +1 -1
  58. package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +44 -0
  59. package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts +4 -3
  60. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  61. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  62. package/dist-types/commands/UpdateGeofenceCollectionCommand.d.ts +1 -1
  63. package/dist-types/commands/UpdateMapCommand.d.ts +1 -1
  64. package/dist-types/commands/UpdatePlaceIndexCommand.d.ts +1 -1
  65. package/dist-types/commands/UpdateRouteCalculatorCommand.d.ts +1 -1
  66. package/dist-types/commands/UpdateTrackerCommand.d.ts +1 -1
  67. package/dist-types/commands/index.d.ts +1 -0
  68. package/dist-types/models/models_0.d.ts +488 -117
  69. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  70. package/dist-types/ts3.4/Location.d.ts +5 -0
  71. package/dist-types/ts3.4/LocationClient.d.ts +3 -2
  72. package/dist-types/ts3.4/commands/SearchPlaceIndexForSuggestionsCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  74. package/dist-types/ts3.4/models/models_0.d.ts +128 -6
  75. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
  76. package/package.json +6 -6
@@ -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
- * 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>
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.
@@ -30,7 +38,7 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic
30
38
  *
31
39
  * @see {@link BatchUpdateDevicePositionCommandInput} for command's `input` shape.
32
40
  * @see {@link BatchUpdateDevicePositionCommandOutput} for command's `response` shape.
33
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
41
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
34
42
  *
35
43
  */
36
44
  export declare class BatchUpdateDevicePositionCommand extends $Command<BatchUpdateDevicePositionCommandInput, BatchUpdateDevicePositionCommandOutput, LocationClientResolvedConfig> {
@@ -11,8 +11,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
11
11
  * <a href="https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html">Calculates a route</a> given the following required parameters:
12
12
  * <code>DeparturePostiton</code> and <code>DestinationPosition</code>. Requires that
13
13
  * you first <a href="https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html">create a
14
- * route calculator resource</a>
15
- * </p>
14
+ * route calculator resource</a>.</p>
16
15
  * <p>By default, a request that doesn't specify a departure time uses the best time of day
17
16
  * to travel with the best traffic conditions when calculating the route.</p>
18
17
  * <p>Additional options include:</p>
@@ -25,7 +24,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
25
24
  * <note>
26
25
  * <p>You can't specify both <code>DepartureTime</code> and
27
26
  * <code>DepartureNow</code> in a single request. Specifying both
28
- * parameters returns an error message.</p>
27
+ * parameters returns a validation error.</p>
29
28
  * </note>
30
29
  * </li>
31
30
  * <li>
@@ -50,7 +49,7 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M
50
49
  *
51
50
  * @see {@link CalculateRouteCommandInput} for command's `input` shape.
52
51
  * @see {@link CalculateRouteCommandOutput} for command's `response` shape.
53
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
52
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
54
53
  *
55
54
  */
56
55
  export declare class CalculateRouteCommand extends $Command<CalculateRouteCommandInput, CalculateRouteCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface CreateGeofenceCollectionCommandOutput extends CreateGeofenceCol
20
20
  *
21
21
  * @see {@link CreateGeofenceCollectionCommandInput} for command's `input` shape.
22
22
  * @see {@link CreateGeofenceCollectionCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class CreateGeofenceCollectionCommand extends $Command<CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput, LocationClientResolvedConfig> {
@@ -21,7 +21,7 @@ export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBea
21
21
  *
22
22
  * @see {@link CreateMapCommandInput} for command's `input` shape.
23
23
  * @see {@link CreateMapCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
25
25
  *
26
26
  */
27
27
  export declare class CreateMapCommand extends $Command<CreateMapCommandInput, CreateMapCommandOutput, LocationClientResolvedConfig> {
@@ -7,8 +7,10 @@ export interface CreatePlaceIndexCommandInput extends CreatePlaceIndexRequest {
7
7
  export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a place index resource in your AWS account, which supports functions with
11
- * geospatial data sourced from your chosen data provider.</p>
10
+ * <p>Creates a place index resource in your AWS account. Use a place index resource to
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, and
13
+ * enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
12
14
  * @example
13
15
  * Use a bare-bones client and the command you need to make an API call.
14
16
  * ```javascript
@@ -21,7 +23,7 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse,
21
23
  *
22
24
  * @see {@link CreatePlaceIndexCommandInput} for command's `input` shape.
23
25
  * @see {@link CreatePlaceIndexCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
25
27
  *
26
28
  */
27
29
  export declare class CreatePlaceIndexCommand extends $Command<CreatePlaceIndexCommandInput, CreatePlaceIndexCommandOutput, LocationClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface CreateRouteCalculatorCommandOutput extends CreateRouteCalculato
23
23
  *
24
24
  * @see {@link CreateRouteCalculatorCommandInput} for command's `input` shape.
25
25
  * @see {@link CreateRouteCalculatorCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class CreateRouteCalculatorCommand extends $Command<CreateRouteCalculatorCommandInput, CreateRouteCalculatorCommandOutput, LocationClientResolvedConfig> {
@@ -21,7 +21,7 @@ export interface CreateTrackerCommandOutput extends CreateTrackerResponse, __Met
21
21
  *
22
22
  * @see {@link CreateTrackerCommandInput} for command's `input` shape.
23
23
  * @see {@link CreateTrackerCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
25
25
  *
26
26
  */
27
27
  export declare class CreateTrackerCommand extends $Command<CreateTrackerCommandInput, CreateTrackerCommandOutput, LocationClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface DeleteGeofenceCollectionCommandOutput extends DeleteGeofenceCol
24
24
  *
25
25
  * @see {@link DeleteGeofenceCollectionCommandInput} for command's `input` shape.
26
26
  * @see {@link DeleteGeofenceCollectionCommandOutput} for command's `response` shape.
27
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class DeleteGeofenceCollectionCommand extends $Command<DeleteGeofenceCollectionCommandInput, DeleteGeofenceCollectionCommandOutput, LocationClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface DeleteMapCommandOutput extends DeleteMapResponse, __MetadataBea
24
24
  *
25
25
  * @see {@link DeleteMapCommandInput} for command's `input` shape.
26
26
  * @see {@link DeleteMapCommandOutput} for command's `response` shape.
27
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class DeleteMapCommand extends $Command<DeleteMapCommandInput, DeleteMapCommandOutput, LocationClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface DeletePlaceIndexCommandOutput extends DeletePlaceIndexResponse,
23
23
  *
24
24
  * @see {@link DeletePlaceIndexCommandInput} for command's `input` shape.
25
25
  * @see {@link DeletePlaceIndexCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class DeletePlaceIndexCommand extends $Command<DeletePlaceIndexCommandInput, DeletePlaceIndexCommandOutput, LocationClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface DeleteRouteCalculatorCommandOutput extends DeleteRouteCalculato
23
23
  *
24
24
  * @see {@link DeleteRouteCalculatorCommandInput} for command's `input` shape.
25
25
  * @see {@link DeleteRouteCalculatorCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class DeleteRouteCalculatorCommand extends $Command<DeleteRouteCalculatorCommandInput, DeleteRouteCalculatorCommandOutput, LocationClientResolvedConfig> {
@@ -25,7 +25,7 @@ export interface DeleteTrackerCommandOutput extends DeleteTrackerResponse, __Met
25
25
  *
26
26
  * @see {@link DeleteTrackerCommandInput} for command's `input` shape.
27
27
  * @see {@link DeleteTrackerCommandOutput} for command's `response` shape.
28
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
28
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
29
29
  *
30
30
  */
31
31
  export declare class DeleteTrackerCommand extends $Command<DeleteTrackerCommandInput, DeleteTrackerCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DescribeGeofenceCollectionCommandOutput extends DescribeGeofenc
20
20
  *
21
21
  * @see {@link DescribeGeofenceCollectionCommandInput} for command's `input` shape.
22
22
  * @see {@link DescribeGeofenceCollectionCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DescribeGeofenceCollectionCommand extends $Command<DescribeGeofenceCollectionCommandInput, DescribeGeofenceCollectionCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DescribeMapCommandOutput extends DescribeMapResponse, __Metadat
20
20
  *
21
21
  * @see {@link DescribeMapCommandInput} for command's `input` shape.
22
22
  * @see {@link DescribeMapCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DescribeMapCommand extends $Command<DescribeMapCommandInput, DescribeMapCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DescribePlaceIndexCommandOutput extends DescribePlaceIndexRespo
20
20
  *
21
21
  * @see {@link DescribePlaceIndexCommandInput} for command's `input` shape.
22
22
  * @see {@link DescribePlaceIndexCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DescribePlaceIndexCommand extends $Command<DescribePlaceIndexCommandInput, DescribePlaceIndexCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DescribeRouteCalculatorCommandOutput extends DescribeRouteCalcu
20
20
  *
21
21
  * @see {@link DescribeRouteCalculatorCommandInput} for command's `input` shape.
22
22
  * @see {@link DescribeRouteCalculatorCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DescribeRouteCalculatorCommand extends $Command<DescribeRouteCalculatorCommandInput, DescribeRouteCalculatorCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DescribeTrackerCommandOutput extends DescribeTrackerResponse, _
20
20
  *
21
21
  * @see {@link DescribeTrackerCommandInput} for command's `input` shape.
22
22
  * @see {@link DescribeTrackerCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DescribeTrackerCommand extends $Command<DescribeTrackerCommandInput, DescribeTrackerCommandOutput, LocationClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface DisassociateTrackerConsumerCommandOutput extends DisassociateTr
24
24
  *
25
25
  * @see {@link DisassociateTrackerConsumerCommandInput} for command's `input` shape.
26
26
  * @see {@link DisassociateTrackerConsumerCommandOutput} for command's `response` shape.
27
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class DisassociateTrackerConsumerCommand extends $Command<DisassociateTrackerConsumerCommandInput, DisassociateTrackerConsumerCommandOutput, LocationClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface GetDevicePositionCommandOutput extends GetDevicePositionRespons
23
23
  *
24
24
  * @see {@link GetDevicePositionCommandInput} for command's `input` shape.
25
25
  * @see {@link GetDevicePositionCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class GetDevicePositionCommand extends $Command<GetDevicePositionCommandInput, GetDevicePositionCommandOutput, LocationClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface GetDevicePositionHistoryCommandOutput extends GetDevicePosition
24
24
  *
25
25
  * @see {@link GetDevicePositionHistoryCommandInput} for command's `input` shape.
26
26
  * @see {@link GetDevicePositionHistoryCommandOutput} for command's `response` shape.
27
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class GetDevicePositionHistoryCommand extends $Command<GetDevicePositionHistoryCommandInput, GetDevicePositionHistoryCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface GetGeofenceCommandOutput extends GetGeofenceResponse, __Metadat
20
20
  *
21
21
  * @see {@link GetGeofenceCommandInput} for command's `input` shape.
22
22
  * @see {@link GetGeofenceCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class GetGeofenceCommand extends $Command<GetGeofenceCommandInput, GetGeofenceCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface GetMapGlyphsCommandOutput extends GetMapGlyphsResponse, __Metad
20
20
  *
21
21
  * @see {@link GetMapGlyphsCommandInput} for command's `input` shape.
22
22
  * @see {@link GetMapGlyphsCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class GetMapGlyphsCommand extends $Command<GetMapGlyphsCommandInput, GetMapGlyphsCommandOutput, LocationClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface GetMapSpritesCommandOutput extends GetMapSpritesResponse, __Met
22
22
  *
23
23
  * @see {@link GetMapSpritesCommandInput} for command's `input` shape.
24
24
  * @see {@link GetMapSpritesCommandOutput} for command's `response` shape.
25
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class GetMapSpritesCommand extends $Command<GetMapSpritesCommandInput, GetMapSpritesCommandOutput, LocationClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface GetMapStyleDescriptorCommandOutput extends GetMapStyleDescripto
23
23
  *
24
24
  * @see {@link GetMapStyleDescriptorCommandInput} for command's `input` shape.
25
25
  * @see {@link GetMapStyleDescriptorCommandOutput} for command's `response` shape.
26
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class GetMapStyleDescriptorCommand extends $Command<GetMapStyleDescriptorCommandInput, GetMapStyleDescriptorCommandOutput, LocationClientResolvedConfig> {
@@ -25,7 +25,7 @@ export interface GetMapTileCommandOutput extends GetMapTileResponse, __MetadataB
25
25
  *
26
26
  * @see {@link GetMapTileCommandInput} for command's `input` shape.
27
27
  * @see {@link GetMapTileCommandOutput} for command's `response` shape.
28
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
28
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
29
29
  *
30
30
  */
31
31
  export declare class GetMapTileCommand extends $Command<GetMapTileCommandInput, GetMapTileCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListDevicePositionsCommandOutput extends ListDevicePositionsRes
20
20
  *
21
21
  * @see {@link ListDevicePositionsCommandInput} for command's `input` shape.
22
22
  * @see {@link ListDevicePositionsCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListDevicePositionsCommand extends $Command<ListDevicePositionsCommandInput, ListDevicePositionsCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListGeofenceCollectionsCommandOutput extends ListGeofenceCollec
20
20
  *
21
21
  * @see {@link ListGeofenceCollectionsCommandInput} for command's `input` shape.
22
22
  * @see {@link ListGeofenceCollectionsCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListGeofenceCollectionsCommand extends $Command<ListGeofenceCollectionsCommandInput, ListGeofenceCollectionsCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListGeofencesCommandOutput extends ListGeofencesResponse, __Met
20
20
  *
21
21
  * @see {@link ListGeofencesCommandInput} for command's `input` shape.
22
22
  * @see {@link ListGeofencesCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListGeofencesCommand extends $Command<ListGeofencesCommandInput, ListGeofencesCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListMapsCommandOutput extends ListMapsResponse, __MetadataBeare
20
20
  *
21
21
  * @see {@link ListMapsCommandInput} for command's `input` shape.
22
22
  * @see {@link ListMapsCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListMapsCommand extends $Command<ListMapsCommandInput, ListMapsCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListPlaceIndexesCommandOutput extends ListPlaceIndexesResponse,
20
20
  *
21
21
  * @see {@link ListPlaceIndexesCommandInput} for command's `input` shape.
22
22
  * @see {@link ListPlaceIndexesCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListPlaceIndexesCommand extends $Command<ListPlaceIndexesCommandInput, ListPlaceIndexesCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListRouteCalculatorsCommandOutput extends ListRouteCalculatorsR
20
20
  *
21
21
  * @see {@link ListRouteCalculatorsCommandInput} for command's `input` shape.
22
22
  * @see {@link ListRouteCalculatorsCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListRouteCalculatorsCommand extends $Command<ListRouteCalculatorsCommandInput, ListRouteCalculatorsCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
20
20
  *
21
21
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
22
22
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListTrackerConsumersCommandOutput extends ListTrackerConsumersR
20
20
  *
21
21
  * @see {@link ListTrackerConsumersCommandInput} for command's `input` shape.
22
22
  * @see {@link ListTrackerConsumersCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListTrackerConsumersCommand extends $Command<ListTrackerConsumersCommandInput, ListTrackerConsumersCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListTrackersCommandOutput extends ListTrackersResponse, __Metad
20
20
  *
21
21
  * @see {@link ListTrackersCommandInput} for command's `input` shape.
22
22
  * @see {@link ListTrackersCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class ListTrackersCommand extends $Command<ListTrackersCommandInput, ListTrackersCommandOutput, LocationClientResolvedConfig> {
@@ -21,7 +21,7 @@ export interface PutGeofenceCommandOutput extends PutGeofenceResponse, __Metadat
21
21
  *
22
22
  * @see {@link PutGeofenceCommandInput} for command's `input` shape.
23
23
  * @see {@link PutGeofenceCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
25
25
  *
26
26
  */
27
27
  export declare class PutGeofenceCommand extends $Command<PutGeofenceCommandInput, PutGeofenceCommandOutput, LocationClientResolvedConfig> {
@@ -21,7 +21,7 @@ export interface SearchPlaceIndexForPositionCommandOutput extends SearchPlaceInd
21
21
  *
22
22
  * @see {@link SearchPlaceIndexForPositionCommandInput} for command's `input` shape.
23
23
  * @see {@link SearchPlaceIndexForPositionCommandOutput} for command's `response` shape.
24
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
25
25
  *
26
26
  */
27
27
  export declare class SearchPlaceIndexForPositionCommand extends $Command<SearchPlaceIndexForPositionCommandInput, SearchPlaceIndexForPositionCommandOutput, LocationClientResolvedConfig> {
@@ -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
+ }
@@ -9,13 +9,14 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
9
9
  /**
10
10
  * <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
11
11
  * search for Places or points of interest. </p>
12
- * <p>Includes the option to apply additional parameters to narrow your list of
13
- * results.</p>
12
+ * <p>Optional parameters let you narrow your search results by bounding box or
13
+ * country, or bias your search toward a specific position on the globe.</p>
14
14
  * <note>
15
15
  * <p>You can search for places near a given position using <code>BiasPosition</code>, or
16
16
  * filter results within a bounding box using <code>FilterBBox</code>. Providing both
17
17
  * parameters simultaneously returns an error.</p>
18
18
  * </note>
19
+ * <p>Search results are returned in order of highest to lowest relevance.</p>
19
20
  * @example
20
21
  * Use a bare-bones client and the command you need to make an API call.
21
22
  * ```javascript
@@ -28,7 +29,7 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
28
29
  *
29
30
  * @see {@link SearchPlaceIndexForTextCommandInput} for command's `input` shape.
30
31
  * @see {@link SearchPlaceIndexForTextCommandOutput} for command's `response` shape.
31
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
32
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
32
33
  *
33
34
  */
34
35
  export declare class SearchPlaceIndexForTextCommand extends $Command<SearchPlaceIndexForTextCommandInput, SearchPlaceIndexForTextCommandOutput, LocationClientResolvedConfig> {
@@ -33,7 +33,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
33
33
  *
34
34
  * @see {@link TagResourceCommandInput} for command's `input` shape.
35
35
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
36
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
36
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
37
37
  *
38
38
  */
39
39
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
20
20
  *
21
21
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
22
22
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UpdateGeofenceCollectionCommandOutput extends UpdateGeofenceCol
20
20
  *
21
21
  * @see {@link UpdateGeofenceCollectionCommandInput} for command's `input` shape.
22
22
  * @see {@link UpdateGeofenceCollectionCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UpdateGeofenceCollectionCommand extends $Command<UpdateGeofenceCollectionCommandInput, UpdateGeofenceCollectionCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UpdateMapCommandOutput extends UpdateMapResponse, __MetadataBea
20
20
  *
21
21
  * @see {@link UpdateMapCommandInput} for command's `input` shape.
22
22
  * @see {@link UpdateMapCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UpdateMapCommand extends $Command<UpdateMapCommandInput, UpdateMapCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UpdatePlaceIndexCommandOutput extends UpdatePlaceIndexResponse,
20
20
  *
21
21
  * @see {@link UpdatePlaceIndexCommandInput} for command's `input` shape.
22
22
  * @see {@link UpdatePlaceIndexCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UpdatePlaceIndexCommand extends $Command<UpdatePlaceIndexCommandInput, UpdatePlaceIndexCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UpdateRouteCalculatorCommandOutput extends UpdateRouteCalculato
20
20
  *
21
21
  * @see {@link UpdateRouteCalculatorCommandInput} for command's `input` shape.
22
22
  * @see {@link UpdateRouteCalculatorCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UpdateRouteCalculatorCommand extends $Command<UpdateRouteCalculatorCommandInput, UpdateRouteCalculatorCommandOutput, LocationClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UpdateTrackerCommandOutput extends UpdateTrackerResponse, __Met
20
20
  *
21
21
  * @see {@link UpdateTrackerCommandInput} for command's `input` shape.
22
22
  * @see {@link UpdateTrackerCommandOutput} for command's `response` shape.
23
- * @see {@link LocationClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class UpdateTrackerCommand extends $Command<UpdateTrackerCommandInput, UpdateTrackerCommandOutput, LocationClientResolvedConfig> {
@@ -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";