location/aws.sdk.kotlin.services.location.model/SearchPlaceIndexForTextRequest/Builder

Builder

Properties

An optional parameter that indicates a preference for places that are closer to a specified position.

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

filterCategories

var filterCategories: List<String>?

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

filterCountries

var filterCountries: List<String>?

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

indexName

var indexName: String?

The name of the place index resource you want to use for the search.

key

var key: String?

The optional API key to authorize the request.

language

var language: String?

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

maxResults

var maxResults: Int?

An optional parameter. The maximum number of results returned per request.

text

var text: String?

The address, name, city, or region to be used in the search in free-form text format. For example, 123 Any Street.