search_place_index_for_position - Boto3 1.34.74 documentation

AddressNumber (string) –

The numerical portion of an address, such as a building number.

Categories (list) –

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.

• (string) –

Country (string) –

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.

Geometry (dict) –

Places uses a point geometry to specify a location or a Place.

Interpolated (boolean) –

True if the result is interpolated from other known places.

False if the Place is a known place.

Not returned when the partner does not provide the information.

For example, returns False for an address location that is found in the partner data, but returns True if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.

Label (string) –

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.

Municipality (string) –

A name for a local area, such as a city or town name. For example, Toronto.

Neighborhood (string) –

The name of a community district. For example, Downtown.

PostalCode (string) –

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

Region (string) –

A name for an area or geographical division, such as a province or state name. For example, British Columbia.

Street (string) –

The name for a street or a road to identify a location. For example, Main Street.

SubMunicipality (string) –

An area that’s part of a larger municipality. For example, Blissville is a submunicipality in the Queen County in New York.

Note

This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district.

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

SubRegion (string) –

A county, or an area that’s part of a larger region. For example, Metro Vancouver.

SupplementalCategories (list) –

Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.

• (string) –

TimeZone (dict) –

The time zone in which the Place is located. Returned only when using HERE or Grab as the selected partner.

• Name (string) –

  The name of the time zone, following the IANA time zone standard. For example, America/Los_Angeles.

• Offset (integer) –

  The time zone’s offset, in seconds, from UTC.

UnitNumber (string) –

For addresses with multiple units, the unit identifier. Can include numbers and letters, for example 3B or Unit 123.

Note

This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for SearchPlaceIndexForPosition.

UnitType (string) –

For addresses with a UnitNumber, the type of unit. For example, Apartment.

Note

This property is returned only for a place index that uses Esri as a data provider.