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.IoT1ClickDevices.InvokeDeviceMethod

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

Creating a Request

data InvokeDeviceMethod Source #

See: newInvokeDeviceMethod smart constructor.

Constructors

InvokeDeviceMethod'
Fields deviceMethod :: Maybe DeviceMethod The device method to invoke. deviceMethodParameters :: Maybe Text A JSON encoded string containing the device method request parameters. deviceId :: Text The unique identifier of the device.

Instances

Instances details

ToJSON InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods toJSON :: InvokeDeviceMethod -> Value # toEncoding :: InvokeDeviceMethod -> Encoding # toJSONList :: [InvokeDeviceMethod] -> Value # toEncodingList :: [InvokeDeviceMethod] -> Encoding #
ToHeaders InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods toHeaders :: InvokeDeviceMethod -> [Header] #
ToPath InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods toPath :: InvokeDeviceMethod -> ByteString #
ToQuery InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods toQuery :: InvokeDeviceMethod -> QueryString #
AWSRequest InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Associated Types type AWSResponse InvokeDeviceMethod # Methods request :: (Service -> Service) -> InvokeDeviceMethod -> Request InvokeDeviceMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InvokeDeviceMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InvokeDeviceMethod))) #
Generic InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Associated Types type Rep InvokeDeviceMethod :: Type -> Type # Methods from :: InvokeDeviceMethod -> Rep InvokeDeviceMethod x # to :: Rep InvokeDeviceMethod x -> InvokeDeviceMethod #
Read InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods readsPrec :: Int -> ReadS InvokeDeviceMethod # readList :: ReadS [InvokeDeviceMethod] # readPrec :: ReadPrec InvokeDeviceMethod # readListPrec :: ReadPrec [InvokeDeviceMethod] #
Show InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods showsPrec :: Int -> InvokeDeviceMethod -> ShowS # show :: InvokeDeviceMethod -> String # showList :: [InvokeDeviceMethod] -> ShowS #
NFData InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods rnf :: InvokeDeviceMethod -> () #
Eq InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods (==) :: InvokeDeviceMethod -> InvokeDeviceMethod -> Bool # (/=) :: InvokeDeviceMethod -> InvokeDeviceMethod -> Bool #
Hashable InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod Methods hashWithSalt :: Int -> InvokeDeviceMethod -> Int # hash :: InvokeDeviceMethod -> Int #
type AWSResponse InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod type AWSResponse InvokeDeviceMethod = InvokeDeviceMethodResponse
type Rep InvokeDeviceMethod Source #
Instance details Defined in Amazonka.IoT1ClickDevices.InvokeDeviceMethod type Rep InvokeDeviceMethod = D1 ('MetaData "InvokeDeviceMethod" "Amazonka.IoT1ClickDevices.InvokeDeviceMethod" "amazonka-iot1click-devices-2.0-9HUhsuXK7LTlqVc7Joztr" 'False) (C1 ('MetaCons "InvokeDeviceMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceMethod)) :: (S1 ('MetaSel ('Just "deviceMethodParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newInvokeDeviceMethod Source #

Arguments

:: Text	`InvokeDeviceMethod`
-> InvokeDeviceMethod

Create a value of InvokeDeviceMethod 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:deviceMethod:InvokeDeviceMethod', invokeDeviceMethod_deviceMethod - The device method to invoke.

$sel:deviceMethodParameters:InvokeDeviceMethod', invokeDeviceMethod_deviceMethodParameters - A JSON encoded string containing the device method request parameters.

InvokeDeviceMethod, invokeDeviceMethod_deviceId - The unique identifier of the device.

Request Lenses

invokeDeviceMethod_deviceMethod :: Lens' InvokeDeviceMethod (Maybe DeviceMethod) Source #

The device method to invoke.

invokeDeviceMethod_deviceMethodParameters :: Lens' InvokeDeviceMethod (Maybe Text) Source #

A JSON encoded string containing the device method request parameters.

invokeDeviceMethod_deviceId :: Lens' InvokeDeviceMethod Text Source #

The unique identifier of the device.

Destructuring the Response

data InvokeDeviceMethodResponse Source #

See: newInvokeDeviceMethodResponse smart constructor.

Constructors

InvokeDeviceMethodResponse'
Fields deviceMethodResponse :: Maybe Text A JSON encoded string containing the device method response. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newInvokeDeviceMethodResponse Source #

Arguments

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

Create a value of InvokeDeviceMethodResponse 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:deviceMethodResponse:InvokeDeviceMethodResponse', invokeDeviceMethodResponse_deviceMethodResponse - A JSON encoded string containing the device method response.

$sel:httpStatus:InvokeDeviceMethodResponse', invokeDeviceMethodResponse_httpStatus - The response's http status code.

Response Lenses

invokeDeviceMethodResponse_deviceMethodResponse :: Lens' InvokeDeviceMethodResponse (Maybe Text) Source #

A JSON encoded string containing the device method response.

invokeDeviceMethodResponse_httpStatus :: Lens' InvokeDeviceMethodResponse Int Source #

The response's http status code.