DescribeTrackerCommand

Suggest an Edit

Retrieves the tracker resource details.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LocationClient, DescribeTrackerCommand } from "@aws-sdk/client-location"; // ES Modules import
// const { LocationClient, DescribeTrackerCommand } = require("@aws-sdk/client-location"); // CommonJS import
const client = new LocationClient(config);
const input = { // DescribeTrackerRequest
  TrackerName: "STRING_VALUE", // required
};
const command = new DescribeTrackerCommand(input);
const response = await client.send(command);
// { // DescribeTrackerResponse
//   TrackerName: "STRING_VALUE", // required
//   TrackerArn: "STRING_VALUE", // required
//   Description: "STRING_VALUE", // required
//   PricingPlan: "STRING_VALUE",
//   PricingPlanDataSource: "STRING_VALUE",
//   Tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
//   CreateTime: new Date("TIMESTAMP"), // required
//   UpdateTime: new Date("TIMESTAMP"), // required
//   KmsKeyId: "STRING_VALUE",
//   PositionFiltering: "STRING_VALUE",
//   EventBridgeEnabled: true || false,
//   KmsKeyEnableGeospatialQueries: true || false,
// };

DescribeTrackerCommand Input

See DescribeTrackerCommandInput for more details

Parameter
Type
Description
TrackerName
Required
string | undefined

The name of the tracker resource.

DescribeTrackerCommand Output

See DescribeTrackerCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreateTime
Required
Date | undefined

The timestamp for when the tracker resource was created in ISO 8601  format: YYYY-MM-DDThh:mm:ss.sssZ.

Description
Required
string | undefined

The optional description for the tracker resource.

TrackerArn
Required
string | undefined

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

TrackerName
Required
string | undefined

The name of the tracker resource.

UpdateTime
Required
Date | undefined

The timestamp for when the tracker resource was last updated in ISO 8601  format: YYYY-MM-DDThh:mm:ss.sssZ.

EventBridgeEnabled
boolean | undefined

Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.

KmsKeyEnableGeospatialQueries
boolean | undefined

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key .

This parameter is only used if you are using a KMS customer managed key.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

KmsKeyId
string | undefined

A key identifier for an Amazon Web Services KMS customer managed key  assigned to the Amazon Location resource.

PositionFiltering
PositionFiltering | undefined

The position filtering method of the tracker resource.

PricingPlan
PricingPlan | undefined

Always returns RequestBasedUsage.

PricingPlanDataSource
string | undefined

No longer used. Always returns an empty string.

Tags
Record<string, string> | undefined

The tags associated with the tracker resource.

Throws

Name
Fault
Details
AccessDeniedException
client

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

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.

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.