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.BatchGetDevicePosition

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the latest device positions for requested devices.

Synopsis

Creating a Request

data BatchGetDevicePosition Source #

See: newBatchGetDevicePosition smart constructor.

Constructors

BatchGetDevicePosition'
Fields deviceIds :: NonEmpty Text Devices whose position you want to retrieve. For example, for two devices: `device-ids=DeviceId1&device-ids=DeviceId2` trackerName :: Text The tracker resource retrieving the device position.

Instances

Instances details

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

newBatchGetDevicePosition Source #

Arguments

:: NonEmpty Text	`$sel:deviceIds:BatchGetDevicePosition'`
-> Text	`BatchGetDevicePosition`
-> BatchGetDevicePosition

Create a value of BatchGetDevicePosition 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:deviceIds:BatchGetDevicePosition', batchGetDevicePosition_deviceIds - Devices whose position you want to retrieve.

For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

BatchGetDevicePosition, batchGetDevicePosition_trackerName - The tracker resource retrieving the device position.

Request Lenses

batchGetDevicePosition_deviceIds :: Lens' BatchGetDevicePosition (NonEmpty Text) Source #

Devices whose position you want to retrieve.

For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

batchGetDevicePosition_trackerName :: Lens' BatchGetDevicePosition Text Source #

The tracker resource retrieving the device position.

Destructuring the Response

data BatchGetDevicePositionResponse Source #

See: newBatchGetDevicePositionResponse smart constructor.

Constructors

BatchGetDevicePositionResponse'
Fields httpStatus :: Int The response's http status code. devicePositions :: [DevicePosition] Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled. errors :: [BatchGetDevicePositionError] Contains error details for each device that failed to send its position to the tracker resource.

Instances

Instances details

Generic BatchGetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.BatchGetDevicePosition Associated Types type Rep BatchGetDevicePositionResponse :: Type -> Type # Methods from :: BatchGetDevicePositionResponse -> Rep BatchGetDevicePositionResponse x # to :: Rep BatchGetDevicePositionResponse x -> BatchGetDevicePositionResponse #
Show BatchGetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.BatchGetDevicePosition Methods showsPrec :: Int -> BatchGetDevicePositionResponse -> ShowS # show :: BatchGetDevicePositionResponse -> String # showList :: [BatchGetDevicePositionResponse] -> ShowS #
NFData BatchGetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.BatchGetDevicePosition Methods rnf :: BatchGetDevicePositionResponse -> () #
Eq BatchGetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.BatchGetDevicePosition Methods (==) :: BatchGetDevicePositionResponse -> BatchGetDevicePositionResponse -> Bool # (/=) :: BatchGetDevicePositionResponse -> BatchGetDevicePositionResponse -> Bool #
type Rep BatchGetDevicePositionResponse Source #
Instance details Defined in Amazonka.Location.BatchGetDevicePosition type Rep BatchGetDevicePositionResponse = D1 ('MetaData "BatchGetDevicePositionResponse" "Amazonka.Location.BatchGetDevicePosition" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "BatchGetDevicePositionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "devicePositions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DevicePosition]) :: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetDevicePositionError]))))

newBatchGetDevicePositionResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchGetDevicePositionResponse'`
-> BatchGetDevicePositionResponse

Create a value of BatchGetDevicePositionResponse 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:httpStatus:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_httpStatus - The response's http status code.

$sel:devicePositions:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_devicePositions - Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

$sel:errors:BatchGetDevicePositionResponse', batchGetDevicePositionResponse_errors - Contains error details for each device that failed to send its position to the tracker resource.

Response Lenses

batchGetDevicePositionResponse_httpStatus :: Lens' BatchGetDevicePositionResponse Int Source #

The response's http status code.

batchGetDevicePositionResponse_devicePositions :: Lens' BatchGetDevicePositionResponse [DevicePosition] Source #

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

batchGetDevicePositionResponse_errors :: Lens' BatchGetDevicePositionResponse [BatchGetDevicePositionError] Source #

Contains error details for each device that failed to send its position to the tracker resource.