LocationService / Client / get_map_sprites

get_map_sprites#

LocationService.Client.get_map_sprites(**kwargs)#

Retrieves the sprite sheet corresponding to a map resource. The sprite sheet is a PNG image paired with a JSON document describing the offsets of individual icons that will be displayed on a rendered map.

See also: AWS API Documentation

Request Syntax

response = client.get_map_sprites(
    FileName='string',
    Key='string',
    MapName='string'
)
Parameters:

  • FileName (string) –

    [REQUIRED]

    The name of the sprite file. Use the following file names for the sprite sheet:

    • sprites.png

    • sprites@2x.png for high pixel density displays

    For the JSON document containing image offsets. Use the following file names:

    • sprites.json

    • sprites@2x.json for high pixel density displays

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

  • MapName (string) –

    [REQUIRED]

    The map resource associated with the sprite file.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Blob (StreamingBody) –

      Contains the body of the sprite sheet or JSON offset file.

    • CacheControl (string) –

      The HTTP Cache-Control directive for the value.

    • ContentType (string) –

      The content type of the sprite sheet and offsets. For example, the sprite sheet content type is image/png, and the sprite offset JSON document is application/json.

Exceptions