Class: Aws::LocationService::Types::SearchPlaceIndexForSuggestionsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:text, :bias_position, :filter_b_box, :key]

Instance Attribute Summary collapse

Instance Attribute Details

#bias_position ⇒ Array<Float>

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.

For example, ‘[-123.1174, 49.2847]` represents the position with longitude `-123.1174` and latitude `49.2847`.

<note markdown=“1”> ‘BiasPosition` and `FilterBBox` are mutually exclusive. Specifying both options results in an error.

</note>

Returns:

  • (Array<Float>) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#filter_b_box ⇒ Array<Float>

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.

For example, ‘[-12.7935, -37.4835, -12.0684, -36.9542]` represents a bounding box where the southwest corner has longitude `-12.7935` and latitude `-37.4835`, and the northeast corner has longitude `-12.0684` and latitude `-36.9542`.

<note markdown=“1”> ‘FilterBBox` and `BiasPosition` are mutually exclusive. Specifying both options results in an error.

</note>

Returns:

  • (Array<Float>) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#filter_categories ⇒ Array<String>

A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match any of the categories listed.

For more information about using categories, including a list of Amazon Location categories, see [Categories and filtering], in the *Amazon Location Service Developer Guide*.

[1]: docs.aws.amazon.com/location/latest/developerguide/category-filtering.html

Returns:

  • (Array<String>) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#filter_countries ⇒ Array<String>

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

  • Use the [ISO 3166] 3-digit country code. For example, Australia uses three upper-case characters: ‘AUS`.

^

[1]: www.iso.org/iso-3166-country-codes.html

Returns:

  • (Array<String>) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#index_name ⇒ String

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

Returns:

  • (String) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#key ⇒ String

The optional [API key] to authorize the request.

[1]: docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html

Returns:

  • (String) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :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. 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 ‘Athens, Gr` to get suggestions with the `language` parameter set to `en`. The results found will most likely be returned as `Athens, Greece`.

If you set the ‘language` parameter to `el`, for Greek, then the result found 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.

[1]: tools.ietf.org/search/bcp47

Returns:

  • (String) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#max_results ⇒ Integer

An optional parameter. The maximum number of results returned per request.

The default: ‘5`

Returns:

  • (Integer) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end

#text ⇒ String

The free-form partial text to use to generate place suggestions. For example, ‘eiffel tow`.

Returns:

  • (String) 


5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
 
# File 'lib/aws-sdk-locationservice/types.rb', line 5935

class SearchPlaceIndexForSuggestionsRequest < Struct.new(
  :index_name,
  :text,
  :bias_position,
  :filter_b_box,
  :filter_countries,
  :max_results,
  :language,
  :filter_categories,
  :key)
  SENSITIVE = [:text, :bias_position, :filter_b_box, :key]
  include Aws::Structure
end