:doc:`EC2 <../../ec2>` / Paginator / DescribeClientVpnConnections

****************************
DescribeClientVpnConnections
****************************



.. py:class:: EC2.Paginator.DescribeClientVpnConnections

  ::

    
    paginator = client.get_paginator('describe_client_vpn_connections')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_client_vpn_connections`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeClientVpnConnections>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ClientVpnEndpointId='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ClientVpnEndpointId: string
    :param ClientVpnEndpointId: **[REQUIRED]** 

      The ID of the Client VPN endpoint.

      

    
    :type Filters: list
    :param Filters: 

      One or more filters. Filter names and values are case-sensitive.

       

      
      * ``connection-id`` - The ID of the connection.
       
      * ``username`` - For Active Directory client authentication, the user name of the client who established the client connection.
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

         

        If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

         

        For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

        

      
        - **Name** *(string) --* 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

          

        
          - *(string) --* 

          
      
      
  
    :type DryRun: boolean
    :param DryRun: 

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

      

    
    :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**

      
      ::

        {
            'Connections': [
                {
                    'ClientVpnEndpointId': 'string',
                    'Timestamp': 'string',
                    'ConnectionId': 'string',
                    'Username': 'string',
                    'ConnectionEstablishedTime': 'string',
                    'IngressBytes': 'string',
                    'EgressBytes': 'string',
                    'IngressPackets': 'string',
                    'EgressPackets': 'string',
                    'ClientIp': 'string',
                    'ClientIpv6Address': 'string',
                    'CommonName': 'string',
                    'Status': {
                        'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated',
                        'Message': 'string'
                    },
                    'ConnectionEndTime': 'string',
                    'PostureComplianceStatuses': [
                        'string',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Connections** *(list) --* 

          Information about the active and terminated client connections.

          
          

          - *(dict) --* 

            Describes a client connection.

            
            

            - **ClientVpnEndpointId** *(string) --* 

              The ID of the Client VPN endpoint to which the client is connected.

              
            

            - **Timestamp** *(string) --* 

              The current date and time.

              
            

            - **ConnectionId** *(string) --* 

              The ID of the client connection.

              
            

            - **Username** *(string) --* 

              The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

              
            

            - **ConnectionEstablishedTime** *(string) --* 

              The date and time the client connection was established.

              
            

            - **IngressBytes** *(string) --* 

              The number of bytes sent by the client.

              
            

            - **EgressBytes** *(string) --* 

              The number of bytes received by the client.

              
            

            - **IngressPackets** *(string) --* 

              The number of packets sent by the client.

              
            

            - **EgressPackets** *(string) --* 

              The number of packets received by the client.

              
            

            - **ClientIp** *(string) --* 

              The IP address of the client.

              
            

            - **ClientIpv6Address** *(string) --* 

              The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.

              
            

            - **CommonName** *(string) --* 

              The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

              
            

            - **Status** *(dict) --* 

              The current state of the client connection.

              
              

              - **Code** *(string) --* 

                The state of the client connection.

                
              

              - **Message** *(string) --* 

                A message about the status of the client connection, if applicable.

                
          
            

            - **ConnectionEndTime** *(string) --* 

              The date and time the client connection was terminated.

              
            

            - **PostureComplianceStatuses** *(list) --* 

              The statuses returned by the client connect handler for posture compliance, if applicable.

              
              

              - *(string) --* 
          
        
      
    