NetworkManager / Client / describe_global_networks

describe_global_networks#

NetworkManager.Client.describe_global_networks(**kwargs)#

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

Request Syntax

response = client.describe_global_networks(
    GlobalNetworkIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

GlobalNetworkIds (list) –
The IDs of one or more global networks. The maximum is 10.
- (string) –
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalNetworks': [
        {
            'GlobalNetworkId': 'string',
            'GlobalNetworkArn': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- GlobalNetworks (list) –
  
  Information about the global networks.
  - (dict) –
    
    Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core Network.
    - GlobalNetworkId (string) –
      
      The ID of the global network.
    - GlobalNetworkArn (string) –
      
      The Amazon Resource Name (ARN) of the global network.
    - Description (string) –
      
      The description of the global network.
    - CreatedAt (datetime) –
      
      The date and time that the global network was created.
    - State (string) –
      
      The state of the global network.
    - Tags (list) –
      
      The tags for the global 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.
- NextToken (string) –
  
  The token for the next page of results.

Exceptions

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