v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458290352.8 KB

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.

get/maps/v0/maps/{MapName}/sprites/{FileName}

Path parameters

FileNamestring required
<p>The name of the sprite file. Use the following file names for the sprite sheet:</p> <ul> <li> <p> <code>sprites.png</code> </p> </li> <li> <p> <code>sprites@2x.png</code> for high pixel density displays</p> </li> </ul> <p>For the JSON document containing image offsets. Use the following file names:</p> <ul> <li> <p> <code>sprites.json</code> </p> </li> <li> <p> <code>sprites@2x.json</code> for high pixel density displays</p> </li> </ul>
MapNamestring required

The map resource associated with the sprite file.

Query parameters

keystring password

The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.

Response

Success

Blobstring

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