GetStyleDescriptor - Amazon Location Service
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetStyleDescriptor

GetStyleDescriptor returns information about the style.

Request Syntax

GET /styles/Style/descriptor?color-scheme=ColorScheme&key=Key&political-view=PoliticalView 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: Light

Default value: Light

Note

Valid values for ColorScheme are case sensitive.

Valid Values: Light | Dark

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.

PoliticalView

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

  • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

  • EGY: Egypt's view on Bir Tawil

  • IND: India's view on Gilgit-Baltistan

  • KEN: Kenya's view on the Ilemi Triangle

  • MAR: Morocco's view on Western Sahara

  • RUS: Russia's view on Crimea

  • SDN: Sudan's view on the Halaib Triangle

  • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

  • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

  • SYR: Syria's view on the Golan Heights

  • TUR: Turkey's view on Cyprus and Northern Cyprus

  • TZA: Tanzania's view on Lake Malawi

  • URY: Uruguay's view on Rincon de Artigas

  • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

Length Constraints: Minimum length of 2. Maximum length of 3.

Pattern: ([A-Z]{2}|[A-Z]{3})

Style

Style specifies the desired map style.

Valid Values: Standard | Monochrome | Hybrid | Satellite

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

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 style descriptor's Etag.

The response returns the following as the HTTP body.

Blob

This Blob contains the body of the style descriptor which is in application/json format.

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: