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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

Creating a Request

data DeleteOTAUpdate Source #

See: newDeleteOTAUpdate smart constructor.

Constructors

DeleteOTAUpdate'

Fields

forceDeleteAWSJob :: Maybe Bool
When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.
deleteStream :: Maybe Bool
When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.
otaUpdateId :: Text
The ID of the OTA update to delete.

Instances

Instances details

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

newDeleteOTAUpdate Source #

Arguments

:: Text	`$sel:otaUpdateId:DeleteOTAUpdate'`
-> DeleteOTAUpdate

Create a value of DeleteOTAUpdate 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:forceDeleteAWSJob:DeleteOTAUpdate', deleteOTAUpdate_forceDeleteAWSJob - When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

$sel:deleteStream:DeleteOTAUpdate', deleteOTAUpdate_deleteStream - When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

$sel:otaUpdateId:DeleteOTAUpdate', deleteOTAUpdate_otaUpdateId - The ID of the OTA update to delete.

Request Lenses

deleteOTAUpdate_forceDeleteAWSJob :: Lens' DeleteOTAUpdate (Maybe Bool) Source #

When true, deletes the IoT job created by the OTAUpdate process even if it is "IN_PROGRESS". Otherwise, if the job is not in a terminal state ("COMPLETED" or "CANCELED") an exception will occur. The default is false.

deleteOTAUpdate_deleteStream :: Lens' DeleteOTAUpdate (Maybe Bool) Source #

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

deleteOTAUpdate_otaUpdateId :: Lens' DeleteOTAUpdate Text Source #

The ID of the OTA update to delete.

Destructuring the Response

data DeleteOTAUpdateResponse Source #

See: newDeleteOTAUpdateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteOTAUpdateResponse Source #

Arguments

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

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

Response Lenses

deleteOTAUpdateResponse_httpStatus :: Lens' DeleteOTAUpdateResponse Int Source #

The response's http status code.