Amazon Location Service Maps V2

2024/10/30 - Amazon Location Service Maps V2 - 5 new api methods

Changes  Release of Amazon Location Maps API. Maps enables you to build digital maps that showcase your locations, visualize your data, and unlock insights to drive your business

GetStaticMap (new) Link ¶

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',
    CompactOverlay='string',
    GeoJsonOverlay='string',
    Height=123,
    Key='string',
    Padding=123,
    Radius=123,
    FileName='string',
    ScaleBarUnit='Kilometers'|'KilometersMiles'|'Miles'|'MilesKilometers',
    Style='Satellite',
    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 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 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 Padding:

integer

param Padding:

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

Example: 100

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 for the Style APIs.

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.

GetSprites (new) Link ¶

Returns the map's sprites.

See also: AWS API Documentation

Request Syntax

client.get_sprites(
    FileName='string',
    Style='Standard'|'Monochrome'|'Hybrid'|'Satellite',
    ColorScheme='Light'|'Dark',
    Variant='Default'
)
type FileName:

string

param FileName:

[REQUIRED]

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\.(png|json).

Example: sprites.png

type Style:

string

param Style:

[REQUIRED]

Style specifies the desired map style for the Sprites APIs.

type ColorScheme:

string

param ColorScheme:

[REQUIRED]

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

Example: Light

Default value: Light

type Variant:

string

param Variant:

[REQUIRED]

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

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

      The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

    • 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 sprite's Etag.

GetStyleDescriptor (new) Link ¶

Returns information about the style.

See also: AWS API Documentation

Request Syntax

client.get_style_descriptor(
    Style='Standard'|'Monochrome'|'Hybrid'|'Satellite',
    ColorScheme='Light'|'Dark',
    PoliticalView='string',
    Key='string'
)
type Style:

string

param Style:

[REQUIRED]

Style specifies the desired map style.

type ColorScheme:

string

param ColorScheme:

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

Example: Light

Default value: Light

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

  • PAK: Pakistan's view on Jammu and Kashmir and the Junagadh Area

  • 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 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.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

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

      This Blob contains the body of the style descriptor which is in application/json format.

    • 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 style descriptor's Etag.

GetGlyphs (new) Link ¶

Returns the map's glyphs.

See also: AWS API Documentation

Request Syntax

client.get_glyphs(
    FontStack='string',
    FontUnicodeRange='string'
)
type FontStack:

string

param FontStack:

[REQUIRED]

Name of the FontStack to retrieve.

Example: Amazon Ember Bold,Noto Sans Bold.

The supported font stacks are as follows:

  • Amazon Ember Bold

  • Amazon Ember Bold Italic

  • Amazon Ember Bold,Noto Sans Bold

  • Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold

  • Amazon Ember Condensed RC BdItalic

  • Amazon Ember Condensed RC Bold

  • Amazon Ember Condensed RC Bold Italic

  • Amazon Ember Condensed RC Bold,Noto Sans Bold

  • Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold

  • Amazon Ember Condensed RC Light

  • Amazon Ember Condensed RC Light Italic

  • Amazon Ember Condensed RC LtItalic

  • Amazon Ember Condensed RC Regular

  • Amazon Ember Condensed RC Regular Italic

  • Amazon Ember Condensed RC Regular,Noto Sans Regular

  • Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular

  • Amazon Ember Condensed RC RgItalic

  • Amazon Ember Condensed RC ThItalic

  • Amazon Ember Condensed RC Thin

  • Amazon Ember Condensed RC Thin Italic

  • Amazon Ember Heavy

  • Amazon Ember Heavy Italic

  • Amazon Ember Light

  • Amazon Ember Light Italic

  • Amazon Ember Medium

  • Amazon Ember Medium Italic

  • Amazon Ember Medium,Noto Sans Medium

  • Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium

  • Amazon Ember Regular

  • Amazon Ember Regular Italic

  • Amazon Ember Regular Italic,Noto Sans Italic

  • Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular

  • Amazon Ember Regular,Noto Sans Regular

  • Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular

  • Amazon Ember Thin

  • Amazon Ember Thin Italic

  • AmazonEmberCdRC_Bd

  • AmazonEmberCdRC_BdIt

  • AmazonEmberCdRC_Lt

  • AmazonEmberCdRC_LtIt

  • AmazonEmberCdRC_Rg

  • AmazonEmberCdRC_RgIt

  • AmazonEmberCdRC_Th

  • AmazonEmberCdRC_ThIt

  • AmazonEmber_Bd

  • AmazonEmber_BdIt

  • AmazonEmber_He

  • AmazonEmber_HeIt

  • AmazonEmber_Lt

  • AmazonEmber_LtIt

  • AmazonEmber_Md

  • AmazonEmber_MdIt

  • AmazonEmber_Rg

  • AmazonEmber_RgIt

  • AmazonEmber_Th

  • AmazonEmber_ThIt

  • Noto Sans Black

  • Noto Sans Black Italic

  • Noto Sans Bold

  • Noto Sans Bold Italic

  • Noto Sans Extra Bold

  • Noto Sans Extra Bold Italic

  • Noto Sans Extra Light

  • Noto Sans Extra Light Italic

  • Noto Sans Italic

  • Noto Sans Light

  • Noto Sans Light Italic

  • Noto Sans Medium

  • Noto Sans Medium Italic

  • Noto Sans Regular

  • Noto Sans Semi Bold

  • Noto Sans Semi Bold Italic

  • Noto Sans Thin

  • Noto Sans Thin Italic

  • NotoSans-Bold

  • NotoSans-Italic

  • NotoSans-Medium

  • NotoSans-Regular

  • Open Sans Regular,Arial Unicode MS Regular

type FontUnicodeRange:

string

param FontUnicodeRange:

[REQUIRED]

A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.

Example: 0-255.pdf

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

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

      The Glyph, as a binary blob.

    • 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 glyph's Etag.

GetTile (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.get_tile(
    Tileset='string',
    Z='string',
    X='string',
    Y='string',
    Key='string'
)
type Tileset:

string

param Tileset:

[REQUIRED]

Specifies the desired tile set.

Valid Values: raster.satellite | vector.basemap

type Z:

string

param Z:

[REQUIRED]

The zoom value for the map tile.

type X:

string

param X:

[REQUIRED]

The X axis value for the map tile. Must be between 0 and 19.

type Y:

string

param Y:

[REQUIRED]

The Y axis value for the map tile.

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.

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 vector tile in mvt format for the GetTile 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 pricing bucket for which the request is charged at.

    • PricingBucket (string) --

      The pricing bucket for which the request is charged at.