:doc:`EVS <../../evs>` / Paginator / ListEnvironmentVlans

********************
ListEnvironmentVlans
********************



.. py:class:: EVS.Paginator.ListEnvironmentVlans

  ::

    
    paginator = client.get_paginator('list_environment_vlans')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EVS.Client.list_environment_vlans`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentVlans>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          environmentId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type environmentId: string
    :param environmentId: **[REQUIRED]** 

      A unique ID for the environment.

      

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

      
      ::

        {
            'environmentVlans': [
                {
                    'vlanId': 123,
                    'cidr': 'string',
                    'availabilityZone': 'string',
                    'functionName': 'string',
                    'subnetId': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'modifiedAt': datetime(2015, 1, 1),
                    'vlanState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
                    'stateDetails': 'string',
                    'eipAssociations': [
                        {
                            'associationId': 'string',
                            'allocationId': 'string',
                            'ipAddress': 'string'
                        },
                    ],
                    'isPublic': True|False,
                    'networkAclId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **environmentVlans** *(list) --* 

          A list of VLANs that are associated with the specified environment.

          
          

          - *(dict) --* 

            The VLANs that Amazon EVS creates during environment creation.

            
            

            - **vlanId** *(integer) --* 

              The unique ID of the VLAN.

              
            

            - **cidr** *(string) --* 

              The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

              
            

            - **availabilityZone** *(string) --* 

              The availability zone of the VLAN.

              
            

            - **functionName** *(string) --* 

              The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a ``functionName`` of ``hcx`` is being used to carry VMware HCX traffic.

              
            

            - **subnetId** *(string) --* 

              The unique ID of the VLAN subnet.

              
            

            - **createdAt** *(datetime) --* 

              The date and time that the VLAN was created.

              
            

            - **modifiedAt** *(datetime) --* 

              The date and time that the VLAN was modified.

              
            

            - **vlanState** *(string) --* 

              The state of the VLAN.

              
            

            - **stateDetails** *(string) --* 

              The state details of the VLAN.

              
            

            - **eipAssociations** *(list) --* 

              An array of Elastic IP address associations.

              
              

              - *(dict) --* 

                An Elastic IP address association with the elastic network interface in the VLAN subnet.

                
                

                - **associationId** *(string) --* 

                  A unique ID for the elastic IP address association with the VLAN subnet.

                  
                

                - **allocationId** *(string) --* 

                  The Elastic IP address allocation ID.

                  
                

                - **ipAddress** *(string) --* 

                  The Elastic IP address.

                  
            
          
            

            - **isPublic** *(boolean) --* 

              Determines if the VLAN that Amazon EVS provisions is public or private.

              
            

            - **networkAclId** *(string) --* 

              A unique ID for a network access control list.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    