LocationService / Client / describe_map

describe_map#

LocationService.Client.describe_map(**kwargs)#

Retrieves the map resource details.

See also: AWS API Documentation

Request Syntax

response = client.describe_map(
    MapName='string'
)
Parameters:

MapName (string) –

[REQUIRED]

The name of the map resource.

Return type:

dict

Returns:

Response Syntax

{
    'Configuration': {
        'CustomLayers': [
            'string',
        ],
        'PoliticalView': 'string',
        'Style': 'string'
    },
    'CreateTime': datetime(2015, 1, 1),
    'DataSource': 'string',
    'Description': 'string',
    'MapArn': 'string',
    'MapName': 'string',
    'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    'Tags': {
        'string': 'string'
    },
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • Configuration (dict) –

      Specifies the map tile style selected from a partner data provider.

      • CustomLayers (list) –

        Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style. Default is unset.

        Note

        Currenlty only VectorEsriNavigation supports CustomLayers. For more information, see Custom Layers.

        • (string) –

      • PoliticalView (string) –

        Specifies the political view for the style. Leave unset to not use a political view, or, for styles that support specific political views, you can choose a view, such as IND for the Indian view.

        Default is unset.

        Note

        Not all map resources or styles support political view styles. See Political views for more information.

      • Style (string) –

        Specifies the map style selected from an available data provider.

        Valid Esri map styles:

        • VectorEsriNavigation – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that’s designed for use during the day in mobile devices. It also includes a richer set of places, such as shops, services, restaurants, attractions, and other points of interest. Enable the POI layer by setting it in CustomLayers to leverage the additional places data.

        • RasterEsriImagery – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.

        • VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that’s designed to draw attention to your thematic content.

        • VectorEsriTopographic – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.

        • VectorEsriStreets – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.

        • VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that’s designed to draw attention to your thematic content.

        Valid HERE Technologies map styles:

        • VectorHereExplore – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.

        • RasterHereExploreSatellite – A global map containing high resolution satellite imagery.

        • HybridHereExploreSatellite – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.

        Note

        Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.

        • VectorHereContrast – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.

        Note

        The VectorHereContrast style has been renamed from VectorHereBerlin. VectorHereBerlin has been deprecated, but will continue to work in applications that use it.

        • VectorHereExploreTruck – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.

        Valid GrabMaps map styles:

        • VectorGrabStandardLight – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.

        • VectorGrabStandardDark – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.

        Note

        Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( ap-southeast-1). For more information, see GrabMaps countries and area covered.

        Valid Open Data map styles:

        • VectorOpenDataStandardLight – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.

        • VectorOpenDataStandardDark – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.

        • VectorOpenDataVisualizationLight – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.

        • VectorOpenDataVisualizationDark – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data.

    • CreateTime (datetime) –

      The timestamp for when the map resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

    • DataSource (string) –

      Specifies the data provider for the associated map tiles.

    • Description (string) –

      The optional description for the map resource.

    • MapArn (string) –

      The Amazon Resource Name (ARN) for the map resource. Used to specify a resource across all Amazon Web Services.

      • Format example: arn:aws:geo:region:account-id:map/ExampleMap

    • MapName (string) –

      The map style selected from an available provider.

    • PricingPlan (string) –

      No longer used. Always returns RequestBasedUsage.

    • Tags (dict) –

      Tags associated with the map resource.

      • (string) –

        • (string) –

    • UpdateTime (datetime) –

      The timestamp for when the map resource was last update in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Exceptions

  • LocationService.Client.exceptions.InternalServerException

  • LocationService.Client.exceptions.ResourceNotFoundException

  • LocationService.Client.exceptions.AccessDeniedException

  • LocationService.Client.exceptions.ValidationException

  • LocationService.Client.exceptions.ThrottlingException