AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Location Service Maps V2 GetStaticMap API operation.

Syntax

Get-GEOMStaticMap
-FileName <String>
-BoundedPosition <String>
-BoundingBox <String>
-Center <String>
-ColorScheme <ColorScheme>
-CompactOverlay <String>
-CropLabel <Boolean>
-GeoJsonOverlay <String>
-Height <Int32>
-Key <String>
-LabelSize <LabelSize>
-Language <String>
-Padding <Int32>
-PointsOfInterest <MapFeatureMode>
-PoliticalView <String>
-Radius <Int64>
-ScaleBarUnit <ScaleBarUnit>
-Style <StaticMapStyle>
-Width <Int32>
-Zoom <Single>
-Select <String>
-ClientConfig <AmazonGeoMapsConfig>

Description

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:

Parameters

-BoundedPosition <String>
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 RadiusExample: 97.170451,78.039098,99.045536,27.176178
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBoundedPositions
-BoundingBox <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Center <String>
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 RadiusExample: 49.295,-123.108
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonGeoMapsConfig>
Amazon.PowerShell.Cmdlets.GEOM.AmazonGeoMapsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ColorScheme <ColorScheme>
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: LightDefault value: LightValid values for ColorScheme are case sensitive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompactOverlay <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=#EE4B2BCurrently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CropLabel <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCropLabels
-FileName <String>
The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.Example: map, map@2x
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-GeoJsonOverlay <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"}}]}
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Height <Int32>
Specifies the height of the map image.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LabelSize <LabelSize>
Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Language <String>
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:
  • ar
  • as
  • az
  • be
  • bg
  • bn
  • bs
  • ca
  • cs
  • cy
  • da
  • de
  • el
  • en
  • es
  • et
  • eu
  • fi
  • fo
  • fr
  • ga
  • gl
  • gn
  • gu
  • he
  • hi
  • hr
  • hu
  • hy
  • id
  • is
  • it
  • ja
  • ka
  • kk
  • km
  • kn
  • ko
  • ky
  • lt
  • lv
  • mk
  • ml
  • mr
  • ms
  • mt
  • my
  • nl
  • no
  • or
  • pa
  • pl
  • pt
  • ro
  • ru
  • sk
  • sl
  • sq
  • sr
  • sv
  • ta
  • te
  • th
  • tr
  • uk
  • uz
  • vi
  • zh
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Padding <Int32>
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: 1Max: min(height, width)/4Example: 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PointsOfInterest <MapFeatureMode>
Determines if the result image will display icons representing points of interest on the map.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPointsOfInterests
-PoliticalView <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
  • 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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Radius <Int64>
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: 1500Cannot be used with Zoom.Unit: Meters
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScaleBarUnit <ScaleBarUnit>
Displays a scale on the bottom right of the map image with the unit specified in the input. Example: KilometersMiles, Miles, Kilometers, MilesKilometers
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GeoMaps.Model.GetStaticMapResponse). Specifying the name of a property of type Amazon.GeoMaps.Model.GetStaticMapResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
Style specifies the desired map style.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Width <Int32>
Specifies the width of the map image.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Zoom <Single>
Specifies the zoom level of the map image.Cannot be used with Radius.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.GeoMaps.Model.GetStaticMapResponse object containing multiple properties.

Supported Version

AWS Tools for PowerShell: 2.x.y.z