Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeMap

Retrieves the map resource details.

Request Syntax


GET /maps/v0/maps/MapName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MapName

The name of the map resource.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Configuration": { 
      "PoliticalView": "string",
      "Style": "string"
   },
   "CreateTime": "string",
   "DataSource": "string",
   "Description": "string",
   "MapArn": "string",
   "MapName": "string",
   "PricingPlan": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Configuration

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

Type: MapConfiguration object

CreateTime

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

Type: Timestamp

DataSource

Specifies the data provider for the associated map tiles.

Type: String

Description

The optional description for the map resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

MapArn

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

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1600.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))

MapName

The map style selected from an available provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

PricingPlan

This parameter has been deprecated.

No longer used. Always returns RequestBasedUsage.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

Tags

Tags associated with the map resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

UpdateTime

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

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400