places

Creates, updates, deletes, gets or lists a places resource.

Overview

Name	places
Type	Resource
Id	aws.geo_places.places

Fields

The following fields are returned by SELECT queries:

get_place

Name	Datatype	Description
access_points	array	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 customers.
access_restrictions	array	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 customers.
address	object	The place address.
address_number_corrected	boolean	Boolean indicating if the address provided has been corrected. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
business_chains	array	The Business Chains associated with the place.
categories	array	Categories of results that results must belong to.
contacts	object	List of potential contact methods for the result/place. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
cross_references	array	The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.
estimated_point_address	boolean	If true, indicates that the coordinates of the position and access points of the point address are estimated.
food_types	array	List of food types offered by this result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
main_address	object	Place that is related to the result item.
map_view	array	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}]
opening_hours	array	List of opening hours objects. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
phonemes	object	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 customers.
place_attributes	array	A list of place attributes for the result, such as whether the business offers drive-through service.
place_id	string	The PlaceId of the place you wish to receive the information for.
place_type	string	A PlaceType is a category that the result place must belong to. (Country, Region, SubRegion, Locality, District, SubDistrict, PostalCode, Block, SubBlock, Intersection, Street, PointOfInterest, PointAddress, InterpolatedAddress, SecondaryAddress, InferredSecondaryAddress)
political_view	string	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 customers. (pattern: <code>[A-Z]{3}</code>)
position	array	The position in World Geodetic System (WGS 84) format: [longitude, latitude].
postal_code_details	array	Contains details about the postal code of the place/result. Not available in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.
pricing_bucket	string	The pricing bucket for which the query is charged at. For more information on pricing, please visit Amazon Location Service Pricing.
secondary_addresses	array	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 customers. Coverage for this functionality is available in the following countries: AUS, CAN, NZL, USA, PRI.
time_zone	object	The time zone in which the place is located.
title	string	The localized display name of this result item based on request parameter language.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_place	select	place_id, region	additional-features, language, political-view, intended-use, key, address-names-mode	GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations. For more information, see GetPlace in the Amazon Location Service Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
place_id	string	The PlaceId of the place you wish to receive the information for.
region	string	AWS region (default: us-east-1)
additional-features	array	A list of optional additional parameters such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.
address-names-mode	string	Specifies how address names are returned. When set to Administrative, the service returns the official administrative names for address components. Administrative currently applies only to addresses in the United States.
intended-use	string	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 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 and service pricing structure to determine the correct setting for your use case.
key	string	Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
language	string	A list of BCP 47 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 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
political-view	string	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 customers.

SELECT examples

get_place

GetPlace finds a place by its unique ID. A PlaceId is returned by other place operations. For more information, see GetPlace in the Amazon Location Service Developer Guide.

SELECT
access_points,
access_restrictions,
address,
address_number_corrected,
business_chains,
categories,
contacts,
cross_references,
estimated_point_address,
food_types,
main_address,
map_view,
opening_hours,
phonemes,
place_attributes,
place_id,
place_type,
political_view,
position,
postal_code_details,
pricing_bucket,
secondary_addresses,
time_zone,
title
FROM aws.geo_places.places
WHERE place_id = '{{ place_id }}' -- required
AND region = '{{ region }}' -- required
AND `additional-features` = '{{ additional-features }}'
AND language = '{{ language }}'
AND `political-view` = '{{ political-view }}'
AND `intended-use` = '{{ intended-use }}'
AND key = '{{ key }}'
AND `address-names-mode` = '{{ address-names-mode }}'
;