aws_sdk_iot/client/
describe_thing_group.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 [`DescribeThingGroup`](crate::operation::describe_thing_group::builders::DescribeThingGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`thing_group_name(impl Into<String>)`](crate::operation::describe_thing_group::builders::DescribeThingGroupFluentBuilder::thing_group_name) / [`set_thing_group_name(Option<String>)`](crate::operation::describe_thing_group::builders::DescribeThingGroupFluentBuilder::set_thing_group_name):<br>required: **true**<br><p>The name of the thing group.</p><br>
7    /// - On success, responds with [`DescribeThingGroupOutput`](crate::operation::describe_thing_group::DescribeThingGroupOutput) with field(s):
8    ///   - [`thing_group_name(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::thing_group_name): <p>The name of the thing group.</p>
9    ///   - [`thing_group_id(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::thing_group_id): <p>The thing group ID.</p>
10    ///   - [`thing_group_arn(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::thing_group_arn): <p>The thing group ARN.</p>
11    ///   - [`version(i64)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::version): <p>The version of the thing group.</p>
12    ///   - [`thing_group_properties(Option<ThingGroupProperties>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::thing_group_properties): <p>The thing group properties.</p>
13    ///   - [`thing_group_metadata(Option<ThingGroupMetadata>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::thing_group_metadata): <p>Thing group metadata.</p>
14    ///   - [`index_name(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::index_name): <p>The dynamic thing group index name.</p>
15    ///   - [`query_string(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::query_string): <p>The dynamic thing group search query string.</p>
16    ///   - [`query_version(Option<String>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::query_version): <p>The dynamic thing group query version.</p>
17    ///   - [`status(Option<DynamicGroupStatus>)`](crate::operation::describe_thing_group::DescribeThingGroupOutput::status): <p>The dynamic thing group status.</p>
18    /// - On failure, responds with [`SdkError<DescribeThingGroupError>`](crate::operation::describe_thing_group::DescribeThingGroupError)
19    pub fn describe_thing_group(&self) -> crate::operation::describe_thing_group::builders::DescribeThingGroupFluentBuilder {
20        crate::operation::describe_thing_group::builders::DescribeThingGroupFluentBuilder::new(self.handle.clone())
21    }
22}