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.IoT.Types.OTAUpdateInfo

Description

Synopsis

data OTAUpdateInfo = OTAUpdateInfo' {
- additionalParameters :: Maybe (HashMap Text Text)
- awsIotJobArn :: Maybe Text
- awsIotJobId :: Maybe Text
- awsJobExecutionsRolloutConfig :: Maybe AwsJobExecutionsRolloutConfig
- awsJobPresignedUrlConfig :: Maybe AwsJobPresignedUrlConfig
- creationDate :: Maybe POSIX
- description :: Maybe Text
- errorInfo :: Maybe ErrorInfo
- lastModifiedDate :: Maybe POSIX
- otaUpdateArn :: Maybe Text
- otaUpdateFiles :: Maybe (NonEmpty OTAUpdateFile)
- otaUpdateId :: Maybe Text
- otaUpdateStatus :: Maybe OTAUpdateStatus
- protocols :: Maybe (NonEmpty Protocol)
- targetSelection :: Maybe TargetSelection
- targets :: Maybe (NonEmpty Text)
}
newOTAUpdateInfo :: OTAUpdateInfo
oTAUpdateInfo_additionalParameters :: Lens' OTAUpdateInfo (Maybe (HashMap Text Text))
oTAUpdateInfo_awsIotJobArn :: Lens' OTAUpdateInfo (Maybe Text)
oTAUpdateInfo_awsIotJobId :: Lens' OTAUpdateInfo (Maybe Text)
oTAUpdateInfo_awsJobExecutionsRolloutConfig :: Lens' OTAUpdateInfo (Maybe AwsJobExecutionsRolloutConfig)
oTAUpdateInfo_awsJobPresignedUrlConfig :: Lens' OTAUpdateInfo (Maybe AwsJobPresignedUrlConfig)
oTAUpdateInfo_creationDate :: Lens' OTAUpdateInfo (Maybe UTCTime)
oTAUpdateInfo_description :: Lens' OTAUpdateInfo (Maybe Text)
oTAUpdateInfo_errorInfo :: Lens' OTAUpdateInfo (Maybe ErrorInfo)
oTAUpdateInfo_lastModifiedDate :: Lens' OTAUpdateInfo (Maybe UTCTime)
oTAUpdateInfo_otaUpdateArn :: Lens' OTAUpdateInfo (Maybe Text)
oTAUpdateInfo_otaUpdateFiles :: Lens' OTAUpdateInfo (Maybe (NonEmpty OTAUpdateFile))
oTAUpdateInfo_otaUpdateId :: Lens' OTAUpdateInfo (Maybe Text)
oTAUpdateInfo_otaUpdateStatus :: Lens' OTAUpdateInfo (Maybe OTAUpdateStatus)
oTAUpdateInfo_protocols :: Lens' OTAUpdateInfo (Maybe (NonEmpty Protocol))
oTAUpdateInfo_targetSelection :: Lens' OTAUpdateInfo (Maybe TargetSelection)
oTAUpdateInfo_targets :: Lens' OTAUpdateInfo (Maybe (NonEmpty Text))

Documentation

data OTAUpdateInfo Source #

Information about an OTA update.

See: newOTAUpdateInfo smart constructor.

Constructors

OTAUpdateInfo'

Fields

additionalParameters :: Maybe (HashMap Text Text)
A collection of name/value pairs
awsIotJobArn :: Maybe Text
The IoT job ARN associated with the OTA update.
awsIotJobId :: Maybe Text
The IoT job ID associated with the OTA update.
awsJobExecutionsRolloutConfig :: Maybe AwsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
awsJobPresignedUrlConfig :: Maybe AwsJobPresignedUrlConfig
Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
creationDate :: Maybe POSIX
The date when the OTA update was created.
description :: Maybe Text
A description of the OTA update.
errorInfo :: Maybe ErrorInfo
Error information associated with the OTA update.
lastModifiedDate :: Maybe POSIX
The date when the OTA update was last updated.
otaUpdateArn :: Maybe Text
The OTA update ARN.
otaUpdateFiles :: Maybe (NonEmpty OTAUpdateFile)
A list of files associated with the OTA update.
otaUpdateId :: Maybe Text
The OTA update ID.
otaUpdateStatus :: Maybe OTAUpdateStatus
The status of the OTA update.
protocols :: Maybe (NonEmpty Protocol)
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 :: Maybe 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 :: Maybe (NonEmpty Text)
The targets of the OTA update.

Instances

Instances details

FromJSON OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods parseJSON :: Value -> Parser OTAUpdateInfo # parseJSONList :: Value -> Parser [OTAUpdateInfo] #
Generic OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Associated Types type Rep OTAUpdateInfo :: Type -> Type # Methods from :: OTAUpdateInfo -> Rep OTAUpdateInfo x # to :: Rep OTAUpdateInfo x -> OTAUpdateInfo #
Read OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods readsPrec :: Int -> ReadS OTAUpdateInfo # readList :: ReadS [OTAUpdateInfo] # readPrec :: ReadPrec OTAUpdateInfo # readListPrec :: ReadPrec [OTAUpdateInfo] #
Show OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods showsPrec :: Int -> OTAUpdateInfo -> ShowS # show :: OTAUpdateInfo -> String # showList :: [OTAUpdateInfo] -> ShowS #
NFData OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods rnf :: OTAUpdateInfo -> () #
Eq OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods (==) :: OTAUpdateInfo -> OTAUpdateInfo -> Bool # (/=) :: OTAUpdateInfo -> OTAUpdateInfo -> Bool #
Hashable OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo Methods hashWithSalt :: Int -> OTAUpdateInfo -> Int # hash :: OTAUpdateInfo -> Int #
type Rep OTAUpdateInfo Source #
Instance details Defined in Amazonka.IoT.Types.OTAUpdateInfo type Rep OTAUpdateInfo = D1 ('MetaData "OTAUpdateInfo" "Amazonka.IoT.Types.OTAUpdateInfo" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "OTAUpdateInfo'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "awsIotJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "awsIotJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsJobExecutionsRolloutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobExecutionsRolloutConfig)))) :: ((S1 ('MetaSel ('Just "awsJobPresignedUrlConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobPresignedUrlConfig)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorInfo))))) :: (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "otaUpdateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "otaUpdateFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty OTAUpdateFile))) :: S1 ('MetaSel ('Just "otaUpdateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "otaUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OTAUpdateStatus)) :: S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol)))) :: (S1 ('MetaSel ('Just "targetSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetSelection)) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))))

newOTAUpdateInfo :: OTAUpdateInfo Source #

Create a value of OTAUpdateInfo 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:additionalParameters:OTAUpdateInfo', oTAUpdateInfo_additionalParameters - A collection of name/value pairs

$sel:awsIotJobArn:OTAUpdateInfo', oTAUpdateInfo_awsIotJobArn - The IoT job ARN associated with the OTA update.

$sel:awsIotJobId:OTAUpdateInfo', oTAUpdateInfo_awsIotJobId - The IoT job ID associated with the OTA update.

$sel:awsJobExecutionsRolloutConfig:OTAUpdateInfo', oTAUpdateInfo_awsJobExecutionsRolloutConfig - Configuration for the rollout of OTA updates.

$sel:awsJobPresignedUrlConfig:OTAUpdateInfo', oTAUpdateInfo_awsJobPresignedUrlConfig - Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

$sel:creationDate:OTAUpdateInfo', oTAUpdateInfo_creationDate - The date when the OTA update was created.

$sel:description:OTAUpdateInfo', oTAUpdateInfo_description - A description of the OTA update.

$sel:errorInfo:OTAUpdateInfo', oTAUpdateInfo_errorInfo - Error information associated with the OTA update.

$sel:lastModifiedDate:OTAUpdateInfo', oTAUpdateInfo_lastModifiedDate - The date when the OTA update was last updated.

$sel:otaUpdateArn:OTAUpdateInfo', oTAUpdateInfo_otaUpdateArn - The OTA update ARN.

$sel:otaUpdateFiles:OTAUpdateInfo', oTAUpdateInfo_otaUpdateFiles - A list of files associated with the OTA update.

$sel:otaUpdateId:OTAUpdateInfo', oTAUpdateInfo_otaUpdateId - The OTA update ID.

$sel:otaUpdateStatus:OTAUpdateInfo', oTAUpdateInfo_otaUpdateStatus - The status of the OTA update.

$sel:protocols:OTAUpdateInfo', 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.

$sel:targetSelection:OTAUpdateInfo', 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.

$sel:targets:OTAUpdateInfo', oTAUpdateInfo_targets - The targets of the OTA update.

oTAUpdateInfo_additionalParameters :: Lens' OTAUpdateInfo (Maybe (HashMap Text Text)) Source #

A collection of name/value pairs

oTAUpdateInfo_awsIotJobArn :: Lens' OTAUpdateInfo (Maybe Text) Source #

The IoT job ARN associated with the OTA update.

oTAUpdateInfo_awsIotJobId :: Lens' OTAUpdateInfo (Maybe Text) Source #

The IoT job ID associated with the OTA update.

oTAUpdateInfo_awsJobExecutionsRolloutConfig :: Lens' OTAUpdateInfo (Maybe AwsJobExecutionsRolloutConfig) Source #

Configuration for the rollout of OTA updates.

oTAUpdateInfo_awsJobPresignedUrlConfig :: Lens' OTAUpdateInfo (Maybe AwsJobPresignedUrlConfig) Source #

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

oTAUpdateInfo_creationDate :: Lens' OTAUpdateInfo (Maybe UTCTime) Source #

The date when the OTA update was created.

oTAUpdateInfo_description :: Lens' OTAUpdateInfo (Maybe Text) Source #

A description of the OTA update.

oTAUpdateInfo_errorInfo :: Lens' OTAUpdateInfo (Maybe ErrorInfo) Source #

Error information associated with the OTA update.

oTAUpdateInfo_lastModifiedDate :: Lens' OTAUpdateInfo (Maybe UTCTime) Source #

The date when the OTA update was last updated.

oTAUpdateInfo_otaUpdateArn :: Lens' OTAUpdateInfo (Maybe Text) Source #

The OTA update ARN.

oTAUpdateInfo_otaUpdateFiles :: Lens' OTAUpdateInfo (Maybe (NonEmpty OTAUpdateFile)) Source #

A list of files associated with the OTA update.

oTAUpdateInfo_otaUpdateId :: Lens' OTAUpdateInfo (Maybe Text) Source #

The OTA update ID.

oTAUpdateInfo_otaUpdateStatus :: Lens' OTAUpdateInfo (Maybe OTAUpdateStatus) Source #

The status of the OTA update.

oTAUpdateInfo_protocols :: Lens' OTAUpdateInfo (Maybe (NonEmpty Protocol)) Source #

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_targetSelection :: Lens' OTAUpdateInfo (Maybe TargetSelection) Source #

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_targets :: Lens' OTAUpdateInfo (Maybe (NonEmpty Text)) Source #

The targets of the OTA update.