aws_sdk_deadline/client/
get_task.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 [`GetTask`](crate::operation::get_task::builders::GetTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the farm connected to the task.</p><br>
7    ///   - [`queue_id(impl Into<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the queue connected to the task.</p><br>
8    ///   - [`job_id(impl Into<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID of the job connected to the task.</p><br>
9    ///   - [`step_id(impl Into<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::step_id) / [`set_step_id(Option<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::set_step_id):<br>required: **true**<br><p>The step ID for the step connected to the task.</p><br>
10    ///   - [`task_id(impl Into<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::get_task::builders::GetTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>The task ID.</p><br>
11    /// - On success, responds with [`GetTaskOutput`](crate::operation::get_task::GetTaskOutput) with field(s):
12    ///   - [`task_id(String)`](crate::operation::get_task::GetTaskOutput::task_id): <p>The task ID.</p>
13    ///   - [`created_at(DateTime)`](crate::operation::get_task::GetTaskOutput::created_at): <p>The date and time the resource was created.</p>
14    ///   - [`created_by(String)`](crate::operation::get_task::GetTaskOutput::created_by): <p>The user or system that created this resource.</p>
15    ///   - [`run_status(TaskRunStatus)`](crate::operation::get_task::GetTaskOutput::run_status): <p>The run status for the task.</p>
16    ///   - [`target_run_status(Option<TaskTargetRunStatus>)`](crate::operation::get_task::GetTaskOutput::target_run_status): <p>The run status with which to start the task.</p>
17    ///   - [`failure_retry_count(Option<i32>)`](crate::operation::get_task::GetTaskOutput::failure_retry_count): <p>The number of times that the task failed and was retried.</p>
18    ///   - [`parameters(Option<HashMap::<String, TaskParameterValue>>)`](crate::operation::get_task::GetTaskOutput::parameters): <p>The parameters for the task.</p>
19    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_task::GetTaskOutput::started_at): <p>The date and time the resource started running.</p>
20    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_task::GetTaskOutput::ended_at): <p>The date and time the resource ended running.</p>
21    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_task::GetTaskOutput::updated_at): <p>The date and time the resource was updated.</p>
22    ///   - [`updated_by(Option<String>)`](crate::operation::get_task::GetTaskOutput::updated_by): <p>The user or system that updated this resource.</p>
23    ///   - [`latest_session_action_id(Option<String>)`](crate::operation::get_task::GetTaskOutput::latest_session_action_id): <p>The latest session ID for the task.</p>
24    /// - On failure, responds with [`SdkError<GetTaskError>`](crate::operation::get_task::GetTaskError)
25    pub fn get_task(&self) -> crate::operation::get_task::builders::GetTaskFluentBuilder {
26        crate::operation::get_task::builders::GetTaskFluentBuilder::new(self.handle.clone())
27    }
28}
aws_sdk_deadline/client/get_task.rs

aws_sdk_deadline/client/
get_task.rs
