Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Location.GetDevicePosition

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a device's most recent position according to its sample time.

Device positions are deleted after 30 days.

Synopsis

data GetDevicePosition = GetDevicePosition' {
- deviceId :: Text
- trackerName :: Text
}
newGetDevicePosition :: Text -> Text -> GetDevicePosition
getDevicePosition_deviceId :: Lens' GetDevicePosition Text
getDevicePosition_trackerName :: Lens' GetDevicePosition Text
data GetDevicePositionResponse = GetDevicePositionResponse' {
- accuracy :: Maybe PositionalAccuracy
- deviceId :: Maybe Text
- positionProperties :: Maybe (Sensitive (HashMap Text Text))
- httpStatus :: Int
- position :: Sensitive (NonEmpty Double)
- receivedTime :: ISO8601
- sampleTime :: ISO8601
}
newGetDevicePositionResponse :: Int -> NonEmpty Double -> UTCTime -> UTCTime -> GetDevicePositionResponse
getDevicePositionResponse_accuracy :: Lens' GetDevicePositionResponse (Maybe PositionalAccuracy)
getDevicePositionResponse_deviceId :: Lens' GetDevicePositionResponse (Maybe Text)
getDevicePositionResponse_positionProperties :: Lens' GetDevicePositionResponse (Maybe (HashMap Text Text))
getDevicePositionResponse_httpStatus :: Lens' GetDevicePositionResponse Int
getDevicePositionResponse_position :: Lens' GetDevicePositionResponse (NonEmpty Double)
getDevicePositionResponse_receivedTime :: Lens' GetDevicePositionResponse UTCTime
getDevicePositionResponse_sampleTime :: Lens' GetDevicePositionResponse UTCTime

Creating a Request

data GetDevicePosition Source #

See: newGetDevicePosition smart constructor.

Constructors

GetDevicePosition'
Fields deviceId :: Text The device whose position you want to retrieve. trackerName :: Text The tracker resource receiving the position update.

Instances

Instances details

ToHeaders GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods toHeaders :: GetDevicePosition -> [Header] #
ToPath GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods toPath :: GetDevicePosition -> ByteString #
ToQuery GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods toQuery :: GetDevicePosition -> QueryString #
AWSRequest GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Associated Types type AWSResponse GetDevicePosition # Methods request :: (Service -> Service) -> GetDevicePosition -> Request GetDevicePosition # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDevicePosition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDevicePosition))) #
Generic GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Associated Types type Rep GetDevicePosition :: Type -> Type # Methods from :: GetDevicePosition -> Rep GetDevicePosition x # to :: Rep GetDevicePosition x -> GetDevicePosition #
Read GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods readsPrec :: Int -> ReadS GetDevicePosition # readList :: ReadS [GetDevicePosition] # readPrec :: ReadPrec GetDevicePosition # readListPrec :: ReadPrec [GetDevicePosition] #
Show GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods showsPrec :: Int -> GetDevicePosition -> ShowS # show :: GetDevicePosition -> String # showList :: [GetDevicePosition] -> ShowS #
NFData GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods rnf :: GetDevicePosition -> () #
Eq GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods (==) :: GetDevicePosition -> GetDevicePosition -> Bool # (/=) :: GetDevicePosition -> GetDevicePosition -> Bool #
Hashable GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods hashWithSalt :: Int -> GetDevicePosition -> Int # hash :: GetDevicePosition -> Int #
type AWSResponse GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition type AWSResponse GetDevicePosition = GetDevicePositionResponse
type Rep GetDevicePosition Source #
Instance details Defined in Amazonka.Location.GetDevicePosition type Rep GetDevicePosition = D1 ('MetaData "GetDevicePosition" "Amazonka.Location.GetDevicePosition" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetDevicePosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDevicePosition Source #

Arguments

:: Text	`GetDevicePosition`
-> Text	`GetDevicePosition`
-> GetDevicePosition

Create a value of GetDevicePosition 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:

GetDevicePosition, getDevicePosition_deviceId - The device whose position you want to retrieve.

GetDevicePosition, getDevicePosition_trackerName - The tracker resource receiving the position update.

Request Lenses

getDevicePosition_deviceId :: Lens' GetDevicePosition Text Source #

The device whose position you want to retrieve.

getDevicePosition_trackerName :: Lens' GetDevicePosition Text Source #

The tracker resource receiving the position update.

Destructuring the Response

data GetDevicePositionResponse Source #

See: newGetDevicePositionResponse smart constructor.

Constructors

GetDevicePositionResponse'

Fields

accuracy :: Maybe PositionalAccuracy
The accuracy of the device position.
deviceId :: Maybe Text
The device whose position you retrieved.
positionProperties :: Maybe (Sensitive (HashMap Text Text))
The properties associated with the position.
httpStatus :: Int
The response's http status code.
position :: Sensitive (NonEmpty Double)
The last known device position.
receivedTime :: ISO8601
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
sampleTime :: ISO8601
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Instances

Instances details

Generic GetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Associated Types type Rep GetDevicePositionResponse :: Type -> Type # Methods from :: GetDevicePositionResponse -> Rep GetDevicePositionResponse x # to :: Rep GetDevicePositionResponse x -> GetDevicePositionResponse #
Show GetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods showsPrec :: Int -> GetDevicePositionResponse -> ShowS # show :: GetDevicePositionResponse -> String # showList :: [GetDevicePositionResponse] -> ShowS #
NFData GetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods rnf :: GetDevicePositionResponse -> () #
Eq GetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.GetDevicePosition Methods (==) :: GetDevicePositionResponse -> GetDevicePositionResponse -> Bool # (/=) :: GetDevicePositionResponse -> GetDevicePositionResponse -> Bool #
type Rep GetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.GetDevicePosition type Rep GetDevicePositionResponse = D1 ('MetaData "GetDevicePositionResponse" "Amazonka.Location.GetDevicePosition" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "GetDevicePositionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PositionalAccuracy)) :: (S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "positionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double)))) :: (S1 ('MetaSel ('Just "receivedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: S1 ('MetaSel ('Just "sampleTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newGetDevicePositionResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDevicePositionResponse'`
-> NonEmpty Double	`GetDevicePositionResponse`
-> UTCTime	`GetDevicePositionResponse`
-> UTCTime	`GetDevicePositionResponse`
-> GetDevicePositionResponse

Create a value of GetDevicePositionResponse 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:

GetDevicePositionResponse, getDevicePositionResponse_accuracy - The accuracy of the device position.

GetDevicePosition, getDevicePositionResponse_deviceId - The device whose position you retrieved.

GetDevicePositionResponse, getDevicePositionResponse_positionProperties - The properties associated with the position.

$sel:httpStatus:GetDevicePositionResponse', getDevicePositionResponse_httpStatus - The response's http status code.

GetDevicePositionResponse, getDevicePositionResponse_position - The last known device position.

GetDevicePositionResponse, getDevicePositionResponse_receivedTime - The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

GetDevicePositionResponse, getDevicePositionResponse_sampleTime - The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Response Lenses

getDevicePositionResponse_accuracy :: Lens' GetDevicePositionResponse (Maybe PositionalAccuracy) Source #

The accuracy of the device position.

getDevicePositionResponse_deviceId :: Lens' GetDevicePositionResponse (Maybe Text) Source #

The device whose position you retrieved.

getDevicePositionResponse_positionProperties :: Lens' GetDevicePositionResponse (Maybe (HashMap Text Text)) Source #

The properties associated with the position.

getDevicePositionResponse_httpStatus :: Lens' GetDevicePositionResponse Int Source #

The response's http status code.

getDevicePositionResponse_position :: Lens' GetDevicePositionResponse (NonEmpty Double) Source #

The last known device position.

getDevicePositionResponse_receivedTime :: Lens' GetDevicePositionResponse UTCTime Source #

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

getDevicePositionResponse_sampleTime :: Lens' GetDevicePositionResponse UTCTime Source #

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.