NetworkManager / Client / get_connect_peer
get_connect_peer#
- NetworkManager.Client.get_connect_peer(**kwargs)#
Returns information about a core network Connect peer.
See also: AWS API Documentation
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'|'NO_ENCAP', 'BgpConfigurations': [ { 'CoreNetworkAsn': 123, 'PeerAsn': 123, 'CoreNetworkAddress': 'string', 'PeerAddress': 'string' }, ] }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SubnetArn': 'string', 'LastModificationErrors': [ { 'Code': 'EDGE_LOCATION_NO_FREE_IPS'|'EDGE_LOCATION_PEER_DUPLICATE'|'SUBNET_NOT_FOUND'|'IP_OUTSIDE_SUBNET_CIDR_RANGE'|'INVALID_INSIDE_CIDR_BLOCK'|'NO_ASSOCIATED_CIDR_BLOCK', 'Message': 'string', 'ResourceArn': 'string', 'RequestId': '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.
SubnetArn (string) –
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
LastModificationErrors (list) –
Describes the error associated with the attachment request.
(dict) –
Describes an error associated with a Connect peer request
Code (string) –
The error code for the Connect peer request.
Message (string) –
The message associated with the error
code
.ResourceArn (string) –
The ARN of the requested Connect peer resource.
RequestId (string) –
The ID of the Connect peer request.
Exceptions
NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException