NetworkManager / Client / delete_global_network

delete_global_network#

NetworkManager.Client.delete_global_network(**kwargs)#

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.

See also: AWS API Documentation

Request Syntax

response = client.delete_global_network(
    GlobalNetworkId='string'
)
Parameters:

GlobalNetworkId (string) –

[REQUIRED]

The ID of the global network.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • GlobalNetwork (dict) –

      Information about the global 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.

Exceptions