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',
    maxResults=123,
    nextToken='string'
)

Parameters:

interconnectId (string) – The ID of the interconnect.
maxResults (integer) –
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
nextToken (string) – The token for the next page of results.

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',
            'macSecCapable': True|False,
            'portEncryptionStatus': 'string',
            'encryptionMode': 'string',
            'macSecKeys': [
                {
                    'secretARN': 'string',
                    'ckn': 'string',
                    'state': 'string',
                    'startOn': 'string'
                },
            ]
        },
    ],
    'nextToken': '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 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.
    - macSecCapable (boolean) –
      
      Indicates whether the interconnect supports MAC Security (MACsec).
    - portEncryptionStatus (string) –
      
      The MAC Security (MACsec) port link status.
      
      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
    - encryptionMode (string) –
      
      The MAC Security (MACsec) encryption mode.
      
      The valid values are no_encrypt, should_encrypt, and must_encrypt.
    - macSecKeys (list) –
      
      The MAC Security (MACsec) security keys.
      - (dict) –
        
        Information about the MAC Security (MACsec) secret key.
        
        secretARN (string) –
        
        The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.
        
        ckn (string) –
        
        The Connection Key Name (CKN) for the MAC Security secret key.
        
        state (string) –
        
        The state of the MAC Security (MACsec) secret key.
        
        The possible values are:
        
        associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
        
        associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
        
        disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
        
        disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.
        
        startOn (string) –
        
        The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.
- nextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describe_interconnects¶

Request Syntax

Response Syntax

Response Structure

Exceptions