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.IotTwinMaker.DeleteEntity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an entity.

Synopsis

Creating a Request

data DeleteEntity Source #

See: newDeleteEntity smart constructor.

Constructors

DeleteEntity'
Fields isRecursive :: Maybe Bool A Boolean value that specifies whether the operation deletes child entities. workspaceId :: Text The ID of the workspace that contains the entity to delete. entityId :: Text The ID of the entity to delete.

Instances

Instances details

ToHeaders DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods toHeaders :: DeleteEntity -> [Header] #
ToPath DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods toPath :: DeleteEntity -> ByteString #
ToQuery DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods toQuery :: DeleteEntity -> QueryString #
AWSRequest DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Associated Types type AWSResponse DeleteEntity # Methods request :: (Service -> Service) -> DeleteEntity -> Request DeleteEntity # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteEntity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteEntity))) #
Generic DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Associated Types type Rep DeleteEntity :: Type -> Type # Methods from :: DeleteEntity -> Rep DeleteEntity x # to :: Rep DeleteEntity x -> DeleteEntity #
Read DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods readsPrec :: Int -> ReadS DeleteEntity # readList :: ReadS [DeleteEntity] # readPrec :: ReadPrec DeleteEntity # readListPrec :: ReadPrec [DeleteEntity] #
Show DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods showsPrec :: Int -> DeleteEntity -> ShowS # show :: DeleteEntity -> String # showList :: [DeleteEntity] -> ShowS #
NFData DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods rnf :: DeleteEntity -> () #
Eq DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods (==) :: DeleteEntity -> DeleteEntity -> Bool # (/=) :: DeleteEntity -> DeleteEntity -> Bool #
Hashable DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity Methods hashWithSalt :: Int -> DeleteEntity -> Int # hash :: DeleteEntity -> Int #
type AWSResponse DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity type AWSResponse DeleteEntity = DeleteEntityResponse
type Rep DeleteEntity Source #
Instance details Defined in Amazonka.IotTwinMaker.DeleteEntity type Rep DeleteEntity = D1 ('MetaData "DeleteEntity" "Amazonka.IotTwinMaker.DeleteEntity" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "DeleteEntity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isRecursive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteEntity Source #

Arguments

:: Text	`DeleteEntity`
-> Text	`DeleteEntity`
-> DeleteEntity

Create a value of DeleteEntity 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:isRecursive:DeleteEntity', deleteEntity_isRecursive - A Boolean value that specifies whether the operation deletes child entities.

DeleteEntity, deleteEntity_workspaceId - The ID of the workspace that contains the entity to delete.

DeleteEntity, deleteEntity_entityId - The ID of the entity to delete.

Request Lenses

deleteEntity_isRecursive :: Lens' DeleteEntity (Maybe Bool) Source #

A Boolean value that specifies whether the operation deletes child entities.

deleteEntity_workspaceId :: Lens' DeleteEntity Text Source #

The ID of the workspace that contains the entity to delete.

deleteEntity_entityId :: Lens' DeleteEntity Text Source #

The ID of the entity to delete.

Destructuring the Response

data DeleteEntityResponse Source #

See: newDeleteEntityResponse smart constructor.

Constructors

DeleteEntityResponse'
Fields httpStatus :: Int The response's http status code. state :: State The current state of the deleted entity.

Instances

Instances details

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

newDeleteEntityResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteEntityResponse'`
-> State	`DeleteEntityResponse`
-> DeleteEntityResponse

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

DeleteEntityResponse, deleteEntityResponse_state - The current state of the deleted entity.

Response Lenses

deleteEntityResponse_httpStatus :: Lens' DeleteEntityResponse Int Source #

The response's http status code.

deleteEntityResponse_state :: Lens' DeleteEntityResponse State Source #

The current state of the deleted entity.