# GetPlace
`GetPlace` finds a place by its unique ID. A `PlaceId` is returned by other place operations.
For more information, see [GetPlace](https://docs.aws.amazon.com/location/latest/developerguide/get-place.html) in the *Amazon Location Service Developer Guide*.
## Request Syntax
```
GET /place/PlaceId?additional-features=AdditionalFeatures&intended-use=IntendedUse&key=Key&language=Language&political-view=PoliticalView HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [AdditionalFeatures](#API_geoplaces_GetPlace_RequestSyntax) **
A list of optional additional parameters such as time zone that can be requested for each result. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the `TimeZone` value.
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Valid Values: `TimeZone | Phonemes | Access | Contact | SecondaryAddresses`
** [IntendedUse](#API_geoplaces_GetPlace_RequestSyntax) **
Indicates if the query results will be persisted in customer infrastructure. Defaults to `SingleUse` (not stored). Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
When storing `GetPlace` responses, you *must* set this field to `Storage` to comply with the terms of service. These requests will be charged at a higher rate. Please review the [user agreement](https://aws.amazon.com/location/sla/) and [service pricing structure](https://aws.amazon.com/location/pricing/) to determine the correct setting for your use case.
Valid Values: `SingleUse | Storage`
** [Key](#API_geoplaces_GetPlace_RequestSyntax) **
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Length Constraints: Minimum length of 0. Maximum length of 1000.
** [Language](#API_geoplaces_GetPlace_RequestSyntax) **
A list of [BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers, `ap-southeast-1` and `ap-southeast-5` regions support only the following codes: `en, id, km, lo, ms, my, pt, th, tl, vi, zh`
Length Constraints: Minimum length of 2. Maximum length of 35.
** [PlaceId](#API_geoplaces_GetPlace_RequestSyntax) **
The `PlaceId` of the place you wish to receive the information for.
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: Yes
** [PoliticalView](#API_geoplaces_GetPlace_RequestSyntax) **
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Length Constraints: Minimum length of 2. Maximum length of 3.
Pattern: `([A-Z]{2}|[A-Z]{3})`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
x-amz-geo-pricing-bucket: PricingBucket
Content-type: application/json
{
"AccessPoints": [
{
"Position": [ number ]
}
],
"AccessRestrictions": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Restricted": boolean
}
],
"Address": {
"AddressNumber": "string",
"Block": "string",
"Building": "string",
"Country": {
"Code2": "string",
"Code3": "string",
"Name": "string"
},
"District": "string",
"Intersection": [ "string" ],
"Label": "string",
"Locality": "string",
"PostalCode": "string",
"Region": {
"Code": "string",
"Name": "string"
},
"SecondaryAddressComponents": [
{
"Designator": "string",
"Number": "string"
}
],
"Street": "string",
"StreetComponents": [
{
"BaseName": "string",
"Direction": "string",
"Language": "string",
"Prefix": "string",
"Suffix": "string",
"Type": "string",
"TypePlacement": "string",
"TypeSeparator": "string"
}
],
"SubBlock": "string",
"SubDistrict": "string",
"SubRegion": {
"Code": "string",
"Name": "string"
}
},
"AddressNumberCorrected": boolean,
"BusinessChains": [
{
"Id": "string",
"Name": "string"
}
],
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Contacts": {
"Emails": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Label": "string",
"Value": "string"
}
],
"Faxes": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Label": "string",
"Value": "string"
}
],
"Phones": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Label": "string",
"Value": "string"
}
],
"Websites": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Label": "string",
"Value": "string"
}
]
},
"FoodTypes": [
{
"Id": "string",
"LocalizedName": "string",
"Primary": boolean
}
],
"MainAddress": {
"AccessPoints": [
{
"Position": [ number ]
}
],
"Address": {
"AddressNumber": "string",
"Block": "string",
"Building": "string",
"Country": {
"Code2": "string",
"Code3": "string",
"Name": "string"
},
"District": "string",
"Intersection": [ "string" ],
"Label": "string",
"Locality": "string",
"PostalCode": "string",
"Region": {
"Code": "string",
"Name": "string"
},
"SecondaryAddressComponents": [
{
"Designator": "string",
"Number": "string"
}
],
"Street": "string",
"StreetComponents": [
{
"BaseName": "string",
"Direction": "string",
"Language": "string",
"Prefix": "string",
"Suffix": "string",
"Type": "string",
"TypePlacement": "string",
"TypeSeparator": "string"
}
],
"SubBlock": "string",
"SubDistrict": "string",
"SubRegion": {
"Code": "string",
"Name": "string"
}
},
"PlaceId": "string",
"PlaceType": "string",
"Position": [ number ],
"Title": "string"
},
"MapView": [ number ],
"OpeningHours": [
{
"Categories": [
{
"Id": "string",
"LocalizedName": "string",
"Name": "string",
"Primary": boolean
}
],
"Components": [
{
"OpenDuration": "string",
"OpenTime": "string",
"Recurrence": "string"
}
],
"Display": [ "string" ],
"OpenNow": boolean
}
],
"Phonemes": {
"Address": {
"Block": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"Country": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"District": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"Locality": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"Region": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"Street": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"SubBlock": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"SubDistrict": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
],
"SubRegion": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
]
},
"Title": [
{
"Language": "string",
"Preferred": boolean,
"Value": "string"
}
]
},
"PlaceId": "string",
"PlaceType": "string",
"PoliticalView": "string",
"Position": [ number ],
"PostalCodeDetails": [
{
"PostalAuthority": "string",
"PostalCode": "string",
"PostalCodeType": "string",
"UspsZip": {
"ZipClassificationCode": "string"
},
"UspsZipPlus4": {
"RecordTypeCode": "string"
}
}
],
"SecondaryAddresses": [
{
"AccessPoints": [
{
"Position": [ number ]
}
],
"Address": {
"AddressNumber": "string",
"Block": "string",
"Building": "string",
"Country": {
"Code2": "string",
"Code3": "string",
"Name": "string"
},
"District": "string",
"Intersection": [ "string" ],
"Label": "string",
"Locality": "string",
"PostalCode": "string",
"Region": {
"Code": "string",
"Name": "string"
},
"SecondaryAddressComponents": [
{
"Designator": "string",
"Number": "string"
}
],
"Street": "string",
"StreetComponents": [
{
"BaseName": "string",
"Direction": "string",
"Language": "string",
"Prefix": "string",
"Suffix": "string",
"Type": "string",
"TypePlacement": "string",
"TypeSeparator": "string"
}
],
"SubBlock": "string",
"SubDistrict": "string",
"SubRegion": {
"Code": "string",
"Name": "string"
}
},
"PlaceId": "string",
"PlaceType": "string",
"Position": [ number ],
"Title": "string"
}
],
"TimeZone": {
"Name": "string",
"Offset": "string",
"OffsetSeconds": number
},
"Title": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [PricingBucket](#API_geoplaces_GetPlace_ResponseSyntax) **
The pricing bucket for which the query is charged at.
For more information on pricing, please visit [Amazon Location Service Pricing](https://aws.amazon.com/location/pricing/).
The following data is returned in JSON format by the service.
** [AccessPoints](#API_geoplaces_GetPlace_ResponseSyntax) **
Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude]. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Array of [AccessPoint](API_geoplaces_AccessPoint.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
** [AccessRestrictions](#API_geoplaces_GetPlace_ResponseSyntax) **
Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Array of [AccessRestriction](API_geoplaces_AccessRestriction.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
** [Address](#API_geoplaces_GetPlace_ResponseSyntax) **
The place's address.
Type: [Address](API_geoplaces_Address.md) object
** [AddressNumberCorrected](#API_geoplaces_GetPlace_ResponseSyntax) **
Boolean indicating if the address provided has been corrected. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Boolean
** [BusinessChains](#API_geoplaces_GetPlace_ResponseSyntax) **
The Business Chains associated with the place.
Type: Array of [BusinessChain](API_geoplaces_BusinessChain.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
** [Categories](#API_geoplaces_GetPlace_ResponseSyntax) **
Categories of results that results must belong to.
Type: Array of [Category](API_geoplaces_Category.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
** [Contacts](#API_geoplaces_GetPlace_ResponseSyntax) **
List of potential contact methods for the result/place. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: [Contacts](API_geoplaces_Contacts.md) object
** [FoodTypes](#API_geoplaces_GetPlace_ResponseSyntax) **
List of food types offered by this result. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Array of [FoodType](API_geoplaces_FoodType.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
** [MainAddress](#API_geoplaces_GetPlace_ResponseSyntax) **
The main address corresponding to a place of type Secondary Address. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: [RelatedPlace](API_geoplaces_RelatedPlace.md) object
** [MapView](#API_geoplaces_GetPlace_ResponseSyntax) **
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set of four coordinates: `[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]`
Type: Array of doubles
Array Members: Fixed number of 4 items.
** [OpeningHours](#API_geoplaces_GetPlace_ResponseSyntax) **
List of opening hours objects. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Array of [OpeningHours](API_geoplaces_OpeningHours.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
** [Phonemes](#API_geoplaces_GetPlace_ResponseSyntax) **
How the various components of the result's address are pronounced in various languages. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: [PhonemeDetails](API_geoplaces_PhonemeDetails.md) object
** [PlaceId](#API_geoplaces_GetPlace_ResponseSyntax) **
The `PlaceId` of the place you wish to receive the information for.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
** [PlaceType](#API_geoplaces_GetPlace_ResponseSyntax) **
A `PlaceType` is a category that the result place must belong to.
Type: String
Valid Values: `Country | Region | SubRegion | Locality | District | SubDistrict | PostalCode | Block | SubBlock | Intersection | Street | PointOfInterest | PointAddress | InterpolatedAddress | SecondaryAddress | InferredSecondaryAddress`
** [PoliticalView](#API_geoplaces_GetPlace_ResponseSyntax) **
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: String
Length Constraints: Fixed length of 3.
Pattern: `[A-Z]{3}`
** [Position](#API_geoplaces_GetPlace_ResponseSyntax) **
The position in World Geodetic System (WGS 84) format: [longitude, latitude].
Type: Array of doubles
Array Members: Fixed number of 2 items.
** [PostalCodeDetails](#API_geoplaces_GetPlace_ResponseSyntax) **
Contains details about the postal code of the place/result. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Type: Array of [PostalCodeDetails](API_geoplaces_PostalCodeDetails.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
** [SecondaryAddresses](#API_geoplaces_GetPlace_ResponseSyntax) **
All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information. Not available in `ap-southeast-1` and `ap-southeast-5` regions for [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html) customers.
Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
Type: Array of [RelatedPlace](API_geoplaces_RelatedPlace.md) objects
Array Members: Minimum number of 1 item.
** [TimeZone](#API_geoplaces_GetPlace_ResponseSyntax) **
The time zone in which the place is located.
Type: [TimeZone](API_geoplaces_TimeZone.md) object
** [Title](#API_geoplaces_GetPlace_ResponseSyntax) **
The localized display name of this result item based on request parameter `language`.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
You don't have sufficient access to perform this action.
HTTP Status Code: 403
** InternalServerException **
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
** ThrottlingException **
The request was denied due to request throttling.
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by an AWS service.
** FieldList **
Test stub for FieldList.
** Reason **
Test stub for reason
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/geo-places-2020-11-19/GetPlace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/geo-places-2020-11-19/GetPlace)