| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoTWireless.GetResourcePosition
Description
Get the position information for a given wireless device or a wireless gateway resource. The postion information uses the World Geodetic System (WGS84).
Synopsis
- data GetResourcePosition = GetResourcePosition' {}
- newGetResourcePosition :: Text -> PositionResourceType -> GetResourcePosition
- getResourcePosition_resourceIdentifier :: Lens' GetResourcePosition Text
- getResourcePosition_resourceType :: Lens' GetResourcePosition PositionResourceType
- data GetResourcePositionResponse = GetResourcePositionResponse' {}
- newGetResourcePositionResponse :: Int -> GetResourcePositionResponse
- getResourcePositionResponse_geoJsonPayload :: Lens' GetResourcePositionResponse (Maybe ByteString)
- getResourcePositionResponse_httpStatus :: Lens' GetResourcePositionResponse Int
Creating a Request
data GetResourcePosition Source #
See: newGetResourcePosition smart constructor.
Constructors
| GetResourcePosition' | |
Fields
| |
Instances
newGetResourcePosition Source #
Arguments
| :: Text | |
| -> PositionResourceType | |
| -> GetResourcePosition |
Create a value of GetResourcePosition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceIdentifier:GetResourcePosition', getResourcePosition_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.
$sel:resourceType:GetResourcePosition', getResourcePosition_resourceType - The type of resource for which position information is retrieved, which
can be a wireless device or a wireless gateway.
Request Lenses
getResourcePosition_resourceIdentifier :: Lens' GetResourcePosition Text Source #
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.
getResourcePosition_resourceType :: Lens' GetResourcePosition PositionResourceType Source #
The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.
Destructuring the Response
data GetResourcePositionResponse Source #
See: newGetResourcePositionResponse smart constructor.
Constructors
| GetResourcePositionResponse' | |
Fields
| |
Instances
newGetResourcePositionResponse Source #
Create a value of GetResourcePositionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:geoJsonPayload:GetResourcePositionResponse', getResourcePositionResponse_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.
$sel:httpStatus:GetResourcePositionResponse', getResourcePositionResponse_httpStatus - The response's http status code.
Response Lenses
getResourcePositionResponse_geoJsonPayload :: Lens' GetResourcePositionResponse (Maybe ByteString) Source #
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.
getResourcePositionResponse_httpStatus :: Lens' GetResourcePositionResponse Int Source #
The response's http status code.