aws_sdk_iot/client/
describe_audit_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 [`DescribeAuditTask`](crate::operation::describe_audit_task::builders::DescribeAuditTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`task_id(impl Into<String>)`](crate::operation::describe_audit_task::builders::DescribeAuditTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::describe_audit_task::builders::DescribeAuditTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>The ID of the audit whose information you want to get.</p><br>
7    /// - On success, responds with [`DescribeAuditTaskOutput`](crate::operation::describe_audit_task::DescribeAuditTaskOutput) with field(s):
8    ///   - [`task_status(Option<AuditTaskStatus>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::task_status): <p>The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".</p>
9    ///   - [`task_type(Option<AuditTaskType>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::task_type): <p>The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".</p>
10    ///   - [`task_start_time(Option<DateTime>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::task_start_time): <p>The time the audit started.</p>
11    ///   - [`task_statistics(Option<TaskStatistics>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::task_statistics): <p>Statistical information about the audit.</p>
12    ///   - [`scheduled_audit_name(Option<String>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::scheduled_audit_name): <p>The name of the scheduled audit (only if the audit was a scheduled audit).</p>
13    ///   - [`audit_details(Option<HashMap::<String, AuditCheckDetails>>)`](crate::operation::describe_audit_task::DescribeAuditTaskOutput::audit_details): <p>Detailed information about each check performed during this audit.</p>
14    /// - On failure, responds with [`SdkError<DescribeAuditTaskError>`](crate::operation::describe_audit_task::DescribeAuditTaskError)
15    pub fn describe_audit_task(&self) -> crate::operation::describe_audit_task::builders::DescribeAuditTaskFluentBuilder {
16        crate::operation::describe_audit_task::builders::DescribeAuditTaskFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_iot/client/describe_audit_task.rs

aws_sdk_iot/client/
describe_audit_task.rs
