AWSLocationPlace

Objective-C

@interface AWSLocationPlace

Swift

class AWSLocationPlace

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.

Required parameters: [Geometry]

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable addressNumber;

    Swift

    var addressNumber: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable categories;

    Swift

    var categories: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable country;

    Swift

    var country: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationPlaceGeometry *_Nullable geometry;

    Swift

    var geometry: AWSLocationPlaceGeometry? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable interpolated;

    Swift

    var interpolated: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable label;

    Swift

    var label: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable municipality;

    Swift

    var municipality: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable neighborhood;

    Swift

    var neighborhood: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable postalCode;

    Swift

    var postalCode: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable region;

    Swift

    var region: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable street;

    Swift

    var street: String? { get set }

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

    This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable subMunicipality;

    Swift

    var subMunicipality: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable subRegion;

    Swift

    var subRegion: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable supplementalCategories;

    Swift

    var supplementalCategories: [String]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationTimeZone *_Nullable timeZone;

    Swift

    var timeZone: AWSLocationTimeZone? { get set }

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

    Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for SearchPlaceIndexForPosition.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable unitNumber;

    Swift

    var unitNumber: String? { get set }

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

    Returned only for a place index that uses Esri as a data provider.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable unitType;

    Swift

    var unitType: String? { get set }