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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Synopsis

data CreateOTAUpdate = CreateOTAUpdate' {
- additionalParameters :: Maybe (HashMap Text Text)
- awsJobAbortConfig :: Maybe AwsJobAbortConfig
- awsJobExecutionsRolloutConfig :: Maybe AwsJobExecutionsRolloutConfig
- awsJobPresignedUrlConfig :: Maybe AwsJobPresignedUrlConfig
- awsJobTimeoutConfig :: Maybe AwsJobTimeoutConfig
- description :: Maybe Text
- protocols :: Maybe (NonEmpty Protocol)
- tags :: Maybe [Tag]
- targetSelection :: Maybe TargetSelection
- otaUpdateId :: Text
- targets :: NonEmpty Text
- files :: NonEmpty OTAUpdateFile
- roleArn :: Text
}
newCreateOTAUpdate :: Text -> NonEmpty Text -> NonEmpty OTAUpdateFile -> Text -> CreateOTAUpdate
createOTAUpdate_additionalParameters :: Lens' CreateOTAUpdate (Maybe (HashMap Text Text))
createOTAUpdate_awsJobAbortConfig :: Lens' CreateOTAUpdate (Maybe AwsJobAbortConfig)
createOTAUpdate_awsJobExecutionsRolloutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobExecutionsRolloutConfig)
createOTAUpdate_awsJobPresignedUrlConfig :: Lens' CreateOTAUpdate (Maybe AwsJobPresignedUrlConfig)
createOTAUpdate_awsJobTimeoutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobTimeoutConfig)
createOTAUpdate_description :: Lens' CreateOTAUpdate (Maybe Text)
createOTAUpdate_protocols :: Lens' CreateOTAUpdate (Maybe (NonEmpty Protocol))
createOTAUpdate_tags :: Lens' CreateOTAUpdate (Maybe [Tag])
createOTAUpdate_targetSelection :: Lens' CreateOTAUpdate (Maybe TargetSelection)
createOTAUpdate_otaUpdateId :: Lens' CreateOTAUpdate Text
createOTAUpdate_targets :: Lens' CreateOTAUpdate (NonEmpty Text)
createOTAUpdate_files :: Lens' CreateOTAUpdate (NonEmpty OTAUpdateFile)
createOTAUpdate_roleArn :: Lens' CreateOTAUpdate Text
data CreateOTAUpdateResponse = CreateOTAUpdateResponse' {
- awsIotJobArn :: Maybe Text
- awsIotJobId :: Maybe Text
- otaUpdateArn :: Maybe Text
- otaUpdateId :: Maybe Text
- otaUpdateStatus :: Maybe OTAUpdateStatus
- httpStatus :: Int
}
newCreateOTAUpdateResponse :: Int -> CreateOTAUpdateResponse
createOTAUpdateResponse_awsIotJobArn :: Lens' CreateOTAUpdateResponse (Maybe Text)
createOTAUpdateResponse_awsIotJobId :: Lens' CreateOTAUpdateResponse (Maybe Text)
createOTAUpdateResponse_otaUpdateArn :: Lens' CreateOTAUpdateResponse (Maybe Text)
createOTAUpdateResponse_otaUpdateId :: Lens' CreateOTAUpdateResponse (Maybe Text)
createOTAUpdateResponse_otaUpdateStatus :: Lens' CreateOTAUpdateResponse (Maybe OTAUpdateStatus)
createOTAUpdateResponse_httpStatus :: Lens' CreateOTAUpdateResponse Int

Creating a Request

data CreateOTAUpdate Source #

See: newCreateOTAUpdate smart constructor.

Constructors

CreateOTAUpdate'

Fields

additionalParameters :: Maybe (HashMap Text Text)
A list of additional OTA update parameters which are name-value pairs.
awsJobAbortConfig :: Maybe AwsJobAbortConfig
The criteria that determine when and how a job abort takes place.
awsJobExecutionsRolloutConfig :: Maybe AwsJobExecutionsRolloutConfig
Configuration for the rollout of OTA updates.
awsJobPresignedUrlConfig :: Maybe AwsJobPresignedUrlConfig
Configuration information for pre-signed URLs.
awsJobTimeoutConfig :: Maybe AwsJobTimeoutConfig
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
description :: Maybe Text
The description 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.
tags :: Maybe [Tag]
Metadata which can be used to manage updates.
targetSelection :: Maybe TargetSelection
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
otaUpdateId :: Text
The ID of the OTA update to be created.
targets :: NonEmpty Text
The devices targeted to receive OTA updates.
files :: NonEmpty OTAUpdateFile
The files to be streamed by the OTA update.
roleArn :: Text
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

Instances

Instances details

ToJSON CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods toJSON :: CreateOTAUpdate -> Value # toEncoding :: CreateOTAUpdate -> Encoding # toJSONList :: [CreateOTAUpdate] -> Value # toEncodingList :: [CreateOTAUpdate] -> Encoding #
ToHeaders CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods toHeaders :: CreateOTAUpdate -> [Header] #
ToPath CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods toPath :: CreateOTAUpdate -> ByteString #
ToQuery CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods toQuery :: CreateOTAUpdate -> QueryString #
AWSRequest CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Associated Types type AWSResponse CreateOTAUpdate # Methods request :: (Service -> Service) -> CreateOTAUpdate -> Request CreateOTAUpdate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateOTAUpdate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateOTAUpdate))) #
Generic CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Associated Types type Rep CreateOTAUpdate :: Type -> Type # Methods from :: CreateOTAUpdate -> Rep CreateOTAUpdate x # to :: Rep CreateOTAUpdate x -> CreateOTAUpdate #
Read CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods readsPrec :: Int -> ReadS CreateOTAUpdate # readList :: ReadS [CreateOTAUpdate] # readPrec :: ReadPrec CreateOTAUpdate # readListPrec :: ReadPrec [CreateOTAUpdate] #
Show CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods showsPrec :: Int -> CreateOTAUpdate -> ShowS # show :: CreateOTAUpdate -> String # showList :: [CreateOTAUpdate] -> ShowS #
NFData CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods rnf :: CreateOTAUpdate -> () #
Eq CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods (==) :: CreateOTAUpdate -> CreateOTAUpdate -> Bool # (/=) :: CreateOTAUpdate -> CreateOTAUpdate -> Bool #
Hashable CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods hashWithSalt :: Int -> CreateOTAUpdate -> Int # hash :: CreateOTAUpdate -> Int #
type AWSResponse CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate type AWSResponse CreateOTAUpdate = CreateOTAUpdateResponse
type Rep CreateOTAUpdate Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate type Rep CreateOTAUpdate = D1 ('MetaData "CreateOTAUpdate" "Amazonka.IoT.CreateOTAUpdate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateOTAUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "awsJobAbortConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobAbortConfig)) :: S1 ('MetaSel ('Just "awsJobExecutionsRolloutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobExecutionsRolloutConfig)))) :: (S1 ('MetaSel ('Just "awsJobPresignedUrlConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobPresignedUrlConfig)) :: (S1 ('MetaSel ('Just "awsJobTimeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsJobTimeoutConfig)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "protocols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Protocol))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "targetSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetSelection)))) :: ((S1 ('MetaSel ('Just "otaUpdateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))) :: (S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty OTAUpdateFile)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateOTAUpdate Source #

Arguments

:: Text	`CreateOTAUpdate`
-> NonEmpty Text	`CreateOTAUpdate`
-> NonEmpty OTAUpdateFile	`CreateOTAUpdate`
-> Text	`CreateOTAUpdate`
-> CreateOTAUpdate

Create a value of CreateOTAUpdate 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:

CreateOTAUpdate, createOTAUpdate_additionalParameters - A list of additional OTA update parameters which are name-value pairs.

$sel:awsJobAbortConfig:CreateOTAUpdate', createOTAUpdate_awsJobAbortConfig - The criteria that determine when and how a job abort takes place.

CreateOTAUpdate, createOTAUpdate_awsJobExecutionsRolloutConfig - Configuration for the rollout of OTA updates.

CreateOTAUpdate, createOTAUpdate_awsJobPresignedUrlConfig - Configuration information for pre-signed URLs.

$sel:awsJobTimeoutConfig:CreateOTAUpdate', createOTAUpdate_awsJobTimeoutConfig - Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

CreateOTAUpdate, createOTAUpdate_description - The description of the OTA update.

CreateOTAUpdate, createOTAUpdate_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:tags:CreateOTAUpdate', createOTAUpdate_tags - Metadata which can be used to manage updates.

CreateOTAUpdate, createOTAUpdate_targetSelection - Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

CreateOTAUpdate, createOTAUpdate_otaUpdateId - The ID of the OTA update to be created.

CreateOTAUpdate, createOTAUpdate_targets - The devices targeted to receive OTA updates.

CreateOTAUpdate, createOTAUpdate_files - The files to be streamed by the OTA update.

CreateOTAUpdate, createOTAUpdate_roleArn - The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

Request Lenses

createOTAUpdate_additionalParameters :: Lens' CreateOTAUpdate (Maybe (HashMap Text Text)) Source #

A list of additional OTA update parameters which are name-value pairs.

createOTAUpdate_awsJobAbortConfig :: Lens' CreateOTAUpdate (Maybe AwsJobAbortConfig) Source #

The criteria that determine when and how a job abort takes place.

createOTAUpdate_awsJobExecutionsRolloutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobExecutionsRolloutConfig) Source #

Configuration for the rollout of OTA updates.

createOTAUpdate_awsJobPresignedUrlConfig :: Lens' CreateOTAUpdate (Maybe AwsJobPresignedUrlConfig) Source #

Configuration information for pre-signed URLs.

createOTAUpdate_awsJobTimeoutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobTimeoutConfig) Source #

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

createOTAUpdate_description :: Lens' CreateOTAUpdate (Maybe Text) Source #

The description of the OTA update.

createOTAUpdate_protocols :: Lens' CreateOTAUpdate (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.

createOTAUpdate_tags :: Lens' CreateOTAUpdate (Maybe [Tag]) Source #

Metadata which can be used to manage updates.

createOTAUpdate_targetSelection :: Lens' CreateOTAUpdate (Maybe TargetSelection) Source #

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

createOTAUpdate_otaUpdateId :: Lens' CreateOTAUpdate Text Source #

The ID of the OTA update to be created.

createOTAUpdate_targets :: Lens' CreateOTAUpdate (NonEmpty Text) Source #

The devices targeted to receive OTA updates.

createOTAUpdate_files :: Lens' CreateOTAUpdate (NonEmpty OTAUpdateFile) Source #

The files to be streamed by the OTA update.

createOTAUpdate_roleArn :: Lens' CreateOTAUpdate Text Source #

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

Destructuring the Response

data CreateOTAUpdateResponse Source #

See: newCreateOTAUpdateResponse smart constructor.

Constructors

CreateOTAUpdateResponse'
Fields awsIotJobArn :: Maybe Text The IoT job ARN associated with the OTA update. awsIotJobId :: Maybe Text The IoT job ID associated with the OTA update. otaUpdateArn :: Maybe Text The OTA update ARN. otaUpdateId :: Maybe Text The OTA update ID. otaUpdateStatus :: Maybe OTAUpdateStatus The OTA update status. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Associated Types type Rep CreateOTAUpdateResponse :: Type -> Type # Methods from :: CreateOTAUpdateResponse -> Rep CreateOTAUpdateResponse x # to :: Rep CreateOTAUpdateResponse x -> CreateOTAUpdateResponse #
Read CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods readsPrec :: Int -> ReadS CreateOTAUpdateResponse # readList :: ReadS [CreateOTAUpdateResponse] # readPrec :: ReadPrec CreateOTAUpdateResponse # readListPrec :: ReadPrec [CreateOTAUpdateResponse] #
Show CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods showsPrec :: Int -> CreateOTAUpdateResponse -> ShowS # show :: CreateOTAUpdateResponse -> String # showList :: [CreateOTAUpdateResponse] -> ShowS #
NFData CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods rnf :: CreateOTAUpdateResponse -> () #
Eq CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate Methods (==) :: CreateOTAUpdateResponse -> CreateOTAUpdateResponse -> Bool # (/=) :: CreateOTAUpdateResponse -> CreateOTAUpdateResponse -> Bool #
type Rep CreateOTAUpdateResponse Source #
Instance details Defined in Amazonka.IoT.CreateOTAUpdate type Rep CreateOTAUpdateResponse = D1 ('MetaData "CreateOTAUpdateResponse" "Amazonka.IoT.CreateOTAUpdate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateOTAUpdateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awsIotJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "awsIotJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "otaUpdateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "otaUpdateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "otaUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OTAUpdateStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))