Kafka / Client / describe_topic

describe_topic¶

Kafka.Client.describe_topic(**kwargs)¶

Returns topic details of this topic on a MSK cluster.

Request Syntax

response = client.describe_topic(
    ClusterArn='string',
    TopicName='string'
)

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TopicName (string) –
[REQUIRED]

The Kafka topic name that uniquely identifies the topic.

Return type:

dict

Returns:

Response Syntax

{
    'TopicArn': 'string',
    'TopicName': 'string',
    'ReplicationFactor': 123,
    'PartitionCount': 123,
    'Configs': 'string',
    'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}

Response Structure

(dict) –

200 response
- TopicArn (string) –
  
  The Amazon Resource Name (ARN) of the topic.
- TopicName (string) –
  
  The Kafka topic name of the topic.
- ReplicationFactor (integer) –
  
  The replication factor of the topic.
- PartitionCount (integer) –
  
  The partition count of the topic.
- Configs (string) –
  
  Topic configurations encoded as a Base64 string.
- Status (string) –
  
  The status of the topic.

Exceptions

Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException
Kafka.Client.exceptions.NotFoundException