@aws-sdk/client-location 3.41.0 → 3.46.0

package/dist-types/commands/CreatePlaceIndexCommand.d.ts

@@ -7,8 +7,10 @@ export interface CreatePlaceIndexCommandInput extends CreatePlaceIndexRequest {
 export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse, __MetadataBearer {
 }
 /**
- * <p>Creates a place index resource in your AWS account, which supports functions with
- *          geospatial data sourced from your chosen data provider.</p>
+ * <p>Creates a place index resource in your AWS account. Use a place index resource to
+ *             geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,
+ *             and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and
+ *             enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/SearchPlaceIndexForSuggestionsCommand.d.ts

@@ -0,0 +1,44 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient";
+import { SearchPlaceIndexForSuggestionsRequest, SearchPlaceIndexForSuggestionsResponse } from "../models/models_0";
+export interface SearchPlaceIndexForSuggestionsCommandInput extends SearchPlaceIndexForSuggestionsRequest {
+}
+export interface SearchPlaceIndexForSuggestionsCommandOutput extends SearchPlaceIndexForSuggestionsResponse, __MetadataBearer {
+}
+/**
+ * <p>Generates suggestions for addresses and points of interest based on partial or
+ *          misspelled free-form text. This operation is also known as autocomplete, autosuggest,
+ *          or fuzzy matching.</p>
+ *          <p>Optional parameters let you narrow your search results by bounding box or
+ *          country, or bias your search toward a specific position on the globe.</p>
+ *          <note>
+ *             <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or
+ *             filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive;
+ *             using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { LocationClient, SearchPlaceIndexForSuggestionsCommand } from "@aws-sdk/client-location"; // ES Modules import
+ * // const { LocationClient, SearchPlaceIndexForSuggestionsCommand } = require("@aws-sdk/client-location"); // CommonJS import
+ * const client = new LocationClient(config);
+ * const command = new SearchPlaceIndexForSuggestionsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link SearchPlaceIndexForSuggestionsCommandInput} for command's `input` shape.
+ * @see {@link SearchPlaceIndexForSuggestionsCommandOutput} for command's `response` shape.
+ * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape.
+ *
+ */
+export declare class SearchPlaceIndexForSuggestionsCommand extends $Command<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput, LocationClientResolvedConfig> {
+    readonly input: SearchPlaceIndexForSuggestionsCommandInput;
+    constructor(input: SearchPlaceIndexForSuggestionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LocationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchPlaceIndexForSuggestionsCommandInput, SearchPlaceIndexForSuggestionsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/SearchPlaceIndexForTextCommand.d.ts

@@ -9,13 +9,14 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo
 /**
  * <p>Geocodes free-form text, such as an address, name, city, or region to allow you to
  *          search for Places or points of interest. </p>
- *          <p>Includes the option to apply additional parameters to narrow your list of
- *          results.</p>
+ *          <p>Optional parameters let you narrow your search results by bounding box or
+ *          country, or bias your search toward a specific position on the globe.</p>
  *          <note>
  *             <p>You can search for places near a given position using <code>BiasPosition</code>, or
  *             filter results within a bounding box using <code>FilterBBox</code>. Providing both
  *             parameters simultaneously returns an error.</p>
  *          </note>
+ *          <p>Search results are returned in order of highest to lowest relevance.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -40,6 +40,7 @@ export * from "./ListTrackerConsumersCommand";
 export * from "./ListTrackersCommand";
 export * from "./PutGeofenceCommand";
 export * from "./SearchPlaceIndexForPositionCommand";
+export * from "./SearchPlaceIndexForSuggestionsCommand";
 export * from "./SearchPlaceIndexForTextCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";