Class: Aws::LocationService::Types::Place

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_numberString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#countryString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#geometryTypes::PlaceGeometry

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



4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#interpolatedBoolean

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.

Returns:

  • (Boolean)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#labelString

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.

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#municipalityString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#neighborhoodString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#postal_codeString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#streetString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#sub_regionString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#time_zoneTypes::TimeZone

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

Returns:



4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#unit_numberString

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 as a data provider. Is not returned for SearchPlaceIndexForPosition.

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end

#unit_typeString

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

Returns:

  • (String)


4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4123

class Place < Struct.new(
  :address_number,
  :country,
  :geometry,
  :interpolated,
  :label,
  :municipality,
  :neighborhood,
  :postal_code,
  :region,
  :street,
  :sub_region,
  :time_zone,
  :unit_number,
  :unit_type)
  SENSITIVE = []
  include Aws::Structure
end