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

Amazonka.IoT.UpdateJob

Description

Updates supported fields of the specified job.

Requires permission to access the UpdateJob action.

Synopsis

Creating a Request

data UpdateJob Source #

See: newUpdateJob smart constructor.

Constructors

UpdateJob' 

Fields

  • jobExecutionsRolloutConfig :: Maybe JobExecutionsRolloutConfig

    Allows you to create a staged rollout of the job.

  • abortConfig :: Maybe AbortConfig

    Allows you to create criteria to abort a 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.

  • description :: Maybe Text

    A short text description of the job.

  • 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
Eq UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Read UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Show UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Generic UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Associated Types

type Rep UpdateJob :: Type -> Type #

NFData UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Methods

rnf :: UpdateJob -> () #

Hashable UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

ToJSON UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

AWSRequest UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Associated Types

type AWSResponse UpdateJob #

ToHeaders UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Methods

toHeaders :: UpdateJob -> [Header] #

ToPath UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

ToQuery UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

type Rep UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

type AWSResponse UpdateJob Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

newUpdateJob Source #

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_description :: Lens' UpdateJob (Maybe Text) Source #

A short text description of the job.

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
Eq UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Read UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Show UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Generic UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Associated Types

type Rep UpdateJobResponse :: Type -> Type #

NFData UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

Methods

rnf :: UpdateJobResponse -> () #

type Rep UpdateJobResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateJob

type Rep UpdateJobResponse = D1 ('MetaData "UpdateJobResponse" "Amazonka.IoT.UpdateJob" "libZSservicesZSamazonka-iotZSamazonka-iot" '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.