GetMapStyleDescriptor - Amazon Location Service

GetMapStyleDescriptor

Retrieves the map style descriptor from a map resource.

The style descriptor contains speciļ¬cations on how features render on a map. For example, what data to display, what order to display the data in, and the style for the data. Style descriptors follow the Mapbox Style Specification.

Request Syntax

GET /maps/v0/maps/MapName/style-descriptor?key=Key HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Key

The optional API key to authorize the request.

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

MapName

The map resource to retrieve the style descriptor from.

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 style descriptor's content type. For example, application/json.

The response returns the following as the HTTP body.

Blob

Contains the body of the style descriptor.

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.

HTTP Status Code: 400

See Also

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