static_maps

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

Overview

Name	static_maps
Type	Resource
Id	aws.geo_maps.static_maps

Fields

The following fields are returned by SELECT queries:

get_static_map

Name	Datatype	Description
blob	string (byte)	The blob represents a map image as a jpeg for the GetStaticMap API.
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 static map's Etag.
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_static_map	select	height, file_name, width, region	bounding-box, bounded-positions, center, color-scheme, compact-overlay, crop-labels, geojson-overlay, key, label-size, lang, padding, political-view, pois, radius, scale-unit, style, zoom	GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see the following topics in the Amazon Location Service Developer Guide: Static maps Customize static maps Overlay on the static map

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
file_name	string	The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$. Example: map, map@2x
height	integer	Specifies the height of the map image.
region	string	AWS region (default: us-east-1)
width	integer	Specifies the width of the map image.
bounded-positions	string	Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates. Cannot be used with Zoom and or Radius Example: 97.170451,78.039098,99.045536,27.176178
bounding-box	string	Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image. Example: -123.17075,49.26959,-123.08125,49.31429
center	string	Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set. Cannot be used with Zoom and or Radius Example: 49.295,-123.108
color-scheme	string	Sets the color tone for the map, such as dark and light. Example: Light Default value: Light Valid values for ColorScheme are case sensitive.
compact-overlay	string	Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat] Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
crop-labels	boolean	It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.
geojson-overlay	string	Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object. Example: {"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}
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.
label-size	string	Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.
lang	string	Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language. Supported codes: ar as az be bg bn bs ca cs cy da de el en es et eu fi fo fr ga gl gn gu he hi hr hu hy id is it ja ka kk km kn ko ky lt lv mk ml mr ms mt my nl no or pa pl pt ro ru sk sl sq sr sv ta te th tr uk uz vi zh
padding	integer	Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured. Value for max and min is determined by: Min: 1 Max: min(height, width)/4 Example: 100
pois	string	Determines if the result image will display icons representing points of interest on the map.
political-view	string	Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format. The following political views are currently supported: ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands EGY: Egypt's view on Bir Tawil IND: India's view on Gilgit-Baltistan KEN: Kenya's view on the Ilemi Triangle MAR: Morocco's view on Western Sahara RUS: Russia's view on Crimea SDN: Sudan's view on the Halaib Triangle SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters SYR: Syria's view on the Golan Heights TUR: Turkey's view on Cyprus and Northern Cyprus TZA: Tanzania's view on Lake Malawi URY: Uruguay's view on Rincon de Artigas VNM: Vietnam's view on the Paracel Islands and Spratly Islands
radius	integer (int64)	Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1. Example: 1500 Cannot be used with Zoom. Unit: Meters
scale-unit	string	Displays a scale on the bottom right of the map image with the unit specified in the input. Example: KilometersMiles, Miles, Kilometers, MilesKilometers
style	string	Style specifies the desired map style.
zoom	number (float)	Specifies the zoom level of the map image. Cannot be used with Radius.

SELECT examples

get_static_map

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. For more information, see the following topics in the Amazon Location Service Developer Guide: Static maps Customize static maps Overlay on the static map

SELECT
blob,
cache_control,
content_type,
e_tag,
pricing_bucket
FROM aws.geo_maps.static_maps
WHERE height = '{{ height }}' -- required
AND file_name = '{{ file_name }}' -- required
AND width = '{{ width }}' -- required
AND region = '{{ region }}' -- required
AND `bounding-box` = '{{ bounding-box }}'
AND `bounded-positions` = '{{ bounded-positions }}'
AND center = '{{ center }}'
AND `color-scheme` = '{{ color-scheme }}'
AND `compact-overlay` = '{{ compact-overlay }}'
AND `crop-labels` = '{{ crop-labels }}'
AND `geojson-overlay` = '{{ geojson-overlay }}'
AND key = '{{ key }}'
AND `label-size` = '{{ label-size }}'
AND lang = '{{ lang }}'
AND padding = '{{ padding }}'
AND `political-view` = '{{ political-view }}'
AND pois = '{{ pois }}'
AND radius = '{{ radius }}'
AND `scale-unit` = '{{ scale-unit }}'
AND style = '{{ style }}'
AND zoom = '{{ zoom }}'
;