GetSprites
GetSprites returns the map's sprites.
For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.
Request Syntax
GET /styles/Style/ColorScheme/Variant/sprites/FileName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ColorScheme
-
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:
LightDefault value:
LightNote
Valid values for ColorScheme are case sensitive.
Valid Values:
Light | DarkRequired: Yes
- FileName
-
SpritesAPI: The name of the sprite file to retrieve, following patternsprites(@2x)?\.(png|json).Example:
sprites.pngPattern:
sprites(@2x)?\.(png|json)Required: Yes
- Style
-
Style specifies the desired map style for the
SpritesAPIs.Valid Values:
Standard | Monochrome | Hybrid | SatelliteRequired: Yes
- Variant
-
Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.
Example:
DefaultNote
Valid values for Variant are case sensitive.
Valid Values:
DefaultRequired: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-Type: ContentType
Cache-Control: CacheControl
ETag: ETag
BlobResponse Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- CacheControl
-
Header that instructs caching configuration for the client.
- ContentType
-
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
The sprite's Etag.
The response returns the following as the HTTP body.
- Blob
-
The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
