LocationService / Client / get_map_tile

get_map_tile

LocationService.Client.get_map_tile(**kwargs)

Warning

This operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data.

  • GetMapTile is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).

  • The version 2 GetTile operation gives a better user experience and is compatible with the remainder of the V2 Maps API.

  • If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location.

  • Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab.

  • Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.

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(
    MapName='string',
    Z='string',
    X='string',
    Y='string',
    Key='string'
)
Parameters:

  • MapName (string) –

    [REQUIRED]

    The map resource to retrieve the map tiles from.

  • Z (string) –

    [REQUIRED]

    The zoom value for the map tile.

  • X (string) –

    [REQUIRED]

    The X axis value for the map tile.

  • Y (string) –

    [REQUIRED]

    The Y axis value for the map tile.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Blob (StreamingBody) –

      Contains Mapbox Vector Tile (MVT) data.

    • ContentType (string) –

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

    • CacheControl (string) –

      The HTTP Cache-Control directive for the value.

Exceptions