sprites

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

Overview

Name	sprites
Type	Resource
Id	aws.geo_maps.sprites

Fields

The following fields are returned by SELECT queries:

get_sprites

Name	Datatype	Description
blob	string (byte)	The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).
cache_control	string	Header that instructs caching configuration for the client.
content_type	string	Header that represents the format of the response. The response returns the following as the HTTP body.
e_tag	string	The sprite's Etag.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sprites	select	file_name, style, color_scheme, variant, region		GetSprites returns the map's sprites. For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.

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
color_scheme	string	Sets the color tone for the map sprites, such as dark and light. Example: Light Default value: Light Valid values for ColorScheme are case sensitive.
file_name	string	Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?.(png|json). Example: sprites.png
region	string	AWS region (default: us-east-1)
style	string	Style specifies the desired map style for the Sprites APIs.
variant	string	Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style. Example: Default Valid values for Variant are case sensitive.

SELECT examples

get_sprites

GetSprites returns the map's sprites. For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.

SELECT
blob,
cache_control,
content_type,
e_tag
FROM aws.geo_maps.sprites
WHERE file_name = '{{ file_name }}' -- required
AND style = '{{ style }}' -- required
AND color_scheme = '{{ color_scheme }}' -- required
AND variant = '{{ variant }}' -- required
AND region = '{{ region }}' -- required
;