NetworkManager / Client / associate_transit_gateway_connect_peer

associate_transit_gateway_connect_peer#

NetworkManager.Client.associate_transit_gateway_connect_peer(**kwargs)#

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that’s registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

See also: AWS API Documentation

Request Syntax

response = client.associate_transit_gateway_connect_peer(
    GlobalNetworkId='string',
    TransitGatewayConnectPeerArn='string',
    DeviceId='string',
    LinkId='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the Connect peer.

  • DeviceId (string) –

    [REQUIRED]

    The ID of the device.

  • LinkId (string) – The ID of the link.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayConnectPeerAssociation': {
        'TransitGatewayConnectPeerArn': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) –

    • TransitGatewayConnectPeerAssociation (dict) –

      The transit gateway Connect peer association.

      • TransitGatewayConnectPeerArn (string) –

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

      • GlobalNetworkId (string) –

        The ID of the global network.

      • DeviceId (string) –

        The ID of the device.

      • LinkId (string) –

        The ID of the link.

      • State (string) –

        The state of the association.

Exceptions