Class: Aws::GeoPlaces::Types::GetPlaceRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:place_id, :political_view, :key]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_features ⇒ Array<String>

A list of optional additional parameters such as time zone that can be requested for each result.

Returns:

  • (Array<String>) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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

#intended_use ⇒ String

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

Storing the response of an GetPlace query is required to comply with service terms, but charged at a higher cost per request. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

Returns:

  • (String) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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

#key ⇒ String

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

  • (String) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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

#language ⇒ String

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

Returns:

  • (String) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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

#place_id ⇒ String

The PlaceId of the place you wish to receive the information for.

Returns:

  • (String) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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

#political_view ⇒ String

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

Returns:

  • (String) 


1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-geoplaces/lib/aws-sdk-geoplaces/types.rb', line 1384

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