Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmanager ]



Updates an existing global network. To remove information for any of the parameters, specify an empty string.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--global-network-id <value>
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--global-network-id (string)

The ID of your global network.

--description (string)

A description of the global network.

Constraints: Maximum length of 256 characters.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To update a global network

The following update-global-network example updates the description for global network global-network-01231231231231231.

aws networkmanager update-global-network \
    --global-network-id global-network-01231231231231231 \
    --description "Head offices" \
    --region us-west-2


    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
        "Description": "Head offices",
        "CreatedAt": 1575553525.0,
        "State": "UPDATING"

For more information, see Global Networks in the Transit Gateway Network Manager Guide.


GlobalNetwork -> (structure)

Information about the global network object.

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 -> (timestamp)

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.


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.