aws_sdk_deadline/client/
update_job.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 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:
    ///   - [`client_token(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_client_token):<br>required: **false**<br><p>The unique token which the server uses to recognize retries of the same request.</p><br>
    ///   - [`farm_id(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the job to update.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID of the job to update.</p><br>
    ///   - [`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 job ID to update.</p><br>
    ///   - [`target_task_run_status(JobTargetTaskRunStatus)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::target_task_run_status) / [`set_target_task_run_status(Option<JobTargetTaskRunStatus>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_target_task_run_status):<br>required: **false**<br><p>The task status to update the job's tasks to.</p><br>
    ///   - [`priority(i32)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::priority) / [`set_priority(Option<i32>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_priority):<br>required: **false**<br><p>The job priority to update.</p><br>
    ///   - [`max_failed_tasks_count(i32)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::max_failed_tasks_count) / [`set_max_failed_tasks_count(Option<i32>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_max_failed_tasks_count):<br>required: **false**<br><p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p><br>
    ///   - [`max_retries_per_task(i32)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::max_retries_per_task) / [`set_max_retries_per_task(Option<i32>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_max_retries_per_task):<br>required: **false**<br><p>The maximum number of retries for a job.</p><br>
    ///   - [`lifecycle_status(UpdateJobLifecycleStatus)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::lifecycle_status) / [`set_lifecycle_status(Option<UpdateJobLifecycleStatus>)`](crate::operation::update_job::builders::UpdateJobFluentBuilder::set_lifecycle_status):<br>required: **false**<br><p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p><important>  <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important><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())
    }
}