POST

/geofencing/v0/collections

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

Creates a geofence collection, which manages and stores geofences.

Access Token Required: API Key

Body Params

Tagsobject

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: <code>"key" : "value"</code> Restrictions: <ul> <li> Maximum 50 tags per resource </li> <li> Each resource tag must be unique with a maximum of one value. </li> <li> Maximum key length: 128 Unicode characters in UTF-8 </li> <li> Maximum value length: 256 Unicode characters in UTF-8 </li> <li> Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. </li> <li> Cannot use "aws:" as a prefix for a key. </li> </ul>

KmsKeyIdstring

A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.

Descriptionstring

An optional description for the geofence collection.

PricingPlanstring

No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.

CollectionNamestringrequired

A custom name for the geofence collection. Requirements: <ul> <li> Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). </li> <li> Must be a unique geofence collection name. </li> <li> No spaces allowed. For example, <code>ExampleGeofenceCollection</code>. </li> </ul>

PricingPlanDataSourcestring

This parameter is no longer used.

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 POST \
2     --url 'http://geo.{region}.amazonaws.com/geofencing/v0/collections' \
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}