EVS / Client / list_environment_vlans

list_environment_vlans¶

EVS.Client.list_environment_vlans(**kwargs)¶

Lists environment VLANs that are associated with the specified environment.

Request Syntax

response = client.list_environment_vlans(
    nextToken='string',
    maxResults=123,
    environmentId='string'
)

Parameters:

nextToken (string) – A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
maxResults (integer) – The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
environmentId (string) –
[REQUIRED]

A unique ID for the environment.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A unique pagination token for next page results. Make the call again using this token to retrieve the next page.
- 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.

Exceptions

EVS.Client.exceptions.ValidationException
EVS.Client.exceptions.ResourceNotFoundException