NetworkManager / Client / get_connect_peer

get_connect_peer#

NetworkManager.Client.get_connect_peer(**kwargs)#

Returns information about a core network Connect peer.

Request Syntax

response = client.get_connect_peer(
    ConnectPeerId='string'
)

Parameters:

ConnectPeerId (string) –

[REQUIRED]

The ID of the Connect peer.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectPeer': {
        'CoreNetworkId': 'string',
        'ConnectAttachmentId': 'string',
        'ConnectPeerId': 'string',
        'EdgeLocation': 'string',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'Configuration': {
            'CoreNetworkAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'GRE',
            'BgpConfigurations': [
                {
                    'CoreNetworkAsn': 123,
                    'PeerAsn': 123,
                    'CoreNetworkAddress': 'string',
                    'PeerAddress': 'string'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- ConnectPeer (dict) –
  
  Returns information about a core network Connect peer.
  - CoreNetworkId (string) –
    
    The ID of a core network.
  - ConnectAttachmentId (string) –
    
    The ID of the attachment to connect.
  - ConnectPeerId (string) –
    
    The ID of the Connect peer.
  - EdgeLocation (string) –
    
    The Connect peer Regions where edges are located.
  - State (string) –
    
    The state of the Connect peer.
  - CreatedAt (datetime) –
    
    The timestamp when the Connect peer was created.
  - Configuration (dict) –
    
    The configuration of the Connect peer.
    - CoreNetworkAddress (string) –
      
      The IP address of a core network.
    - PeerAddress (string) –
      
      The IP address of the Connect peer.
    - InsideCidrBlocks (list) –
      
      The inside IP addresses used for a Connect peer configuration.
      - (string) –
    - Protocol (string) –
      
      The protocol used for a Connect peer configuration.
    - BgpConfigurations (list) –
      
      The Connect peer BGP configurations.
      - (dict) –
        
        Describes a core network BGP configuration.
        
        CoreNetworkAsn (integer) –
        
        The ASN of the Coret Network.
        
        PeerAsn (integer) –
        
        The ASN of the Connect peer.
        
        CoreNetworkAddress (string) –
        
        The address of a core network.
        
        PeerAddress (string) –
        
        The address of a core network Connect peer.
  - Tags (list) –
    
    The list of key-value tags associated with the Connect peer.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
      - Value (string) –
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.

Exceptions

NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException