amazonka-iot-1.6.0: Amazon IoT SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IoT.CreateOTAUpdate

Contents

Description

Creates an AWS IoT OTAUpdate on a target group of things or groups.

Synopsis

Creating a Request

createOTAUpdate Source #

Creates a value of CreateOTAUpdate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cotauAdditionalParameters - A list of additional OTA update parameters which are name-value pairs.
  • cotauDescription - The description of the OTA update.
  • cotauTargetSelection - 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.
  • cotauOtaUpdateId - The ID of the OTA update to be created.
  • cotauTargets - The targeted devices to receive OTA updates.
  • cotauFiles - The files to be streamed by the OTA update.
  • cotauRoleARN - The IAM role that allows access to the AWS IoT Jobs service.

data CreateOTAUpdate Source #

See: createOTAUpdate smart constructor.

Instances

Eq CreateOTAUpdate Source # 
Data CreateOTAUpdate Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateOTAUpdate -> c CreateOTAUpdate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateOTAUpdate #

toConstr :: CreateOTAUpdate -> Constr #

dataTypeOf :: CreateOTAUpdate -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateOTAUpdate) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateOTAUpdate) #

gmapT :: (forall b. Data b => b -> b) -> CreateOTAUpdate -> CreateOTAUpdate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateOTAUpdate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateOTAUpdate -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateOTAUpdate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateOTAUpdate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateOTAUpdate -> m CreateOTAUpdate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateOTAUpdate -> m CreateOTAUpdate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateOTAUpdate -> m CreateOTAUpdate #

Read CreateOTAUpdate Source # 
Show CreateOTAUpdate Source # 
Generic CreateOTAUpdate Source # 
Hashable CreateOTAUpdate Source # 
ToJSON CreateOTAUpdate Source # 
NFData CreateOTAUpdate Source # 

Methods

rnf :: CreateOTAUpdate -> () #

AWSRequest CreateOTAUpdate Source # 
ToHeaders CreateOTAUpdate Source # 
ToPath CreateOTAUpdate Source # 
ToQuery CreateOTAUpdate Source # 
type Rep CreateOTAUpdate Source # 
type Rep CreateOTAUpdate = D1 * (MetaData "CreateOTAUpdate" "Network.AWS.IoT.CreateOTAUpdate" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateOTAUpdate'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cotauAdditionalParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cotauDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cotauTargetSelection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TargetSelection))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cotauOtaUpdateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cotauTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cotauFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 OTAUpdateFile))) (S1 * (MetaSel (Just Symbol "_cotauRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs CreateOTAUpdate Source # 

Request Lenses

cotauAdditionalParameters :: Lens' CreateOTAUpdate (HashMap Text Text) Source #

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

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

The description of the OTA update.

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

cotauOtaUpdateId :: Lens' CreateOTAUpdate Text Source #

The ID of the OTA update to be created.

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

The targeted devices to receive OTA updates.

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

The files to be streamed by the OTA update.

cotauRoleARN :: Lens' CreateOTAUpdate Text Source #

The IAM role that allows access to the AWS IoT Jobs service.

Destructuring the Response

createOTAUpdateResponse Source #

Creates a value of CreateOTAUpdateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateOTAUpdateResponse Source #

See: createOTAUpdateResponse smart constructor.

Instances

Eq CreateOTAUpdateResponse Source # 
Data CreateOTAUpdateResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateOTAUpdateResponse -> c CreateOTAUpdateResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateOTAUpdateResponse #

toConstr :: CreateOTAUpdateResponse -> Constr #

dataTypeOf :: CreateOTAUpdateResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateOTAUpdateResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateOTAUpdateResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateOTAUpdateResponse -> CreateOTAUpdateResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateOTAUpdateResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateOTAUpdateResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateOTAUpdateResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateOTAUpdateResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateOTAUpdateResponse -> m CreateOTAUpdateResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateOTAUpdateResponse -> m CreateOTAUpdateResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateOTAUpdateResponse -> m CreateOTAUpdateResponse #

Read CreateOTAUpdateResponse Source # 
Show CreateOTAUpdateResponse Source # 
Generic CreateOTAUpdateResponse Source # 
NFData CreateOTAUpdateResponse Source # 

Methods

rnf :: CreateOTAUpdateResponse -> () #

type Rep CreateOTAUpdateResponse Source # 
type Rep CreateOTAUpdateResponse = D1 * (MetaData "CreateOTAUpdateResponse" "Network.AWS.IoT.CreateOTAUpdate" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateOTAUpdateResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cotaursAwsIotJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cotaursOtaUpdateStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OTAUpdateStatus))) (S1 * (MetaSel (Just Symbol "_cotaursAwsIotJobARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cotaursOtaUpdateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cotaursOtaUpdateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cotaursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

cotaursAwsIotJobId :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The AWS IoT job ID associated with the OTA update.

cotaursAwsIotJobARN :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The AWS IoT job ARN associated with the OTA update.