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

Description

Delete an OTA update.

Requires permission to access the DeleteOTAUpdate action.

Synopsis

Creating a Request

data DeleteOTAUpdate Source #

See: newDeleteOTAUpdate smart constructor.

Constructors

DeleteOTAUpdate' 

Fields

  • 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.

  • 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.

  • otaUpdateId :: Text

    The ID of the OTA update to delete.

Instances

Instances details
ToHeaders DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

ToPath DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

ToQuery DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

AWSRequest DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Associated Types

type AWSResponse DeleteOTAUpdate #

Generic DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Associated Types

type Rep DeleteOTAUpdate :: Type -> Type #

Read DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Show DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

NFData DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Methods

rnf :: DeleteOTAUpdate -> () #

Eq DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Hashable DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

type AWSResponse DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

type Rep DeleteOTAUpdate Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

type Rep DeleteOTAUpdate = D1 ('MetaData "DeleteOTAUpdate" "Amazonka.IoT.DeleteOTAUpdate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DeleteOTAUpdate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "forceDeleteAWSJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "otaUpdateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteOTAUpdate Source #

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: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: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.

DeleteOTAUpdate, deleteOTAUpdate_otaUpdateId - The ID of the OTA update to delete.

Request Lenses

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_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_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

Instances

Instances details
Generic DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Associated Types

type Rep DeleteOTAUpdateResponse :: Type -> Type #

Read DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Show DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

NFData DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

Methods

rnf :: DeleteOTAUpdateResponse -> () #

Eq DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

type Rep DeleteOTAUpdateResponse Source # 
Instance details

Defined in Amazonka.IoT.DeleteOTAUpdate

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

newDeleteOTAUpdateResponse Source #

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