amazonka-iotwireless-2.0: Amazon IoT Wireless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTWireless.GetPositionEstimate

Description

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.

Synopsis

Creating a Request

data GetPositionEstimate Source #

See: newGetPositionEstimate smart constructor.

Constructors

GetPositionEstimate' 

Fields

  • cellTowers :: Maybe CellTowers

    Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

  • gnss :: Maybe Gnss

    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.

  • ip :: Maybe Ip

    Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

  • timestamp :: Maybe POSIX

    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.

  • wiFiAccessPoints :: Maybe [WiFiAccessPoint]

    Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

Instances

Instances details
ToJSON GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

toJSON :: GetPositionEstimate -> Value #

toEncoding :: GetPositionEstimate -> Encoding #

toJSONList :: [GetPositionEstimate] -> Value #

toEncodingList :: [GetPositionEstimate] -> Encoding #

ToHeaders GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

toHeaders :: GetPositionEstimate -> [Header] #

ToPath GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

toPath :: GetPositionEstimate -> ByteString #

ToQuery GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

toQuery :: GetPositionEstimate -> QueryString #

AWSRequest GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Associated Types

type AWSResponse GetPositionEstimate #

Methods

request :: (Service -> Service) -> GetPositionEstimate -> Request GetPositionEstimate #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPositionEstimate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPositionEstimate))) #

Generic GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Associated Types

type Rep GetPositionEstimate :: Type -> Type #

Methods

from :: GetPositionEstimate -> Rep GetPositionEstimate x #

to :: Rep GetPositionEstimate x -> GetPositionEstimate #

Read GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

readsPrec :: Int -> ReadS GetPositionEstimate #

readList :: ReadS [GetPositionEstimate] #

readPrec :: ReadPrec GetPositionEstimate #

readListPrec :: ReadPrec [GetPositionEstimate] #

Show GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

showsPrec :: Int -> GetPositionEstimate -> ShowS #

show :: GetPositionEstimate -> String #

showList :: [GetPositionEstimate] -> ShowS #

NFData GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

rnf :: GetPositionEstimate -> () #

Eq GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

(==) :: GetPositionEstimate -> GetPositionEstimate -> Bool #

(/=) :: GetPositionEstimate -> GetPositionEstimate -> Bool #

Hashable GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

hashWithSalt :: Int -> GetPositionEstimate -> Int #

hash :: GetPositionEstimate -> Int #

type AWSResponse GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

type AWSResponse GetPositionEstimate = GetPositionEstimateResponse
type Rep GetPositionEstimate Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

type Rep GetPositionEstimate = D1 ('MetaData "GetPositionEstimate" "Amazonka.IoTWireless.GetPositionEstimate" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "GetPositionEstimate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cellTowers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CellTowers)) :*: S1 ('MetaSel ('Just "gnss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Gnss))) :*: (S1 ('MetaSel ('Just "ip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Ip)) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "wiFiAccessPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WiFiAccessPoint]))))))

newGetPositionEstimate :: GetPositionEstimate Source #

Create a value of GetPositionEstimate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cellTowers:GetPositionEstimate', getPositionEstimate_cellTowers - Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

GetPositionEstimate, getPositionEstimate_gnss - 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.

$sel:ip:GetPositionEstimate', getPositionEstimate_ip - Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

GetPositionEstimate, getPositionEstimate_timestamp - 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.

$sel:wiFiAccessPoints:GetPositionEstimate', getPositionEstimate_wiFiAccessPoints - Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

Request Lenses

getPositionEstimate_cellTowers :: Lens' GetPositionEstimate (Maybe CellTowers) Source #

Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

getPositionEstimate_gnss :: Lens' GetPositionEstimate (Maybe Gnss) Source #

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.

getPositionEstimate_ip :: Lens' GetPositionEstimate (Maybe Ip) Source #

Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

getPositionEstimate_timestamp :: Lens' GetPositionEstimate (Maybe UTCTime) Source #

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.

getPositionEstimate_wiFiAccessPoints :: Lens' GetPositionEstimate (Maybe [WiFiAccessPoint]) Source #

Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

Destructuring the Response

data GetPositionEstimateResponse Source #

See: newGetPositionEstimateResponse smart constructor.

Constructors

GetPositionEstimateResponse' 

Fields

  • geoJsonPayload :: Maybe ByteString

    The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Associated Types

type Rep GetPositionEstimateResponse :: Type -> Type #

Methods

from :: GetPositionEstimateResponse -> Rep GetPositionEstimateResponse x #

to :: Rep GetPositionEstimateResponse x -> GetPositionEstimateResponse #

Read GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

readsPrec :: Int -> ReadS GetPositionEstimateResponse #

readList :: ReadS [GetPositionEstimateResponse] #

readPrec :: ReadPrec GetPositionEstimateResponse #

readListPrec :: ReadPrec [GetPositionEstimateResponse] #

Show GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

showsPrec :: Int -> GetPositionEstimateResponse -> ShowS #

show :: GetPositionEstimateResponse -> String #

showList :: [GetPositionEstimateResponse] -> ShowS #

NFData GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

rnf :: GetPositionEstimateResponse -> () #

Eq GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

Methods

(==) :: GetPositionEstimateResponse -> GetPositionEstimateResponse -> Bool #

(/=) :: GetPositionEstimateResponse -> GetPositionEstimateResponse -> Bool #

type Rep GetPositionEstimateResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.GetPositionEstimate

type Rep GetPositionEstimateResponse = D1 ('MetaData "GetPositionEstimateResponse" "Amazonka.IoTWireless.GetPositionEstimate" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "GetPositionEstimateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "geoJsonPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetPositionEstimateResponse Source #

Arguments

:: Int

$sel:httpStatus:GetPositionEstimateResponse'

-> GetPositionEstimateResponse 

Create a value of GetPositionEstimateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:geoJsonPayload:GetPositionEstimateResponse', getPositionEstimateResponse_geoJsonPayload - The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

$sel:httpStatus:GetPositionEstimateResponse', getPositionEstimateResponse_httpStatus - The response's http status code.

Response Lenses

getPositionEstimateResponse_geoJsonPayload :: Lens' GetPositionEstimateResponse (Maybe ByteString) Source #

The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

getPositionEstimateResponse_httpStatus :: Lens' GetPositionEstimateResponse Int Source #

The response's http status code.