nearbies
Creates, updates, deletes, gets or lists a nearbies resource.
Overview
| Name | nearbies |
| Type | Resource |
| Id | aws.geo_places.nearbies |
Fields
The following fields are returned by SELECT queries:
- search_nearby
| Name | Datatype | Description |
|---|---|---|
next_token | string | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. |
pricing_bucket | string | The pricing bucket for which the query is charged at. For more information on pricing, please visit Amazon Location Service Pricing. |
result_items | array | List of places or results returned for a query. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
search_nearby | select | region | key | SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see Search Nearby 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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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. |
SELECT examples
- search_nearby
SearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see Search Nearby in the Amazon Location Service Developer Guide.
SELECT
next_token,
pricing_bucket,
result_items
FROM aws.geo_places.nearbies
WHERE region = '{{ region }}' -- required
AND key = '{{ key }}'
;