Skip to content

Get Place

locationservice_get_place R Documentation

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 the V2 get_place operation unless you require Grab data.

  • This version of get_place 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).

  • Version 2 of the get_place operation interoperates with the rest of the Places V2 API, while this version does not.

  • 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.

  • Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.

Finds a place by its unique ID. A PlaceId is returned by other search operations.

A PlaceId is valid only if all of the following are the same in the original search request and the call to get_place.

  • Customer Amazon Web Services account

  • Amazon Web Services Region

  • Data provider specified in the place index resource

If your Place index resource is configured with Grab as your geolocation provider and Storage as Intended use, the GetPlace operation is unavailable. For more information, see AWS service terms.

Usage

locationservice_get_place(IndexName, PlaceId, Language, Key)

Arguments

IndexName

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

[required] The identifier of the place to find.
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(
  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"
  )
)

Request syntax

svc$get_place(
  IndexName = "string",
  PlaceId = "string",
  Language = "string",
  Key = "string"
)