Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
Synopsis
- data UpdateJob = UpdateJob' {}
- newUpdateJob :: Text -> UpdateJob
- updateJob_jobExecutionsRolloutConfig :: Lens' UpdateJob (Maybe JobExecutionsRolloutConfig)
- updateJob_abortConfig :: Lens' UpdateJob (Maybe AbortConfig)
- updateJob_namespaceId :: Lens' UpdateJob (Maybe Text)
- updateJob_presignedUrlConfig :: Lens' UpdateJob (Maybe PresignedUrlConfig)
- updateJob_description :: Lens' UpdateJob (Maybe Text)
- updateJob_timeoutConfig :: Lens' UpdateJob (Maybe TimeoutConfig)
- updateJob_jobId :: Lens' UpdateJob Text
- data UpdateJobResponse = UpdateJobResponse' {
- newUpdateJobResponse :: UpdateJobResponse
Creating a Request
See: newUpdateJob
smart constructor.
UpdateJob' | |
|
Instances
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:
$sel:jobExecutionsRolloutConfig:UpdateJob'
, updateJob_jobExecutionsRolloutConfig
- Allows you to create a staged rollout of the job.
$sel:abortConfig:UpdateJob'
, updateJob_abortConfig
- Allows you to create criteria to abort a job.
$sel:namespaceId: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.
$sel:presignedUrlConfig:UpdateJob'
, updateJob_presignedUrlConfig
- Configuration information for pre-signed S3 URLs.
$sel:description:UpdateJob'
, updateJob_description
- A short text description of the job.
$sel:timeoutConfig: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
.
$sel:jobId:UpdateJob'
, updateJob_jobId
- The ID of the job to be updated.
Request Lenses
updateJob_jobExecutionsRolloutConfig :: Lens' UpdateJob (Maybe JobExecutionsRolloutConfig) Source #
Allows you to create a staged rollout of the job.
updateJob_abortConfig :: Lens' UpdateJob (Maybe AbortConfig) Source #
Allows you to create criteria to abort a 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
.
Destructuring the Response
data UpdateJobResponse Source #
See: newUpdateJobResponse
smart constructor.
Instances
Eq UpdateJobResponse Source # | |
Defined in Amazonka.IoT.UpdateJob (==) :: UpdateJobResponse -> UpdateJobResponse -> Bool # (/=) :: UpdateJobResponse -> UpdateJobResponse -> Bool # | |
Read UpdateJobResponse Source # | |
Defined in Amazonka.IoT.UpdateJob | |
Show UpdateJobResponse Source # | |
Defined in Amazonka.IoT.UpdateJob showsPrec :: Int -> UpdateJobResponse -> ShowS # show :: UpdateJobResponse -> String # showList :: [UpdateJobResponse] -> ShowS # | |
Generic UpdateJobResponse Source # | |
Defined in Amazonka.IoT.UpdateJob type Rep UpdateJobResponse :: Type -> Type # from :: UpdateJobResponse -> Rep UpdateJobResponse x # to :: Rep UpdateJobResponse x -> UpdateJobResponse # | |
NFData UpdateJobResponse Source # | |
Defined in Amazonka.IoT.UpdateJob rnf :: UpdateJobResponse -> () # | |
type Rep UpdateJobResponse Source # | |
newUpdateJobResponse :: UpdateJobResponse Source #
Create a value of UpdateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.