tiles
Creates, updates, deletes, gets or lists a tiles resource.
Overview
| Name | tiles |
| Type | Resource |
| Id | aws.geo_maps.tiles |
Fields
The following fields are returned by SELECT queries:
- get_tile
| Name | Datatype | Description |
|---|---|---|
blob | string (byte) | The blob represents a vector tile in mvt or a raster tile in an image format. |
cache_control | string | Header that instructs caching configuration for the client. |
content_type | string | Header that represents the format of the response. The response returns the following as the HTTP body. |
e_tag | string | The pricing bucket for which the request is charged at. |
pricing_bucket | string | The pricing bucket for which the request is charged at. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_tile | select | tileset, z, x, y, region | additional-features, key | GetTile returns a tile. Map tiles are used by clients to render a map. They're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. For more information, see Tiles 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) |
tileset | string | Specifies the desired tile set. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the vector.basemap value. Valid Values: raster.satellite | vector.basemap | vector.traffic | raster.dem |
x | string | The X axis value for the map tile. |
y | string | The Y axis value for the map tile. |
z | string | The zoom value for the map tile. |
additional-features | array | A list of optional additional parameters such as map styles that can be requested for each result. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. |
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
- get_tile
GetTile returns a tile. Map tiles are used by clients to render a map. They're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level. For more information, see Tiles in the Amazon Location Service Developer Guide.
SELECT
blob,
cache_control,
content_type,
e_tag,
pricing_bucket
FROM aws.geo_maps.tiles
WHERE tileset = '{{ tileset }}' -- required
AND z = '{{ z }}' -- required
AND x = '{{ x }}' -- required
AND y = '{{ y }}' -- required
AND region = '{{ region }}' -- required
AND `additional-features` = '{{ additional-features }}'
AND key = '{{ key }}'
;