Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeTracker

Retrieves the tracker resource details.

Request Syntax


GET /tracking/v0/trackers/TrackerName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

TrackerName

The name of the tracker resource.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateTime": "string",
   "Description": "string",
   "EventBridgeEnabled": boolean,
   "KmsKeyEnableGeospatialQueries": boolean,
   "KmsKeyId": "string",
   "PositionFiltering": "string",
   "PricingPlan": "string",
   "PricingPlanDataSource": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TrackerArn": "string",
   "TrackerName": "string",
   "UpdateTime": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreateTime

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

Type: Timestamp

Description

The optional description for the tracker resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

EventBridgeEnabled

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

Type: Boolean

KmsKeyEnableGeospatialQueries

Enables GeospatialQueries for a tracker that uses a AWS KMS customer managed key.

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

Note

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.

Type: Boolean

KmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

PositionFiltering

The position filtering method of the tracker resource.

Type: String

Valid Values: TimeBased | DistanceBased | AccuracyBased

PricingPlan

This parameter has been deprecated.

Always returns RequestBasedUsage.

Type: String

Valid Values: RequestBasedUsage | MobileAssetTracking | MobileAssetManagement

PricingPlanDataSource

This parameter has been deprecated.

No longer used. Always returns an empty string.

Type: String

Tags

The tags associated with the tracker resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.,:/=+\-@]*)

TrackerArn

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

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

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}:([^/].*)?

TrackerName

The name of the tracker resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-._\w]+

UpdateTime

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

Type: Timestamp

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

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

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