amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.DeleteThing

Description

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

Requires permission to access the DeleteThing action.

Synopsis

Creating a Request

data DeleteThing Source #

The input for the DeleteThing operation.

See: newDeleteThing smart constructor.

Constructors

DeleteThing' 

Fields

  • 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 DeleteThing request is rejected with a VersionConflictException.

  • thingName :: Text

    The name of the thing to delete.

Instances

Instances details
ToHeaders DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Methods

toHeaders :: DeleteThing -> [Header] #

ToPath DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

ToQuery DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

AWSRequest DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Associated Types

type AWSResponse DeleteThing #

Generic DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Associated Types

type Rep DeleteThing :: Type -> Type #

Read DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Show DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

NFData DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Methods

rnf :: DeleteThing -> () #

Eq DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Hashable DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

type AWSResponse DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

type Rep DeleteThing Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

type Rep DeleteThing = D1 ('MetaData "DeleteThing" "Amazonka.IoT.DeleteThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteThing'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteThing Source #

Create a value of DeleteThing 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:expectedVersion:DeleteThing', deleteThing_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 DeleteThing request is rejected with a VersionConflictException.

DeleteThing, deleteThing_thingName - The name of the thing to delete.

Request Lenses

deleteThing_expectedVersion :: Lens' DeleteThing (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 DeleteThing request is rejected with a VersionConflictException.

deleteThing_thingName :: Lens' DeleteThing Text Source #

The name of the thing to delete.

Destructuring the Response

data DeleteThingResponse Source #

The output of the DeleteThing operation.

See: newDeleteThingResponse smart constructor.

Constructors

DeleteThingResponse' 

Fields

Instances

Instances details
Generic DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Associated Types

type Rep DeleteThingResponse :: Type -> Type #

Read DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Show DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

NFData DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

Methods

rnf :: DeleteThingResponse -> () #

Eq DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

type Rep DeleteThingResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteThing

type Rep DeleteThingResponse = D1 ('MetaData "DeleteThingResponse" "Amazonka.IoT.DeleteThing" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteThingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteThingResponse Source #

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

Response Lenses