Class: Aws::LocationService::Types::GetPlaceRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:key]

Instance Attribute Summary collapse

Instance Attribute Details

#index_name ⇒ String

The name of the place index resource that you want to use for the search.

Returns:

  • (String) 


3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3567

class GetPlaceRequest < Struct.new(
  :index_name,
  :key,
  :language,
  :place_id)
  SENSITIVE = [:key]
  include Aws::Structure
end

#key ⇒ String

The optional API key to authorize the request.

Returns:

  • (String) 


3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3567

class GetPlaceRequest < Struct.new(
  :index_name,
  :key,
  :language,
  :place_id)
  SENSITIVE = [:key]
  include Aws::Structure
end

#language ⇒ String

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example, en for English.

This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.

For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as Αθήνα.

If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Returns:

  • (String) 


3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3567

class GetPlaceRequest < Struct.new(
  :index_name,
  :key,
  :language,
  :place_id)
  SENSITIVE = [:key]
  include Aws::Structure
end

#place_id ⇒ String

The identifier of the place to find.

While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:

  • Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.

  • HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.

  • Grab: Place IDs can expire or become invalid in the following situations.

    • Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.

    • Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the place.result_type field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.

Returns:

  • (String) 


3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3567

class GetPlaceRequest < Struct.new(
  :index_name,
  :key,
  :language,
  :place_id)
  SENSITIVE = [:key]
  include Aws::Structure
end