map_sprites

Creates, updates, deletes, gets or lists a map_sprites resource.

Overview

Name	map_sprites
Type	Resource
Id	aws.location.map_sprites

Fields

The following fields are returned by SELECT queries:

get_map_sprites

Name	Datatype	Description
blob	string (byte)	Contains the body of the sprite sheet or JSON offset file.
cache_control	string	The HTTP Cache-Control directive for the value.
content_type	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_map_sprites	select	map_name, file_name, region	key	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
file_name	string	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
map_name	string	The map resource associated with the sprite file.
region	string	AWS region (default: us-east-1)
key	string	The optional API key to authorize the request.

SELECT examples

get_map_sprites

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.

SELECT
blob,
cache_control,
content_type
FROM aws.location.map_sprites
WHERE map_name = '{{ map_name }}' -- required
AND file_name = '{{ file_name }}' -- required
AND region = '{{ region }}' -- required
AND key = '{{ key }}'
;