Class: Aws::LocationService::Types::SearchPlaceIndexForTextRequest

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

Overview

Note:

When making an API call, you may pass SearchPlaceIndexForTextRequest data as a hash:

{
  bias_position: [1.0],
  filter_b_box: [1.0],
  filter_countries: ["CountryCode"],
  index_name: "ResourceName", # required
  max_results: 1,
  text: "SyntheticSearchPlaceIndexForTextRequestString", # required
}

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#bias_positionArray<Float>

Searches for results closest to the given position. An optional parameter defined by longitude, and latitude.

  • The first bias position is the X coordinate, or longitude.

  • The second bias position is the Y coordinate, or latitude.

For example, bias=xLongitude&bias=yLatitude.

Returns:

  • (Array<Float>)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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

#filter_b_boxArray<Float>

Filters the results by returning only Places within the provided bounding box. An optional parameter.

The first 2 bbox parameters describe the lower southwest corner:

  • The first bbox position is the X coordinate or longitude of the lower southwest corner.

  • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

The next bbox parameters describe the upper northeast corner:

  • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

  • The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

For example, bbox=xLongitudeNE&bbox=yLatitudeNE

Returns:

  • (Array<Float>)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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

#filter_countriesArray<String>

Limits the search to the given a list of countries/regions. An optional parameter.

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

^

Returns:

  • (Array<String>)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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

#index_nameString

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

Returns:

  • (String)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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

#max_resultsInteger

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

The default: 50

Returns:

  • (Integer)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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

#textString

The address, name, city, or region to be used in the search. In free-form text format. For example, 123 Any Street.

Returns:

  • (String)


4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 4487

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