GetTile - Amazon Location Service

GetTile

GetTile returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

Request Syntax

GET /tiles/Tileset/Z/X/Y?key=Key HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Key

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

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

Tileset

Specifies the desired tile set.

Valid Values: raster.satellite | vector.basemap

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

Pattern: [-.\w]+

Required: Yes

X

The X axis value for the map tile. Must be between 0 and 19.

Pattern: .*\d+.*

Required: Yes

Y

The Y axis value for the map tile.

Pattern: .*\d+.*

Required: Yes

Z

The zoom value for the map tile.

Pattern: .*\d+.*

Required: 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 x-amz-geo-pricing-bucket: PricingBucket Blob

Response 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 pricing bucket for which the request is charged at.

PricingBucket

The pricing bucket for which the request is charged at.

The response returns the following as the HTTP body.

Blob

The blob represents a vector tile in mvt or a raster tile in an image format.

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 processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: