GET

/places/v0/indexes/{IndexName}/places/{PlaceId}

http://geo.{region}.amazonaws.com/places/v0/indexes/{IndexName}/places/{PlaceId}

Finds a place by its unique ID. A <code>PlaceId</code> is returned by other search operations. <note> A PlaceId is valid only if all of the following are the same in the original search request and the call to <code>GetPlace</code>. <ul> <li> Customer Amazon Web Services account </li> <li> Amazon Web Services Region </li> <li> Data provider specified in the place index resource </li> </ul> </note>

Access Token Required: API Key

Path Parameters

IndexNamestringrequired

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

PlaceIdstringrequired

The identifier of the place to find.

Query Params

languagestring

The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> 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 <code>language</code> parameter set to <code>en</code>. The <code>city</code> in the results will most likely be returned as <code>Athens</code>. If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the <code>city</code> in the results will more likely be returned as <code>Αθήνα</code>. If the data provider does not have a value for Greek, the result will be in a language that the provider does support.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://geo.{region}.amazonaws.com/places/v0/indexes/{IndexName}/places/{PlaceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET