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

Description

Updates the specified properties of a given tracker resource.

Synopsis

Creating a Request

data UpdateTracker Source #

See: newUpdateTracker smart constructor.

Constructors

UpdateTracker' 

Fields

  • description :: Maybe Text

    Updates the description for the tracker resource.

  • positionFiltering :: Maybe PositionFiltering

    Updates the position filtering for the tracker resource.

    Valid values:

    • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
    • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
    • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.
  • pricingPlan :: Maybe PricingPlan

    No longer used. If included, the only allowed value is RequestBasedUsage.

  • pricingPlanDataSource :: Maybe Text

    This parameter is no longer used.

  • trackerName :: Text

    The name of the tracker resource to update.

Instances

Instances details
ToJSON UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

ToHeaders UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

ToPath UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

ToQuery UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

AWSRequest UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Associated Types

type AWSResponse UpdateTracker #

Generic UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Associated Types

type Rep UpdateTracker :: Type -> Type #

Read UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Show UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

NFData UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Methods

rnf :: UpdateTracker -> () #

Eq UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Hashable UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

type AWSResponse UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

type Rep UpdateTracker Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

type Rep UpdateTracker = D1 ('MetaData "UpdateTracker" "Amazonka.Location.UpdateTracker" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "UpdateTracker'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "positionFiltering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PositionFiltering))) :*: (S1 ('MetaSel ('Just "pricingPlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PricingPlan)) :*: (S1 ('MetaSel ('Just "pricingPlanDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateTracker Source #

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

UpdateTracker, updateTracker_description - Updates the description for the tracker resource.

$sel:positionFiltering:UpdateTracker', updateTracker_positionFiltering - Updates the position filtering for the tracker resource.

Valid values:

  • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
  • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

UpdateTracker, updateTracker_pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

UpdateTracker, updateTracker_pricingPlanDataSource - This parameter is no longer used.

UpdateTracker, updateTracker_trackerName - The name of the tracker resource to update.

Request Lenses

updateTracker_description :: Lens' UpdateTracker (Maybe Text) Source #

Updates the description for the tracker resource.

updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering) Source #

Updates the position filtering for the tracker resource.

Valid values:

  • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
  • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan) Source #

No longer used. If included, the only allowed value is RequestBasedUsage.

updateTracker_trackerName :: Lens' UpdateTracker Text Source #

The name of the tracker resource to update.

Destructuring the Response

data UpdateTrackerResponse Source #

See: newUpdateTrackerResponse smart constructor.

Constructors

UpdateTrackerResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • trackerArn :: Text

    The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

    • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
  • trackerName :: Text

    The name of the updated tracker resource.

  • updateTime :: ISO8601

    The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Instances

Instances details
Generic UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Associated Types

type Rep UpdateTrackerResponse :: Type -> Type #

Read UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Show UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

NFData UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

Methods

rnf :: UpdateTrackerResponse -> () #

Eq UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

type Rep UpdateTrackerResponse Source # 
Instance details

Defined in Amazonka.Location.UpdateTracker

type Rep UpdateTrackerResponse = D1 ('MetaData "UpdateTrackerResponse" "Amazonka.Location.UpdateTracker" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "UpdateTrackerResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "trackerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "trackerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))

newUpdateTrackerResponse Source #

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

$sel:trackerArn:UpdateTrackerResponse', updateTrackerResponse_trackerArn - The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

UpdateTracker, updateTrackerResponse_trackerName - The name of the updated tracker resource.

UpdateTrackerResponse, updateTrackerResponse_updateTime - The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Response Lenses

updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text Source #

The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text Source #

The name of the updated tracker resource.

updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime Source #

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.