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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Synopsis

data UpdateJob = UpdateJob' {
- abortConfig :: Maybe AbortConfig
- description :: Maybe Text
- jobExecutionsRetryConfig :: Maybe JobExecutionsRetryConfig
- jobExecutionsRolloutConfig :: Maybe JobExecutionsRolloutConfig
- namespaceId :: Maybe Text
- presignedUrlConfig :: Maybe PresignedUrlConfig
- timeoutConfig :: Maybe TimeoutConfig
- jobId :: Text
}
newUpdateJob :: Text -> UpdateJob
updateJob_abortConfig :: Lens' UpdateJob (Maybe AbortConfig)
updateJob_description :: Lens' UpdateJob (Maybe Text)
updateJob_jobExecutionsRetryConfig :: Lens' UpdateJob (Maybe JobExecutionsRetryConfig)
updateJob_jobExecutionsRolloutConfig :: Lens' UpdateJob (Maybe JobExecutionsRolloutConfig)
updateJob_namespaceId :: Lens' UpdateJob (Maybe Text)
updateJob_presignedUrlConfig :: Lens' UpdateJob (Maybe PresignedUrlConfig)
updateJob_timeoutConfig :: Lens' UpdateJob (Maybe TimeoutConfig)
updateJob_jobId :: Lens' UpdateJob Text
data UpdateJobResponse = UpdateJobResponse' {
}
newUpdateJobResponse :: UpdateJobResponse

Creating a Request

data UpdateJob Source #

See: newUpdateJob smart constructor.

Constructors

UpdateJob'

Fields

abortConfig :: Maybe AbortConfig
Allows you to create criteria to abort a job.
description :: Maybe Text
A short text description of the job.
jobExecutionsRetryConfig :: Maybe JobExecutionsRetryConfig
Allows you to create the criteria to retry a job.
jobExecutionsRolloutConfig :: Maybe JobExecutionsRolloutConfig
Allows you to create a staged rollout of the job.
namespaceId :: Maybe Text
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.
$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
The namespaceId feature is in public preview.
presignedUrlConfig :: Maybe PresignedUrlConfig
Configuration information for pre-signed S3 URLs.
timeoutConfig :: Maybe TimeoutConfig
Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.
jobId :: Text
The ID of the job to be updated.

Instances

Instances details

ToJSON UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods toJSON :: UpdateJob -> Value # toEncoding :: UpdateJob -> Encoding # toJSONList :: [UpdateJob] -> Value # toEncodingList :: [UpdateJob] -> Encoding #
ToHeaders UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods toHeaders :: UpdateJob -> [Header] #
ToPath UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods toPath :: UpdateJob -> ByteString #
ToQuery UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods toQuery :: UpdateJob -> QueryString #
AWSRequest UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Associated Types type AWSResponse UpdateJob # Methods request :: (Service -> Service) -> UpdateJob -> Request UpdateJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJob))) #
Generic UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Associated Types type Rep UpdateJob :: Type -> Type # Methods from :: UpdateJob -> Rep UpdateJob x # to :: Rep UpdateJob x -> UpdateJob #
Read UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJob # readList :: ReadS [UpdateJob] # readPrec :: ReadPrec UpdateJob # readListPrec :: ReadPrec [UpdateJob] #
Show UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods showsPrec :: Int -> UpdateJob -> ShowS # show :: UpdateJob -> String # showList :: [UpdateJob] -> ShowS #
NFData UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods rnf :: UpdateJob -> () #
Eq UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods (==) :: UpdateJob -> UpdateJob -> Bool # (/=) :: UpdateJob -> UpdateJob -> Bool #
Hashable UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods hashWithSalt :: Int -> UpdateJob -> Int # hash :: UpdateJob -> Int #
type AWSResponse UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob type AWSResponse UpdateJob = UpdateJobResponse
type Rep UpdateJob Source #
Instance details Defined in Amazonka.IoT.UpdateJob type Rep UpdateJob = D1 ('MetaData "UpdateJob" "Amazonka.IoT.UpdateJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abortConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbortConfig)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobExecutionsRetryConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionsRetryConfig)) :: S1 ('MetaSel ('Just "jobExecutionsRolloutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionsRolloutConfig)))) :: ((S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "presignedUrlConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PresignedUrlConfig))) :: (S1 ('MetaSel ('Just "timeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeoutConfig)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateJob Source #

Arguments

:: Text	`UpdateJob`
-> UpdateJob

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

UpdateJob, updateJob_abortConfig - Allows you to create criteria to abort a job.

UpdateJob, updateJob_description - A short text description of the job.

UpdateJob, updateJob_jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

UpdateJob, updateJob_jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.

UpdateJob, updateJob_namespaceId - The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

UpdateJob, updateJob_presignedUrlConfig - Configuration information for pre-signed S3 URLs.

UpdateJob, updateJob_timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

UpdateJob, updateJob_jobId - The ID of the job to be updated.

Request Lenses

updateJob_abortConfig :: Lens' UpdateJob (Maybe AbortConfig) Source #

Allows you to create criteria to abort a job.

updateJob_description :: Lens' UpdateJob (Maybe Text) Source #

A short text description of the job.

updateJob_jobExecutionsRetryConfig :: Lens' UpdateJob (Maybe JobExecutionsRetryConfig) Source #

Allows you to create the criteria to retry a job.

updateJob_jobExecutionsRolloutConfig :: Lens' UpdateJob (Maybe JobExecutionsRolloutConfig) Source #

Allows you to create a staged rollout of the job.

updateJob_namespaceId :: Lens' UpdateJob (Maybe Text) Source #

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

updateJob_presignedUrlConfig :: Lens' UpdateJob (Maybe PresignedUrlConfig) Source #

Configuration information for pre-signed S3 URLs.

updateJob_timeoutConfig :: Lens' UpdateJob (Maybe TimeoutConfig) Source #

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

updateJob_jobId :: Lens' UpdateJob Text Source #

The ID of the job to be updated.

Destructuring the Response

data UpdateJobResponse Source #

See: newUpdateJobResponse smart constructor.

Constructors

UpdateJobResponse'

Instances

Instances details

Generic UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob Associated Types type Rep UpdateJobResponse :: Type -> Type # Methods from :: UpdateJobResponse -> Rep UpdateJobResponse x # to :: Rep UpdateJobResponse x -> UpdateJobResponse #
Read UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJobResponse # readList :: ReadS [UpdateJobResponse] # readPrec :: ReadPrec UpdateJobResponse # readListPrec :: ReadPrec [UpdateJobResponse] #
Show UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods showsPrec :: Int -> UpdateJobResponse -> ShowS # show :: UpdateJobResponse -> String # showList :: [UpdateJobResponse] -> ShowS #
NFData UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods rnf :: UpdateJobResponse -> () #
Eq UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob Methods (==) :: UpdateJobResponse -> UpdateJobResponse -> Bool # (/=) :: UpdateJobResponse -> UpdateJobResponse -> Bool #
type Rep UpdateJobResponse Source #
Instance details Defined in Amazonka.IoT.UpdateJob type Rep UpdateJobResponse = D1 ('MetaData "UpdateJobResponse" "Amazonka.IoT.UpdateJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateJobResponse :: UpdateJobResponse Source #

Create a value of UpdateJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.