aws_sdk_iot/client/start_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 [`StartThingRegistrationTask`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`template_body(impl Into<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::template_body) / [`set_template_body(Option<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::set_template_body):<br>required: **true**<br><p>The provisioning template.</p><br>
7 /// - [`input_file_bucket(impl Into<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::input_file_bucket) / [`set_input_file_bucket(Option<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::set_input_file_bucket):<br>required: **true**<br><p>The S3 bucket that contains the input file.</p><br>
8 /// - [`input_file_key(impl Into<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::input_file_key) / [`set_input_file_key(Option<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::set_input_file_key):<br>required: **true**<br><p>The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).</p><br>
9 /// - [`role_arn(impl Into<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::set_role_arn):<br>required: **true**<br><p>The IAM role ARN that grants permission the input file.</p><br>
10 /// - On success, responds with [`StartThingRegistrationTaskOutput`](crate::operation::start_thing_registration_task::StartThingRegistrationTaskOutput) with field(s):
11 /// - [`task_id(Option<String>)`](crate::operation::start_thing_registration_task::StartThingRegistrationTaskOutput::task_id): <p>The bulk thing provisioning task ID.</p>
12 /// - On failure, responds with [`SdkError<StartThingRegistrationTaskError>`](crate::operation::start_thing_registration_task::StartThingRegistrationTaskError)
13 pub fn start_thing_registration_task(
14 &self,
15 ) -> crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder {
16 crate::operation::start_thing_registration_task::builders::StartThingRegistrationTaskFluentBuilder::new(self.handle.clone())
17 }
18}