LocationService / Client / update_map

update_map

LocationService.Client.update_map(**kwargs)

Warning

This operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data.

  • UpdateMap is part of a previous Amazon Location Service Maps API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2).

  • The Maps API version 2 has a simplified interface that can be used without creating or managing map resources.

  • If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is found under geo-maps or geo_maps, not under location.

  • Since Grab is not yet fully supported in Maps API version 2, we recommend you continue using API version 1 when using Grab.

  • Start your version 2 API journey with the Maps V2 API Reference or the Developer Guide.

Updates the specified properties of a given map resource.

See also: AWS API Documentation

Request Syntax

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

  • MapName (string) –

    [REQUIRED]

    The name of the map resource to update.

  • PricingPlan (string) – No longer used. If included, the only allowed value is RequestBasedUsage.

  • Description (string) – Updates the description for the map resource.

  • ConfigurationUpdate (dict) –

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

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

      Note

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

    • 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

      Not all map resources or styles support custom layers. See Custom Layers for more information.

      • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • MapName (string) –

      The name of the updated map resource.

    • 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

    • UpdateTime (datetime) –

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

Exceptions