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

Inherits:

Struct

Object
Struct
Aws::LocationService::Types::Place

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

#address_number ⇒ String
The numerical portion of an address, such as a building number.
#categories ⇒ Array<String>
The Amazon Location categories that describe this Place.
#country ⇒ String
A country/region specified using [ISO 3166][1] 3-digit country/region code.
#geometry ⇒ Types::PlaceGeometry
Places uses a point geometry to specify a location or a Place.
#interpolated ⇒ Boolean
True if the result is interpolated from other known places.
#label ⇒ String
The full name and address of the point of interest such as a city, region, or country.
#municipality ⇒ String
A name for a local area, such as a city or town name.
#neighborhood ⇒ String
The name of a community district.
#postal_code ⇒ 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.
#street ⇒ String
The name for a street or a road to identify a location.
#sub_municipality ⇒ String
An area that's part of a larger municipality.
#sub_region ⇒ String
A county, or an area that's part of a larger region.
#supplemental_categories ⇒ Array<String>
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
#time_zone ⇒ Types::TimeZone
The time zone in which the Place is located.
#unit_number ⇒ String
For addresses with multiple units, the unit identifier.
#unit_type ⇒ String
For addresses with a UnitNumber, the type of unit.

Instance Attribute Details

#address_number ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#categories ⇒ `Array<String>`

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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#country ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#geometry ⇒ `Types::PlaceGeometry`

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

Returns:

(Types::PlaceGeometry)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

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

Returns:

(Boolean)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#municipality ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#neighborhood ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#postal_code ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#region ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#street ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#sub_municipality ⇒ `String`

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

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.

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#sub_region ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#supplemental_categories ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#time_zone ⇒ `Types::TimeZone`

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

Returns:

(Types::TimeZone)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#unit_number ⇒ `String`

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

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

#unit_type ⇒ `String`

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

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

Returns:

(String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4959

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#address_number ⇒ String

#categories ⇒ Array<String>

#country ⇒ String

#geometry ⇒ Types::PlaceGeometry

#interpolated ⇒ Boolean

#label ⇒ String

#municipality ⇒ String

#neighborhood ⇒ String

#postal_code ⇒ String

#region ⇒ String

#street ⇒ String

#sub_municipality ⇒ String

#sub_region ⇒ String

#supplemental_categories ⇒ Array<String>

#time_zone ⇒ Types::TimeZone

#unit_number ⇒ String

#unit_type ⇒ String

#address_number ⇒ `String`

#categories ⇒ `Array<String>`

#country ⇒ `String`

#geometry ⇒ `Types::PlaceGeometry`

#interpolated ⇒ `Boolean`

#label ⇒ `String`

#municipality ⇒ `String`

#neighborhood ⇒ `String`

#postal_code ⇒ `String`

#region ⇒ `String`

#street ⇒ `String`

#sub_municipality ⇒ `String`

#sub_region ⇒ `String`

#supplemental_categories ⇒ `Array<String>`

#time_zone ⇒ `Types::TimeZone`

#unit_number ⇒ `String`

#unit_type ⇒ `String`