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.
Request Syntax
POST /tracking/v0/trackers/TrackerName/consumers HTTP/1.1
Content-type: application/json
{
"ConsumerArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- TrackerName
-
The name of the tracker resource to be associated with a geofence collection.
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.
- ConsumerArn
-
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 AWS.
-
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1600.
Pattern:
arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?Required: Yes
-
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
The request was unsuccessful because of a conflict.
HTTP Status Code: 409
- 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
- ServiceQuotaExceededException
-
The operation was denied because the request would exceed the maximum quota set for Amazon Location Service.
HTTP Status Code: 402
- 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:
