Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetMapSprites

Important

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.

Request Syntax


GET /maps/v0/maps/MapName/sprites/FileName?key=Key HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FileName

The name of the sprite ﬁle. Use the following ﬁle 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 ﬁle names:

sprites.json
sprites@2x.json for high pixel density displays

Pattern: sprites(@2x)?\.(png|json)

Required: Yes

Key

The optional API key to authorize the request.

Length Constraints: Minimum length of 0. Maximum length of 1000.

MapName

The map resource associated with the sprite ﬁle.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-Type: ContentType
Cache-Control: CacheControl

Blob

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

CacheControl: The HTTP Cache-Control directive for the value.
ContentType: 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.

The response returns the following as the HTTP body.

Blob: Contains the body of the sprite sheet or JSON offset ﬁle.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

FieldList: The field where the invalid entry was detected.
Reason: A message with the reason for the validation exception error.

HTTP Status Code: 400