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.IoTData.UpdateThingShadow

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

For more information, see UpdateThingShadow in the IoT Developer Guide.

Creating a Request

data UpdateThingShadow Source #

The input for the UpdateThingShadow operation.

See: newUpdateThingShadow smart constructor.

Constructors

UpdateThingShadow'
Fields shadowName :: Maybe Text The name of the shadow. thingName :: Text The name of the thing. payload :: ByteString The state information, in JSON format.

Instances

Instances details

ToBody UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods toBody :: UpdateThingShadow -> RequestBody #
ToHeaders UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods toHeaders :: UpdateThingShadow -> [Header] #
ToPath UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods toPath :: UpdateThingShadow -> ByteString #
ToQuery UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods toQuery :: UpdateThingShadow -> QueryString #
AWSRequest UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Associated Types type AWSResponse UpdateThingShadow # Methods request :: (Service -> Service) -> UpdateThingShadow -> Request UpdateThingShadow # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateThingShadow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateThingShadow))) #
Generic UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Associated Types type Rep UpdateThingShadow :: Type -> Type # Methods from :: UpdateThingShadow -> Rep UpdateThingShadow x # to :: Rep UpdateThingShadow x -> UpdateThingShadow #
Show UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods showsPrec :: Int -> UpdateThingShadow -> ShowS # show :: UpdateThingShadow -> String # showList :: [UpdateThingShadow] -> ShowS #
NFData UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods rnf :: UpdateThingShadow -> () #
Eq UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods (==) :: UpdateThingShadow -> UpdateThingShadow -> Bool # (/=) :: UpdateThingShadow -> UpdateThingShadow -> Bool #
Hashable UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods hashWithSalt :: Int -> UpdateThingShadow -> Int # hash :: UpdateThingShadow -> Int #
type AWSResponse UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow type AWSResponse UpdateThingShadow = UpdateThingShadowResponse
type Rep UpdateThingShadow Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow type Rep UpdateThingShadow = D1 ('MetaData "UpdateThingShadow" "Amazonka.IoTData.UpdateThingShadow" "amazonka-iot-dataplane-2.0-Fdc9p3E1INX2O9pOv9RFV7" 'False) (C1 ('MetaCons "UpdateThingShadow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shadowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

newUpdateThingShadow Source #

Arguments

:: Text	`$sel:thingName:UpdateThingShadow'`
-> ByteString	`UpdateThingShadow`
-> UpdateThingShadow

Create a value of UpdateThingShadow 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:shadowName:UpdateThingShadow', updateThingShadow_shadowName - The name of the shadow.

$sel:thingName:UpdateThingShadow', updateThingShadow_thingName - The name of the thing.

UpdateThingShadow, updateThingShadow_payload - The state information, in JSON format.

Request Lenses

updateThingShadow_shadowName :: Lens' UpdateThingShadow (Maybe Text) Source #

The name of the shadow.

updateThingShadow_thingName :: Lens' UpdateThingShadow Text Source #

The name of the thing.

updateThingShadow_payload :: Lens' UpdateThingShadow ByteString Source #

The state information, in JSON format.

Destructuring the Response

data UpdateThingShadowResponse Source #

The output from the UpdateThingShadow operation.

See: newUpdateThingShadowResponse smart constructor.

Constructors

UpdateThingShadowResponse'
Fields payload :: Maybe ByteString The state information, in JSON format. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateThingShadowResponse Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Associated Types type Rep UpdateThingShadowResponse :: Type -> Type # Methods from :: UpdateThingShadowResponse -> Rep UpdateThingShadowResponse x # to :: Rep UpdateThingShadowResponse x -> UpdateThingShadowResponse #
Show UpdateThingShadowResponse Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods showsPrec :: Int -> UpdateThingShadowResponse -> ShowS # show :: UpdateThingShadowResponse -> String # showList :: [UpdateThingShadowResponse] -> ShowS #
NFData UpdateThingShadowResponse Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods rnf :: UpdateThingShadowResponse -> () #
Eq UpdateThingShadowResponse Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow Methods (==) :: UpdateThingShadowResponse -> UpdateThingShadowResponse -> Bool # (/=) :: UpdateThingShadowResponse -> UpdateThingShadowResponse -> Bool #
type Rep UpdateThingShadowResponse Source #
Instance details Defined in Amazonka.IoTData.UpdateThingShadow type Rep UpdateThingShadowResponse = D1 ('MetaData "UpdateThingShadowResponse" "Amazonka.IoTData.UpdateThingShadow" "amazonka-iot-dataplane-2.0-Fdc9p3E1INX2O9pOv9RFV7" 'False) (C1 ('MetaCons "UpdateThingShadowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateThingShadowResponse Source #

Arguments

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

Create a value of UpdateThingShadowResponse 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:

UpdateThingShadow, updateThingShadowResponse_payload - The state information, in JSON format.

$sel:httpStatus:UpdateThingShadowResponse', updateThingShadowResponse_httpStatus - The response's http status code.

Response Lenses

updateThingShadowResponse_payload :: Lens' UpdateThingShadowResponse (Maybe ByteString) Source #

The state information, in JSON format.

updateThingShadowResponse_httpStatus :: Lens' UpdateThingShadowResponse Int Source #

The response's http status code.