GetResourcePosition
Get the position information for a given wireless device or a wireless gateway
resource. The position information uses the World Geodetic System
(WGS84)
Request Syntax
GET /resource-positions/ResourceIdentifier?resourceType=ResourceType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ResourceIdentifier
-
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.
Pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Required: Yes
- ResourceType
-
The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.
Valid Values:
WirelessDevice | WirelessGatewayRequired: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
GeoJsonPayloadResponse Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following as the HTTP body.
- GeoJsonPayload
-
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
.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have permission to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429
- ValidationException
-
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
