[ aws . networkmanager ]



Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--global-network-id <value>
--transit-gateway-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--global-network-id (string)

The ID of the global network.

--transit-gateway-arn (string)

The Amazon Resource Name (ARN) of the transit gateway.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 deregister a transit gateway from a global network

The following deregister-transit-gateway example deregisters the specified transit gateway from the specified global network.

aws networkmanager deregister-transit-gateway \
    --global-network-id global-network-01231231231231231 \
    --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \
    --region us-west-2


    "TransitGatewayRegistration": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc",
        "State": {
            "Code": "DELETING"

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


TransitGatewayRegistration -> (structure)

The transit gateway registration information.

GlobalNetworkId -> (string)

The ID of the global network.

TransitGatewayArn -> (string)

The Amazon Resource Name (ARN) of the transit gateway.

State -> (structure)

The state of the transit gateway registration.

Code -> (string)

The code for the state reason.

Message -> (string)

The message for the state reason.