[ aws . location ]

search-place-index-for-position

Description

Reverse geocodes a given coordinate and returns a legible address. Allows you to search for Places or points of interest near a given position.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-place-index-for-position
--index-name <value>
[--max-results <value>]
--position <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--index-name (string)

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

--max-results (integer)

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

Default value: 50

--position (list)

Specifies a coordinate for the query defined by a longitude, and latitude.

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

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

For example, position=xLongitude&position=yLatitude .

(double)

Syntax:

double double ...

--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)

Returns a list of Places closest to the specified position. Each result contains additional information about the Places returned.

(structure)

Specifies a single point of interest, or Place as a result of a search query obtained from a dataset configured in the place index resource.

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.

DataSource -> (string)

The data provider of geospatial data. Indicates one of the available providers:

• Esri

• HERE

For additional details on data providers, see Amazon Location Service data providers .

MaxResults -> (integer)

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

Default value: 50

Position -> (list)

The position given in the reverse geocoding request.

(double)