class Aws::LocationService::Types::SearchPlaceIndexForTextRequest
@note When making an API call, you may pass SearchPlaceIndexForTextRequest
data as a hash: { bias_position: [1.0], filter_b_box: [1.0], filter_countries: ["CountryCode"], index_name: "ResourceName", # required max_results: 1, text: "SyntheticSearchPlaceIndexForTextRequestString", # required }
@!attribute [rw] bias_position
Searches for results closest to the given position. An optional parameter defined by longitude, and latitude. * The first `bias` position is the X coordinate, or longitude. * The second `bias` position is the Y coordinate, or latitude. For example, `bias=xLongitude&bias=yLatitude`. @return [Array<Float>]
@!attribute [rw] filter_b_box
Filters the results by returning only Places within the provided bounding box. An optional parameter. The first 2 `bbox` parameters describe the lower southwest corner: * The first `bbox` position is the X coordinate or longitude of the lower southwest corner. * The second `bbox` position is the Y coordinate or latitude of the lower southwest corner. For example, `bbox=xLongitudeSW&bbox=yLatitudeSW`. The next `bbox` parameters describe the upper northeast corner: * The third `bbox` position is the X coordinate, or longitude of the upper northeast corner. * The fourth `bbox` position is the Y coordinate, or longitude of the upper northeast corner. For example, `bbox=xLongitudeNE&bbox=yLatitudeNE` @return [Array<Float>]
@!attribute [rw] filter_countries
Limits the search to the given a list of countries/regions. An optional parameter. * Use the [ISO 3166][1] 3-digit country code. For example, Australia uses three upper-case characters: `AUS`. ^ [1]: https://www.iso.org/iso-3166-country-codes.html @return [Array<String>]
@!attribute [rw] index_name
The name of the place index resource you want to use for the search. @return [String]
@!attribute [rw] max_results
An optional parameter. The maximum number of results returned per request. The default: `50` @return [Integer]
@!attribute [rw] text
The address, name, city, or region to be used in the search. In free-form text format. For example, `123 Any Street`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/SearchPlaceIndexForTextRequest AWS API Documentation
Constants
- SENSITIVE