Skip to content

Returns topic details of this topic on a MSK cluster

Description

Returns topic details of this topic on a MSK cluster.

Usage

kafka_describe_topic(ClusterArn, TopicName)

Arguments

  • ClusterArn

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

  • TopicName

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

Value

A list with the following syntax:

list(
  TopicArn = "string",
  TopicName = "string",
  ReplicationFactor = 123,
  PartitionCount = 123,
  Configs = "string",
  Status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"
)

Request syntax

svc$describe_topic(
  ClusterArn = "string",
  TopicName = "string"
)