- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AssociateTrackerConsumerCommand
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.
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LocationClient, AssociateTrackerConsumerCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, AssociateTrackerConsumerCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // AssociateTrackerConsumerRequest
TrackerName: "STRING_VALUE", // required
ConsumerArn: "STRING_VALUE", // required
};
const command = new AssociateTrackerConsumerCommand(input);
const response = await client.send(command);
// {};
AssociateTrackerConsumerCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ConsumerArnRequired | string | undefined | 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.
|
TrackerNameRequired | string | undefined | The name of the tracker resource to be associated with a geofence collection. |
AssociateTrackerConsumerCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions. |
| ConflictException | client | The request was unsuccessful because of a conflict. |
| InternalServerException | server | The request has failed to process because of an unknown server error, exception, or failure. |
| ResourceNotFoundException | client | The resource that you've entered was not found in your AWS account. |
| ServiceQuotaExceededException | client | The operation was denied because the request would exceed the maximum quota set for Amazon Location Service. |
| ThrottlingException | client | The request was denied because of request throttling. |
| ValidationException | client | The input failed to meet the constraints specified by the AWS service. |
| LocationServiceException | Base exception class for all service exceptions from Location service. |