LocationServiceMapsV2 / Client / get_sprites
get_sprites#
- LocationServiceMapsV2.Client.get_sprites(**kwargs)#
Returns the map’s sprites.
See also: AWS API Documentation
Request Syntax
response = client.get_sprites( FileName='string', Style='Standard'|'Monochrome'|'Hybrid'|'Satellite', ColorScheme='Light'|'Dark', Variant='Default' )
- Parameters:
FileName (string) –
[REQUIRED]
Sprites
API: The name of the sprite file to retrieve, following patternsprites(@2x)?\.(png|json)
.Example:
sprites.png
Style (string) –
[REQUIRED]
Style specifies the desired map style for the
Sprites
APIs.ColorScheme (string) –
[REQUIRED]
Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
Example:
Light
Default value:
Light
Note
Valid values for ColorScheme are case sensitive.
Variant (string) –
[REQUIRED]
Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.
Example:
Default
Note
Valid values for Variant are case sensitive.
- Return type:
dict
- Returns:
Response Syntax
{ 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string' }
Response Structure
(dict) –
Blob (
StreamingBody
) –The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).
ContentType (string) –
Header that represents the format of the response. The response returns the following as the HTTP body.
CacheControl (string) –
Header that instructs caching configuration for the client.
ETag (string) –
The sprite’s Etag.