[ aws . location ]

search-place-index-for-text

Description

Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.

Includes the option to apply additional parameters to narrow your list of results.

Note

You can search for places near a given position using BiasPosition , or filter results within a bounding box using FilterBBox . Providing both parameters simultaneously returns an error.

Note

By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.

Also, when using HERE as your data provider, you may not (a) use HERE Places for Asset Management, or (b) select the Storage option for the IntendedUse parameter when requesting Places in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-place-index-for-text
[--bias-position <value>]
[--filter-b-box <value>]
[--filter-countries <value>]
--index-name <value>
[--max-results <value>]
--text <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bias-position (list)

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 .

(double)

Syntax:

double double ...

--filter-b-box (list)

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

(double)

Syntax:

double double ...

--filter-countries (list)

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 .

(string)

Syntax:

"string" "string" ...

--index-name (string)

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

--max-results (integer)

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

The default: 50

--text (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Results -> (list)

A list of Places closest to the specified position. Each result contains additional information about the specific point of interest.

(structure)

Contains relevant Places returned by calling SearchPlaceIndexForText .

Place -> (structure)

Contains details about the relevant point of interest.

AddressNumber -> (string)

The numerical portion of an address, such as a building number.

Country -> (string)

A country/region specified using ISO 3166 3-digit country/region code. For example, CAN .

Geometry -> (structure)

Places uses a point geometry to specify a location or a Place.

Point -> (list)

A single point geometry specifies a location for a Place using WGS 84 coordinates:

• x — Specifies the x coordinate or longitude.

• y — Specifies the y coordinate or latitude.

(double)

Label -> (string)

The full name and address of the point of interest such as a city, region, or country. For example, 123 Any Street, Any Town, USA .

Municipality -> (string)

A name for a local area, such as a city or town name. For example, Toronto .

Neighborhood -> (string)

The name of a community district. For example, Downtown .

PostalCode -> (string)

A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.

Region -> (string)

A name for an area or geographical division, such as a province or state name. For example, British Columbia .

Street -> (string)

The name for a street or a road to identify a location. For example, Main Street .

SubRegion -> (string)

A country, or an area that’s part of a larger region . For example, Metro Vancouver .

Summary -> (structure)

Contains a summary of the request. Contains the BiasPosition , DataSource , FilterBBox , FilterCountries , MaxResults , ResultBBox , and Text .

BiasPosition -> (list)

Contains the coordinates for the bias position entered in the geocoding request.

(double)

DataSource -> (string)

The data provider of geospatial data for the Place index resource.

FilterBBox -> (list)

Contains the coordinates for the optional bounding box coordinated entered in the geocoding request.

(double)

FilterCountries -> (list)

Contains the country filter entered in the geocoding request.

(string)

MaxResults -> (integer)

Contains the maximum number of results indicated for the request.

ResultBBox -> (list)

A bounding box that contains the search results within the specified area indicated by FilterBBox . A subset of bounding box specified using FilterBBox .

(double)

Text -> (string)

The address, name, city or region to be used in the geocoding request. In free-form text format. For example, Vancouver .