POST

/tracking/v0/trackers/{TrackerName}/consumers

http://geo.{region}.amazonaws.com/tracking/v0/trackers/{TrackerName}/consumers

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. <note> Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account. </note>

Access Token Required: API Key

Path Parameters

TrackerNamestringrequired

The name of the tracker resource to be associated with a geofence collection.

Body Params

ConsumerArnstringrequired

The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all Amazon Web Services. <ul> <li> Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer</code> </li> </ul>

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/tracking/v0/trackers/{TrackerName}/consumers' \
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}