Amazon Location Service

2024/01/10 - Amazon Location Service - 3 updated api methods

Changes  This release adds API support for custom layers for the maps service APIs: CreateMap, UpdateMap, DescribeMap.

CreateMap (updated) Link ¶
Changes (request) 
{'Configuration': {'CustomLayers': ['string']}}

Creates a map resource in your Amazon Web Services account, which provides map tiles of different styles sourced from global location data providers.

See also: AWS API Documentation

Request Syntax

client.create_map(
    Configuration={
        'CustomLayers': [
            'string',
        ],
        'PoliticalView': 'string',
        'Style': 'string'
    },
    Description='string',
    MapName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    Tags={
        'string': 'string'
    }
)
type Configuration:

dict

param Configuration:

[REQUIRED]

Specifies the MapConfiguration, including the map style, for the map resource that you create. The map style defines the look of maps and the data provider for your map resource.

  • 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.

    • (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.

  • Style (string) -- [REQUIRED]

    Specifies the map style selected from an available data provider.

    Valid Esri map styles:

    • 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.

    • 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.

    • 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.

    Valid HERE Technologies map styles:

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

    • 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.

    • 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.

    • 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.

    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.

    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.

type Description:

string

param Description:

An optional description for the map resource.

type MapName:

string

param MapName:

[REQUIRED]

The name for the map resource.

Requirements:

  • Must contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

  • Must be a unique map resource name.

  • No spaces allowed. For example, ExampleMap.

type PricingPlan:

string

param PricingPlan:

No longer used. If included, the only allowed value is RequestBasedUsage.

type Tags:

dict

param Tags:

Applies one or more tags to the map resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

  • Cannot use "aws:" as a prefix for a key.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'CreateTime': datetime(2015, 1, 1),
    'MapArn': 'string',
    'MapName': 'string'
}

Response Structure

  • (dict) --

    • CreateTime (datetime) --

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

    • 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 name of the map resource.

DescribeMap (updated) Link ¶
Changes (response) 
{'Configuration': {'CustomLayers': ['string']}}

Retrieves the map resource details.

See also: AWS API Documentation

Request Syntax

client.describe_map(
    MapName='string'
)
type MapName:

string

param MapName:

[REQUIRED]

The name of the map resource.

rtype:

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.

        • (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.

      • Style (string) --

        Specifies the map style selected from an available data provider.

        Valid Esri map styles:

        • 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.

        • 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.

        • 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.

        Valid HERE Technologies map styles:

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

        • 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.

        • 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.

        • 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.

        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.

        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.

UpdateMap (updated) Link ¶
Changes (request) 
{'ConfigurationUpdate': {'CustomLayers': ['string']}}

Updates the specified properties of a given map resource.

See also: AWS API Documentation

Request Syntax

client.update_map(
    ConfigurationUpdate={
        'CustomLayers': [
            'string',
        ],
        'PoliticalView': 'string'
    },
    Description='string',
    MapName='string',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement'
)
type ConfigurationUpdate:

dict

param ConfigurationUpdate:

Updates the parts of the map configuration that can be updated, including the political view.

  • 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.

    • (string) --

  • PoliticalView (string) --

    Specifies the political view for the style. Set to an empty string 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.

type Description:

string

param Description:

Updates the description for the map resource.

type MapName:

string

param MapName:

[REQUIRED]

The name of the map resource to update.

type PricingPlan:

string

param PricingPlan:

No longer used. If included, the only allowed value is RequestBasedUsage.

rtype:

dict

returns:

Response Syntax

{
    'MapArn': 'string',
    'MapName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • MapArn (string) --

      The Amazon Resource Name (ARN) of the updated map resource. Used to specify a resource across AWS.

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

    • MapName (string) --

      The name of the updated map resource.

    • UpdateTime (datetime) --

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