View a markdown version of this page

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

GetStyleDescriptor

GetStyleDescriptor returns information about the style.

For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.

Request Syntax

GET /v2/styles/Style/descriptor?buildings=Buildings&color-scheme=ColorScheme&contour-density=ContourDensity&key=Key&poi-categories=PoiCategories&poi-density=PoiDensity&political-view=PoliticalView&terrain=Terrain&traffic=Traffic&travel-modes=TravelModes HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Buildings

Adjusts how building details are rendered on the map.

The following building styles are currently supported:

  • Buildings3D: Displays buildings as three-dimensional extrusions on the map.

Buildings3D is valid only for the Standard and Monochrome map styles.

Valid Values: Buildings3D

ColorScheme

Sets the color tone for the map, such as dark and light.

Example: Light

Default value: Light

Note

Valid values for ColorScheme are case sensitive.

Valid Values: Light | Dark

ContourDensity

Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

Valid Values: Low | Medium | High

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.

PoiCategories

Renders only the specified categories of points of interest. When you omit this parameter, the map renders all categories.

The following categories are currently supported:

  • FoodAndDrink

  • Entertainment

  • SightsAndMuseums

  • Transportation

  • Accommodations

  • LeisureAndOutdoor

  • Shopping

  • BusinessAndServices

  • FacilitiesAndBuildings

Specify each category as a separate poi-categories query parameter. Duplicate values are rejected.

Note

This parameter has no effect when poi-density is set to Off, which hides all points of interest regardless of category.

This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

Array Members: Minimum number of 0 items. Maximum number of 9 items.

Valid Values: FoodAndDrink | Entertainment | SightsAndMuseums | Transportation | Accommodations | LeisureAndOutdoor | Shopping | BusinessAndServices | FacilitiesAndBuildings

PoiDensity

Controls how densely points of interest are rendered on the map. The density value controls the zoom level at which each category of points of interest appears, and how quickly less prominent points of interest are revealed as you zoom in. Denser values display more points of interest at lower zoom levels.

Use Off to hide all points of interest. When you omit this parameter, the map renders at Default density.

Note

The difference between density values is most noticeable at mid-range zoom levels. At high zoom levels, all density values converge on displaying every available point of interest.

This parameter is valid only for the Standard and Hybrid map styles. In ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers, this parameter is valid only for the Standard map style.

Valid Values: Off | VerySparse | Sparse | Default | Dense | VeryDense

PoliticalView

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the Standard and Monochrome values.

Valid Values: Standard | Monochrome | Hybrid | Satellite

Required: Yes

Terrain

Adjusts how physical terrain details are rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

The following terrain styles are currently supported:

  • Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.

  • Terrain3D: Displays physical terrain details and elevations as a three-dimensional model.

Hillshade is valid only for the Standard and Monochrome map styles.

Valid Values: Hillshade | Terrain3D

Traffic

Displays real-time traffic information overlay on map, such as incident events and flow events. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

Valid Values: All | Congestion

TravelModes

Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

This parameter is valid for all map styles except Satellite.

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Valid Values: Transit | Truck

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 Error Types.

See Also

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