Amazon Location Service Maps V2 2020-11-19
- Client: Aws\GeoMaps\GeoMapsClient
- Service ID: geo-maps
- Version: 2020-11-19
This page describes the parameters and results for the operations of the Amazon Location Service Maps V2 (2020-11-19), and shows how to use the Aws\GeoMaps\GeoMapsClient object to call the described operations. This documentation is specific to the 2020-11-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- GetGlyphs ( array $params = [] )
- Returns the map's glyphs.
- GetSprites ( array $params = [] )
- Returns the map's sprites.
- GetStaticMap ( array $params = [] )
- Provides high-quality static map images with customizable options.
- GetStyleDescriptor ( array $params = [] )
- Returns information about the style.
- GetTile ( array $params = [] )
- Returns a tile.
Operations
GetGlyphs
$result = $client->getGlyphs
([/* ... */]); $promise = $client->getGlyphsAsync
([/* ... */]);
Returns the map's glyphs.
Parameter Syntax
$result = $client->getGlyphs([ 'FontStack' => '<string>', // REQUIRED 'FontUnicodeRange' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FontStack
-
- Required: Yes
- Type: string
Name of the
FontStack
to retrieve.Example:
Amazon Ember Bold,Noto Sans Bold
.The supported font stacks are as follows:
-
Amazon Ember Bold
-
Amazon Ember Bold Italic
-
Amazon Ember Bold,Noto Sans Bold
-
Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
-
Amazon Ember Condensed RC BdItalic
-
Amazon Ember Condensed RC Bold
-
Amazon Ember Condensed RC Bold Italic
-
Amazon Ember Condensed RC Bold,Noto Sans Bold
-
Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold
-
Amazon Ember Condensed RC Light
-
Amazon Ember Condensed RC Light Italic
-
Amazon Ember Condensed RC LtItalic
-
Amazon Ember Condensed RC Regular
-
Amazon Ember Condensed RC Regular Italic
-
Amazon Ember Condensed RC Regular,Noto Sans Regular
-
Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular
-
Amazon Ember Condensed RC RgItalic
-
Amazon Ember Condensed RC ThItalic
-
Amazon Ember Condensed RC Thin
-
Amazon Ember Condensed RC Thin Italic
-
Amazon Ember Heavy
-
Amazon Ember Heavy Italic
-
Amazon Ember Light
-
Amazon Ember Light Italic
-
Amazon Ember Medium
-
Amazon Ember Medium Italic
-
Amazon Ember Medium,Noto Sans Medium
-
Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
-
Amazon Ember Regular
-
Amazon Ember Regular Italic
-
Amazon Ember Regular Italic,Noto Sans Italic
-
Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
-
Amazon Ember Regular,Noto Sans Regular
-
Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
-
Amazon Ember Thin
-
Amazon Ember Thin Italic
-
AmazonEmberCdRC_Bd
-
AmazonEmberCdRC_BdIt
-
AmazonEmberCdRC_Lt
-
AmazonEmberCdRC_LtIt
-
AmazonEmberCdRC_Rg
-
AmazonEmberCdRC_RgIt
-
AmazonEmberCdRC_Th
-
AmazonEmberCdRC_ThIt
-
AmazonEmber_Bd
-
AmazonEmber_BdIt
-
AmazonEmber_He
-
AmazonEmber_HeIt
-
AmazonEmber_Lt
-
AmazonEmber_LtIt
-
AmazonEmber_Md
-
AmazonEmber_MdIt
-
AmazonEmber_Rg
-
AmazonEmber_RgIt
-
AmazonEmber_Th
-
AmazonEmber_ThIt
-
Noto Sans Black
-
Noto Sans Black Italic
-
Noto Sans Bold
-
Noto Sans Bold Italic
-
Noto Sans Extra Bold
-
Noto Sans Extra Bold Italic
-
Noto Sans Extra Light
-
Noto Sans Extra Light Italic
-
Noto Sans Italic
-
Noto Sans Light
-
Noto Sans Light Italic
-
Noto Sans Medium
-
Noto Sans Medium Italic
-
Noto Sans Regular
-
Noto Sans Semi Bold
-
Noto Sans Semi Bold Italic
-
Noto Sans Thin
-
Noto Sans Thin Italic
-
NotoSans-Bold
-
NotoSans-Italic
-
NotoSans-Medium
-
NotoSans-Regular
-
Open Sans Regular,Arial Unicode MS Regular
- FontUnicodeRange
-
- Required: Yes
- Type: string
A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.
Example:
0-255.pdf
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'CacheControl' => '<string>', 'ContentType' => '<string>', 'ETag' => '<string>', ]
Result Details
Members
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The Glyph, as a binary blob.
- CacheControl
-
- Type: string
Header that instructs caching configuration for the client.
- ContentType
-
- Type: string
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
- Type: string
The glyph's Etag.
Errors
There are no errors described for this operation.
GetSprites
$result = $client->getSprites
([/* ... */]); $promise = $client->getSpritesAsync
([/* ... */]);
Returns the map's sprites.
Parameter Syntax
$result = $client->getSprites([ 'ColorScheme' => 'Light|Dark', // REQUIRED 'FileName' => '<string>', // REQUIRED 'Style' => 'Standard|Monochrome|Hybrid|Satellite', // REQUIRED 'Variant' => 'Default', // REQUIRED ]);
Parameter Details
Members
- ColorScheme
-
- Required: Yes
- Type: string
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.
- FileName
-
- Required: Yes
- Type: string
Sprites
API: The name of the sprite file to retrieve, following patternsprites(@2x)?\.(png|json)
.Example:
sprites.png
- Style
-
- Required: Yes
- Type: string
Style specifies the desired map style for the
Sprites
APIs. - Variant
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'CacheControl' => '<string>', 'ContentType' => '<string>', 'ETag' => '<string>', ]
Result Details
Members
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).
- CacheControl
-
- Type: string
Header that instructs caching configuration for the client.
- ContentType
-
- Type: string
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
- Type: string
The sprite's Etag.
Errors
There are no errors described for this operation.
GetStaticMap
$result = $client->getStaticMap
([/* ... */]); $promise = $client->getStaticMapAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getStaticMap([ 'BoundedPositions' => '<string>', 'BoundingBox' => '<string>', 'Center' => '<string>', 'CompactOverlay' => '<string>', 'FileName' => '<string>', // REQUIRED 'GeoJsonOverlay' => '<string>', 'Height' => <integer>, // REQUIRED 'Key' => '<string>', 'Padding' => <integer>, 'Radius' => <integer>, 'ScaleBarUnit' => 'Kilometers|KilometersMiles|Miles|MilesKilometers', 'Style' => 'Satellite', 'Width' => <integer>, // REQUIRED 'Zoom' => <float>, ]);
Parameter Details
Members
- BoundedPositions
-
- Type: string
Takes in two or more pair of coordinates, [Lon, Lat], 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 orRadius
Example: 97.170451,78.039098,99.045536,27.176178
- BoundingBox
-
- Type: string
Takes in two pairs of coordinates, [Lon, Lat], 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
- Center
-
- Type: string
Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.
Cannot be used with
Zoom
and orRadius
Example: 49.295,-123.108
- CompactOverlay
-
- Type: string
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.
- FileName
-
- Required: Yes
- Type: string
The map scaling parameter to size the image, icons, and labels. It follows the pattern of
^map(@2x)?$
.Example:
map, map@2x
- GeoJsonOverlay
-
- Type: string
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"}}]}
- Height
-
- Required: Yes
- Type: int
Specifies the height of the map image.
- Key
-
- Type: string
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
- Padding
-
- Type: int
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
- Radius
-
- Type: long (int|float)
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
- ScaleBarUnit
-
- Type: string
Displays a scale on the bottom right of the map image with the unit specified in the input.
Example:
KilometersMiles, Miles, Kilometers, MilesKilometers
- Style
-
- Type: string
Style specifies the desired map style for the
Style
APIs. - Width
-
- Required: Yes
- Type: int
Specifies the width of the map image.
- Zoom
-
- Type: float
Specifies the zoom level of the map image.
Cannot be used with
Radius
.
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'CacheControl' => '<string>', 'ContentType' => '<string>', 'ETag' => '<string>', 'PricingBucket' => '<string>', ]
Result Details
Members
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The blob represents a map image as a
jpeg
for theGetStaticMap
API. - CacheControl
-
- Type: string
Header that instructs caching configuration for the client.
- ContentType
-
- Type: string
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
- Type: string
The static map's Etag.
- PricingBucket
-
- Required: Yes
- Type: string
The pricing bucket for which the request is charged at.
Errors
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
GetStyleDescriptor
$result = $client->getStyleDescriptor
([/* ... */]); $promise = $client->getStyleDescriptorAsync
([/* ... */]);
Returns information about the style.
Parameter Syntax
$result = $client->getStyleDescriptor([ 'ColorScheme' => 'Light|Dark', 'Key' => '<string>', 'PoliticalView' => '<string>', 'Style' => 'Standard|Monochrome|Hybrid|Satellite', // REQUIRED ]);
Parameter Details
Members
- ColorScheme
-
- Type: string
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.
- Key
-
- Type: string
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
- PoliticalView
-
- Type: string
Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
PAK
: Pakistan's view on Jammu and Kashmir and the Junagadh Area -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
- Style
-
- Required: Yes
- Type: string
Style specifies the desired map style.
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'CacheControl' => '<string>', 'ContentType' => '<string>', 'ETag' => '<string>', ]
Result Details
Members
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
This Blob contains the body of the style descriptor which is in application/json format.
- CacheControl
-
- Type: string
Header that instructs caching configuration for the client.
- ContentType
-
- Type: string
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
- Type: string
The style descriptor's Etag.
Errors
There are no errors described for this operation.
GetTile
$result = $client->getTile
([/* ... */]); $promise = $client->getTileAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->getTile([ 'Key' => '<string>', 'Tileset' => '<string>', // REQUIRED 'X' => '<string>', // REQUIRED 'Y' => '<string>', // REQUIRED 'Z' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Key
-
- Type: string
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
- Tileset
-
- Required: Yes
- Type: string
Specifies the desired tile set.
Valid Values:
raster.satellite | vector.basemap
- X
-
- Required: Yes
- Type: string
The X axis value for the map tile. Must be between 0 and 19.
- Y
-
- Required: Yes
- Type: string
The Y axis value for the map tile.
- Z
-
- Required: Yes
- Type: string
The zoom value for the map tile.
Result Syntax
[ 'Blob' => <string || resource || Psr\Http\Message\StreamInterface>, 'CacheControl' => '<string>', 'ContentType' => '<string>', 'ETag' => '<string>', 'PricingBucket' => '<string>', ]
Result Details
Members
- Blob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The blob represents a vector tile in
mvt
format for theGetTile
API. - CacheControl
-
- Type: string
Header that instructs caching configuration for the client.
- ContentType
-
- Type: string
Header that represents the format of the response. The response returns the following as the HTTP body.
- ETag
-
- Type: string
The pricing bucket for which the request is charged at.
- PricingBucket
-
- Required: Yes
- Type: string
The pricing bucket for which the request is charged at.
Errors
- InternalServerException:
The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException:
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
The request was denied due to request throttling.
Shapes
AccessDeniedException
Description
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
Members
- Message
-
- Required: Yes
- Type: string
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
- Message
-
- Required: Yes
- Type: string
ThrottlingException
Description
The request was denied due to request throttling.
Members
- Message
-
- Required: Yes
- Type: string
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- FieldList
-
- Required: Yes
- Type: Array of ValidationExceptionField structures
A message with the reason for the validation exception error.
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Required: Yes
- Type: string
The field where thebb invalid entry was detected.
ValidationExceptionField
Description
The input fails to satisfy the constraints specified by the Amazon Location service.
Members
- Message
-
- Required: Yes
- Type: string
The error message.
- Name
-
- Required: Yes
- Type: string
The name of the resource.