LocationService / Client / get_map_tile

get_map_tile#

LocationService.Client.get_map_tile(**kwargs)#

Retrieves a vector data tile from the map resource. 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.

The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, so a tile containing data for the entire world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1).

See also: AWS API Documentation

Request Syntax

response = client.get_map_tile(
    Key='string',
    MapName='string',
    X='string',
    Y='string',
    Z='string'
)
Parameters:

  • Key (string) – The optional API key to authorize the request.

  • MapName (string) –

    [REQUIRED]

    The map resource to retrieve the map tiles from.

  • X (string) –

    [REQUIRED]

    The X axis value for the map tile.

  • Y (string) –

    [REQUIRED]

    The Y axis value for the map tile.

  • Z (string) –

    [REQUIRED]

    The zoom value for the map tile.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Blob (StreamingBody) –

      Contains Mapbox Vector Tile (MVT) data.

    • CacheControl (string) –

      The HTTP Cache-Control directive for the value.

    • ContentType (string) –

      The map tile’s content type. For example, application/vnd.mapbox-vector-tile.

Exceptions

  • LocationService.Client.exceptions.InternalServerException

  • LocationService.Client.exceptions.ResourceNotFoundException

  • LocationService.Client.exceptions.AccessDeniedException

  • LocationService.Client.exceptions.ValidationException

  • LocationService.Client.exceptions.ThrottlingException