aws_sdk_deadline/client/
get_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetJob`](crate::operation::get_job::builders::GetJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the farm in the job.</p><br>
7    ///   - [`queue_id(impl Into<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID associated with the job.</p><br>
8    ///   - [`job_id(impl Into<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID.</p><br>
9    /// - On success, responds with [`GetJobOutput`](crate::operation::get_job::GetJobOutput) with field(s):
10    ///   - [`job_id(String)`](crate::operation::get_job::GetJobOutput::job_id): <p>The job ID.</p>
11    ///   - [`name(String)`](crate::operation::get_job::GetJobOutput::name): <p>The name of the job.</p>
12    ///   - [`lifecycle_status(JobLifecycleStatus)`](crate::operation::get_job::GetJobOutput::lifecycle_status): <p>The life cycle status for the job.</p>
13    ///   - [`lifecycle_status_message(String)`](crate::operation::get_job::GetJobOutput::lifecycle_status_message): <p>A message that communicates the status of the life cycle for the job.</p>
14    ///   - [`priority(i32)`](crate::operation::get_job::GetJobOutput::priority): <p>The job priority.</p>
15    ///   - [`created_at(DateTime)`](crate::operation::get_job::GetJobOutput::created_at): <p>The date and time the resource was created.</p>
16    ///   - [`created_by(String)`](crate::operation::get_job::GetJobOutput::created_by): <p>The user or system that created this resource.</p>
17    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_job::GetJobOutput::updated_at): <p>The date and time the resource was updated.</p>
18    ///   - [`updated_by(Option<String>)`](crate::operation::get_job::GetJobOutput::updated_by): <p>The user or system that updated this resource.</p>
19    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_job::GetJobOutput::started_at): <p>The date and time the resource started running.</p>
20    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_job::GetJobOutput::ended_at): <p>The date and time the resource ended running.</p>
21    ///   - [`task_run_status(Option<TaskRunStatus>)`](crate::operation::get_job::GetJobOutput::task_run_status): <p>The task run status for the job.</p>
22    ///   - [`target_task_run_status(Option<JobTargetTaskRunStatus>)`](crate::operation::get_job::GetJobOutput::target_task_run_status): <p>The task status with which the job started.</p>
23    ///   - [`task_run_status_counts(Option<HashMap::<TaskRunStatus, i32>>)`](crate::operation::get_job::GetJobOutput::task_run_status_counts): <p>The number of tasks running on the job.</p>
24    ///   - [`task_failure_retry_count(Option<i32>)`](crate::operation::get_job::GetJobOutput::task_failure_retry_count): <p>The total number of times tasks from the job failed and were retried.</p>
25    ///   - [`storage_profile_id(Option<String>)`](crate::operation::get_job::GetJobOutput::storage_profile_id): <p>The storage profile ID associated with the job.</p>
26    ///   - [`max_failed_tasks_count(Option<i32>)`](crate::operation::get_job::GetJobOutput::max_failed_tasks_count): <p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>
27    ///   - [`max_retries_per_task(Option<i32>)`](crate::operation::get_job::GetJobOutput::max_retries_per_task): <p>The maximum number of retries per failed tasks.</p>
28    ///   - [`parameters(Option<HashMap::<String, JobParameter>>)`](crate::operation::get_job::GetJobOutput::parameters): <p>The parameters for the job.</p>
29    ///   - [`attachments(Option<Attachments>)`](crate::operation::get_job::GetJobOutput::attachments): <p>The attachments for the job.</p>
30    ///   - [`description(Option<String>)`](crate::operation::get_job::GetJobOutput::description): <p>The description of the job.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
31    ///   - [`max_worker_count(Option<i32>)`](crate::operation::get_job::GetJobOutput::max_worker_count): <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>If you don't set the <code>maxWorkerCount</code> when you create a job, this value is not returned in the response.</p>
32    ///   - [`source_job_id(Option<String>)`](crate::operation::get_job::GetJobOutput::source_job_id): <p>The job ID for the source job.</p>
33    /// - On failure, responds with [`SdkError<GetJobError>`](crate::operation::get_job::GetJobError)
34    pub fn get_job(&self) -> crate::operation::get_job::builders::GetJobFluentBuilder {
35        crate::operation::get_job::builders::GetJobFluentBuilder::new(self.handle.clone())
36    }
37}
aws_sdk_deadline/client/get_job.rs

aws_sdk_deadline/client/
get_job.rs
