[ aws . location ]

update-tracker

Description

Updates the specified properties of a given tracker resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-tracker
[--description <value>]
[--position-filtering <value>]
[--pricing-plan <value>]
[--pricing-plan-data-source <value>]
--tracker-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string)

Updates the description for the tracker resource.

--position-filtering (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.

Possible values:

• TimeBased

• DistanceBased

--pricing-plan (string)

Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing .

Possible values:

• RequestBasedUsage

• MobileAssetTracking

• MobileAssetManagement

--pricing-plan-data-source (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.

--tracker-name (string)

The name of the tracker resource to update.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

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 -> (timestamp)

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