Skip to content

GetTileRequest

Source code in docs_src/capo_geo_maps/types/get_tile_request.py
class GetTileRequest(TypedDict, closed=True):
    additional_features: NotRequired[
        "capo_geo_maps.types.tile_additional_feature_list.TileAdditionalFeatureList"
    ]
    """<p>A list of optional additional parameters such as map styles that can be requested for each result. Not supported in <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions for <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers.</p>"""
    tileset: "capo_geo_maps.types.tileset.Tileset"
    """<p>Specifies the desired tile set. For <a href="https://docs.aws.amazon.com/location/latest/developerguide/GrabMaps.html">GrabMaps</a> customers, <code>ap-southeast-1</code> and <code>ap-southeast-5</code> regions support only the <code>vector.basemap</code> value.</p> <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code> </p>"""
    z: "capo_geo_maps.types.sensitive_string.SensitiveString"
    """<p>The zoom value for the map tile.</p>"""
    x: "capo_geo_maps.types.sensitive_string.SensitiveString"
    """<p>The X axis value for the map tile.</p>"""
    y: "capo_geo_maps.types.sensitive_string.SensitiveString"
    """<p>The Y axis value for the map tile.</p>"""
    key: NotRequired["capo_geo_maps.types.api_key.ApiKey"]
    """<p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. </p>"""

additional_features instance-attribute

additional_features: NotRequired[TileAdditionalFeatureList]

A list of optional additional parameters such as map styles that can be requested for each result. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

key instance-attribute

key: NotRequired[ApiKey]

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 instance-attribute

tileset: Tileset

Specifies the desired tile set. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the vector.basemap value.

Valid Values: raster.satellite | vector.basemap | vector.traffic | raster.dem

x instance-attribute

The X axis value for the map tile.

y instance-attribute

The Y axis value for the map tile.

z instance-attribute

The zoom value for the map tile.