aws_sdk_kafka/client/
describe_topic.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 [`DescribeTopic`](crate::operation::describe_topic::builders::DescribeTopicFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_arn(impl Into<String>)`](crate::operation::describe_topic::builders::DescribeTopicFluentBuilder::cluster_arn) / [`set_cluster_arn(Option<String>)`](crate::operation::describe_topic::builders::DescribeTopicFluentBuilder::set_cluster_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p><br>
7    ///   - [`topic_name(impl Into<String>)`](crate::operation::describe_topic::builders::DescribeTopicFluentBuilder::topic_name) / [`set_topic_name(Option<String>)`](crate::operation::describe_topic::builders::DescribeTopicFluentBuilder::set_topic_name):<br>required: **true**<br><p>The Kafka topic name that uniquely identifies the topic.</p><br>
8    /// - On success, responds with [`DescribeTopicOutput`](crate::operation::describe_topic::DescribeTopicOutput) with field(s):
9    ///   - [`topic_arn(Option<String>)`](crate::operation::describe_topic::DescribeTopicOutput::topic_arn): <p>The Amazon Resource Name (ARN) of the topic.</p>
10    ///   - [`topic_name(Option<String>)`](crate::operation::describe_topic::DescribeTopicOutput::topic_name): <p>The Kafka topic name of the topic.</p>
11    ///   - [`replication_factor(Option<i32>)`](crate::operation::describe_topic::DescribeTopicOutput::replication_factor): <p>The replication factor of the topic.</p>
12    ///   - [`partition_count(Option<i32>)`](crate::operation::describe_topic::DescribeTopicOutput::partition_count): <p>The partition count of the topic.</p>
13    ///   - [`configs(Option<String>)`](crate::operation::describe_topic::DescribeTopicOutput::configs): <p>Topic configurations encoded as a Base64 string.</p>
14    ///   - [`status(Option<TopicState>)`](crate::operation::describe_topic::DescribeTopicOutput::status): <p>The status of the topic.</p>
15    /// - On failure, responds with [`SdkError<DescribeTopicError>`](crate::operation::describe_topic::DescribeTopicError)
16    pub fn describe_topic(&self) -> crate::operation::describe_topic::builders::DescribeTopicFluentBuilder {
17        crate::operation::describe_topic::builders::DescribeTopicFluentBuilder::new(self.handle.clone())
18    }
19}