BatchEvaluateGeofences - Amazon Location Service Geofences

BatchEvaluateGeofences

Used in geofence monitoring. Evaluates device positions against the position of geofences in a given geofence collection.

Request Syntax

POST /geofencing/v0/collections/CollectionName/positions HTTP/1.1 Content-type: application/json { "DevicePositionUpdates": [ { "DeviceId": "string", "Position": [ number ], "SampleTime": number } ] }

URI Request Parameters

The request uses the following URI parameters.

CollectionName

The geofence collection used in evaluating the position of devices against its geofences.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\w]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

DevicePositionUpdates

Contains device details for each device to be evaluated against the given geofence collection.

Type: Array of DevicePositionUpdate objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "string" }, "SampleTime": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

Contains error details for each device that failed to evaluate its position against the given geofence collection.

Type: Array of BatchEvaluateGeofencesError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied due to insufficient access or permission. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: