IoTWireless / Client / get_position

get_position#

IoTWireless.Client.get_position(**kwargs)#

Get the position information for a given resource.

Warning

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_position(
    ResourceIdentifier='string',
    ResourceType='WirelessDevice'|'WirelessGateway'
)
Parameters:

  • ResourceIdentifier (string) –

    [REQUIRED]

    Resource identifier used to retrieve the position information.

  • ResourceType (string) –

    [REQUIRED]

    Resource type of the resource for which position information is retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'Position': [
        ...,
    ],
    'Accuracy': {
        'HorizontalAccuracy': ...,
        'VerticalAccuracy': ...
    },
    'SolverType': 'GNSS',
    'SolverProvider': 'Semtech',
    'SolverVersion': 'string',
    'Timestamp': 'string'
}

Response Structure

  • (dict) –

    • Position (list) –

      The position information of the resource.

      • (float) –

    • Accuracy (dict) –

      The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

      • HorizontalAccuracy (float) –

        The horizontal accuracy of the estimated position, which is the difference between the estimated location and the actual device location.

      • VerticalAccuracy (float) –

        The vertical accuracy of the estimated position, which is the difference between the estimated altitude and actual device latitude in meters.

    • SolverType (string) –

      The type of solver used to identify the position of the resource.

    • SolverProvider (string) –

      The vendor of the positioning solver.

    • SolverVersion (string) –

      The version of the positioning solver.

    • Timestamp (string) –

      The timestamp at which the device’s position was determined.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException

  • IoTWireless.Client.exceptions.AccessDeniedException

  • IoTWireless.Client.exceptions.ResourceNotFoundException

  • IoTWireless.Client.exceptions.ThrottlingException

  • IoTWireless.Client.exceptions.InternalServerException