Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
get-static-map¶
Description¶
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.
See also: AWS API Documentation
Synopsis¶
get-static-map
[--bounding-box <value>]
[--bounded-positions <value>]
[--center <value>]
[--compact-overlay <value>]
[--geo-json-overlay <value>]
--height <value>
[--key <value>]
[--padding <value>]
[--radius <value>]
--file-name <value>
[--scale-bar-unit <value>]
[--style <value>]
--width <value>
[--zoom <value>]
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--bounding-box (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
--bounded-positions (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.
Note
Cannot be used withZoomand orRadiusExample: 97.170451,78.039098,99.045536,27.176178
--center (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.
Note
Cannot be used withZoomand orRadiusExample: 49.295,-123.108
--compact-overlay (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=#EE4B2BNote
Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
--geo-json-overlay (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 (integer)
Specifies the height of the map image.
--key (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 (integer)
Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.
Note
Value for max and min is determined by:
Min:
1Max:
min(height, width)/4Example:
100
--radius (long)
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:
1500Note
Cannot be used withZoom.Unit :
Meters
--file-name (string)
The map scaling parameter to size the image, icons, and labels. It follows the pattern of
^map(@2x)?$.Example:
map, map@2x
--scale-bar-unit (string)
Displays a scale on the bottom right of the map image with the unit specified in the input.
Example:
KilometersMiles, Miles, Kilometers, MilesKilometersPossible values:
KilometersKilometersMilesMilesMilesKilometers
--style (string)
Style specifies the desired map style for the
StyleAPIs.Possible values:
Satellite
--width (integer)
Specifies the width of the map image.
--zoom (float)
Specifies the zoom level of the map image.
Note
Cannot be used withRadius.
outfile (string)
Filename where the content will be saved
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
Blob -> (blob)
The blob represents a map image as ajpegfor theGetStaticMapAPI.
ContentType -> (string)
Header that represents the format of the response. The response returns the following as the HTTP body.
CacheControl -> (string)
Header that instructs caching configuration for the client.
ETag -> (string)
The static map's Etag.
PricingBucket -> (string)
The pricing bucket for which the request is charged at.