Network.AWS.IoT.CreateOTAUpdate

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

Creating a Request

createOTAUpdate

Arguments

:: Text

cotauOtaUpdateId

-> NonEmpty Text

cotauTargets

-> NonEmpty OTAUpdateFile

cotauFiles

-> Text

cotauRoleARN

-> CreateOTAUpdate

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

See: createOTAUpdate smart constructor.

Instances

Eq CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

(==) :: CreateOTAUpdate -> CreateOTAUpdate -> Bool

(/=) :: CreateOTAUpdate -> CreateOTAUpdate -> Bool

Data CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

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

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

readsPrec :: Int -> ReadS CreateOTAUpdate

readList :: ReadS [CreateOTAUpdate]

readPrec :: ReadPrec CreateOTAUpdate

readListPrec :: ReadPrec [CreateOTAUpdate]

Show CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

showsPrec :: Int -> CreateOTAUpdate -> ShowS

show :: CreateOTAUpdate -> String

showList :: [CreateOTAUpdate] -> ShowS

Generic CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Associated Types

type Rep CreateOTAUpdate :: Type -> Type

Methods

from :: CreateOTAUpdate -> Rep CreateOTAUpdate x

to :: Rep CreateOTAUpdate x -> CreateOTAUpdate

Hashable CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

hashWithSalt :: Int -> CreateOTAUpdate -> Int

hash :: CreateOTAUpdate -> Int

ToJSON CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

toJSON :: CreateOTAUpdate -> Value

toEncoding :: CreateOTAUpdate -> Encoding

toJSONList :: [CreateOTAUpdate] -> Value

toEncodingList :: [CreateOTAUpdate] -> Encoding

AWSRequest CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Associated Types

type Rs CreateOTAUpdate :: Type

Methods

request :: CreateOTAUpdate -> Request CreateOTAUpdate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateOTAUpdate -> ClientResponse -> m (Response CreateOTAUpdate)

ToHeaders CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

toHeaders :: CreateOTAUpdate -> [Header]

ToPath CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

toPath :: CreateOTAUpdate -> ByteString

ToQuery CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

toQuery :: CreateOTAUpdate -> QueryString

NFData CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

rnf :: CreateOTAUpdate -> ()

type Rep CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

type Rep CreateOTAUpdate = D1 (MetaData "CreateOTAUpdate" "Network.AWS.IoT.CreateOTAUpdate" "amazonka-iot-1.6.1-1U0NSVSRVsCEeZIE9W0TkV" False) (C1 (MetaCons "CreateOTAUpdate'" PrefixI True) ((S1 (MetaSel (Just "_cotauAdditionalParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: (S1 (MetaSel (Just "_cotauDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cotauTargetSelection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TargetSelection)))) :*: ((S1 (MetaSel (Just "_cotauOtaUpdateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cotauTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 Text))) :*: (S1 (MetaSel (Just "_cotauFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 OTAUpdateFile)) :*: S1 (MetaSel (Just "_cotauRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateOTAUpdate

Defined in Network.AWS.IoT.CreateOTAUpdate

type Rs CreateOTAUpdate = CreateOTAUpdateResponse

Request Lenses

cotauAdditionalParameters :: Lens' CreateOTAUpdate (HashMap Text Text)

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

cotauDescription :: Lens' CreateOTAUpdate (Maybe Text)

The description of the OTA update.

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

cotauOtaUpdateId :: Lens' CreateOTAUpdate Text

The ID of the OTA update to be created.

cotauTargets :: Lens' CreateOTAUpdate (NonEmpty Text)

The targeted devices to receive OTA updates.

cotauFiles :: Lens' CreateOTAUpdate (NonEmpty OTAUpdateFile)

The files to be streamed by the OTA update.

cotauRoleARN :: Lens' CreateOTAUpdate Text

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

Destructuring the Response

createOTAUpdateResponse

Arguments

:: Int

cotaursResponseStatus

-> CreateOTAUpdateResponse

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:

• cotaursAwsIotJobId - The AWS IoT job ID associated with the OTA update.
• cotaursOtaUpdateStatus - The OTA update status.
• cotaursAwsIotJobARN - The AWS IoT job ARN associated with the OTA update.
• cotaursOtaUpdateId - The OTA update ID.
• cotaursOtaUpdateARN - The OTA update ARN.
• cotaursResponseStatus - -- | The response status code.

data CreateOTAUpdateResponse

See: createOTAUpdateResponse smart constructor.

Instances

Eq CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

(==) :: CreateOTAUpdateResponse -> CreateOTAUpdateResponse -> Bool

(/=) :: CreateOTAUpdateResponse -> CreateOTAUpdateResponse -> Bool

Data CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

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

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

readsPrec :: Int -> ReadS CreateOTAUpdateResponse

readList :: ReadS [CreateOTAUpdateResponse]

readPrec :: ReadPrec CreateOTAUpdateResponse

readListPrec :: ReadPrec [CreateOTAUpdateResponse]

Show CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

showsPrec :: Int -> CreateOTAUpdateResponse -> ShowS

show :: CreateOTAUpdateResponse -> String

showList :: [CreateOTAUpdateResponse] -> ShowS

Generic CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

Associated Types

type Rep CreateOTAUpdateResponse :: Type -> Type

Methods

from :: CreateOTAUpdateResponse -> Rep CreateOTAUpdateResponse x

to :: Rep CreateOTAUpdateResponse x -> CreateOTAUpdateResponse

NFData CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

Methods

rnf :: CreateOTAUpdateResponse -> ()

type Rep CreateOTAUpdateResponse

Defined in Network.AWS.IoT.CreateOTAUpdate

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

Response Lenses

cotaursAwsIotJobId :: Lens' CreateOTAUpdateResponse (Maybe Text)

The AWS IoT job ID associated with the OTA update.

cotaursOtaUpdateStatus :: Lens' CreateOTAUpdateResponse (Maybe OTAUpdateStatus)

The OTA update status.

cotaursAwsIotJobARN :: Lens' CreateOTAUpdateResponse (Maybe Text)

The AWS IoT job ARN associated with the OTA update.

cotaursOtaUpdateId :: Lens' CreateOTAUpdateResponse (Maybe Text)

The OTA update ID.

cotaursOtaUpdateARN :: Lens' CreateOTAUpdateResponse (Maybe Text)

The OTA update ARN.

cotaursResponseStatus :: Lens' CreateOTAUpdateResponse Int

• - | The response status code.