get_tile ¶

def get_tile(
    self,
    tileset: "capo_geo_maps.types.tileset.Tileset",
    z: "capo_geo_maps.types.sensitive_string.SensitiveString",
    x: "capo_geo_maps.types.sensitive_string.SensitiveString",
    y: "capo_geo_maps.types.sensitive_string.SensitiveString",
    *,
    config_overrides: Optional[GeoMapsClientConfig] = None,
    additional_features: Optional[
        "capo_geo_maps.types.tile_additional_feature_list.TileAdditionalFeatureList"
    ] = None,
    key: Optional["capo_geo_maps.types.api_key.ApiKey"] = None,
) -> "capo_geo_maps.types.get_tile_response.GetTileResponse":
    """<p> <code>GetTile</code> 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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/tiles.html">Tiles</a> in the <i>Amazon Location Service Developer Guide</i>.</p>

    Args:
        additional_features: <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: <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: <p>The zoom value for the map tile.</p>
        x: <p>The X axis value for the map tile.</p>
        y: <p>The Y axis value for the map tile.</p>
        key: <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>

    Raises:
        capo_geo_maps.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.</p>
        capo_geo_maps.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_geo_maps.errors.resource_not_found_exception.ResourceNotFoundException: <p>Exception thrown when the associated resource could not be found.</p>
        capo_geo_maps.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_geo_maps.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_geo_maps.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_geo_maps.types.get_tile_request.GetTileRequest]",
    ) -> OperationResponse["capo_geo_maps.types.get_tile_response.GetTileResponse"]:
        import capo_geo_maps._operations.maps_service.get_tile

        output, http_response = (
            capo_geo_maps._operations.maps_service.get_tile.get_tile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_geo_maps.types.get_tile_request.GetTileRequest",
    ) -> dict[str, Any]:
        import capo_geo_maps.types.get_tile_request

        return capo_geo_maps.types.get_tile_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTile", redact_input=_redact_input)
    )
    input_: capo_geo_maps.types.get_tile_request.GetTileRequest = {
        "tileset": tileset,
        "z": z,
        "x": x,
        "y": y,
    }
    if additional_features is not None:
        input_["additional_features"] = additional_features
    if key is not None:
        input_["key"] = key

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output