LocationServiceMapsV2Client

Index > LocationServiceMapsV2 > LocationServiceMapsV2Client

Auto-generated documentation for LocationServiceMapsV2 type annotations stubs module mypy-boto3-geo-maps.

LocationServiceMapsV2Client

Type annotations and code completion for boto3.client("geo-maps"). boto3 documentation

# LocationServiceMapsV2Client usage example

from boto3.session import Session
from mypy_boto3_geo_maps.client import LocationServiceMapsV2Client

def get_geo-maps_client() -> LocationServiceMapsV2Client:
    return Session().client("geo-maps")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("geo-maps").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("geo-maps")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_geo_maps.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("geo-maps").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("geo-maps").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("geo-maps").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_glyphs

Returns the map's glyphs.

Type annotations and code completion for boto3.client("geo-maps").get_glyphs method. boto3 documentation

# get_glyphs method definition

def get_glyphs(
    self,
    *,
    FontStack: str,
    FontUnicodeRange: str,
) -> GetGlyphsResponseTypeDef:  # (1)
    ...

1. See GetGlyphsResponseTypeDef

# get_glyphs method usage example with argument unpacking

kwargs: GetGlyphsRequestRequestTypeDef = {  # (1)
    "FontStack": ...,
    "FontUnicodeRange": ...,
}

parent.get_glyphs(**kwargs)

1. See GetGlyphsRequestRequestTypeDef

get_sprites

Returns the map's sprites.

Type annotations and code completion for boto3.client("geo-maps").get_sprites method. boto3 documentation

# get_sprites method definition

def get_sprites(
    self,
    *,
    FileName: str,
    Style: MapStyleType,  # (1)
    ColorScheme: ColorSchemeType,  # (2)
    Variant: VariantType,  # (3)
) -> GetSpritesResponseTypeDef:  # (4)
    ...

1. See MapStyleType
2. See ColorSchemeType
3. See VariantType
4. See GetSpritesResponseTypeDef

# get_sprites method usage example with argument unpacking

kwargs: GetSpritesRequestRequestTypeDef = {  # (1)
    "FileName": ...,
    "Style": ...,
    "ColorScheme": ...,
    "Variant": ...,
}

parent.get_sprites(**kwargs)

1. See GetSpritesRequestRequestTypeDef

get_static_map

Provides high-quality static map images with customizable options.

Type annotations and code completion for boto3.client("geo-maps").get_static_map method. boto3 documentation

# get_static_map method definition

def get_static_map(
    self,
    *,
    Height: int,
    FileName: str,
    Width: int,
    BoundingBox: str = ...,
    BoundedPositions: str = ...,
    Center: str = ...,
    CompactOverlay: str = ...,
    GeoJsonOverlay: str = ...,
    Key: str = ...,
    Padding: int = ...,
    Radius: int = ...,
    ScaleBarUnit: ScaleBarUnitType = ...,  # (1)
    Style: StaticMapStyleType = ...,  # (2)
    Zoom: float = ...,
) -> GetStaticMapResponseTypeDef:  # (3)
    ...

1. See ScaleBarUnitType
2. See StaticMapStyleType
3. See GetStaticMapResponseTypeDef

# get_static_map method usage example with argument unpacking

kwargs: GetStaticMapRequestRequestTypeDef = {  # (1)
    "Height": ...,
    "FileName": ...,
    "Width": ...,
}

parent.get_static_map(**kwargs)

1. See GetStaticMapRequestRequestTypeDef

get_style_descriptor

Returns information about the style.

Type annotations and code completion for boto3.client("geo-maps").get_style_descriptor method. boto3 documentation

# get_style_descriptor method definition

def get_style_descriptor(
    self,
    *,
    Style: MapStyleType,  # (1)
    ColorScheme: ColorSchemeType = ...,  # (2)
    PoliticalView: str = ...,
    Key: str = ...,
) -> GetStyleDescriptorResponseTypeDef:  # (3)
    ...

1. See MapStyleType
2. See ColorSchemeType
3. See GetStyleDescriptorResponseTypeDef

# get_style_descriptor method usage example with argument unpacking

kwargs: GetStyleDescriptorRequestRequestTypeDef = {  # (1)
    "Style": ...,
}

parent.get_style_descriptor(**kwargs)

1. See GetStyleDescriptorRequestRequestTypeDef

get_tile

Returns a tile.

Type annotations and code completion for boto3.client("geo-maps").get_tile method. boto3 documentation

# get_tile method definition

def get_tile(
    self,
    *,
    Tileset: str,
    Z: str,
    X: str,
    Y: str,
    Key: str = ...,
) -> GetTileResponseTypeDef:  # (1)
    ...

1. See GetTileResponseTypeDef

# get_tile method usage example with argument unpacking

kwargs: GetTileRequestRequestTypeDef = {  # (1)
    "Tileset": ...,
    "Z": ...,
    "X": ...,
    "Y": ...,
}

parent.get_tile(**kwargs)

1. See GetTileRequestRequestTypeDef