SearchPlaceIndexForTextSummary - Amazon Location Service

SearchPlaceIndexForTextSummary

A summary of the request sent by using SearchPlaceIndexForText.

Contents

BiasPosition

Contains the coordinates for the optional bias position specified in the request.

This parameter contains a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

DataSource

The geospatial data provider attached to the place index resource specified in the request. Values can be one of the following:

  • Esri

  • Here

For more information about data providers, see Amazon Location Service data providers.

Type: String

Required: Yes

FilterBBox

Contains the coordinates for the optional bounding box specified in the request.

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

FilterCountries

Contains the optional country filter specified in the request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^[A-Z]{3}$

Required: No

Language

The preferred language used to return results. Matches the language in the request. The value is a valid BCP 47 language tag, for example, en for English.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 35.

Required: No

MaxResults

Contains the optional result count limit specified in the request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

ResultBBox

The bounding box that fully contains all search results.

Note

If you specified the optional FilterBBox parameter in the request, ResultBBox is contained within FilterBBox.

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

Text

The search text specified in the request.

Type: String

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: