{ "version":"2.0", "metadata":{ "apiVersion":"2020-11-19", "auth":["aws.auth#sigv4"], "endpointPrefix":"geo-maps", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"Amazon Location Service Maps V2", "serviceId":"Geo Maps", "signatureVersion":"v4", "signingName":"geo-maps", "uid":"geo-maps-2020-11-19" }, "operations":{ "GetGlyphs":{ "name":"GetGlyphs", "http":{ "method":"GET", "requestUri":"/glyphs/{FontStack}/{FontUnicodeRange}", "responseCode":200 }, "input":{"shape":"GetGlyphsRequest"}, "output":{"shape":"GetGlyphsResponse"}, "documentation":"

GetGlyphs returns the map's glyphs.

For more information, see Style labels with glyphs in the Amazon Location Service Developer Guide.

", "readonly":true }, "GetSprites":{ "name":"GetSprites", "http":{ "method":"GET", "requestUri":"/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}", "responseCode":200 }, "input":{"shape":"GetSpritesRequest"}, "output":{"shape":"GetSpritesResponse"}, "documentation":"

GetSprites returns the map's sprites.

For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.

", "readonly":true }, "GetStaticMap":{ "name":"GetStaticMap", "http":{ "method":"GET", "requestUri":"/static/{FileName}", "responseCode":200 }, "input":{"shape":"GetStaticMapRequest"}, "output":{"shape":"GetStaticMapResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

For more information, see the following topics in the Amazon Location Service Developer Guide:

", "readonly":true }, "GetStyleDescriptor":{ "name":"GetStyleDescriptor", "http":{ "method":"GET", "requestUri":"/styles/{Style}/descriptor", "responseCode":200 }, "input":{"shape":"GetStyleDescriptorRequest"}, "output":{"shape":"GetStyleDescriptorResponse"}, "documentation":"

GetStyleDescriptor returns information about the style.

For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.

", "readonly":true }, "GetTile":{ "name":"GetTile", "http":{ "method":"GET", "requestUri":"/tiles/{Tileset}/{Z}/{X}/{Y}", "responseCode":200 }, "input":{"shape":"GetTileRequest"}, "output":{"shape":"GetTileResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], "documentation":"

GetTile returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

For more information, see Tiles in the Amazon Location Service Developer Guide.

", "readonly":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

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

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ApiKey":{ "type":"string", "max":1000, "min":0, "sensitive":true }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", "box":true }, "ColorScheme":{ "type":"string", "enum":[ "Light", "Dark" ] }, "CompactOverlay":{ "type":"string", "max":7000, "min":1, "sensitive":true }, "ContourDensity":{ "type":"string", "enum":["Medium"] }, "CountryCode":{ "type":"string", "max":3, "min":2, "pattern":"([A-Z]{2}|[A-Z]{3})", "sensitive":true }, "DistanceMeters":{ "type":"long", "max":4294967295, "min":0, "sensitive":true }, "GeoJsonOverlay":{ "type":"string", "max":7000, "min":1, "sensitive":true }, "GetGlyphsRequest":{ "type":"structure", "required":[ "FontStack", "FontUnicodeRange" ], "members":{ "FontStack":{ "shape":"GetGlyphsRequestFontStackString", "documentation":"

Name of the FontStack to retrieve.

Example: Amazon Ember Bold,Noto Sans Bold.

The supported font stacks are as follows:

", "location":"uri", "locationName":"FontStack" }, "FontUnicodeRange":{ "shape":"GetGlyphsRequestFontUnicodeRangeString", "documentation":"

A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.

Example: 0-255.pbf

", "location":"uri", "locationName":"FontUnicodeRange" } } }, "GetGlyphsRequestFontStackString":{ "type":"string", "max":1000, "min":0 }, "GetGlyphsRequestFontUnicodeRangeString":{ "type":"string", "max":50, "min":0, "pattern":"[0-9]+-[0-9]+\\.pbf" }, "GetGlyphsResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

The Glyph, as a binary blob.

" }, "ContentType":{ "shape":"String", "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

Header that instructs caching configuration for the client.

", "location":"header", "locationName":"Cache-Control" }, "ETag":{ "shape":"String", "documentation":"

The glyph's Etag.

", "location":"header", "locationName":"ETag" } }, "payload":"Blob" }, "GetSpritesRequest":{ "type":"structure", "required":[ "FileName", "Style", "ColorScheme", "Variant" ], "members":{ "FileName":{ "shape":"GetSpritesRequestFileNameString", "documentation":"

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\\.(png|json).

Example: sprites.png

", "location":"uri", "locationName":"FileName" }, "Style":{ "shape":"MapStyle", "documentation":"

Style specifies the desired map style for the Sprites APIs.

", "location":"uri", "locationName":"Style" }, "ColorScheme":{ "shape":"ColorScheme", "documentation":"

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "location":"uri", "locationName":"ColorScheme" }, "Variant":{ "shape":"Variant", "documentation":"

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

", "location":"uri", "locationName":"Variant" } } }, "GetSpritesRequestFileNameString":{ "type":"string", "pattern":"sprites(@2x)?\\.(png|json)" }, "GetSpritesResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

" }, "ContentType":{ "shape":"String", "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

Header that instructs caching configuration for the client.

", "location":"header", "locationName":"Cache-Control" }, "ETag":{ "shape":"String", "documentation":"

The sprite's Etag.

", "location":"header", "locationName":"ETag" } }, "payload":"Blob" }, "GetStaticMapRequest":{ "type":"structure", "required":[ "Height", "FileName", "Width" ], "members":{ "BoundingBox":{ "shape":"GetStaticMapRequestBoundingBoxString", "documentation":"

Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

Example: -123.17075,49.26959,-123.08125,49.31429

", "location":"querystring", "locationName":"bounding-box" }, "BoundedPositions":{ "shape":"GetStaticMapRequestBoundedPositionsString", "documentation":"

Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

", "location":"querystring", "locationName":"bounded-positions" }, "Center":{ "shape":"PositionString", "documentation":"

Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

", "location":"querystring", "locationName":"center" }, "ColorScheme":{ "shape":"ColorScheme", "documentation":"

Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "location":"querystring", "locationName":"color-scheme" }, "CompactOverlay":{ "shape":"CompactOverlay", "documentation":"

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

", "location":"querystring", "locationName":"compact-overlay" }, "CropLabels":{ "shape":"Boolean", "documentation":"

It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

", "location":"querystring", "locationName":"crop-labels" }, "GeoJsonOverlay":{ "shape":"GeoJsonOverlay", "documentation":"

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

Example: {\"type\":\"FeatureCollection\",\"features\": [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\": [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\": {\"color\":\"#00DD00\"}}]}

", "location":"querystring", "locationName":"geojson-overlay" }, "Height":{ "shape":"GetStaticMapRequestHeightInteger", "documentation":"

Specifies the height of the map image.

", "location":"querystring", "locationName":"height" }, "Key":{ "shape":"ApiKey", "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "location":"querystring", "locationName":"key" }, "LabelSize":{ "shape":"LabelSize", "documentation":"

Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

", "location":"querystring", "locationName":"label-size" }, "Language":{ "shape":"LanguageTag", "documentation":"

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

Supported codes:

", "location":"querystring", "locationName":"lang" }, "Padding":{ "shape":"GetStaticMapRequestPaddingInteger", "documentation":"

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

", "location":"querystring", "locationName":"padding" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

", "location":"querystring", "locationName":"political-view" }, "PointsOfInterests":{ "shape":"MapFeatureMode", "documentation":"

Determines if the result image will display icons representing points of interest on the map.

", "location":"querystring", "locationName":"pois" }, "Radius":{ "shape":"DistanceMeters", "documentation":"

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

Example: 1500

Cannot be used with Zoom.

Unit: Meters

", "box":true, "location":"querystring", "locationName":"radius" }, "FileName":{ "shape":"GetStaticMapRequestFileNameString", "documentation":"

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

Example: map, map@2x

", "location":"uri", "locationName":"FileName" }, "ScaleBarUnit":{ "shape":"ScaleBarUnit", "documentation":"

Displays a scale on the bottom right of the map image with the unit specified in the input.

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

", "location":"querystring", "locationName":"scale-unit" }, "Style":{ "shape":"StaticMapStyle", "documentation":"

Style specifies the desired map style.

", "location":"querystring", "locationName":"style" }, "Width":{ "shape":"GetStaticMapRequestWidthInteger", "documentation":"

Specifies the width of the map image.

", "location":"querystring", "locationName":"width" }, "Zoom":{ "shape":"GetStaticMapRequestZoomFloat", "documentation":"

Specifies the zoom level of the map image.

Cannot be used with Radius.

", "location":"querystring", "locationName":"zoom" } } }, "GetStaticMapRequestBoundedPositionsString":{ "type":"string", "max":2000, "min":0, "pattern":"(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?)(,(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?))*", "sensitive":true }, "GetStaticMapRequestBoundingBoxString":{ "type":"string", "max":100, "min":0, "pattern":"(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?)(,(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?))*", "sensitive":true }, "GetStaticMapRequestFileNameString":{ "type":"string", "pattern":"map(@2x)?" }, "GetStaticMapRequestHeightInteger":{ "type":"integer", "box":true, "max":1400, "min":64, "sensitive":true }, "GetStaticMapRequestPaddingInteger":{ "type":"integer", "box":true, "max":350, "min":0, "sensitive":true }, "GetStaticMapRequestWidthInteger":{ "type":"integer", "box":true, "max":1400, "min":64, "sensitive":true }, "GetStaticMapRequestZoomFloat":{ "type":"float", "box":true, "max":20, "min":0, "sensitive":true }, "GetStaticMapResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "Blob":{ "shape":"Blob", "documentation":"

The blob represents a map image as a jpeg for the GetStaticMap API.

" }, "ContentType":{ "shape":"String", "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

Header that instructs caching configuration for the client.

", "location":"header", "locationName":"Cache-Control" }, "ETag":{ "shape":"String", "documentation":"

The static map's Etag.

", "location":"header", "locationName":"ETag" }, "PricingBucket":{ "shape":"String", "documentation":"

The pricing bucket for which the request is charged at.

", "location":"header", "locationName":"x-amz-geo-pricing-bucket" } }, "payload":"Blob" }, "GetStyleDescriptorRequest":{ "type":"structure", "required":["Style"], "members":{ "Style":{ "shape":"MapStyle", "documentation":"

Style specifies the desired map style.

", "location":"uri", "locationName":"Style" }, "ColorScheme":{ "shape":"ColorScheme", "documentation":"

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", "location":"querystring", "locationName":"color-scheme" }, "PoliticalView":{ "shape":"CountryCode", "documentation":"

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

", "location":"querystring", "locationName":"political-view" }, "Terrain":{ "shape":"Terrain", "documentation":"

Adjusts how physical terrain details are rendered on the map.

The following terrain styles are currently supported:

This parameter is valid only for the Standard map style.

", "location":"querystring", "locationName":"terrain" }, "ContourDensity":{ "shape":"ContourDensity", "documentation":"

Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map.

This parameter is valid only for the Standard map style.

", "location":"querystring", "locationName":"contour-density" }, "Traffic":{ "shape":"Traffic", "documentation":"

Displays real-time traffic information overlay on map, such as incident events and flow events.

This parameter is valid only for the Standard map style.

", "location":"querystring", "locationName":"traffic" }, "TravelModes":{ "shape":"TravelModeList", "documentation":"

Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map.

This parameter is valid only for the Standard map style.

", "location":"querystring", "locationName":"travel-modes" }, "Key":{ "shape":"ApiKey", "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "location":"querystring", "locationName":"key" } } }, "GetStyleDescriptorResponse":{ "type":"structure", "members":{ "Blob":{ "shape":"Blob", "documentation":"

This Blob contains the body of the style descriptor which is in application/json format.

" }, "ContentType":{ "shape":"String", "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

Header that instructs caching configuration for the client.

", "location":"header", "locationName":"Cache-Control" }, "ETag":{ "shape":"String", "documentation":"

The style descriptor's Etag.

", "location":"header", "locationName":"ETag" } }, "payload":"Blob" }, "GetTileRequest":{ "type":"structure", "required":[ "Tileset", "Z", "X", "Y" ], "members":{ "AdditionalFeatures":{ "shape":"TileAdditionalFeatureList", "documentation":"

A list of optional additional parameters such as map styles that can be requested for each result.

", "location":"querystring", "locationName":"additional-features" }, "Tileset":{ "shape":"Tileset", "documentation":"

Specifies the desired tile set.

Valid Values: raster.satellite | vector.basemap

", "location":"uri", "locationName":"Tileset" }, "Z":{ "shape":"GetTileRequestZString", "documentation":"

The zoom value for the map tile.

", "location":"uri", "locationName":"Z" }, "X":{ "shape":"GetTileRequestXString", "documentation":"

The X axis value for the map tile. Must be between 0 and 19.

", "location":"uri", "locationName":"X" }, "Y":{ "shape":"GetTileRequestYString", "documentation":"

The Y axis value for the map tile.

", "location":"uri", "locationName":"Y" }, "Key":{ "shape":"ApiKey", "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", "location":"querystring", "locationName":"key" } } }, "GetTileRequestXString":{ "type":"string", "max":7, "min":0, "pattern":".*\\d+.*", "sensitive":true }, "GetTileRequestYString":{ "type":"string", "max":7, "min":0, "pattern":".*\\d+.*", "sensitive":true }, "GetTileRequestZString":{ "type":"string", "max":2, "min":0, "pattern":".*\\d+.*", "sensitive":true }, "GetTileResponse":{ "type":"structure", "required":["PricingBucket"], "members":{ "Blob":{ "shape":"Blob", "documentation":"

The blob represents a vector tile in mvt or a raster tile in an image format.

" }, "ContentType":{ "shape":"String", "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", "location":"header", "locationName":"Content-Type" }, "CacheControl":{ "shape":"String", "documentation":"

Header that instructs caching configuration for the client.

", "location":"header", "locationName":"Cache-Control" }, "ETag":{ "shape":"String", "documentation":"

The pricing bucket for which the request is charged at.

", "location":"header", "locationName":"ETag" }, "PricingBucket":{ "shape":"String", "documentation":"

The pricing bucket for which the request is charged at.

", "location":"header", "locationName":"x-amz-geo-pricing-bucket" } }, "payload":"Blob" }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "LabelSize":{ "type":"string", "enum":[ "Small", "Large" ] }, "LanguageTag":{ "type":"string", "max":35, "min":2 }, "MapFeatureMode":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "MapStyle":{ "type":"string", "enum":[ "Standard", "Monochrome", "Hybrid", "Satellite" ] }, "PositionString":{ "type":"string", "max":36, "min":3, "pattern":"-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?", "sensitive":true }, "ResourceNotFoundException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

Exception thrown when the associated resource could not be found.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ScaleBarUnit":{ "type":"string", "enum":[ "Kilometers", "KilometersMiles", "Miles", "MilesKilometers" ] }, "StaticMapStyle":{ "type":"string", "enum":[ "Satellite", "Standard" ] }, "String":{"type":"string"}, "Terrain":{ "type":"string", "enum":["Hillshade"] }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "locationName":"message" } }, "documentation":"

The request was denied due to request throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TileAdditionalFeature":{ "type":"string", "enum":[ "ContourLines", "Hillshade", "Logistics", "Transit" ] }, "TileAdditionalFeatureList":{ "type":"list", "member":{"shape":"TileAdditionalFeature"}, "max":4, "min":0 }, "Tileset":{ "type":"string", "max":100, "min":1, "pattern":"[-.\\w]+" }, "Traffic":{ "type":"string", "enum":["All"] }, "TravelMode":{ "type":"string", "enum":[ "Transit", "Truck" ] }, "TravelModeList":{ "type":"list", "member":{"shape":"TravelMode"}, "max":2, "min":0 }, "ValidationException":{ "type":"structure", "required":[ "Message", "Reason", "FieldList" ], "members":{ "Message":{ "shape":"String", "locationName":"message" }, "Reason":{ "shape":"ValidationExceptionReason", "documentation":"

The field where the invalid entry was detected.

", "locationName":"reason" }, "FieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

A message with the reason for the validation exception error.

", "locationName":"fieldList" } }, "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message" ], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the resource.

", "locationName":"name" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

The input fails to satisfy the constraints specified by the Amazon Location service.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "UnknownOperation", "Missing", "CannotParse", "FieldValidationFailed", "Other", "UnknownField" ] }, "Variant":{ "type":"string", "enum":["Default"] } }, "documentation":"

Integrate high-quality base map data into your applications using MapLibre. Capabilities include:

" }