Skip to content

Describe Map

locationservice_describe_map R Documentation

This operation is no longer current and may be deprecated in the future

Description

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.

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

Retrieves the map resource details.

Usage

locationservice_describe_map(MapName)

Arguments

MapName

[required] The name of the map resource.

Value

A list with the following syntax:

list(
  MapName = "string",
  MapArn = "string",
  PricingPlan = "RequestBasedUsage"|"MobileAssetTracking"|"MobileAssetManagement",
  DataSource = "string",
  Configuration = list(
    Style = "string",
    PoliticalView = "string",
    CustomLayers = list(
      "string"
    )
  ),
  Description = "string",
  Tags = list(
    "string"
  ),
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_map(
  MapName = "string"
)