NetworkManager / Client / associate_link

associate_link

NetworkManager.Client.associate_link(**kwargs)

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

See also: AWS API Documentation

Request Syntax

response = client.associate_link(
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• DeviceId (string) –

  [REQUIRED]

  The ID of the device.

• LinkId (string) –

  [REQUIRED]

  The ID of the link.

Return type:

dict

Returns:

Response Syntax

{
    'LinkAssociation': {
        'GlobalNetworkId': 'string',
        'DeviceId': 'string',
        'LinkId': 'string',
        'LinkAssociationState': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
    }
}

Response Structure

• (dict) –

  • LinkAssociation (dict) –

    The link association.

    • GlobalNetworkId (string) –

      The ID of the global network.

    • DeviceId (string) –

      The device ID for the link association.

    • LinkId (string) –

      The ID of the link.

    • LinkAssociationState (string) –

      The state of the association.

Exceptions

• NetworkManager.Client.exceptions.ValidationException

• NetworkManager.Client.exceptions.ServiceQuotaExceededException

• NetworkManager.Client.exceptions.AccessDeniedException

• NetworkManager.Client.exceptions.ResourceNotFoundException

• NetworkManager.Client.exceptions.ConflictException

• NetworkManager.Client.exceptions.ThrottlingException

• NetworkManager.Client.exceptions.InternalServerException