2021/10/05 - Amazon Location Service - 3 updated api methods
Changes Add support for PositionFiltering.
{'PositionFiltering': 'TimeBased | DistanceBased'}
Creates a tracker resource in your AWS account, which lets you retrieve current and historical location of devices.
See also: AWS API Documentation
Request Syntax
client.create_tracker(
Description='string',
KmsKeyId='string',
PositionFiltering='TimeBased'|'DistanceBased',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
Tags={
'string': 'string'
},
TrackerName='string'
)
string
An optional description for the tracker resource.
string
A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.
string
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 distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
This field is optional. If not specified, the default value is TimeBased .
string
[REQUIRED]
Specifies the pricing plan for the tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
string
Specifies the data provider for the tracker resource.
Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.
Note
Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid values: Esri | Here
dict
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: + - = . _ : / @.
(string) --
(string) --
string
[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 .
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'TrackerArn': 'string',
'TrackerName': 'string'
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
TrackerArn (string) --
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
TrackerName (string) --
The name of the tracker resource.
{'PositionFiltering': 'TimeBased | DistanceBased'}
Retrieves the tracker resource details.
See also: AWS API Documentation
Request Syntax
client.describe_tracker(
TrackerName='string'
)
string
[REQUIRED]
The name of the tracker resource.
dict
Response Syntax
{
'CreateTime': datetime(2015, 1, 1),
'Description': 'string',
'KmsKeyId': 'string',
'PositionFiltering': 'TimeBased'|'DistanceBased',
'PricingPlan': 'RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
'PricingPlanDataSource': 'string',
'Tags': {
'string': 'string'
},
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreateTime (datetime) --
The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
Description (string) --
The optional description for the tracker resource.
KmsKeyId (string) --
A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource.
PositionFiltering (string) --
The position filtering method of the tracker resource.
PricingPlan (string) --
The pricing plan selected for the specified tracker resource.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
PricingPlanDataSource (string) --
The specified data provider for the tracker resource.
Tags (dict) --
The tags associated with the tracker resource.
(string) --
(string) --
TrackerArn (string) --
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
TrackerName (string) --
The name of the tracker resource.
UpdateTime (datetime) --
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
{'PositionFiltering': 'TimeBased | DistanceBased'}
Updates the specified properties of a given tracker resource.
See also: AWS API Documentation
Request Syntax
client.update_tracker(
Description='string',
PositionFiltering='TimeBased'|'DistanceBased',
PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
PricingPlanDataSource='string',
TrackerName='string'
)
string
Updates the description for the tracker resource.
string
Updates 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 distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.
string
Updates the pricing plan for the tracker resource.
For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
string
Updates the data provider for the tracker resource.
A required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement
For more information about data providers and pricing plans, see the Amazon Location Service product page
Note
This can only be updated when updating the PricingPlan in the same request.
Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.
string
[REQUIRED]
The name of the tracker resource to update.
dict
Response Syntax
{
'TrackerArn': 'string',
'TrackerName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
TrackerArn (string) --
The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.
Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker
TrackerName (string) --
The name of the updated tracker resource.
UpdateTime (datetime) --
The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .