amazonka-iot-2.0: gen/Amazonka/IoT/Types/OTAUpdateInfo.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.IoT.Types.OTAUpdateInfo
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.IoT.Types.OTAUpdateInfo where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoT.Types.AwsJobExecutionsRolloutConfig
import Amazonka.IoT.Types.AwsJobPresignedUrlConfig
import Amazonka.IoT.Types.ErrorInfo
import Amazonka.IoT.Types.OTAUpdateFile
import Amazonka.IoT.Types.OTAUpdateStatus
import Amazonka.IoT.Types.Protocol
import Amazonka.IoT.Types.TargetSelection
import qualified Amazonka.Prelude as Prelude
-- | Information about an OTA update.
--
-- /See:/ 'newOTAUpdateInfo' smart constructor.
data OTAUpdateInfo = OTAUpdateInfo'
{ -- | A collection of name\/value pairs
additionalParameters :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
-- | The IoT job ARN associated with the OTA update.
awsIotJobArn :: Prelude.Maybe Prelude.Text,
-- | The IoT job ID associated with the OTA update.
awsIotJobId :: Prelude.Maybe Prelude.Text,
-- | Configuration for the rollout of OTA updates.
awsJobExecutionsRolloutConfig :: Prelude.Maybe AwsJobExecutionsRolloutConfig,
-- | Configuration information for pre-signed URLs. Valid when @protocols@
-- contains HTTP.
awsJobPresignedUrlConfig :: Prelude.Maybe AwsJobPresignedUrlConfig,
-- | The date when the OTA update was created.
creationDate :: Prelude.Maybe Data.POSIX,
-- | A description of the OTA update.
description :: Prelude.Maybe Prelude.Text,
-- | Error information associated with the OTA update.
errorInfo :: Prelude.Maybe ErrorInfo,
-- | The date when the OTA update was last updated.
lastModifiedDate :: Prelude.Maybe Data.POSIX,
-- | The OTA update ARN.
otaUpdateArn :: Prelude.Maybe Prelude.Text,
-- | A list of files associated with the OTA update.
otaUpdateFiles :: Prelude.Maybe (Prelude.NonEmpty OTAUpdateFile),
-- | The OTA update ID.
otaUpdateId :: Prelude.Maybe Prelude.Text,
-- | The status of the OTA update.
otaUpdateStatus :: Prelude.Maybe OTAUpdateStatus,
-- | The protocol used to transfer the OTA update image. Valid values are
-- [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the
-- target device can choose the protocol.
protocols :: Prelude.Maybe (Prelude.NonEmpty Protocol),
-- | Specifies whether the OTA update will continue to run (CONTINUOUS), or
-- will be complete after all those things specified as targets have
-- completed the OTA update (SNAPSHOT). If continuous, the OTA update may
-- also be run on a thing when a change is detected in a target. For
-- example, an OTA update will run on a thing when the thing is added to a
-- target group, even after the OTA update was completed by all things
-- originally in the group.
targetSelection :: Prelude.Maybe TargetSelection,
-- | The targets of the OTA update.
targets :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text)
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'OTAUpdateInfo' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'additionalParameters', 'oTAUpdateInfo_additionalParameters' - A collection of name\/value pairs
--
-- 'awsIotJobArn', 'oTAUpdateInfo_awsIotJobArn' - The IoT job ARN associated with the OTA update.
--
-- 'awsIotJobId', 'oTAUpdateInfo_awsIotJobId' - The IoT job ID associated with the OTA update.
--
-- 'awsJobExecutionsRolloutConfig', 'oTAUpdateInfo_awsJobExecutionsRolloutConfig' - Configuration for the rollout of OTA updates.
--
-- 'awsJobPresignedUrlConfig', 'oTAUpdateInfo_awsJobPresignedUrlConfig' - Configuration information for pre-signed URLs. Valid when @protocols@
-- contains HTTP.
--
-- 'creationDate', 'oTAUpdateInfo_creationDate' - The date when the OTA update was created.
--
-- 'description', 'oTAUpdateInfo_description' - A description of the OTA update.
--
-- 'errorInfo', 'oTAUpdateInfo_errorInfo' - Error information associated with the OTA update.
--
-- 'lastModifiedDate', 'oTAUpdateInfo_lastModifiedDate' - The date when the OTA update was last updated.
--
-- 'otaUpdateArn', 'oTAUpdateInfo_otaUpdateArn' - The OTA update ARN.
--
-- 'otaUpdateFiles', 'oTAUpdateInfo_otaUpdateFiles' - A list of files associated with the OTA update.
--
-- 'otaUpdateId', 'oTAUpdateInfo_otaUpdateId' - The OTA update ID.
--
-- 'otaUpdateStatus', 'oTAUpdateInfo_otaUpdateStatus' - The status of the OTA update.
--
-- 'protocols', 'oTAUpdateInfo_protocols' - The protocol used to transfer the OTA update image. Valid values are
-- [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the
-- target device can choose the protocol.
--
-- 'targetSelection', 'oTAUpdateInfo_targetSelection' - Specifies whether the OTA update will continue to run (CONTINUOUS), or
-- will be complete after all those things specified as targets have
-- completed the OTA update (SNAPSHOT). If continuous, the OTA update may
-- also be run on a thing when a change is detected in a target. For
-- example, an OTA update will run on a thing when the thing is added to a
-- target group, even after the OTA update was completed by all things
-- originally in the group.
--
-- 'targets', 'oTAUpdateInfo_targets' - The targets of the OTA update.
newOTAUpdateInfo ::
OTAUpdateInfo
newOTAUpdateInfo =
OTAUpdateInfo'
{ additionalParameters =
Prelude.Nothing,
awsIotJobArn = Prelude.Nothing,
awsIotJobId = Prelude.Nothing,
awsJobExecutionsRolloutConfig = Prelude.Nothing,
awsJobPresignedUrlConfig = Prelude.Nothing,
creationDate = Prelude.Nothing,
description = Prelude.Nothing,
errorInfo = Prelude.Nothing,
lastModifiedDate = Prelude.Nothing,
otaUpdateArn = Prelude.Nothing,
otaUpdateFiles = Prelude.Nothing,
otaUpdateId = Prelude.Nothing,
otaUpdateStatus = Prelude.Nothing,
protocols = Prelude.Nothing,
targetSelection = Prelude.Nothing,
targets = Prelude.Nothing
}
-- | A collection of name\/value pairs
oTAUpdateInfo_additionalParameters :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
oTAUpdateInfo_additionalParameters = Lens.lens (\OTAUpdateInfo' {additionalParameters} -> additionalParameters) (\s@OTAUpdateInfo' {} a -> s {additionalParameters = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Lens.coerced
-- | The IoT job ARN associated with the OTA update.
oTAUpdateInfo_awsIotJobArn :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.Text)
oTAUpdateInfo_awsIotJobArn = Lens.lens (\OTAUpdateInfo' {awsIotJobArn} -> awsIotJobArn) (\s@OTAUpdateInfo' {} a -> s {awsIotJobArn = a} :: OTAUpdateInfo)
-- | The IoT job ID associated with the OTA update.
oTAUpdateInfo_awsIotJobId :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.Text)
oTAUpdateInfo_awsIotJobId = Lens.lens (\OTAUpdateInfo' {awsIotJobId} -> awsIotJobId) (\s@OTAUpdateInfo' {} a -> s {awsIotJobId = a} :: OTAUpdateInfo)
-- | Configuration for the rollout of OTA updates.
oTAUpdateInfo_awsJobExecutionsRolloutConfig :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe AwsJobExecutionsRolloutConfig)
oTAUpdateInfo_awsJobExecutionsRolloutConfig = Lens.lens (\OTAUpdateInfo' {awsJobExecutionsRolloutConfig} -> awsJobExecutionsRolloutConfig) (\s@OTAUpdateInfo' {} a -> s {awsJobExecutionsRolloutConfig = a} :: OTAUpdateInfo)
-- | Configuration information for pre-signed URLs. Valid when @protocols@
-- contains HTTP.
oTAUpdateInfo_awsJobPresignedUrlConfig :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe AwsJobPresignedUrlConfig)
oTAUpdateInfo_awsJobPresignedUrlConfig = Lens.lens (\OTAUpdateInfo' {awsJobPresignedUrlConfig} -> awsJobPresignedUrlConfig) (\s@OTAUpdateInfo' {} a -> s {awsJobPresignedUrlConfig = a} :: OTAUpdateInfo)
-- | The date when the OTA update was created.
oTAUpdateInfo_creationDate :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.UTCTime)
oTAUpdateInfo_creationDate = Lens.lens (\OTAUpdateInfo' {creationDate} -> creationDate) (\s@OTAUpdateInfo' {} a -> s {creationDate = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Data._Time
-- | A description of the OTA update.
oTAUpdateInfo_description :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.Text)
oTAUpdateInfo_description = Lens.lens (\OTAUpdateInfo' {description} -> description) (\s@OTAUpdateInfo' {} a -> s {description = a} :: OTAUpdateInfo)
-- | Error information associated with the OTA update.
oTAUpdateInfo_errorInfo :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe ErrorInfo)
oTAUpdateInfo_errorInfo = Lens.lens (\OTAUpdateInfo' {errorInfo} -> errorInfo) (\s@OTAUpdateInfo' {} a -> s {errorInfo = a} :: OTAUpdateInfo)
-- | The date when the OTA update was last updated.
oTAUpdateInfo_lastModifiedDate :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.UTCTime)
oTAUpdateInfo_lastModifiedDate = Lens.lens (\OTAUpdateInfo' {lastModifiedDate} -> lastModifiedDate) (\s@OTAUpdateInfo' {} a -> s {lastModifiedDate = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Data._Time
-- | The OTA update ARN.
oTAUpdateInfo_otaUpdateArn :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.Text)
oTAUpdateInfo_otaUpdateArn = Lens.lens (\OTAUpdateInfo' {otaUpdateArn} -> otaUpdateArn) (\s@OTAUpdateInfo' {} a -> s {otaUpdateArn = a} :: OTAUpdateInfo)
-- | A list of files associated with the OTA update.
oTAUpdateInfo_otaUpdateFiles :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe (Prelude.NonEmpty OTAUpdateFile))
oTAUpdateInfo_otaUpdateFiles = Lens.lens (\OTAUpdateInfo' {otaUpdateFiles} -> otaUpdateFiles) (\s@OTAUpdateInfo' {} a -> s {otaUpdateFiles = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Lens.coerced
-- | The OTA update ID.
oTAUpdateInfo_otaUpdateId :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe Prelude.Text)
oTAUpdateInfo_otaUpdateId = Lens.lens (\OTAUpdateInfo' {otaUpdateId} -> otaUpdateId) (\s@OTAUpdateInfo' {} a -> s {otaUpdateId = a} :: OTAUpdateInfo)
-- | The status of the OTA update.
oTAUpdateInfo_otaUpdateStatus :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe OTAUpdateStatus)
oTAUpdateInfo_otaUpdateStatus = Lens.lens (\OTAUpdateInfo' {otaUpdateStatus} -> otaUpdateStatus) (\s@OTAUpdateInfo' {} a -> s {otaUpdateStatus = a} :: OTAUpdateInfo)
-- | The protocol used to transfer the OTA update image. Valid values are
-- [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the
-- target device can choose the protocol.
oTAUpdateInfo_protocols :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe (Prelude.NonEmpty Protocol))
oTAUpdateInfo_protocols = Lens.lens (\OTAUpdateInfo' {protocols} -> protocols) (\s@OTAUpdateInfo' {} a -> s {protocols = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Lens.coerced
-- | Specifies whether the OTA update will continue to run (CONTINUOUS), or
-- will be complete after all those things specified as targets have
-- completed the OTA update (SNAPSHOT). If continuous, the OTA update may
-- also be run on a thing when a change is detected in a target. For
-- example, an OTA update will run on a thing when the thing is added to a
-- target group, even after the OTA update was completed by all things
-- originally in the group.
oTAUpdateInfo_targetSelection :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe TargetSelection)
oTAUpdateInfo_targetSelection = Lens.lens (\OTAUpdateInfo' {targetSelection} -> targetSelection) (\s@OTAUpdateInfo' {} a -> s {targetSelection = a} :: OTAUpdateInfo)
-- | The targets of the OTA update.
oTAUpdateInfo_targets :: Lens.Lens' OTAUpdateInfo (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
oTAUpdateInfo_targets = Lens.lens (\OTAUpdateInfo' {targets} -> targets) (\s@OTAUpdateInfo' {} a -> s {targets = a} :: OTAUpdateInfo) Prelude.. Lens.mapping Lens.coerced
instance Data.FromJSON OTAUpdateInfo where
parseJSON =
Data.withObject
"OTAUpdateInfo"
( \x ->
OTAUpdateInfo'
Prelude.<$> ( x
Data..:? "additionalParameters"
Data..!= Prelude.mempty
)
Prelude.<*> (x Data..:? "awsIotJobArn")
Prelude.<*> (x Data..:? "awsIotJobId")
Prelude.<*> (x Data..:? "awsJobExecutionsRolloutConfig")
Prelude.<*> (x Data..:? "awsJobPresignedUrlConfig")
Prelude.<*> (x Data..:? "creationDate")
Prelude.<*> (x Data..:? "description")
Prelude.<*> (x Data..:? "errorInfo")
Prelude.<*> (x Data..:? "lastModifiedDate")
Prelude.<*> (x Data..:? "otaUpdateArn")
Prelude.<*> (x Data..:? "otaUpdateFiles")
Prelude.<*> (x Data..:? "otaUpdateId")
Prelude.<*> (x Data..:? "otaUpdateStatus")
Prelude.<*> (x Data..:? "protocols")
Prelude.<*> (x Data..:? "targetSelection")
Prelude.<*> (x Data..:? "targets")
)
instance Prelude.Hashable OTAUpdateInfo where
hashWithSalt _salt OTAUpdateInfo' {..} =
_salt
`Prelude.hashWithSalt` additionalParameters
`Prelude.hashWithSalt` awsIotJobArn
`Prelude.hashWithSalt` awsIotJobId
`Prelude.hashWithSalt` awsJobExecutionsRolloutConfig
`Prelude.hashWithSalt` awsJobPresignedUrlConfig
`Prelude.hashWithSalt` creationDate
`Prelude.hashWithSalt` description
`Prelude.hashWithSalt` errorInfo
`Prelude.hashWithSalt` lastModifiedDate
`Prelude.hashWithSalt` otaUpdateArn
`Prelude.hashWithSalt` otaUpdateFiles
`Prelude.hashWithSalt` otaUpdateId
`Prelude.hashWithSalt` otaUpdateStatus
`Prelude.hashWithSalt` protocols
`Prelude.hashWithSalt` targetSelection
`Prelude.hashWithSalt` targets
instance Prelude.NFData OTAUpdateInfo where
rnf OTAUpdateInfo' {..} =
Prelude.rnf additionalParameters
`Prelude.seq` Prelude.rnf awsIotJobArn
`Prelude.seq` Prelude.rnf awsIotJobId
`Prelude.seq` Prelude.rnf awsJobExecutionsRolloutConfig
`Prelude.seq` Prelude.rnf awsJobPresignedUrlConfig
`Prelude.seq` Prelude.rnf creationDate
`Prelude.seq` Prelude.rnf description
`Prelude.seq` Prelude.rnf errorInfo
`Prelude.seq` Prelude.rnf lastModifiedDate
`Prelude.seq` Prelude.rnf otaUpdateArn
`Prelude.seq` Prelude.rnf otaUpdateFiles
`Prelude.seq` Prelude.rnf otaUpdateId
`Prelude.seq` Prelude.rnf otaUpdateStatus
`Prelude.seq` Prelude.rnf protocols
`Prelude.seq` Prelude.rnf targetSelection
`Prelude.seq` Prelude.rnf targets