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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data GetResourcePosition Source #

See: newGetResourcePosition smart constructor.

Constructors

GetResourcePosition'
Fields resourceIdentifier :: Text 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 :: PositionResourceType The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

Instances

Instances details

ToHeaders GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods toHeaders :: GetResourcePosition -> [Header] #
ToPath GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods toPath :: GetResourcePosition -> ByteString #
ToQuery GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods toQuery :: GetResourcePosition -> QueryString #
AWSRequest GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Associated Types type AWSResponse GetResourcePosition # Methods request :: (Service -> Service) -> GetResourcePosition -> Request GetResourcePosition # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetResourcePosition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResourcePosition))) #
Generic GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Associated Types type Rep GetResourcePosition :: Type -> Type # Methods from :: GetResourcePosition -> Rep GetResourcePosition x # to :: Rep GetResourcePosition x -> GetResourcePosition #
Read GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods readsPrec :: Int -> ReadS GetResourcePosition # readList :: ReadS [GetResourcePosition] # readPrec :: ReadPrec GetResourcePosition # readListPrec :: ReadPrec [GetResourcePosition] #
Show GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods showsPrec :: Int -> GetResourcePosition -> ShowS # show :: GetResourcePosition -> String # showList :: [GetResourcePosition] -> ShowS #
NFData GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods rnf :: GetResourcePosition -> () #
Eq GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods (==) :: GetResourcePosition -> GetResourcePosition -> Bool # (/=) :: GetResourcePosition -> GetResourcePosition -> Bool #
Hashable GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods hashWithSalt :: Int -> GetResourcePosition -> Int # hash :: GetResourcePosition -> Int #
type AWSResponse GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition type AWSResponse GetResourcePosition = GetResourcePositionResponse
type Rep GetResourcePosition Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition type Rep GetResourcePosition = D1 ('MetaData "GetResourcePosition" "Amazonka.IoTWireless.GetResourcePosition" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "GetResourcePosition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PositionResourceType)))

newGetResourcePosition Source #

Arguments

:: Text	`$sel:resourceIdentifier:GetResourcePosition'`
-> PositionResourceType	`$sel:resourceType:GetResourcePosition'`
-> 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 geoJsonPayload :: Maybe ByteString 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Associated Types type Rep GetResourcePositionResponse :: Type -> Type # Methods from :: GetResourcePositionResponse -> Rep GetResourcePositionResponse x # to :: Rep GetResourcePositionResponse x -> GetResourcePositionResponse #
Read GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods readsPrec :: Int -> ReadS GetResourcePositionResponse # readList :: ReadS [GetResourcePositionResponse] # readPrec :: ReadPrec GetResourcePositionResponse # readListPrec :: ReadPrec [GetResourcePositionResponse] #
Show GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods showsPrec :: Int -> GetResourcePositionResponse -> ShowS # show :: GetResourcePositionResponse -> String # showList :: [GetResourcePositionResponse] -> ShowS #
NFData GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods rnf :: GetResourcePositionResponse -> () #
Eq GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition Methods (==) :: GetResourcePositionResponse -> GetResourcePositionResponse -> Bool # (/=) :: GetResourcePositionResponse -> GetResourcePositionResponse -> Bool #
type Rep GetResourcePositionResponse Source #
Instance details Defined in Amazonka.IoTWireless.GetResourcePosition type Rep GetResourcePositionResponse = D1 ('MetaData "GetResourcePositionResponse" "Amazonka.IoTWireless.GetResourcePosition" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "GetResourcePositionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "geoJsonPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetResourcePositionResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetResourcePositionResponse'`
-> GetResourcePositionResponse

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.