LocationServiceMapsV2 ********************* Client ====== class LocationServiceMapsV2.Client A low-level client representing Amazon Location Service Maps V2 Integrate high-quality base map data into your applications using MapLibre. Capabilities include: * Access to comprehensive base map data, allowing you to tailor the map display to your specific needs. * Multiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization. * Generation of static map images for scenarios where interactive maps aren't suitable, such as: * Embedding in emails or documents * Displaying in low-bandwidth environments * Creating printable maps * Enhancing application performance by reducing client-side rendering import boto3 client = boto3.client('geo-maps') These are the available methods: * can_paginate * close * get_glyphs * get_paginator * get_sprites * get_static_map * get_style_descriptor * get_tile * get_waiter LocationServiceMapsV2 / Client / get_paginator get_paginator ************* LocationServiceMapsV2.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. LocationServiceMapsV2 / Client / get_sprites get_sprites *********** LocationServiceMapsV2.Client.get_sprites(**kwargs) "GetSprites" returns the map's sprites. See also: AWS API Documentation **Request Syntax** response = client.get_sprites( FileName='string', Style='Standard'|'Monochrome'|'Hybrid'|'Satellite', ColorScheme='Light'|'Dark', Variant='Default' ) Parameters: * **FileName** (*string*) -- **[REQUIRED]** "Sprites" API: The name of the sprite file to retrieve, following pattern "sprites(@2x)?\.(png|json)". Example: "sprites.png" * **Style** (*string*) -- **[REQUIRED]** Style specifies the desired map style for the "Sprites" APIs. * **ColorScheme** (*string*) -- **[REQUIRED]** 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" Note: Valid values for ColorScheme are case sensitive. * **Variant** (*string*) -- **[REQUIRED]** Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style. Example: "Default" Note: Valid values for Variant are case sensitive. Return type: dict Returns: **Response Syntax** { 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Blob** ("StreamingBody") -- The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input). * **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 sprite's Etag. LocationServiceMapsV2 / Client / can_paginate can_paginate ************ LocationServiceMapsV2.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. LocationServiceMapsV2 / Client / get_glyphs get_glyphs ********** LocationServiceMapsV2.Client.get_glyphs(**kwargs) "GetGlyphs" returns the map's glyphs. See also: AWS API Documentation **Request Syntax** response = client.get_glyphs( FontStack='string', FontUnicodeRange='string' ) Parameters: * **FontStack** (*string*) -- **[REQUIRED]** 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** (*string*) -- **[REQUIRED]** A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256. Example: "0-255.pdf" Return type: dict Returns: **Response Syntax** { 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Blob** ("StreamingBody") -- The Glyph, as a binary blob. * **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 glyph's Etag. LocationServiceMapsV2 / Client / get_style_descriptor get_style_descriptor ******************** LocationServiceMapsV2.Client.get_style_descriptor(**kwargs) "GetStyleDescriptor" returns information about the style. See also: AWS API Documentation **Request Syntax** response = client.get_style_descriptor( Style='Standard'|'Monochrome'|'Hybrid'|'Satellite', ColorScheme='Light'|'Dark', PoliticalView='string', Key='string' ) Parameters: * **Style** (*string*) -- **[REQUIRED]** Style specifies the desired map style. * **ColorScheme** (*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" Note: Valid values for ColorScheme are case sensitive. * **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 * **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. Return type: dict Returns: **Response Syntax** { 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string' } **Response Structure** * *(dict) --* * **Blob** ("StreamingBody") -- This Blob contains the body of the style descriptor which is in application/json format. * **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 style descriptor's Etag. LocationServiceMapsV2 / Client / get_static_map get_static_map ************** LocationServiceMapsV2.Client.get_static_map(**kwargs) "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. See also: AWS API Documentation **Request Syntax** response = client.get_static_map( BoundingBox='string', BoundedPositions='string', Center='string', ColorScheme='Light'|'Dark', CompactOverlay='string', CropLabels=True|False, GeoJsonOverlay='string', Height=123, Key='string', LabelSize='Small'|'Large', Language='string', Padding=123, PoliticalView='string', PointsOfInterests='Enabled'|'Disabled', Radius=123, FileName='string', ScaleBarUnit='Kilometers'|'KilometersMiles'|'Miles'|'MilesKilometers', Style='Satellite'|'Standard', Width=123, Zoom=... ) Parameters: * **BoundingBox** (*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 * **BoundedPositions** (*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 with "Zoom" and or "Radius" Example: 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 with "Zoom" and or "Radius" Example: 49.295,-123.108 * **ColorScheme** (*string*) -- 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" Note: Valid values for "ColorScheme" are case sensitive. * **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;co lor=%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" Note: Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon. * **CropLabels** (*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. * **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":"F eature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}" * **Height** (*integer*) -- **[REQUIRED]** 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. * **LabelSize** (*string*) -- Overrides the label size auto- calculated by "FileName". Takes in one of the values - "Small" or "Large". * **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" * **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: "1"Max: "min(height, width)/4" Example: "100" * **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 * **PointsOfInterests** (*string*) -- Determines if the result image will display icons representing points of interest on the map. * **Radius** (*integer*) -- 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" Note: Cannot be used with "Zoom". **Unit**: "Meters" * **FileName** (*string*) -- **[REQUIRED]** The map scaling parameter to size the image, icons, and labels. It follows the pattern of "^map(@2x)?$". Example: "map, map@2x" * **ScaleBarUnit** (*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** (*string*) -- "Style" specifies the desired map style. * **Width** (*integer*) -- **[REQUIRED]** Specifies the width of the map image. * **Zoom** (*float*) -- Specifies the zoom level of the map image. Note: Cannot be used with "Radius". Return type: dict Returns: **Response Syntax** { 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string', 'PricingBucket': 'string' } **Response Structure** * *(dict) --* * **Blob** ("StreamingBody") -- The blob represents a map image as a "jpeg" for the "GetStaticMap" API. * **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. **Exceptions** * "LocationServiceMapsV2.Client.exceptions.InternalServerException" * "LocationServiceMapsV2.Client.exceptions.AccessDeniedException" * "LocationServiceMapsV2.Client.exceptions.ValidationException" * "LocationServiceMapsV2.Client.exceptions.ThrottlingException" LocationServiceMapsV2 / Client / get_waiter get_waiter ********** LocationServiceMapsV2.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" LocationServiceMapsV2 / Client / get_tile get_tile ******** LocationServiceMapsV2.Client.get_tile(**kwargs) "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. See also: AWS API Documentation **Request Syntax** response = client.get_tile( Tileset='string', Z='string', X='string', Y='string', Key='string' ) Parameters: * **Tileset** (*string*) -- **[REQUIRED]** Specifies the desired tile set. Valid Values: "raster.satellite | vector.basemap" * **Z** (*string*) -- **[REQUIRED]** The zoom value for the map tile. * **X** (*string*) -- **[REQUIRED]** The X axis value for the map tile. Must be between 0 and 19. * **Y** (*string*) -- **[REQUIRED]** The Y axis value for the map tile. * **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. Return type: dict Returns: **Response Syntax** { 'Blob': StreamingBody(), 'ContentType': 'string', 'CacheControl': 'string', 'ETag': 'string', 'PricingBucket': 'string' } **Response Structure** * *(dict) --* * **Blob** ("StreamingBody") -- The blob represents a vector tile in "mvt" or a raster tile in an image format. * **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 pricing bucket for which the request is charged at. * **PricingBucket** *(string) --* The pricing bucket for which the request is charged at. **Exceptions** * "LocationServiceMapsV2.Client.exceptions.InternalServerException" * "LocationServiceMapsV2.Client.exceptions.AccessDeniedException" * "LocationServiceMapsV2.Client.exceptions.ValidationException" * "LocationServiceMapsV2.Client.exceptions.ThrottlingException" LocationServiceMapsV2 / Client / close close ***** LocationServiceMapsV2.Client.close() Closes underlying endpoint connections.