[ aws . location ]

describe-map

Description

Retrieves the map resource details.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-map
--map-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--map-name (string)

The name of the map resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Configuration -> (structure)

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

Style -> (string)

Specifies the map style selected from an available data provider.

Valid styles: VectorEsriStreets , VectorEsriTopographic , VectorEsriNavigation , VectorEsriDarkGrayCanvas , VectorEsriLightGrayCanvas , VectorHereBerlin .

Note

When using HERE as your data provider, and selecting the Style VectorHereBerlin , you may not use HERE Maps for Asset Management. See the AWS Service Terms for Amazon Location Service.

CreateTime -> (timestamp)

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 when you need to specify a resource across all AWS.

MapName -> (string)

The map style selected from an available provider.

UpdateTime -> (timestamp)

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