BatchPutGeofence
A batch request for storing geofence geometries into a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.
Request Syntax
POST /geofencing/v0/collections/CollectionName
/put-geofences HTTP/1.1
Content-type: application/json
{
"Entries": [
{
"GeofenceId": "string
",
"GeofenceProperties": {
"string
" : "string
"
},
"Geometry": {
"Circle": {
"Center": [ number
],
"Radius": number
},
"Geobuf": blob
,
"Polygon": [
[
[ number
]
]
]
}
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- CollectionName
-
The geofence collection storing the 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.
- Entries
-
The batch of geofences to be stored in a geofence collection.
Type: Array of BatchPutGeofenceRequestEntry 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": [
{
"Error": {
"Code": "string",
"Message": "string"
},
"GeofenceId": "string"
}
],
"Successes": [
{
"CreateTime": "string",
"GeofenceId": "string",
"UpdateTime": "string"
}
]
}
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 additional error details for each geofence that failed to be stored in a geofence collection.
Type: Array of BatchPutGeofenceError objects
- Successes
-
Contains each geofence that was successfully stored in a geofence collection.
Type: Array of BatchPutGeofenceSuccess objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. 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 because of 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: