IoTWireless / Client / get_resource_position

get_resource_position#

IoTWireless.Client.get_resource_position(**kwargs)#

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).

See also: AWS API Documentation

Request Syntax

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

  • ResourceIdentifier (string) –

    [REQUIRED]

    The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

  • ResourceType (string) –

    [REQUIRED]

    The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

Return type:

dict

Returns:

Response Syntax

{
    'GeoJsonPayload': StreamingBody()
}

Response Structure

  • (dict) –

    • GeoJsonPayload (StreamingBody) –

      The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that’s used to encode geographic data structures. For more information, see GeoJSON.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException

  • IoTWireless.Client.exceptions.AccessDeniedException

  • IoTWireless.Client.exceptions.ResourceNotFoundException

  • IoTWireless.Client.exceptions.ThrottlingException

  • IoTWireless.Client.exceptions.InternalServerException