aws_sdk_iot/client/
describe_provisioning_template.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 [`DescribeProvisioningTemplate`](crate::operation::describe_provisioning_template::builders::DescribeProvisioningTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`template_name(impl Into<String>)`](crate::operation::describe_provisioning_template::builders::DescribeProvisioningTemplateFluentBuilder::template_name) / [`set_template_name(Option<String>)`](crate::operation::describe_provisioning_template::builders::DescribeProvisioningTemplateFluentBuilder::set_template_name):<br>required: **true**<br><p>The name of the provisioning template.</p><br>
7    /// - On success, responds with [`DescribeProvisioningTemplateOutput`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput) with field(s):
8    ///   - [`template_arn(Option<String>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::template_arn): <p>The ARN of the provisioning template.</p>
9    ///   - [`template_name(Option<String>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::template_name): <p>The name of the provisioning template.</p>
10    ///   - [`description(Option<String>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::description): <p>The description of the provisioning template.</p>
11    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::creation_date): <p>The date when the provisioning template was created.</p>
12    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::last_modified_date): <p>The date when the provisioning template was last modified.</p>
13    ///   - [`default_version_id(Option<i32>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::default_version_id): <p>The default fleet template version ID.</p>
14    ///   - [`template_body(Option<String>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::template_body): <p>The JSON formatted contents of the provisioning template.</p>
15    ///   - [`enabled(Option<bool>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::enabled): <p>True if the provisioning template is enabled, otherwise false.</p>
16    ///   - [`provisioning_role_arn(Option<String>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::provisioning_role_arn): <p>The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.</p>
17    ///   - [`pre_provisioning_hook(Option<ProvisioningHook>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::pre_provisioning_hook): <p>Gets information about a pre-provisioned hook.</p>
18    ///   - [`r#type(Option<TemplateType>)`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateOutput::type): <p>The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is <code>FLEET_PROVISIONING</code>. For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>.</p>
19    /// - On failure, responds with [`SdkError<DescribeProvisioningTemplateError>`](crate::operation::describe_provisioning_template::DescribeProvisioningTemplateError)
20    pub fn describe_provisioning_template(
21        &self,
22    ) -> crate::operation::describe_provisioning_template::builders::DescribeProvisioningTemplateFluentBuilder {
23        crate::operation::describe_provisioning_template::builders::DescribeProvisioningTemplateFluentBuilder::new(self.handle.clone())
24    }
25}