aws_sdk_snowdevicemanagement/client/describe_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 [`DescribeTask`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`task_id(impl Into<String>)`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>The ID of the task to be described.</p><br>
7 /// - On success, responds with [`DescribeTaskOutput`](crate::operation::describe_task::DescribeTaskOutput) with field(s):
8 /// - [`task_id(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::task_id): <p>The ID of the task.</p>
9 /// - [`task_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::task_arn): <p>The Amazon Resource Name (ARN) of the task.</p>
10 /// - [`targets(Option<Vec::<String>>)`](crate::operation::describe_task::DescribeTaskOutput::targets): <p>The managed devices that the task was sent to.</p>
11 /// - [`state(Option<TaskState>)`](crate::operation::describe_task::DescribeTaskOutput::state): <p>The current state of the task.</p>
12 /// - [`created_at(Option<DateTime>)`](crate::operation::describe_task::DescribeTaskOutput::created_at): <p>When the <code>CreateTask</code> operation was called.</p>
13 /// - [`last_updated_at(Option<DateTime>)`](crate::operation::describe_task::DescribeTaskOutput::last_updated_at): <p>When the state of the task was last updated.</p>
14 /// - [`completed_at(Option<DateTime>)`](crate::operation::describe_task::DescribeTaskOutput::completed_at): <p>When the task was completed.</p>
15 /// - [`description(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::description): <p>The description provided of the task and managed devices.</p>
16 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_task::DescribeTaskOutput::tags): <p>Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.</p>
17 /// - On failure, responds with [`SdkError<DescribeTaskError>`](crate::operation::describe_task::DescribeTaskError)
18 pub fn describe_task(&self) -> crate::operation::describe_task::builders::DescribeTaskFluentBuilder {
19 crate::operation::describe_task::builders::DescribeTaskFluentBuilder::new(self.handle.clone())
20 }
21}