Skip to content

Returns partition details of this topic on a MSK cluster

Description

Returns partition details of this topic on a MSK cluster.

Usage

kafka_describe_topic_partitions(ClusterArn, TopicName, MaxResults,
  NextToken)

Arguments

  • ClusterArn

    [required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.

  • TopicName

    [required] The Kafka topic name that uniquely identifies the topic.

  • MaxResults

    The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

  • NextToken

    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.

Value

A list with the following syntax:

list(
  Partitions = list(
    list(
      Partition = 123,
      Leader = 123,
      Replicas = list(
        123
      ),
      Isr = list(
        123
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_topic_partitions(
  ClusterArn = "string",
  TopicName = "string",
  MaxResults = 123,
  NextToken = "string"
)