NetworkManager / Client / associate_connect_peer

associate_connect_peer#

NetworkManager.Client.associate_connect_peer(**kwargs)#

Associates a core network 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 core network Connect peers that have been created on a core network Connect attachment on a core network.

See also: AWS API Documentation

Request Syntax

response = client.associate_connect_peer(
    GlobalNetworkId='string',
    ConnectPeerId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of your global network.

  • ConnectPeerId (string) –

    [REQUIRED]

    The ID 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

{
    'ConnectPeerAssociation': {
        'ConnectPeerId': 'string',
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

  • (dict) –

    • ConnectPeerAssociation (dict) –

      The response to the Connect peer request.

      • ConnectPeerId (string) –

        The ID of the Connect peer.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • DeviceId (string) –

        The ID of the device to connect to.

      • LinkId (string) –

        The ID of the link.

      • State (string) –

        The state of the Connect peer association.

Exceptions