aws_sdk_iot/client/
describe_thing_registration_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 [`DescribeThingRegistrationTask`](crate::operation::describe_thing_registration_task::builders::DescribeThingRegistrationTaskFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`task_id(impl Into<String>)`](crate::operation::describe_thing_registration_task::builders::DescribeThingRegistrationTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::describe_thing_registration_task::builders::DescribeThingRegistrationTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>The task ID.</p><br>
7    /// - On success, responds with [`DescribeThingRegistrationTaskOutput`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput) with field(s):
8    ///   - [`task_id(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::task_id): <p>The task ID.</p>
9    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::creation_date): <p>The task creation date.</p>
10    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::last_modified_date): <p>The date when the task was last modified.</p>
11    ///   - [`template_body(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::template_body): <p>The task's template.</p>
12    ///   - [`input_file_bucket(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::input_file_bucket): <p>The S3 bucket that contains the input file.</p>
13    ///   - [`input_file_key(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::input_file_key): <p>The input file key.</p>
14    ///   - [`role_arn(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::role_arn): <p>The role ARN that grants access to the input file bucket.</p>
15    ///   - [`status(Option<Status>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::status): <p>The status of the bulk thing provisioning task.</p>
16    ///   - [`message(Option<String>)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::message): <p>The message.</p>
17    ///   - [`success_count(i32)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::success_count): <p>The number of things successfully provisioned.</p>
18    ///   - [`failure_count(i32)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::failure_count): <p>The number of things that failed to be provisioned.</p>
19    ///   - [`percentage_progress(i32)`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskOutput::percentage_progress): <p>The progress of the bulk provisioning task expressed as a percentage.</p>
20    /// - On failure, responds with [`SdkError<DescribeThingRegistrationTaskError>`](crate::operation::describe_thing_registration_task::DescribeThingRegistrationTaskError)
21    pub fn describe_thing_registration_task(
22        &self,
23    ) -> crate::operation::describe_thing_registration_task::builders::DescribeThingRegistrationTaskFluentBuilder {
24        crate::operation::describe_thing_registration_task::builders::DescribeThingRegistrationTaskFluentBuilder::new(self.handle.clone())
25    }
26}