LocationServiceMapsV2 / Client / get_tile

get_tile#

LocationServiceMapsV2.Client.get_tile(**kwargs)#

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

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

  • Tileset (string) –

    [REQUIRED]

    Specifies the desired tile set.

    Valid Values: raster.satellite | vector.basemap

  • Z (string) –

    [REQUIRED]

    The zoom value for the map tile.

  • X (string) –

    [REQUIRED]

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

  • Y (string) –

    [REQUIRED]

    The Y axis value for the map tile.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

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

Exceptions

  • LocationServiceMapsV2.Client.exceptions.InternalServerException

  • LocationServiceMapsV2.Client.exceptions.AccessDeniedException

  • LocationServiceMapsV2.Client.exceptions.ValidationException

  • LocationServiceMapsV2.Client.exceptions.ThrottlingException