aws_sdk_iot/client/
describe_dimension.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 [`DescribeDimension`](crate::operation::describe_dimension::builders::DescribeDimensionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::describe_dimension::builders::DescribeDimensionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_dimension::builders::DescribeDimensionFluentBuilder::set_name):<br>required: **true**<br><p>The unique identifier for the dimension.</p><br>
7    /// - On success, responds with [`DescribeDimensionOutput`](crate::operation::describe_dimension::DescribeDimensionOutput) with field(s):
8    ///   - [`name(Option<String>)`](crate::operation::describe_dimension::DescribeDimensionOutput::name): <p>The unique identifier for the dimension.</p>
9    ///   - [`arn(Option<String>)`](crate::operation::describe_dimension::DescribeDimensionOutput::arn): <p>The Amazon Resource Name (ARN) for the dimension.</p>
10    ///   - [`r#type(Option<DimensionType>)`](crate::operation::describe_dimension::DescribeDimensionOutput::type): <p>The type of the dimension.</p>
11    ///   - [`string_values(Option<Vec::<String>>)`](crate::operation::describe_dimension::DescribeDimensionOutput::string_values): <p>The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.</p>
12    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_dimension::DescribeDimensionOutput::creation_date): <p>The date the dimension was created.</p>
13    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_dimension::DescribeDimensionOutput::last_modified_date): <p>The date the dimension was last modified.</p>
14    /// - On failure, responds with [`SdkError<DescribeDimensionError>`](crate::operation::describe_dimension::DescribeDimensionError)
15    pub fn describe_dimension(&self) -> crate::operation::describe_dimension::builders::DescribeDimensionFluentBuilder {
16        crate::operation::describe_dimension::builders::DescribeDimensionFluentBuilder::new(self.handle.clone())
17    }
18}