Skip to content

UpdateJobRequest

Source code in docs_src/capo_iot/types/update_job_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class UpdateJobRequest(TypedDict, closed=True):
    job_id: "capo_iot.types.job_id.JobId"
    """<p>The ID of the job to be updated.</p>"""
    description: NotRequired["capo_iot.types.job_description.JobDescription"]
    """<p>A short text description of the job.</p>"""
    presigned_url_config: NotRequired[
        "capo_iot.types.presigned_url_config.PresignedUrlConfig"
    ]
    """<p>Configuration information for pre-signed S3 URLs.</p>"""
    job_executions_rollout_config: NotRequired[
        "capo_iot.types.job_executions_rollout_config.JobExecutionsRolloutConfig"
    ]
    """<p>Allows you to create a staged rollout of the job.</p>"""
    abort_config: NotRequired["capo_iot.types.abort_config.AbortConfig"]
    """<p>Allows you to create criteria to abort a job.</p>"""
    timeout_config: NotRequired["capo_iot.types.timeout_config.TimeoutConfig"]
    """<p>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 <code>IN_PROGRESS</code>. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to <code>TIMED_OUT</code>. </p>"""
    namespace_id: NotRequired["capo_iot.types.namespace_id.NamespaceId"]
    """<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>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.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a> </p> </note>"""
    job_executions_retry_config: NotRequired[
        "capo_iot.types.job_executions_retry_config.JobExecutionsRetryConfig"
    ]
    """<p>Allows you to create the criteria to retry a job.</p>"""

abort_config instance-attribute 

abort_config: NotRequired[AbortConfig]

Allows you to create criteria to abort a job.

description instance-attribute 

description: NotRequired[JobDescription]

A short text description of the job.

job_executions_retry_config instance-attribute 

job_executions_retry_config: NotRequired[JobExecutionsRetryConfig]

Allows you to create the criteria to retry a job.

job_executions_rollout_config instance-attribute 

job_executions_rollout_config: NotRequired[JobExecutionsRolloutConfig]

Allows you to create a staged rollout of the job.

job_id instance-attribute 

job_id: JobId

The ID of the job to be updated.

namespace_id instance-attribute 

namespace_id: NotRequired[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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

presigned_url_config instance-attribute 

presigned_url_config: NotRequired[PresignedUrlConfig]

Configuration information for pre-signed S3 URLs.

timeout_config instance-attribute 

timeout_config: NotRequired[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.