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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data BatchEvaluateGeofences Source #

See: newBatchEvaluateGeofences smart constructor.

Constructors

BatchEvaluateGeofences'
Fields collectionName :: Text The geofence collection used in evaluating the position of devices against its geofences. devicePositionUpdates :: NonEmpty DevicePositionUpdate Contains device details for each device to be evaluated against the given geofence collection.

Instances

Instances details

Eq BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods (==) :: BatchEvaluateGeofences -> BatchEvaluateGeofences -> Bool # (/=) :: BatchEvaluateGeofences -> BatchEvaluateGeofences -> Bool #
Show BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods showsPrec :: Int -> BatchEvaluateGeofences -> ShowS # show :: BatchEvaluateGeofences -> String # showList :: [BatchEvaluateGeofences] -> ShowS #
Generic BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Associated Types type Rep BatchEvaluateGeofences :: Type -> Type # Methods from :: BatchEvaluateGeofences -> Rep BatchEvaluateGeofences x # to :: Rep BatchEvaluateGeofences x -> BatchEvaluateGeofences #
NFData BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods rnf :: BatchEvaluateGeofences -> () #
Hashable BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods hashWithSalt :: Int -> BatchEvaluateGeofences -> Int # hash :: BatchEvaluateGeofences -> Int #
ToJSON BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods toJSON :: BatchEvaluateGeofences -> Value # toEncoding :: BatchEvaluateGeofences -> Encoding # toJSONList :: [BatchEvaluateGeofences] -> Value # toEncodingList :: [BatchEvaluateGeofences] -> Encoding #
AWSRequest BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Associated Types type AWSResponse BatchEvaluateGeofences # Methods request :: BatchEvaluateGeofences -> Request BatchEvaluateGeofences # response :: MonadResource m => Logger -> Service -> Proxy BatchEvaluateGeofences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchEvaluateGeofences))) #
ToHeaders BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods toHeaders :: BatchEvaluateGeofences -> [Header] #
ToPath BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods toPath :: BatchEvaluateGeofences -> ByteString #
ToQuery BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods toQuery :: BatchEvaluateGeofences -> QueryString #
type Rep BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences type Rep BatchEvaluateGeofences = D1 ('MetaData "BatchEvaluateGeofences" "Amazonka.Location.BatchEvaluateGeofences" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "BatchEvaluateGeofences'" 'PrefixI 'True) (S1 ('MetaSel ('Just "collectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "devicePositionUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty DevicePositionUpdate))))
type AWSResponse BatchEvaluateGeofences Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences type AWSResponse BatchEvaluateGeofences = BatchEvaluateGeofencesResponse

newBatchEvaluateGeofences Source #

Arguments

:: Text	`$sel:collectionName:BatchEvaluateGeofences'`
-> NonEmpty DevicePositionUpdate	`$sel:devicePositionUpdates:BatchEvaluateGeofences'`
-> 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 httpStatus :: Int The response's http status code. errors :: [BatchEvaluateGeofencesError] Contains error details for each device that failed to evaluate its position against the given geofence collection.

Instances

Instances details

Eq BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods (==) :: BatchEvaluateGeofencesResponse -> BatchEvaluateGeofencesResponse -> Bool # (/=) :: BatchEvaluateGeofencesResponse -> BatchEvaluateGeofencesResponse -> Bool #
Read BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods readsPrec :: Int -> ReadS BatchEvaluateGeofencesResponse # readList :: ReadS [BatchEvaluateGeofencesResponse] # readPrec :: ReadPrec BatchEvaluateGeofencesResponse # readListPrec :: ReadPrec [BatchEvaluateGeofencesResponse] #
Show BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods showsPrec :: Int -> BatchEvaluateGeofencesResponse -> ShowS # show :: BatchEvaluateGeofencesResponse -> String # showList :: [BatchEvaluateGeofencesResponse] -> ShowS #
Generic BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Associated Types type Rep BatchEvaluateGeofencesResponse :: Type -> Type # Methods from :: BatchEvaluateGeofencesResponse -> Rep BatchEvaluateGeofencesResponse x # to :: Rep BatchEvaluateGeofencesResponse x -> BatchEvaluateGeofencesResponse #
NFData BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences Methods rnf :: BatchEvaluateGeofencesResponse -> () #
type Rep BatchEvaluateGeofencesResponse Source #
Instance details Defined in Amazonka.Location.BatchEvaluateGeofences type Rep BatchEvaluateGeofencesResponse = D1 ('MetaData "BatchEvaluateGeofencesResponse" "Amazonka.Location.BatchEvaluateGeofences" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "BatchEvaluateGeofencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchEvaluateGeofencesError])))

newBatchEvaluateGeofencesResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchEvaluateGeofencesResponse'`
-> BatchEvaluateGeofencesResponse

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.