PUT

/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}

http://geo.{region}.amazonaws.com/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}

Stores a geofence geometry in a given geofence collection, or updates the geometry of an existing geofence if a geofence ID is included in the request.

Access Token Required: API Key

Path Parameters

CollectionNamestringrequired

The geofence collection to store the geofence in.

GeofenceIdstringrequired

An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.

Body Params

Geometryobjectrequired

Contains the geofence geometry details. A geofence geometry is made up of either a polygon or a circle. Can be either a polygon or a circle. Including both will return a validation error. <note> Amazon Location doesn't currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian. </note>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://geo.{region}.amazonaws.com/geofencing/v0/collections/{CollectionName}/geofences/{GeofenceId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT