get_position_estimate ¶

def get_position_estimate(
    self,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    wi_fi_access_points: Optional[
        "capo_iot_wireless.types.wi_fi_access_points.WiFiAccessPoints"
    ] = None,
    cell_towers: Optional["capo_iot_wireless.types.cell_towers.CellTowers"] = None,
    ip: Optional["capo_iot_wireless.types.ip.Ip"] = None,
    gnss: Optional["capo_iot_wireless.types.gnss.Gnss"] = None,
    gnss_multi_frame: Optional[
        "capo_iot_wireless.types.gnss_multi_frame.GnssMultiFrame"
    ] = None,
    timestamp: Optional[
        "capo_iot_wireless.types.creation_date.CreationDate"
    ] = None,
    advanced_configuration: Optional[
        "capo_iot_wireless.types.advanced_configuration.AdvancedConfiguration"
    ] = None,
) -> "capo_iot_wireless.types.get_position_estimate_response.GetPositionEstimateResponse":
    """<p>Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.</p>

    Args:
        wi_fi_access_points: <p>Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.</p>
        cell_towers: <p>Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.</p>
        ip: <p>Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.</p>
        gnss: <p>Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud. This field is mutually exclusive with the GnssMultiFrame field.</p>
        gnss_multi_frame: <p>Retrieves an estimated device position by resolving multiple global navigation satellite system (GNSS) scan captures. The position is resolved using the multi-frame GNSS solver powered by LoRa Cloud. This field is mutually exclusive with the Gnss field.</p>
        timestamp: <p>Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.</p>
        advanced_configuration: <p>Optional configuration for customizing position measurement data.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.get_position_estimate_request.GetPositionEstimateRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.get_position_estimate_response.GetPositionEstimateResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.get_position_estimate

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.get_position_estimate.get_position_estimate(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPositionEstimate")
    )
    input_: capo_iot_wireless.types.get_position_estimate_request.GetPositionEstimateRequest = {}
    if wi_fi_access_points is not None:
        input_["wi_fi_access_points"] = wi_fi_access_points
    if cell_towers is not None:
        input_["cell_towers"] = cell_towers
    if ip is not None:
        input_["ip"] = ip
    if gnss is not None:
        input_["gnss"] = gnss
    if gnss_multi_frame is not None:
        input_["gnss_multi_frame"] = gnss_multi_frame
    if timestamp is not None:
        input_["timestamp"] = timestamp
    if advanced_configuration is not None:
        input_["advanced_configuration"] = advanced_configuration

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