Class: Aws::LocationService::Types::SearchPlaceIndexForTextRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LocationService::Types::SearchPlaceIndexForTextRequest
- Defined in:
- gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:bias_position, :filter_b_box, :key, :text]
Instance Attribute Summary collapse
-
#bias_position ⇒ Array<Float>
An optional parameter that indicates a preference for places that are closer to a specified position.
-
#filter_b_box ⇒ Array<Float>
An optional parameter that limits the search results by returning only places that are within the provided bounding box.
-
#filter_categories ⇒ Array<String>
A list of one or more Amazon Location categories to filter the returned places.
-
#filter_countries ⇒ Array<String>
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
-
#index_name ⇒ String
The name of the place index resource you want to use for the search.
-
#key ⇒ String
The optional [API key][1] to authorize the request.
-
#language ⇒ String
The preferred language used to return results.
-
#max_results ⇒ Integer
An optional parameter.
-
#text ⇒ String
The address, name, city, or region to be used in the search in free-form text format.
Instance Attribute Details
#bias_position ⇒ Array<Float>
An optional parameter that indicates a preference for places 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
.
BiasPosition
and FilterBBox
are mutually exclusive. Specifying
both options results in an error.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#filter_b_box ⇒ Array<Float>
An optional parameter that limits the search results by returning only places that are within the provided 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
.
FilterBBox
and BiasPosition
are mutually exclusive. Specifying
both options results in an error.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] 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.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#filter_countries ⇒ Array<String>
An optional parameter that limits the search results by returning only places that are in a specified list of countries.
- Valid values include ISO 3166 3-digit country codes. For
example, Australia uses three upper-case characters:
AUS
.
^
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#index_name ⇒ String
The name of the place index resource you want to use for the search.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#key ⇒ String
The optional API key to authorize the request.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] 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
Athens, Greece
, with the language
parameter set to en
. The
result found will most likely be returned as Athens
.
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.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#max_results ⇒ Integer
An optional parameter. The maximum number of results returned per request.
The default: 50
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |
#text ⇒ String
The address, name, city, or region to be used in the search in
free-form text format. For example, 123 Any Street
.
5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 |
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5844 class SearchPlaceIndexForTextRequest < Struct.new( :bias_position, :filter_b_box, :filter_categories, :filter_countries, :index_name, :key, :language, :max_results, :text) SENSITIVE = [:bias_position, :filter_b_box, :key, :text] include Aws::Structure end |