[ aws . location ]

batch-update-device-position

Description

Uploads a position update for one or more devices to a tracker resource. The data is used for API queries requesting the device position and position history.

Note

Limitation — Location data is sampled at a fixed rate of 1 position per 30 second interval, and retained for 1 year before it is deleted.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-update-device-position
--tracker-name <value>
--updates <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--tracker-name (string)

The name of the tracker resource to update.

--updates (list)

Contains the position update details for each device.

(structure)

Contains the position update details for a device.

DeviceId -> (string)

The device associated to the position update.

Position -> (list)

The latest device position defined in WGS 84 format: [Xlongitude, Ylatitude] .

(double)

SampleTime -> (timestamp)

The timestamp for when the position update was received in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Shorthand Syntax:

DeviceId=string,Position=double,double,SampleTime=timestamp ...

JSON Syntax:

[
  {
    "DeviceId": "string",
    "Position": [double, ...],
    "SampleTime": timestamp
  }
  ...
]

--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

Errors -> (list)

Contains error details for each device that failed to update its position.

(structure)

Contains error details for each device that failed to update its position.

DeviceId -> (string)

The device associated with the failed location update.

Error -> (structure)

Contains details related to the error code such as the error code and error message.

Code -> (string)

The error code associated with the batch request error.

Message -> (string)

A message with the reason for the batch request error.

SampleTime -> (timestamp)

The timestamp for when a position sample was attempted in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .