AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
See also: AWS API Documentation
verify-device-position
--tracker-name <value>
--device-state <value>
[--distance-unit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--tracker-name
(string)
The name of the tracker resource to be associated with verification request.
--device-state
(structure)
The device's state, including position, IP address, cell signals and Wi-Fi access points.
DeviceId -> (string)
The device identifier.SampleTime -> (timestamp)
The timestamp at which the device's position was determined. Uses ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.Position -> (list)
The last known device position.
(double)
Accuracy -> (structure)
Defines the level of certainty of the position.
Horizontal -> (double)
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.Ipv4Address -> (string)
The device's Ipv4 address.WiFiAccessPoints -> (list)
The Wi-Fi access points the device is using.
(structure)
Wi-Fi access point.
MacAddress -> (string)
Medium access control address (Mac).Rss -> (integer)
Received signal strength (dBm) of the WLAN measurement data.CellSignals -> (structure)
The cellular network infrastructure that the device is connected to.
LteCellDetails -> (list)
Information about the Long-Term Evolution (LTE) network the device is connected to.
(structure)
Details about the Long-Term Evolution (LTE) network.
CellId -> (integer)
The E-UTRAN Cell Identifier (ECI).Mcc -> (integer)
The Mobile Country Code (MCC).Mnc -> (integer)
The Mobile Network Code (MNC)LocalId -> (structure)
The LTE local identification information (local ID).
Earfcn -> (integer)
E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).Pci -> (integer)
Physical Cell ID (PCI).NetworkMeasurements -> (list)
The network measurements.
(structure)
LTE network measurements.
Earfcn -> (integer)
E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).CellId -> (integer)
E-UTRAN Cell Identifier (ECI).Pci -> (integer)
Physical Cell ID (PCI).Rsrp -> (integer)
Signal power of the reference signal received, measured in dBm (decibel-milliwatts).Rsrq -> (float)
Signal quality of the reference Signal received, measured in decibels (dB).TimingAdvance -> (integer)
Timing Advance (TA).NrCapable -> (boolean)
Indicates whether the LTE object is capable of supporting NR (new radio).Rsrp -> (integer)
Signal power of the reference signal received, measured in decibel-milliwatts (dBm).Rsrq -> (float)
Signal quality of the reference Signal received, measured in decibels (dB).Tac -> (integer)
LTE Tracking Area Code (TAC).
JSON Syntax:
{
"DeviceId": "string",
"SampleTime": timestamp,
"Position": [double, ...],
"Accuracy": {
"Horizontal": double
},
"Ipv4Address": "string",
"WiFiAccessPoints": [
{
"MacAddress": "string",
"Rss": integer
}
...
],
"CellSignals": {
"LteCellDetails": [
{
"CellId": integer,
"Mcc": integer,
"Mnc": integer,
"LocalId": {
"Earfcn": integer,
"Pci": integer
},
"NetworkMeasurements": [
{
"Earfcn": integer,
"CellId": integer,
"Pci": integer,
"Rsrp": integer,
"Rsrq": float
}
...
],
"TimingAdvance": integer,
"NrCapable": true|false,
"Rsrp": integer,
"Rsrq": float,
"Tac": integer
}
...
]
}
}
--distance-unit
(string)
The distance unit for the verification request.
Default Value:
Kilometers
Possible values:
Kilometers
Miles
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
InferredState -> (structure)
The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.
Position -> (list)
The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points.
(double)
Accuracy -> (structure)
The level of certainty of the inferred position.
Horizontal -> (double)
Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth's surface.DeviationDistance -> (double)
The distance between the inferred position and the device's self-reported position.ProxyDetected -> (boolean)
Indicates if a proxy was used.
DeviceId -> (string)
The device identifier.
SampleTime -> (timestamp)
The timestamp at which the device's position was determined. Uses ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.
ReceivedTime -> (timestamp)
The timestamp for when the tracker resource received the device position in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.
DistanceUnit -> (string)
The distance unit for the verification response.