This operation is no longer current and may be deprecated in the future¶

Description¶

This operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode or SearchNearby unless you require Grab data.

• search_place_index_for_position is part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).
• The version 2 ReverseGeocode operation gives better results in the address reverse-geocoding use case, while the version 2 SearchNearby operation gives better results when searching for businesses and points of interest near a specific location.
• If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under geo-places or geo_places, not under location.
• Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.

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

Usage¶

locationservice_search_place_index_for_position(IndexName, Position,
  MaxResults, Language, Key)

Arguments¶

• IndexName

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

• Position

  [required] Specifies the longitude and latitude of the position to query.

  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 a position with longitude -123.1174 and latitude 49.2847.

• MaxResults

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

  Default value: 50

• Language

  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 a location around Athens, Greece, with the language parameter set to en. The city in the results will most likely be returned as Athens.

  If you set the language parameter to el, for Greek, then the city in the results will more likely be returned as $A\Theta\eta\nu\alpha$.

  If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

• Key

  The optional API key to authorize the request.

Value¶

A list with the following syntax:

list(
  Summary = list(
    Position = list(
      123.0
    ),
    MaxResults = 123,
    DataSource = "string",
    Language = "string"
  ),
  Results = list(
    list(
      Place = list(
        Label = "string",
        Geometry = list(
          Point = list(
            123.0
          )
        ),
        AddressNumber = "string",
        Street = "string",
        Neighborhood = "string",
        Municipality = "string",
        SubRegion = "string",
        Region = "string",
        Country = "string",
        PostalCode = "string",
        Interpolated = TRUE|FALSE,
        TimeZone = list(
          Name = "string",
          Offset = 123
        ),
        UnitType = "string",
        UnitNumber = "string",
        Categories = list(
          "string"
        ),
        SupplementalCategories = list(
          "string"
        ),
        SubMunicipality = "string"
      ),
      Distance = 123.0,
      PlaceId = "string"
    )
  )
)

Request syntax¶

svc$search_place_index_for_position(
  IndexName = "string",
  Position = list(
    123.0
  ),
  MaxResults = 123,
  Language = "string",
  Key = "string"
)