:doc:`Kafka <../../kafka>` / Paginator / ListVpcConnections

******************
ListVpcConnections
******************



.. py:class:: Kafka.Paginator.ListVpcConnections

  ::

    
    paginator = client.get_paginator('list_vpc_connections')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Kafka.Client.list_vpc_connections`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

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

      

      - *(dict) --* 

        200 response

        
        

        - **VpcConnections** *(list) --* 

          List of VPC connections.

          
          

          - *(dict) --* 

            The VPC connection object.

            
            

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

              The ARN that identifies the Vpc Connection.

              
            

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

              The ARN that identifies the Cluster which the Vpc Connection belongs to.

              
            

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

              Creation time of the Vpc Connection.

              
            

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

              Information about the auth scheme of Vpc Connection.

              
            

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

              The vpcId that belongs to the Vpc Connection.

              
            

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

              State of the Vpc Connection.

              
        
      
    