Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPlace

Important

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

This version of GetPlace 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 GetPlace operation interoperates with the rest of the Places V2 API, while this version does not.
If you are using an AWS SDK or the AWS 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.

Note

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

Customer AWS account
AWS Region
Data provider specified in the place index resource

Note

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.

Request Syntax


GET /places/v0/indexes/IndexName/places/PlaceId?key=Key&language=Language HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

IndexName

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

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 Αθήνα.

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

Length Constraints: Minimum length of 2. Maximum length of 35.

PlaceId

The identifier of the place to find.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Place": { 
      "AddressNumber": "string",
      "Categories": [ "string" ],
      "Country": "string",
      "Geometry": { 
         "Point": [ number ]
      },
      "Interpolated": boolean,
      "Label": "string",
      "Municipality": "string",
      "Neighborhood": "string",
      "PostalCode": "string",
      "Region": "string",
      "Street": "string",
      "SubMunicipality": "string",
      "SubRegion": "string",
      "SupplementalCategories": [ "string" ],
      "TimeZone": { 
         "Name": "string",
         "Offset": number
      },
      "UnitNumber": "string",
      "UnitType": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Place

Details about the result, such as its address and position.

Type: Place object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

FieldList: The field where the invalid entry was detected.
Reason: A message with the reason for the validation exception error.

HTTP Status Code: 400