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.IoT.UpdateThing

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the data for a thing.

Requires permission to access the UpdateThing action.

Creating a Request

data UpdateThing Source #

The input for the UpdateThing operation.

See: newUpdateThing smart constructor.

Constructors

UpdateThing'

Fields

attributePayload :: Maybe AttributePayload
A list of thing attributes, a JSON string containing name-value pairs. For example:
```
{\"attributes\":{\"name1\":\"value2\"}}
```
This data is used to add new attributes or update existing attributes.
expectedVersion :: Maybe Integer
The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.
removeThingType :: Maybe Bool
Remove a thing type association. If true, the association is removed.
thingTypeName :: Maybe Text
The name of the thing type.
thingName :: Text
The name of the thing to update.
You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Instances

Instances details

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

newUpdateThing Source #

Arguments

:: Text	`UpdateThing`
-> UpdateThing

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

UpdateThing, updateThing_attributePayload - A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

$sel:expectedVersion:UpdateThing', updateThing_expectedVersion - The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

$sel:removeThingType:UpdateThing', updateThing_removeThingType - Remove a thing type association. If true, the association is removed.

UpdateThing, updateThing_thingTypeName - The name of the thing type.

UpdateThing, updateThing_thingName - The name of the thing to update.

You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Request Lenses

updateThing_attributePayload :: Lens' UpdateThing (Maybe AttributePayload) Source #

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

updateThing_expectedVersion :: Lens' UpdateThing (Maybe Integer) Source #

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

updateThing_removeThingType :: Lens' UpdateThing (Maybe Bool) Source #

Remove a thing type association. If true, the association is removed.

updateThing_thingTypeName :: Lens' UpdateThing (Maybe Text) Source #

The name of the thing type.

updateThing_thingName :: Lens' UpdateThing Text Source #

The name of the thing to update.

You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Destructuring the Response

data UpdateThingResponse Source #

The output from the UpdateThing operation.

See: newUpdateThingResponse smart constructor.

Constructors

UpdateThingResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateThingResponse Source #

Arguments

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

Create a value of UpdateThingResponse 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:httpStatus:UpdateThingResponse', updateThingResponse_httpStatus - The response's http status code.

Response Lenses

updateThingResponse_httpStatus :: Lens' UpdateThingResponse Int Source #

The response's http status code.