LocationServiceMapsV2 / Client / get_style_descriptor

get_style_descriptor

LocationServiceMapsV2.Client.get_style_descriptor(**kwargs)

GetStyleDescriptor returns information about the style.

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

See also: AWS API Documentation

Request Syntax

response = client.get_style_descriptor(
    Style='Standard'|'Monochrome'|'Hybrid'|'Satellite',
    ColorScheme='Light'|'Dark',
    PoliticalView='string',
    Terrain='Hillshade',
    ContourDensity='Medium',
    Traffic='All',
    TravelModes=[
        'Transit'|'Truck',
    ],
    Key='string'
)
Parameters:

  • Style (string) –

    [REQUIRED]

    Style specifies the desired map style.

  • ColorScheme (string) –

    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.

  • PoliticalView (string) –

    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

  • Terrain (string) –

    Adjusts how physical terrain details are rendered on the map.

    The following terrain styles are currently supported:

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

    This parameter is valid only for the Standard map style.

  • ContourDensity (string) –

    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.

    This parameter is valid only for the Standard map style.

  • Traffic (string) –

    Displays real-time traffic information overlay on map, such as incident events and flow events.

    This parameter is valid only for the Standard map style.

  • TravelModes (list) –

    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.

    This parameter is valid only for the Standard map style.

    • (string) –

  • Key (string) – Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Return type:

dict

Returns:

Response Syntax

{
    'Blob': StreamingBody(),
    'ContentType': 'string',
    'CacheControl': 'string',
    'ETag': 'string'
}

Response Structure

  • (dict) –

    • Blob (StreamingBody) –

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

    • ContentType (string) –

      Header that represents the format of the response. The response returns the following as the HTTP body.

    • CacheControl (string) –

      Header that instructs caching configuration for the client.

    • ETag (string) –

      The style descriptor’s Etag.