SearchTextResultItem - Amazon Location Service

SearchTextResultItem

The text search result.

Contents

PlaceId

The PlaceId of the place you wish to receive the information for.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: Yes

PlaceType

A PlaceType is a category that the result place must belong to.

Type: String

Valid Values: Country | Region | SubRegion | Locality | District | SubDistrict | PostalCode | Block | SubBlock | Intersection | Street | PointOfInterest | PointAddress | InterpolatedAddress

Required: Yes

Title

The item's title.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: Yes

AccessPoints

Position of the access point represent by longitude and latitude.

Type: Array of AccessPoint objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

AccessRestrictions

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

Type: Array of AccessRestriction objects

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

Required: No

Address

The place's address.

Type: Address object

Required: No

AddressNumberCorrected

Boolean indicating if the address provided has been corrected.

Type: Boolean

Required: No

BusinessChains

The Business Chains associated with the place.

Type: Array of BusinessChain objects

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

Required: No

Categories

Categories of results that results must belong to.

Type: Array of Category objects

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

Required: No

Contacts

List of potential contact methods for the result/place.

Type: Contacts object

Required: No

Distance

The distance in meters from the QueryPosition.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 4294967295.

Required: No

FoodTypes

List of food types offered by this result.

Type: Array of FoodType objects

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

Required: No

MapView

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

Type: Array of doubles

Array Members: Fixed number of 4 items.

Required: No

OpeningHours

List of opening hours objects.

Type: Array of OpeningHours objects

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

Required: No

Phonemes

How the various components of the result's address are pronounced in various languages.

Type: PhonemeDetails object

Required: No

PoliticalView

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

Type: String

Length Constraints: Fixed length of 3.

Pattern: [A-Z]{3}

Required: No

Position

The position, in longitude and latitude.

Type: Array of doubles

Array Members: Fixed number of 2 items.

Required: No

TimeZone

The time zone in which the place is located.

Type: TimeZone object

Required: No

See Also

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