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

******************************************
DescribeLocalGatewayVirtualInterfaceGroups
******************************************



.. py:class:: EC2.Paginator.DescribeLocalGatewayVirtualInterfaceGroups

  ::

    
    paginator = client.get_paginator('describe_local_gateway_virtual_interface_groups')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The IDs of the virtual interface groups.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      One or more filters.

       

      
      * ``local-gateway-id`` - The ID of a local gateway.
       
      * ``local-gateway-virtual-interface-group-id`` - The ID of the virtual interface group.
       
      * ``local-gateway-virtual-interface-id`` - The ID of the virtual interface.
       
      * ``owner-id`` - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
      

      

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

      
      ::

        {
            'LocalGatewayVirtualInterfaceGroups': [
                {
                    'LocalGatewayVirtualInterfaceGroupId': 'string',
                    'LocalGatewayVirtualInterfaceIds': [
                        'string',
                    ],
                    'LocalGatewayId': 'string',
                    'OwnerId': 'string',
                    'LocalBgpAsn': 123,
                    'LocalBgpAsnExtended': 123,
                    'LocalGatewayVirtualInterfaceGroupArn': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **LocalGatewayVirtualInterfaceGroups** *(list) --* 

          The virtual interface groups.

          
          

          - *(dict) --* 

            Describes a local gateway virtual interface group.

            
            

            - **LocalGatewayVirtualInterfaceGroupId** *(string) --* 

              The ID of the virtual interface group.

              
            

            - **LocalGatewayVirtualInterfaceIds** *(list) --* 

              The IDs of the virtual interfaces.

              
              

              - *(string) --* 
          
            

            - **LocalGatewayId** *(string) --* 

              The ID of the local gateway.

              
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

              
            

            - **LocalBgpAsn** *(integer) --* 

              The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).

              
            

            - **LocalBgpAsnExtended** *(integer) --* 

              The extended 32-bit ASN for the local BGP configuration.

              
            

            - **LocalGatewayVirtualInterfaceGroupArn** *(string) --* 

              The Amazon Resource Number (ARN) of the local gateway virtual interface group.

              
            

            - **Tags** *(list) --* 

              The tags assigned to the virtual interface group.

              
              

              - *(dict) --* 

                Describes a tag.

                
                

                - **Key** *(string) --* 

                  The key of the tag.

                   

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                  
                

                - **Value** *(string) --* 

                  The value of the tag.

                   

                  Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                  
            
          
            

            - **ConfigurationState** *(string) --* 

              The current state of the local gateway virtual interface group.

              
        
      
    