Contains details about addresses or points of interest that match the search criteria.
Not all details are included with all responses. Some details may only be returned by specific data partners.
Contents
- Geometry
-
Places uses a point geometry to specify a location or a Place.
Type: PlaceGeometry object
Required: Yes
- AddressNumber
-
The numerical portion of an address, such as a building number.
Type: String
Required: No
- Categories
-
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service developer guide.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 0. Maximum length of 35.
Required: No
- Country
-
A country/region specified using ISO 3166
3-digit country/region code. For example, CAN.Type: String
Required: No
- Interpolated
-
Trueif the result is interpolated from other known places.Falseif the Place is a known place.Not returned when the partner does not provide the information.
For example, returns
Falsefor an address location that is found in the partner data, but returnsTrueif an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.Type: Boolean
Required: No
- Label
-
The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA.Type: String
Required: No
- Municipality
-
A name for a local area, such as a city or town name. For example,
Toronto.Type: String
Required: No
- Neighborhood
-
The name of a community district. For example,
Downtown.Type: String
Required: No
- PostalCode
-
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
Type: String
Required: No
- Region
-
A name for an area or geographical division, such as a province or state name. For example,
British Columbia.Type: String
Required: No
- Street
-
The name for a street or a road to identify a location. For example,
Main Street.Type: String
Required: No
- SubMunicipality
-
An area that's part of a larger municipality. For example,
Blissvilleis a submunicipality in the Queen County in New York.Note
This property supported by Esri and OpenData. The Esri property is
district, and the OpenData property isborough.Type: String
Required: No
- SubRegion
-
A county, or an area that's part of a larger region. For example,
Metro Vancouver.Type: String
Required: No
- SupplementalCategories
-
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 0. Maximum length of 35.
Required: No
- TimeZone
-
The time zone in which the
Placeis located. Returned only when using HERE or Grab as the selected partner.Type: TimeZone object
Required: No
- UnitNumber
-
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3BorUnit 123.Note
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition.Type: String
Required: No
- UnitType
-
For addresses with a
UnitNumber, the type of unit. For example,Apartment.Note
Returned only for a place index that uses Esri as a data provider.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
