libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.BatchGetDevicePosition

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
Eq BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Read BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Show BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Generic BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Associated Types

type Rep BatchGetDevicePosition :: Type -> Type #

NFData BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Methods

rnf :: BatchGetDevicePosition -> () #

Hashable BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

ToJSON BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

AWSRequest BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Associated Types

type AWSResponse BatchGetDevicePosition #

ToHeaders BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

ToPath BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

ToQuery BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

type Rep BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

type Rep BatchGetDevicePosition = D1 ('MetaData "BatchGetDevicePosition" "Amazonka.Location.BatchGetDevicePosition" "libZSservicesZSamazonka-locationZSamazonka-location" '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)))
type AWSResponse BatchGetDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

newBatchGetDevicePosition Source #

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

$sel:trackerName: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

Instances

Instances details
Eq BatchGetDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Show BatchGetDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Generic BatchGetDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

Associated Types

type Rep BatchGetDevicePositionResponse :: Type -> Type #

NFData BatchGetDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

type Rep BatchGetDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchGetDevicePosition

type Rep BatchGetDevicePositionResponse = D1 ('MetaData "BatchGetDevicePositionResponse" "Amazonka.Location.BatchGetDevicePosition" "libZSservicesZSamazonka-locationZSamazonka-location" '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 #

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