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

***********************
describe_vpc_connection
***********************



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

  

  Returns a description of this MSK VPC connection.

  

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


  **Request Syntax**
  ::

    response = client.describe_vpc_connection(
        Arn='string'
    )
    
  :type Arn: string
  :param Arn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VpcConnectionArn': 'string',
          'TargetClusterArn': 'string',
          'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
          'Authentication': 'string',
          'VpcId': 'string',
          'Subnets': [
              'string',
          ],
          'SecurityGroups': [
              'string',
          ],
          'CreationTime': datetime(2015, 1, 1),
          'Tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      200 response

      
      

      - **VpcConnectionArn** *(string) --* 

        The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

        
      

      - **TargetClusterArn** *(string) --* 

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

        
      

      - **State** *(string) --* 

        The state of VPC connection.

        
      

      - **Authentication** *(string) --* 

        The authentication type of VPC connection.

        
      

      - **VpcId** *(string) --* 

        The VPC Id for the VPC connection.

        
      

      - **Subnets** *(list) --* 

        The list of subnets for the VPC connection.

        
        

        - *(string) --* 
    
      

      - **SecurityGroups** *(list) --* 

        The list of security groups for the VPC connection.

        
        

        - *(string) --* 
    
      

      - **CreationTime** *(datetime) --* 

        The creation time of the VPC connection.

        
      

      - **Tags** *(dict) --* 

        A map of tags for the VPC connection.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **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`

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

  