LocationService / Client / get_map_sprites

get_map_sprites

LocationService.Client.get_map_sprites(**kwargs)

Warning

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

  • GetMapSprites 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 GetSprites 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 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(
    MapName='string',
    FileName='string',
    Key='string'
)
Parameters:

  • MapName (string) –

    [REQUIRED]

    The map resource associated with the sprite file.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Blob (StreamingBody) –

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

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

    • CacheControl (string) –

      The HTTP Cache-Control directive for the value.

Exceptions