EVS / Paginator / ListEnvironmentVlans

ListEnvironmentVlans¶

class EVS.Paginator.ListEnvironmentVlans¶

paginator = client.get_paginator('list_environment_vlans')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EVS.Client.list_environment_vlans().

Request Syntax

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

Parameters:

environmentId (string) –
[REQUIRED]

A unique ID for the environment.
PaginationConfig (dict) –
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.

Return type:

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'
        },
    ],
    '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.
    - 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.
- NextToken (string) –
  
  A token to resume pagination.