amazonka-location-2.0: Amazon Location Service 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.Location.BatchUpdateDevicePosition

Description

Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).

When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate.

Synopsis

Creating a Request

data BatchUpdateDevicePosition Source #

See: newBatchUpdateDevicePosition smart constructor.

Constructors

BatchUpdateDevicePosition' 

Fields

Instances

Instances details
ToJSON BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

ToHeaders BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

ToPath BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

ToQuery BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

AWSRequest BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Generic BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Associated Types

type Rep BatchUpdateDevicePosition :: Type -> Type #

Show BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

NFData BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Eq BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Hashable BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

type AWSResponse BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

type Rep BatchUpdateDevicePosition Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

type Rep BatchUpdateDevicePosition = D1 ('MetaData "BatchUpdateDevicePosition" "Amazonka.Location.BatchUpdateDevicePosition" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "BatchUpdateDevicePosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty DevicePositionUpdate))))

newBatchUpdateDevicePosition Source #

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

BatchUpdateDevicePosition, batchUpdateDevicePosition_trackerName - The name of the tracker resource to update.

$sel:updates:BatchUpdateDevicePosition', batchUpdateDevicePosition_updates - Contains the position update details for each device.

Request Lenses

Destructuring the Response

data BatchUpdateDevicePositionResponse Source #

See: newBatchUpdateDevicePositionResponse smart constructor.

Constructors

BatchUpdateDevicePositionResponse' 

Fields

Instances

Instances details
Generic BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Associated Types

type Rep BatchUpdateDevicePositionResponse :: Type -> Type #

Read BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Show BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

NFData BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

Eq BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

type Rep BatchUpdateDevicePositionResponse Source # 
Instance details

Defined in Amazonka.Location.BatchUpdateDevicePosition

type Rep BatchUpdateDevicePositionResponse = D1 ('MetaData "BatchUpdateDevicePositionResponse" "Amazonka.Location.BatchUpdateDevicePosition" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "BatchUpdateDevicePositionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchUpdateDevicePositionError])))

newBatchUpdateDevicePositionResponse Source #

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

$sel:errors:BatchUpdateDevicePositionResponse', batchUpdateDevicePositionResponse_errors - Contains error details for each device that failed to update its position.

Response Lenses

batchUpdateDevicePositionResponse_errors :: Lens' BatchUpdateDevicePositionResponse [BatchUpdateDevicePositionError] Source #

Contains error details for each device that failed to update its position.