Get Place
locationservice_get_place | R Documentation |
Finds a place by its unique ID¶
Description¶
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
Usage¶
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 toen
. Thecity
in the results will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then thecity
in the results will more likely be returned asA\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"
)
)