DirectConnect / Client / describe_interconnects

describe_interconnects#

DirectConnect.Client.describe_interconnects(**kwargs)#

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

Request Syntax

response = client.describe_interconnects(
    interconnectId='string'
)

Parameters:

interconnectId (string) – The ID of the interconnect.

Return type:

dict

Returns:

Response Syntax

{
    'interconnects': [
        {
            'interconnectId': 'string',
            'interconnectName': 'string',
            'interconnectState': 'requested'|'pending'|'available'|'down'|'deleting'|'deleted'|'unknown',
            'region': 'string',
            'location': 'string',
            'bandwidth': 'string',
            'loaIssueTime': datetime(2015, 1, 1),
            'lagId': 'string',
            'awsDevice': 'string',
            'jumboFrameCapable': True|False,
            'awsDeviceV2': 'string',
            'awsLogicalDeviceId': 'string',
            'hasLogicalRedundancy': 'unknown'|'yes'|'no',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'providerName': 'string'
        },
    ]
}

Response Structure

(dict) –
- interconnects (list) –
  
  The interconnects.
  - (dict) –
    
    Information about an interconnect.
    - interconnectId (string) –
      
      The ID of the interconnect.
    - interconnectName (string) –
      
      The name of the interconnect.
    - interconnectState (string) –
      
      The state of the interconnect. The following are the possible values:
      - requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
      - pending: The interconnect is approved, and is being initialized.
      - available: The network link is up, and the interconnect is ready for use.
      - down: The network link is down.
      - deleting: The interconnect is being deleted.
      - deleted: The interconnect is deleted.
      - unknown: The state of the interconnect is not available.
    - region (string) –
      
      The Amazon Web Services Region where the connection is located.
    - location (string) –
      
      The location of the connection.
    - bandwidth (string) –
      
      The bandwidth of the connection.
    - loaIssueTime (datetime) –
      
      The time of the most recent call to DescribeLoa for this connection.
    - lagId (string) –
      
      The ID of the LAG.
    - awsDevice (string) –
      
      The Direct Connect endpoint on which the physical connection terminates.
    - jumboFrameCapable (boolean) –
      
      Indicates whether jumbo frames (9001 MTU) are supported.
    - awsDeviceV2 (string) –
      
      The Direct Connect endpoint that terminates the physical connection.
    - awsLogicalDeviceId (string) –
      
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
    - hasLogicalRedundancy (string) –
      
      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
    - tags (list) –
      
      The tags associated with the interconnect.
      - (dict) –
        
        Information about a tag.
        
        key (string) –
        
        The key.
        
        value (string) –
        
        The value.
    - providerName (string) –
      
      The name of the service provider associated with the interconnect.

Exceptions

DirectConnect.Client.exceptions.DirectConnectServerException
DirectConnect.Client.exceptions.DirectConnectClientException