import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient"; import { SearchPlaceIndexForTextRequest, SearchPlaceIndexForTextResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SearchPlaceIndexForTextCommand}. */ export interface SearchPlaceIndexForTextCommandInput extends SearchPlaceIndexForTextRequest { } /** * @public * * The output of {@link SearchPlaceIndexForTextCommand}. */ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexForTextResponse, __MetadataBearer { } declare const SearchPlaceIndexForTextCommand_base: { new (input: SearchPlaceIndexForTextCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: SearchPlaceIndexForTextCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Geocodes free-form text, such as an address, name, city, or region to allow you to * search for Places or points of interest.

*

Optional parameters let you narrow your search results by bounding box or country, or * bias your search toward a specific position on the globe.

* *

You can search for places near a given position using BiasPosition, * or filter results within a bounding box using FilterBBox. Providing * both parameters simultaneously returns an error.

*
*

Search results are returned in order of highest to lowest relevance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LocationClient, SearchPlaceIndexForTextCommand } from "@aws-sdk/client-location"; // ES Modules import * // const { LocationClient, SearchPlaceIndexForTextCommand } = require("@aws-sdk/client-location"); // CommonJS import * const client = new LocationClient(config); * const input = { // SearchPlaceIndexForTextRequest * IndexName: "STRING_VALUE", // required * Text: "STRING_VALUE", // required * BiasPosition: [ // Position * Number("double"), * ], * FilterBBox: [ // BoundingBox * Number("double"), * ], * FilterCountries: [ // CountryCodeList * "STRING_VALUE", * ], * MaxResults: Number("int"), * Language: "STRING_VALUE", * FilterCategories: [ // FilterPlaceCategoryList * "STRING_VALUE", * ], * Key: "STRING_VALUE", * }; * const command = new SearchPlaceIndexForTextCommand(input); * const response = await client.send(command); * // { // SearchPlaceIndexForTextResponse * // Summary: { // SearchPlaceIndexForTextSummary * // Text: "STRING_VALUE", // required * // BiasPosition: [ // Position * // Number("double"), * // ], * // FilterBBox: [ // BoundingBox * // Number("double"), * // ], * // FilterCountries: [ // CountryCodeList * // "STRING_VALUE", * // ], * // MaxResults: Number("int"), * // ResultBBox: [ * // Number("double"), * // ], * // DataSource: "STRING_VALUE", // required * // Language: "STRING_VALUE", * // FilterCategories: [ // FilterPlaceCategoryList * // "STRING_VALUE", * // ], * // }, * // Results: [ // SearchForTextResultList // required * // { // SearchForTextResult * // Place: { // Place * // Label: "STRING_VALUE", * // Geometry: { // PlaceGeometry * // Point: [ * // Number("double"), * // ], * // }, * // AddressNumber: "STRING_VALUE", * // Street: "STRING_VALUE", * // Neighborhood: "STRING_VALUE", * // Municipality: "STRING_VALUE", * // SubRegion: "STRING_VALUE", * // Region: "STRING_VALUE", * // Country: "STRING_VALUE", * // PostalCode: "STRING_VALUE", * // Interpolated: true || false, * // TimeZone: { // TimeZone * // Name: "STRING_VALUE", // required * // Offset: Number("int"), * // }, * // UnitType: "STRING_VALUE", * // UnitNumber: "STRING_VALUE", * // Categories: [ // PlaceCategoryList * // "STRING_VALUE", * // ], * // SupplementalCategories: [ // PlaceSupplementalCategoryList * // "STRING_VALUE", * // ], * // SubMunicipality: "STRING_VALUE", * // }, * // Distance: Number("double"), * // Relevance: Number("double"), * // PlaceId: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param SearchPlaceIndexForTextCommandInput - {@link SearchPlaceIndexForTextCommandInput} * @returns {@link SearchPlaceIndexForTextCommandOutput} * @see {@link SearchPlaceIndexForTextCommandInput} for command's `input` shape. * @see {@link SearchPlaceIndexForTextCommandOutput} for command's `response` shape. * @see {@link LocationClientResolvedConfig | config} for LocationClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

The request was denied because of insufficient access or permissions. Check with an * administrator to verify your permissions.

* * @throws {@link InternalServerException} (server fault) *

The request has failed to process because of an unknown server error, exception, or failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource that you've entered was not found in your AWS account.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied because of request throttling.

* * @throws {@link ValidationException} (client fault) *

The input failed to meet the constraints specified by the AWS service.

* * @throws {@link LocationServiceException} *

Base exception class for all service exceptions from Location service.

* * * @public */ export declare class SearchPlaceIndexForTextCommand extends SearchPlaceIndexForTextCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SearchPlaceIndexForTextRequest; output: SearchPlaceIndexForTextResponse; }; sdk: { input: SearchPlaceIndexForTextCommandInput; output: SearchPlaceIndexForTextCommandOutput; }; }; }