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 |
Updates the specified properties of a given tracker resource.
Synopsis
- data UpdateTracker = UpdateTracker' {}
- newUpdateTracker :: Text -> UpdateTracker
- updateTracker_description :: Lens' UpdateTracker (Maybe Text)
- updateTracker_positionFiltering :: Lens' UpdateTracker (Maybe PositionFiltering)
- updateTracker_pricingPlan :: Lens' UpdateTracker (Maybe PricingPlan)
- updateTracker_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text)
- updateTracker_trackerName :: Lens' UpdateTracker Text
- data UpdateTrackerResponse = UpdateTrackerResponse' {
- httpStatus :: Int
- trackerArn :: Text
- trackerName :: Text
- updateTime :: ISO8601
- newUpdateTrackerResponse :: Int -> Text -> Text -> UTCTime -> UpdateTrackerResponse
- updateTrackerResponse_httpStatus :: Lens' UpdateTrackerResponse Int
- updateTrackerResponse_trackerArn :: Lens' UpdateTrackerResponse Text
- updateTrackerResponse_trackerName :: Lens' UpdateTrackerResponse Text
- updateTrackerResponse_updateTime :: Lens' UpdateTrackerResponse UTCTime
Creating a Request
data UpdateTracker Source #
See: newUpdateTracker
smart constructor.
UpdateTracker' | |
|
Instances
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_pricingPlanDataSource :: Lens' UpdateTracker (Maybe Text) Source #
This parameter is no longer used.
updateTracker_trackerName :: Lens' UpdateTracker Text Source #
The name of the tracker resource to update.
Destructuring the Response
data UpdateTrackerResponse Source #
See: newUpdateTrackerResponse
smart constructor.
UpdateTrackerResponse' | |
|
Instances
newUpdateTrackerResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UpdateTrackerResponse |
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_httpStatus :: Lens' UpdateTrackerResponse Int Source #
The response's http status code.
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
.