Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.Location.BatchEvaluateGeofences
Description
Evaluates device positions against the geofence geometries from a given geofence collection.
This operation always returns an empty response because geofences are asynchronously evaluated. The evaluation determines if the device has entered or exited a geofenced area, and then publishes one of the following events to Amazon EventBridge:
ENTER
if Amazon Location determines that the tracked device has entered a geofenced area.EXIT
if Amazon Location determines that the tracked device has exited a geofenced area.
The last geofence that a device was observed within is tracked for 30 days after the most recent device position update.
Synopsis
- data BatchEvaluateGeofences = BatchEvaluateGeofences' {}
- newBatchEvaluateGeofences :: Text -> NonEmpty DevicePositionUpdate -> BatchEvaluateGeofences
- batchEvaluateGeofences_collectionName :: Lens' BatchEvaluateGeofences Text
- batchEvaluateGeofences_devicePositionUpdates :: Lens' BatchEvaluateGeofences (NonEmpty DevicePositionUpdate)
- data BatchEvaluateGeofencesResponse = BatchEvaluateGeofencesResponse' {}
- newBatchEvaluateGeofencesResponse :: Int -> BatchEvaluateGeofencesResponse
- batchEvaluateGeofencesResponse_httpStatus :: Lens' BatchEvaluateGeofencesResponse Int
- batchEvaluateGeofencesResponse_errors :: Lens' BatchEvaluateGeofencesResponse [BatchEvaluateGeofencesError]
Creating a Request
data BatchEvaluateGeofences Source #
See: newBatchEvaluateGeofences
smart constructor.
Constructors
BatchEvaluateGeofences' | |
Fields
|
Instances
newBatchEvaluateGeofences Source #
Arguments
:: Text | |
-> NonEmpty DevicePositionUpdate | |
-> BatchEvaluateGeofences |
Create a value of BatchEvaluateGeofences
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:collectionName:BatchEvaluateGeofences'
, batchEvaluateGeofences_collectionName
- The geofence collection used in evaluating the position of devices
against its geofences.
$sel:devicePositionUpdates:BatchEvaluateGeofences'
, batchEvaluateGeofences_devicePositionUpdates
- Contains device details for each device to be evaluated against the
given geofence collection.
Request Lenses
batchEvaluateGeofences_collectionName :: Lens' BatchEvaluateGeofences Text Source #
The geofence collection used in evaluating the position of devices against its geofences.
batchEvaluateGeofences_devicePositionUpdates :: Lens' BatchEvaluateGeofences (NonEmpty DevicePositionUpdate) Source #
Contains device details for each device to be evaluated against the given geofence collection.
Destructuring the Response
data BatchEvaluateGeofencesResponse Source #
See: newBatchEvaluateGeofencesResponse
smart constructor.
Constructors
BatchEvaluateGeofencesResponse' | |
Fields
|
Instances
newBatchEvaluateGeofencesResponse Source #
Create a value of BatchEvaluateGeofencesResponse
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:BatchEvaluateGeofencesResponse'
, batchEvaluateGeofencesResponse_httpStatus
- The response's http status code.
$sel:errors:BatchEvaluateGeofencesResponse'
, batchEvaluateGeofencesResponse_errors
- Contains error details for each device that failed to evaluate its
position against the given geofence collection.
Response Lenses
batchEvaluateGeofencesResponse_httpStatus :: Lens' BatchEvaluateGeofencesResponse Int Source #
The response's http status code.
batchEvaluateGeofencesResponse_errors :: Lens' BatchEvaluateGeofencesResponse [BatchEvaluateGeofencesError] Source #
Contains error details for each device that failed to evaluate its position against the given geofence collection.