[ aws . location ]

batch-delete-device-position-history

Description

Deletes the position history of one or more devices from a tracker resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-delete-device-position-history
--device-ids <value>
--tracker-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--device-ids (list)

Devices whose position history you want to delete.

• For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

(string)

Syntax:

"string" "string" ...

--tracker-name (string)

The name of the tracker resource to delete the device position history from.

--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 history that failed to delete.

(structure)

Contains the tracker resource details.

DeviceId -> (string)

The ID of the device for this position.

Error -> (structure)

Contains the batch request error details associated with the request.

Code -> (string)

The error code associated with the batch request error.

Message -> (string)

A message with the reason for the batch request error.