aws_sdk_iot/client/

update_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateJob`](crate::operation::update_job::builders::UpdateJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_id(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The ID of the job to be updated.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_description):<br>required: **false**<br><p>A short text description of the job.</p><br>
    ///   - [`presigned_url_config(PresignedUrlConfig)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::presigned_url_config) / [`set_presigned_url_config(Option<PresignedUrlConfig>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_presigned_url_config):<br>required: **false**<br><p>Configuration information for pre-signed S3 URLs.</p><br>
    ///   - [`job_executions_rollout_config(JobExecutionsRolloutConfig)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::job_executions_rollout_config) / [`set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_job_executions_rollout_config):<br>required: **false**<br><p>Allows you to create a staged rollout of the job.</p><br>
    ///   - [`abort_config(AbortConfig)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::abort_config) / [`set_abort_config(Option<AbortConfig>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_abort_config):<br>required: **false**<br><p>Allows you to create criteria to abort a job.</p><br>
    ///   - [`timeout_config(TimeoutConfig)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::timeout_config) / [`set_timeout_config(Option<TimeoutConfig>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_timeout_config):<br>required: **false**<br><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><br>
    ///   - [`namespace_id(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::namespace_id) / [`set_namespace_id(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_namespace_id):<br>required: **false**<br><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><br>
    ///   - [`job_executions_retry_config(JobExecutionsRetryConfig)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::job_executions_retry_config) / [`set_job_executions_retry_config(Option<JobExecutionsRetryConfig>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_job_executions_retry_config):<br>required: **false**<br><p>Allows you to create the criteria to retry a job.</p><br>
    /// - On success, responds with [`UpdateJobOutput`](crate::operation::update_job::UpdateJobOutput)
    /// - On failure, responds with [`SdkError<UpdateJobError>`](crate::operation::update_job::UpdateJobError)
    pub fn update_job(&self) -> crate::operation::update_job::builders::UpdateJobFluentBuilder {
        crate::operation::update_job::builders::UpdateJobFluentBuilder::new(self.handle.clone())
    }
}