Amazon Location Service Maps V2

{'ColorScheme': 'Light | Dark',
 'CropLabels': 'boolean',
 'LabelSize': 'Small | Large',
 'Language': 'string',
 'PointsOfInterests': 'Enabled | Disabled',
 'PoliticalView': 'string',
 'Style': {'Standard'}}

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.

See also: AWS API Documentation

Request Syntax

client.get_static_map(
    BoundingBox='string',
    BoundedPositions='string',
    Center='string',
    ColorScheme='Light'|'Dark',
    CompactOverlay='string',
    CropLabels=True|False,
    GeoJsonOverlay='string',
    Height=123,
    Key='string',
    LabelSize='Small'|'Large',
    Language='string',
    Padding=123,
    PoliticalView='string',
    PointsOfInterests='Enabled'|'Disabled',
    Radius=123,
    FileName='string',
    ScaleBarUnit='Kilometers'|'KilometersMiles'|'Miles'|'MilesKilometers',
    Style='Satellite'|'Standard',
    Width=123,
    Zoom=...
)

type BoundingBox:

string

param BoundingBox:

Takes in two pairs of coordinates, [Lon, Lat], 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

type BoundedPositions:

string

param BoundedPositions:

Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

Example: 97.170451,78.039098,99.045536,27.176178

type Center:

string

param Center:

Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

Example: 49.295,-123.108

type ColorScheme:

string

param ColorScheme:

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

Example: Light

Default value: Light

type CompactOverlay:

string

param CompactOverlay:

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

type CropLabels:

boolean

param CropLabels:

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.

type GeoJsonOverlay:

string

param GeoJsonOverlay:

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"}}]}

type Height:

integer

param Height:

[REQUIRED]

Specifies the height of the map image.

type Key:

string

param Key:

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

type LabelSize:

string

param LabelSize:

Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

type Language:

string

param Language:

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

type Padding:

integer

param Padding:

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

Example: 100

type PoliticalView:

string

param PoliticalView:

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

type PointsOfInterests:

string

param PointsOfInterests:

Determines if the result image will display icons representing points of interest on the map.

type Radius:

integer

param Radius:

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

Unit: Meters

type FileName:

string

param FileName:

[REQUIRED]

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

Example: map, map@2x

type ScaleBarUnit:

string

param ScaleBarUnit:

Displays a scale on the bottom right of the map image with the unit specified in the input.

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

type Style:

string

param Style:

Style specifies the desired map style.

type Width:

integer

param Width:

[REQUIRED]

Specifies the width of the map image.

type Zoom:

float

param Zoom:

Specifies the zoom level of the map image.

rtype:

dict

returns:

Response Syntax

{
    'Blob': StreamingBody(),
    'ContentType': 'string',
    'CacheControl': 'string',
    'ETag': 'string',
    'PricingBucket': 'string'
}

Response Structure

• (dict) --

  • Blob (:class:`.StreamingBody`) --

    The blob represents a map image as a jpeg for the GetStaticMap API.

  • ContentType (string) --

    Header that represents the format of the response. The response returns the following as the HTTP body.

  • CacheControl (string) --

    Header that instructs caching configuration for the client.

  • ETag (string) --

    The static map's Etag.

  • PricingBucket (string) --

    The pricing bucket for which the request is charged at.