NetworkManager / Client / deregister_transit_gateway

deregister_transit_gateway#

NetworkManager.Client.deregister_transit_gateway(**kwargs)#

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.

Request Syntax

response = client.deregister_transit_gateway(
    GlobalNetworkId='string',
    TransitGatewayArn='string'
)

Parameters:

GlobalNetworkId (string) –
[REQUIRED]

The ID of the global network.
TransitGatewayArn (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayRegistration': {
        'GlobalNetworkId': 'string',
        'TransitGatewayArn': 'string',
        'State': {
            'Code': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'|'FAILED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) –
- TransitGatewayRegistration (dict) –
  
  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 (dict) –
    
    The state of the transit gateway registration.
    - Code (string) –
      
      The code for the state reason.
    - Message (string) –
      
      The message for the state reason.

Exceptions

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