:doc:`Kafka <../../kafka>` / Client / describe_topic

**************
describe_topic
**************



.. py:method:: Kafka.Client.describe_topic(**kwargs)

  

  Returns topic details of this topic on a MSK cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeTopic>`_  


  **Request Syntax**
  ::

    response = client.describe_topic(
        ClusterArn='string',
        TopicName='string'
    )
    
  :type ClusterArn: string
  :param ClusterArn: **[REQUIRED]** 

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

    

  
  :type TopicName: string
  :param TopicName: **[REQUIRED]** 

    The Kafka topic name that uniquely identifies the topic.

    

  
  
  :rtype: 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**
  
  *   :py:class:`Kafka.Client.exceptions.BadRequestException`

  
  *   :py:class:`Kafka.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`Kafka.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Kafka.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Kafka.Client.exceptions.NotFoundException`

  