aws_sdk_kafka/client/
describe_topic_partitions.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 [`DescribeTopicPartitions`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`cluster_arn(impl Into<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::cluster_arn) / [`set_cluster_arn(Option<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::set_cluster_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p><br>
8    ///   - [`topic_name(impl Into<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::topic_name) / [`set_topic_name(Option<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::set_topic_name):<br>required: **true**<br><p>The Kafka topic name that uniquely identifies the topic.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</p><br>
11    /// - On success, responds with [`DescribeTopicPartitionsOutput`](crate::operation::describe_topic_partitions::DescribeTopicPartitionsOutput) with field(s):
12    ///   - [`partitions(Option<Vec::<TopicPartitionInfo>>)`](crate::operation::describe_topic_partitions::DescribeTopicPartitionsOutput::partitions): <p>The list of partition information for the topic.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_topic_partitions::DescribeTopicPartitionsOutput::next_token): <p>The paginated results marker. When the result of a DescribeTopicPartitions operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.</p>
14    /// - On failure, responds with [`SdkError<DescribeTopicPartitionsError>`](crate::operation::describe_topic_partitions::DescribeTopicPartitionsError)
15    pub fn describe_topic_partitions(&self) -> crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder {
16        crate::operation::describe_topic_partitions::builders::DescribeTopicPartitionsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_kafka/client/describe_topic_partitions.rs

aws_sdk_kafka/client/
describe_topic_partitions.rs
