| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IoTData.UpdateThingShadow
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.
Synopsis
- data UpdateThingShadow = UpdateThingShadow' {
- shadowName :: Maybe Text
- thingName :: Text
- payload :: ByteString
- newUpdateThingShadow :: Text -> ByteString -> UpdateThingShadow
- updateThingShadow_shadowName :: Lens' UpdateThingShadow (Maybe Text)
- updateThingShadow_thingName :: Lens' UpdateThingShadow Text
- updateThingShadow_payload :: Lens' UpdateThingShadow ByteString
- data UpdateThingShadowResponse = UpdateThingShadowResponse' {
- payload :: Maybe ByteString
- httpStatus :: Int
- newUpdateThingShadowResponse :: Int -> UpdateThingShadowResponse
- updateThingShadowResponse_payload :: Lens' UpdateThingShadowResponse (Maybe ByteString)
- updateThingShadowResponse_httpStatus :: Lens' UpdateThingShadowResponse Int
Creating a Request
data UpdateThingShadow Source #
The input for the UpdateThingShadow operation.
See: newUpdateThingShadow smart constructor.
Constructors
| UpdateThingShadow' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ByteString | |
| -> 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.
$sel:payload: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
| |
Instances
newUpdateThingShadowResponse Source #
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:
$sel:payload: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.