NetworkManager / Client / register_transit_gateway

register_transit_gateway#

NetworkManager.Client.register_transit_gateway(**kwargs)#

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

Request Syntax

response = client.register_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) –
  
  Information about the transit gateway registration.
  - 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