NetworkManager / Client / get_core_network
get_core_network#
- NetworkManager.Client.get_core_network(**kwargs)#
Returns information about the LIVE policy for a core network.
See also: AWS API Documentation
Request Syntax
response = client.get_core_network( CoreNetworkId='string' )
- Parameters:
CoreNetworkId (string) –
[REQUIRED]
The ID of a core network.
- Return type:
dict
- Returns:
Response Syntax
{ 'CoreNetwork': { 'GlobalNetworkId': 'string', 'CoreNetworkId': 'string', 'CoreNetworkArn': 'string', 'Description': 'string', 'CreatedAt': datetime(2015, 1, 1), 'State': 'CREATING'|'UPDATING'|'AVAILABLE'|'DELETING', 'Segments': [ { 'Name': 'string', 'EdgeLocations': [ 'string', ], 'SharedSegments': [ 'string', ] }, ], 'NetworkFunctionGroups': [ { 'Name': 'string', 'EdgeLocations': [ 'string', ], 'Segments': { 'SendVia': [ 'string', ], 'SendTo': [ 'string', ] } }, ], 'Edges': [ { 'EdgeLocation': 'string', 'Asn': 123, 'InsideCidrBlocks': [ 'string', ] }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } }
Response Structure
(dict) –
CoreNetwork (dict) –
Details about a core network.
GlobalNetworkId (string) –
The ID of the global network that your core network is a part of.
CoreNetworkId (string) –
The ID of a core network.
CoreNetworkArn (string) –
The ARN of a core network.
Description (string) –
The description of a core network.
CreatedAt (datetime) –
The timestamp when a core network was created.
State (string) –
The current state of a core network.
Segments (list) –
The segments within a core network.
(dict) –
Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.
Name (string) –
The name of a core network segment.
EdgeLocations (list) –
The Regions where the edges are located.
(string) –
SharedSegments (list) –
The shared segments of a core network.
(string) –
NetworkFunctionGroups (list) –
The network function groups associated with a core network.
(dict) –
Describes a network function group.
Name (string) –
The name of the network function group.
EdgeLocations (list) –
The core network edge locations.
(string) –
Segments (dict) –
The segments associated with the network function group.
SendVia (list) –
The list of segments associated with the
send-via
action.(string) –
SendTo (list) –
The list of segments associated with the
send-to
action.(string) –
Edges (list) –
The edges within a core network.
(dict) –
Describes a core network edge.
EdgeLocation (string) –
The Region where a core network edge is located.
Asn (integer) –
The ASN of a core network edge.
InsideCidrBlocks (list) –
The inside IP addresses used for core network edges.
(string) –
Tags (list) –
The list of key-value tags associated with a core network.
(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