Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.
See https://www.paws-r-sdk.com/docs/locationservice_create_tracker/ for full documentation.
locationservice_create_tracker(
TrackerName,
PricingPlan = NULL,
KmsKeyId = NULL,
PricingPlanDataSource = NULL,
Description = NULL,
Tags = NULL,
PositionFiltering = NULL,
EventBridgeEnabled = NULL,
KmsKeyEnableGeospatialQueries = NULL
)
[required] The name for the tracker resource.
Requirements:
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
Must be a unique tracker resource name.
No spaces allowed. For example, ExampleTracker
.
No longer used. If included, the only allowed value is
RequestBasedUsage
.
A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
This parameter is no longer used.
An optional description for the tracker resource.
Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
Format: "key" : "value"
Restrictions:
Maximum 50 tags per resource
Each resource tag must be unique with a maximum of one value.
Maximum key length: 128 Unicode characters in UTF-8
Maximum value length: 256 Unicode characters in UTF-8
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
Cannot use "aws:" as a prefix for a key.
Specifies the position filtering for the tracker resource.
Valid values:
TimeBased
- Location updates are evaluated against linked geofence
collections, but not every location update is stored. If your update
frequency is more often than 30 seconds, only one update per 30
seconds is stored for each unique device ID.
DistanceBased
- If the device has moved less than 30 m (98.4 ft),
location updates are ignored. Location updates within this area are
neither evaluated against linked geofence collections, nor stored.
This helps control costs by reducing the number of geofence
evaluations and historical device positions to paginate through.
Distance-based filtering can also reduce the effects of GPS noise
when displaying device trajectories on a map.
AccuracyBased
- If the device has moved less than the measured
accuracy, location updates are ignored. For example, if two
consecutive updates from a device have a horizontal accuracy of 5 m
and 10 m, the second update is ignored if the device has moved less
than 15 m. Ignored location updates are neither evaluated against
linked geofence collections, nor stored. This can reduce the effects
of GPS noise when displaying device trajectories on a map, and can
help control your costs by reducing the number of geofence
evaluations.
This field is optional. If not specified, the default value is
TimeBased
.
Whether to enable position UPDATE
events from this tracker to be sent
to EventBridge.
You do not need enable this feature to get ENTER
and EXIT
events for
geofences with this tracker. Those events are always sent to
EventBridge.
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.